-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
Servers.json
1195 lines (1195 loc) · 55.7 KB
/
Servers.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"swagger": "2.0",
"info": {
"version": "2023-02-01-preview",
"title": "SqlManagementClient",
"description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities."
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/subscriptions/{subscriptionId}/providers/Microsoft.Sql/checkNameAvailability": {
"post": {
"tags": [
"Servers"
],
"description": "Determines whether a resource can be created with the specified name.",
"operationId": "Servers_CheckNameAvailability",
"parameters": [
{
"name": "parameters",
"in": "body",
"description": "The name availability request parameters.",
"required": true,
"schema": {
"$ref": "#/definitions/CheckNameAvailabilityRequest"
}
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully completed the availability check.",
"schema": {
"$ref": "#/definitions/CheckNameAvailabilityResponse"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 InvalidNameAvailabilityRequest - The check name availability request is invalid.\n\n * 400 UnknownNameType - Unknown resource type specified for a subscription level name availability check."
}
},
"x-ms-examples": {
"Check for a server name that already exists": {
"$ref": "./examples/CheckNameAvailabilityServerAlreadyExists.json"
},
"Check for a server name that is available": {
"$ref": "./examples/CheckNameAvailabilityServerAvailable.json"
},
"Check for a server name that is invalid": {
"$ref": "./examples/CheckNameAvailabilityServerInvalid.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Sql/servers": {
"get": {
"tags": [
"Servers"
],
"description": "Gets a list of all servers in the subscription.",
"operationId": "Servers_List",
"parameters": [
{
"name": "$expand",
"in": "query",
"description": "The child resources to include in the response.",
"required": false,
"type": "string"
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully retrieved the list of servers.",
"schema": {
"$ref": "#/definitions/ServerListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 404 SubscriptionNotFound - The requested subscription was not found."
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"List servers": {
"$ref": "./examples/ServerList.json"
},
"List servers with $expand=administrators/activedirectory": {
"$ref": "./examples/ServerListWithExpandEqualsAdministrators.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers": {
"get": {
"tags": [
"Servers"
],
"description": "Gets a list of servers in a resource groups.",
"operationId": "Servers_ListByResourceGroup",
"parameters": [
{
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
},
{
"name": "$expand",
"in": "query",
"description": "The child resources to include in the response.",
"required": false,
"type": "string"
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully retrieved the list of servers.",
"schema": {
"$ref": "#/definitions/ServerListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 404 SubscriptionNotFound - The requested subscription was not found."
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"List servers by resource group": {
"$ref": "./examples/ServerListByResourceGroup.json"
},
"List servers by resource group with $expand=administrators/activedirectory": {
"$ref": "./examples/ServerListByResourceGroupWithExpandEqualsAdministrators.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}": {
"get": {
"tags": [
"Servers"
],
"description": "Gets a server.",
"operationId": "Servers_Get",
"parameters": [
{
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
},
{
"$ref": "#/parameters/ServerNameParameter"
},
{
"name": "$expand",
"in": "query",
"description": "The child resources to include in the response.",
"required": false,
"type": "string"
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully retrieved the specified server.",
"schema": {
"$ref": "#/definitions/Server"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ResourceNotFound - The requested resource was not found."
}
},
"x-ms-examples": {
"Get server": {
"$ref": "./examples/ServerGet.json"
},
"Get server with $expand=administrators/activedirectory": {
"$ref": "./examples/ServerGetWithExpandEqualsAdministrators.json"
}
}
},
"put": {
"tags": [
"Servers"
],
"description": "Creates or updates a server.",
"operationId": "Servers_CreateOrUpdate",
"parameters": [
{
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
},
{
"$ref": "#/parameters/ServerNameParameter"
},
{
"name": "parameters",
"in": "body",
"description": "The requested server resource state.",
"required": true,
"schema": {
"$ref": "#/definitions/Server"
}
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully updated the server.",
"schema": {
"$ref": "#/definitions/Server"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 PECsNotExistingToDenyPublicNetworkAccess - Unable to set Deny Public Network Access to Yes since there is no private endpoint enabled to access the server. Please set up private endpoints and retry the operation (https://docs.microsoft.com/azure/sql-database/sql-database-private-endpoint-overview#how-to-set-up-private-link-for-azure-sql-database).\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 Ipv6FeatureNotEnabled - User tried to turn on Ipv6 support on the server without enabling feature flag on subscription, or the feature support is currently disabled in the region.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name.\n\n * 400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id.\n\n * 400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id.\n\n * 400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group.\n\n * 400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator.\n\n * 400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpsertLogicalServerRequestAlreadyInProgress - An ongoing logical server request is already in progress, please try your request again later.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources."
},
"202": {
"description": "Accepted"
},
"201": {
"description": "Successfully created the server.",
"schema": {
"$ref": "#/definitions/Server"
}
}
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
"Create server": {
"$ref": "./examples/ServerCreate.json"
}
}
},
"delete": {
"tags": [
"Servers"
],
"description": "Deletes a server.",
"operationId": "Servers_Delete",
"parameters": [
{
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
},
{
"$ref": "#/parameters/ServerNameParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted the server."
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 DropLogicalServerAlreadyInProgress - Server is already being dropped.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources."
},
"202": {
"description": "Accepted"
},
"204": {
"description": "The specified server does not exist."
}
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
"Delete server": {
"$ref": "./examples/ServerDelete.json"
}
}
},
"patch": {
"tags": [
"Servers"
],
"description": "Updates a server.",
"operationId": "Servers_Update",
"parameters": [
{
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
},
{
"$ref": "#/parameters/ServerNameParameter"
},
{
"name": "parameters",
"in": "body",
"description": "The requested server resource state.",
"required": true,
"schema": {
"$ref": "#/definitions/ServerUpdate"
}
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully updated the server.",
"schema": {
"$ref": "#/definitions/Server"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 PECsNotExistingToDenyPublicNetworkAccess - Unable to set Deny Public Network Access to Yes since there is no private endpoint enabled to access the server. Please set up private endpoints and retry the operation (https://docs.microsoft.com/azure/sql-database/sql-database-private-endpoint-overview#how-to-set-up-private-link-for-azure-sql-database).\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 Ipv6FeatureNotEnabled - User tried to turn on Ipv6 support on the server without enabling feature flag on subscription, or the feature support is currently disabled in the region.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name.\n\n * 400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id.\n\n * 400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id.\n\n * 400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group.\n\n * 400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator.\n\n * 400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpsertLogicalServerRequestAlreadyInProgress - An ongoing logical server request is already in progress, please try your request again later.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources."
},
"202": {
"description": "Accepted"
}
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
"Update a server": {
"$ref": "./examples/ServerUpdate.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/import": {
"post": {
"tags": [
"Servers"
],
"description": "Imports a bacpac into a new database.",
"operationId": "Servers_ImportDatabase",
"parameters": [
{
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
},
{
"$ref": "#/parameters/ServerNameParameter"
},
{
"name": "parameters",
"in": "body",
"description": "The database import request parameters.",
"required": true,
"schema": {
"$ref": "#/definitions/ImportNewDatabaseDefinition"
}
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully imported the database.",
"schema": {
"$ref": "#/definitions/ImportExportOperationResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 MissingImportExportInputParameters - Missing ImportExport input parameters.\n\n * 400 InvalidImportExportInputParameter - The import/export request failed due to an invalid input parameter.\n\n * 400 PolybaseImportAuthenticationTypeNotSupported - Authentication type parameter is not support for PolybaseImport operation.\n\n * 400 DatabaseExtensionsInvalidOperationMode - Invalid operationMode parameter for database extension.\n\n * 400 DatabaseExtensionsInvalidStorageKeyType - The storage key type must by 'StorageAccessKey'.\n\n * 400 DatabaseExtensionsMissingStorageUri - Storage URI cannot be empty.\n\n * 400 InvalidSqlAuthType - ImportExport operation failed because the sql authentication type is invalid\n\n * 400 BlobAlreadyExist - ImportExport operation failed because the storage blob is already exists\n\n * 400 InvalidImportExportOperationResourceLocks - The Import/Export request is invalid due to locks on the Private Link resources.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 ImportExportJobError - The ImportExport operation has failed.\n\n * 400 BlockedByOutboundFirewall - The outbound firewall rules blocked the request.\n\n * 400 InvalidOperationType - Provide a valid operation type.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidImportExportParameter - The Import/Export request failed due to an invalid input parameter.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 InvalidImportExportStorageCredentials - Import/Export operation failed due to invalid storage credentials\n\n * 400 InvalidImportExportStorageAuthType - Import/Export operation failed due to invalid storage auth type\n\n * 400 InvalidImportExportStorageKeyFormat - Import/Export operation failed due to invalid storage key format\n\n * 400 LongImportExportStorageUri - Import/Export operation failed due to long storage URI\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 LargeExportDatabaseSize - Export operation failed because database is larger than max supported size\n\n * 400 UnSupportedImportExportEdition - ImportExport operation failed because it is targeting a invalid edition\n\n * 400 InvalidImportExportStorageURI - ImportExport operation failed because storage URI is invalid\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - Invalid request specifying a non-existent resource.\n\n * 404 ImportExportOperationIdNotFound - The operation Id for import or export cannot be found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 ImportExportOperationInProgress - There is an import or export operation in progress on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources."
},
"202": {
"description": "Importing the database is in progress."
}
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
"Imports to a new database.": {
"$ref": "./examples/ImportNewDatabase.json"
},
"Imports to a new database, using private link for the SQL server and storage account.": {
"$ref": "./examples/ImportNewDatabaseWithNetworkIsolation.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/refreshExternalGovernanceStatus": {
"post": {
"tags": [
"Servers"
],
"description": "Refresh external governance enablement status.",
"operationId": "Servers_RefreshStatus",
"parameters": [
{
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
},
{
"$ref": "#/parameters/ServerNameParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully refreshed external governance enablement status.",
"schema": {
"$ref": "#/definitions/RefreshExternalGovernanceStatusOperationResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources."
},
"202": {
"description": "Refreshing external governance enablement status."
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-examples": {
"Refresh external governance enablement status.": {
"$ref": "./examples/RefreshExternalGovernanceStatus.json"
}
}
}
}
},
"definitions": {
"CheckNameAvailabilityRequest": {
"description": "A request to check whether the specified name for a resource is available.",
"required": [
"name",
"type"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"Microsoft.Sql/servers"
],
"type": "string",
"x-ms-enum": {
"name": "CheckNameAvailabilityResourceType",
"modelAsString": false
}
}
}
},
"CheckNameAvailabilityResponse": {
"description": "The result of a name availability check.",
"type": "object",
"properties": {
"name": {
"description": "The name whose availability was checked.",
"type": "string",
"readOnly": true
},
"available": {
"description": "True if the name is available, otherwise false.",
"type": "boolean",
"readOnly": true
},
"reason": {
"description": "The reason code explaining why the name is unavailable. Will be undefined if the name is available.",
"enum": [
"Invalid",
"AlreadyExists"
],
"type": "string",
"readOnly": true,
"x-ms-enum": {
"name": "CheckNameAvailabilityReason",
"modelAsString": false
}
},
"message": {
"description": "A message explaining why the name is unavailable. Will be undefined if the name is available.",
"type": "string",
"readOnly": true
}
}
},
"ImportExportOperationResult": {
"description": "An ImportExport operation result resource.",
"type": "object",
"allOf": [
{
"$ref": "../../../common/v1/types.json#/definitions/ProxyResource"
}
],
"properties": {
"properties": {
"$ref": "#/definitions/ImportExportOperationResultProperties",
"description": "Resource properties.",
"x-ms-client-flatten": true
}
}
},
"ImportExportOperationResultProperties": {
"description": "Contains the operation result properties for import/export operation.",
"type": "object",
"properties": {
"requestId": {
"format": "uuid",
"description": "Request Id.",
"type": "string",
"readOnly": true
},
"requestType": {
"description": "Request type.",
"type": "string",
"readOnly": true
},
"queuedTime": {
"description": "Queued time.",
"type": "string",
"readOnly": true
},
"lastModifiedTime": {
"description": "Last modified time.",
"type": "string",
"readOnly": true
},
"blobUri": {
"description": "Blob Uri.",
"type": "string",
"readOnly": true
},
"serverName": {
"description": "Server name.",
"type": "string",
"readOnly": true
},
"databaseName": {
"description": "Database name.",
"type": "string",
"readOnly": true
},
"status": {
"description": "Operation status.",
"type": "string",
"readOnly": true
},
"errorMessage": {
"description": "Error message.",
"type": "string",
"readOnly": true
},
"privateEndpointConnections": {
"description": "Gets the status of private endpoints associated with this request.",
"type": "array",
"items": {
"$ref": "#/definitions/PrivateEndpointConnectionRequestStatus"
},
"readOnly": true
}
}
},
"ImportNewDatabaseDefinition": {
"description": "Contains the information necessary to perform import operation for new database.",
"required": [
"storageKeyType",
"storageKey",
"storageUri",
"administratorLogin",
"administratorLoginPassword"
],
"type": "object",
"properties": {
"databaseName": {
"description": "Name of the import database.",
"type": "string",
"x-ms-mutability": [
"create"
]
},
"edition": {
"description": "Edition of the import database.",
"type": "string",
"x-ms-mutability": [
"create"
]
},
"serviceObjectiveName": {
"description": "Service level objective name of the import database.",
"type": "string",
"x-ms-mutability": [
"create"
]
},
"maxSizeBytes": {
"description": "Max size in bytes for the import database.",
"type": "string",
"x-ms-mutability": [
"create"
]
},
"storageKeyType": {
"description": "Storage key type.",
"enum": [
"SharedAccessKey",
"StorageAccessKey"
],
"type": "string",
"x-ms-enum": {
"name": "StorageKeyType",
"modelAsString": true
},
"x-ms-mutability": [
"create"
]
},
"storageKey": {
"description": "Storage key.",
"type": "string",
"x-ms-mutability": [
"create"
]
},
"storageUri": {
"description": "Storage Uri.",
"type": "string",
"x-ms-mutability": [
"create"
]
},
"administratorLogin": {
"description": "Administrator login name.",
"type": "string",
"x-ms-mutability": [
"create"
]
},
"administratorLoginPassword": {
"description": "Administrator login password.",
"type": "string",
"x-ms-secret": true,
"x-ms-mutability": [
"create"
]
},
"authenticationType": {
"description": "Authentication type.",
"type": "string",
"x-ms-mutability": [
"create"
]
},
"networkIsolation": {
"$ref": "#/definitions/NetworkIsolationSettings",
"description": "Optional resource information to enable network isolation for request.",
"x-ms-mutability": [
"create"
]
}
}
},
"NetworkIsolationSettings": {
"description": "Contains the ARM resources for which to create private endpoint connection.",
"type": "object",
"properties": {
"storageAccountResourceId": {
"description": "The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter.",
"type": "string",
"format": "arm-id",
"x-ms-arm-id-details": {
"allowedResources": [
{}
]
},
"x-ms-mutability": [
"create"
]
},
"sqlServerResourceId": {
"description": "The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation.",
"type": "string",
"format": "arm-id",
"x-ms-mutability": [
"create"
]
}
}
},
"PrivateEndpointConnectionProperties": {
"description": "Properties of a private endpoint connection.",
"type": "object",
"properties": {
"privateEndpoint": {
"$ref": "#/definitions/PrivateEndpointProperty",
"description": "Private endpoint which the connection belongs to."
},
"groupIds": {
"description": "Group IDs.",
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"privateLinkServiceConnectionState": {
"$ref": "#/definitions/PrivateLinkServiceConnectionStateProperty",
"description": "Connection state of the private endpoint connection."
},
"provisioningState": {
"description": "State of the private endpoint connection.",
"enum": [
"Approving",
"Ready",
"Dropping",
"Failed",
"Rejecting"
],
"type": "string",
"readOnly": true,
"x-ms-enum": {
"name": "PrivateEndpointProvisioningState",
"modelAsString": true
}
}
}
},
"PrivateEndpointConnectionRequestStatus": {
"description": "Contains the private endpoint connection requests status.",
"type": "object",
"properties": {
"privateLinkServiceId": {
"description": "Resource id for which the private endpoint is created.",
"type": "string",
"readOnly": true
},
"privateEndpointConnectionName": {
"description": "The connection name for the private endpoint.",
"type": "string",
"readOnly": true
},
"status": {
"description": "Status of this private endpoint connection.",
"type": "string",
"readOnly": true
}
}
},
"PrivateEndpointProperty": {
"type": "object",
"properties": {
"id": {
"description": "Resource id of the private endpoint.",
"type": "string"
}
},
"x-ms-azure-resource": true
},
"PrivateLinkServiceConnectionStateProperty": {
"required": [
"status",
"description"
],
"type": "object",
"properties": {
"status": {
"description": "The private link service connection status.",
"enum": [
"Approved",
"Pending",
"Rejected",
"Disconnected"
],
"type": "string",
"x-ms-enum": {
"name": "PrivateLinkServiceConnectionStateStatus",
"modelAsString": true
}
},
"description": {
"description": "The private link service connection description.",
"type": "string"
},
"actionsRequired": {
"description": "The actions required for private link service connection.",
"enum": [
"None"
],
"type": "string",
"readOnly": true,
"x-ms-enum": {
"name": "PrivateLinkServiceConnectionStateActionsRequire",
"modelAsString": true
}
}
}
},
"RefreshExternalGovernanceStatusOperationResult": {
"description": "An RefreshExternalGovernanceStatus operation result resource.",
"type": "object",
"allOf": [
{
"$ref": "../../../common/v1/types.json#/definitions/ProxyResource"
}
],
"properties": {
"properties": {
"$ref": "#/definitions/RefreshExternalGovernanceStatusOperationResultProperties",
"description": "Resource properties.",
"x-ms-client-flatten": true
}
}
},
"RefreshExternalGovernanceStatusOperationResultProperties": {
"description": "Contains the operation result properties for refresh external governance status operation.",
"type": "object",
"properties": {
"requestId": {
"format": "uuid",
"description": "Request Id.",
"type": "string",
"readOnly": true
},
"requestType": {
"description": "Request type.",
"type": "string",
"readOnly": true
},
"queuedTime": {
"description": "Queued time.",
"type": "string",
"readOnly": true
},
"serverName": {
"description": "Server name.",
"type": "string",
"readOnly": true
},
"status": {
"description": "Operation status.",
"type": "string",
"readOnly": true
},
"errorMessage": {
"description": "Error message.",
"type": "string",
"readOnly": true
}
}
},
"Server": {
"description": "An Azure SQL Database server.",
"required": [
"location"
],
"type": "object",
"allOf": [
{
"$ref": "../../../common/v1/types.json#/definitions/TrackedResource"
}
],
"properties": {
"identity": {
"$ref": "../../../common/v2/types.json#/definitions/ResourceIdentity",
"description": "The Azure Active Directory identity of the server."
},
"kind": {
"description": "Kind of sql server. This is metadata used for the Azure portal experience.",
"type": "string",
"readOnly": true
},
"properties": {
"$ref": "#/definitions/ServerProperties",
"description": "Resource properties.",
"x-ms-client-flatten": true
}
}
},
"ServerExternalAdministrator": {
"description": "Properties of a active directory administrator.",
"type": "object",
"properties": {
"administratorType": {
"description": "Type of the sever administrator.",
"enum": [
"ActiveDirectory"
],
"type": "string",
"x-ms-enum": {
"name": "AdministratorType",
"modelAsString": true
}
},
"principalType": {
"description": "Principal Type of the sever administrator.",
"enum": [
"User",
"Group",
"Application"
],
"type": "string",
"x-ms-enum": {
"name": "PrincipalType",
"modelAsString": true
}
},
"login": {
"description": "Login name of the server administrator.",
"type": "string"
},
"sid": {
"format": "uuid",
"description": "SID (object ID) of the server administrator.",
"type": "string"
},
"tenantId": {
"format": "uuid",
"description": "Tenant ID of the administrator.",
"type": "string"
},
"azureADOnlyAuthentication": {
"description": "Azure Active Directory only Authentication enabled.",
"type": "boolean"
}
}
},
"ServerListResult": {
"description": "A list of servers.",
"type": "object",
"properties": {
"value": {
"description": "Array of results.",
"type": "array",
"items": {
"$ref": "#/definitions/Server"
},
"readOnly": true
},
"nextLink": {
"description": "Link to retrieve next page of results.",
"type": "string",
"readOnly": true
}
}
},
"ServerPrivateEndpointConnection": {
"description": "A private endpoint connection under a server",
"type": "object",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string",
"readOnly": true
},
"properties": {
"$ref": "#/definitions/PrivateEndpointConnectionProperties",
"description": "Private endpoint connection properties",
"readOnly": true
}
}
},
"ServerProperties": {
"description": "The properties of a server.",
"type": "object",
"properties": {
"administratorLogin": {
"description": "Administrator username for the server. Once created it cannot be changed.",
"type": "string",
"x-ms-mutability": [
"read",