-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
storage.json
5850 lines (5850 loc) · 215 KB
/
storage.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": {
"title": "StorageManagementClient",
"description": "The Azure Storage Management API.",
"version": "2023-05-01"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/providers/Microsoft.Storage/operations": {
"get": {
"tags": [
"Operations"
],
"description": "Lists all of the available Storage Rest API operations.",
"operationId": "Operations_List",
"x-ms-examples": {
"OperationsList": {
"$ref": "./examples/OperationsList.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/OperationListResult"
}
}
},
"x-ms-pageable": {
"nextLinkName": null
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Storage/skus": {
"get": {
"tags": [
"Skus"
],
"operationId": "Skus_List",
"description": "Lists the available SKUs supported by Microsoft.Storage for given subscription.",
"x-ms-examples": {
"SkuList": {
"$ref": "./examples/SKUList.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- List of storage SKUs in the given subscription retrieved and returned successfully.",
"schema": {
"$ref": "#/definitions/StorageSkuListResult"
}
}
},
"x-ms-pageable": {
"nextLinkName": null
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability": {
"post": {
"tags": [
"StorageAccounts"
],
"operationId": "StorageAccounts_CheckNameAvailability",
"description": "Checks that the storage account name is valid and is not already in use.",
"x-ms-examples": {
"StorageAccountCheckNameAvailability": {
"$ref": "./examples/StorageAccountCheckNameAvailability.json"
}
},
"parameters": [
{
"name": "accountName",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StorageAccountCheckNameAvailabilityParameters"
},
"description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only."
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- Operation to check the storage account name availability was successful.",
"schema": {
"$ref": "#/definitions/CheckNameAvailabilityResult"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}": {
"put": {
"tags": [
"StorageAccounts"
],
"operationId": "StorageAccounts_Create",
"description": "Asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.",
"x-ms-examples": {
"StorageAccountCreate": {
"$ref": "./examples/StorageAccountCreate.json"
},
"NfsV3AccountCreate": {
"$ref": "./examples/NfsV3AccountCreate.json"
},
"StorageAccountCreateUserAssignedEncryptionIdentityWithCMK": {
"$ref": "./examples/StorageAccountCreateUserAssignedEncryptionIdentityWithCMK.json"
},
"StorageAccountCreateWithImmutabilityPolicy": {
"$ref": "./examples/StorageAccountCreateWithImmutabilityPolicy.json"
},
"StorageAccountCreateDisallowPublicNetworkAccess": {
"$ref": "./examples/StorageAccountCreateDisallowPublicNetworkAccess.json"
},
"StorageAccountCreateEnablePublicNetworkAccess": {
"$ref": "./examples/StorageAccountCreateEnablePublicNetworkAccess.json"
},
"StorageAccountCreateUserAssignedIdentityWithFederatedIdentityClientId.": {
"$ref": "./examples/StorageAccountCreateUserAssignedIdentityWithFederatedIdentityClientId.json"
},
"StorageAccountCreateAllowedCopyScopeToPrivateLink": {
"$ref": "./examples/StorageAccountCreateAllowedCopyScopeToPrivateLink.json"
},
"StorageAccountCreateAllowedCopyScopeToAAD": {
"$ref": "./examples/StorageAccountCreateAllowedCopyScopeToAAD.json"
},
"StorageAccountCreatePremiumBlockBlobStorage": {
"$ref": "./examples/StorageAccountCreatePremiumBlockBlobStorage.json"
},
"StorageAccountCreateDnsEndpointTypeToAzureDnsZone": {
"$ref": "./examples/StorageAccountCreateDnsEndpointTypeToAzureDnsZone.json"
},
"StorageAccountCreateDnsEndpointTypeToStandard": {
"$ref": "./examples/StorageAccountCreateDnsEndpointTypeToStandard.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/StorageAccountName"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StorageAccountCreateParameters"
},
"description": "The parameters to provide for the created account."
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- returned when the storage account was already created from a previous request with the same properties specified in the request body.",
"schema": {
"$ref": "#/definitions/StorageAccount"
}
},
"202": {
"description": "Accepted -- Create or update request accepted; operation will complete asynchronously."
}
},
"x-ms-long-running-operation": true
},
"delete": {
"tags": [
"StorageAccounts"
],
"operationId": "StorageAccounts_Delete",
"description": "Deletes a storage account in Microsoft Azure.",
"x-ms-examples": {
"StorageAccountDelete": {
"$ref": "./examples/StorageAccountDelete.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/StorageAccountName"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- storage account deleted successfully."
},
"204": {
"description": "NoContent -- account does not exist in the subscription."
}
}
},
"get": {
"tags": [
"StorageAccounts"
],
"operationId": "StorageAccounts_GetProperties",
"description": "Returns the properties for the specified storage account including but not limited to name, SKU name, location, and account status. The ListKeys operation should be used to retrieve storage keys.",
"x-ms-examples": {
"StorageAccountGetProperties": {
"$ref": "./examples/StorageAccountGetProperties.json"
},
"StorageAccountGetPropertiesCMKEnabled": {
"$ref": "./examples/StorageAccountGetPropertiesCMKEnabled.json"
},
"StorageAccountGetAsyncSkuConversionStatus": {
"$ref": "./examples/StorageAccountGetAsyncSkuConversionStatus.json"
},
"StorageAccountGetPropertiesCMKVersionExpirationTime": {
"$ref": "./examples/StorageAccountGetPropertiesCMKVersionExpirationTime.json"
},
"StorageAccountGetPropertiesGeoReplicationStatscanFailoverTrue": {
"$ref": "./examples/StorageAccountGetPropertiesGeoReplicationStatscanFailoverTrue.json"
},
"StorageAccountGetPropertiesGeoReplicationStatscanFailoverFalse": {
"$ref": "./examples/StorageAccountGetPropertiesGeoReplicationStatscanFailoverFalse.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/StorageAccountName"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "$expand",
"description": "May be used to expand the properties within account's properties. By default, data is not included when fetching properties. Currently we only support geoReplicationStats and blobRestoreStatus.",
"in": "query",
"required": false,
"type": "string",
"enum": [
"geoReplicationStats",
"blobRestoreStatus"
],
"x-ms-enum": {
"name": "StorageAccountExpand",
"modelAsString": false
}
}
],
"responses": {
"200": {
"description": "OK -- properties retrieved successfully for the storage account.",
"schema": {
"$ref": "#/definitions/StorageAccount"
}
}
}
},
"patch": {
"tags": [
"StorageAccounts"
],
"operationId": "StorageAccounts_Update",
"description": "The update operation can be used to update the SKU, encryption, access tier, or tags for a storage account. It can also be used to map the account to a custom domain. Only one custom domain is supported per storage account; the replacement/change of custom domain is not supported. In order to replace an old custom domain, the old value must be cleared/unregistered before a new value can be set. The update of multiple properties is supported. This call does not change the storage keys for the account. If you want to change the storage account keys, use the regenerate keys operation. The location and name of the storage account cannot be changed after creation.",
"x-ms-examples": {
"StorageAccountUpdate": {
"$ref": "./examples/StorageAccountUpdate.json"
},
"StorageAccountEnableAD": {
"$ref": "./examples/StorageAccountEnableAD.json"
},
"StorageAccountEnableCMK": {
"$ref": "./examples/StorageAccountEnableCMK.json"
},
"StorageAccountUpdateUserAssignedEncryptionIdentityWithCMK": {
"$ref": "./examples/StorageAccountUpdateUserAssignedEncryptionIdentityWithCMK.json"
},
"StorageAccountUpdateDisablePublicNetworkAccess": {
"$ref": "./examples/StorageAccountUpdateDisablePublicNetworkAccess.json"
},
"StorageAccountUpdateWithImmutabilityPolicy": {
"$ref": "./examples/StorageAccountUpdateWithImmutabilityPolicy.json"
},
"StorageAccountUpdateUserAssignedIdentityWithFederatedIdentityClientId": {
"$ref": "./examples/StorageAccountUpdateUserAssignedIdentityWithFederatedIdentityClientId.json"
},
"StorageAccountUpdateAllowedCopyScopeToAAD": {
"$ref": "./examples/StorageAccountUpdateAllowedCopyScopeToAAD.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/StorageAccountName"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StorageAccountUpdateParameters"
},
"description": "The parameters to provide for the updated account."
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- storage account properties updated successfully.",
"schema": {
"$ref": "#/definitions/StorageAccount"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Storage/deletedAccounts": {
"get": {
"tags": [
"DeletedAccounts"
],
"operationId": "DeletedAccounts_List",
"description": "Lists deleted accounts under the subscription.",
"x-ms-examples": {
"DeletedAccountList": {
"$ref": "./examples/DeletedAccountList.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- List of deleted accounts was retrieved and returned successfully.",
"schema": {
"$ref": "#/definitions/DeletedAccountListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/deletedAccounts/{deletedAccountName}": {
"get": {
"tags": [
"DeletedAccounts"
],
"operationId": "DeletedAccounts_Get",
"description": "Get properties of specified deleted account resource.",
"x-ms-examples": {
"DeletedAccountGet": {
"$ref": "./examples/DeletedAccountGet.json"
}
},
"parameters": [
{
"$ref": "#/parameters/DeletedAccountName"
},
{
"name": "location",
"in": "path",
"required": true,
"type": "string",
"description": "The location of the deleted storage account."
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- properties retrieved and returned successfully for the deleted account.",
"schema": {
"$ref": "#/definitions/DeletedAccount"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts": {
"get": {
"tags": [
"StorageAccounts"
],
"operationId": "StorageAccounts_List",
"description": "Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.",
"x-ms-examples": {
"StorageAccountList": {
"$ref": "./examples/StorageAccountList.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- List of storage accounts was retrieved and returned successfully.",
"schema": {
"$ref": "#/definitions/StorageAccountListResult"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts": {
"get": {
"tags": [
"StorageAccounts"
],
"operationId": "StorageAccounts_ListByResourceGroup",
"description": "Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.",
"x-ms-examples": {
"StorageAccountListByResourceGroup": {
"$ref": "./examples/StorageAccountListByResourceGroup.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- List of storage accounts in the given resource group retrieved and returned successfully.",
"schema": {
"$ref": "#/definitions/StorageAccountListResult"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys": {
"post": {
"tags": [
"StorageAccounts"
],
"operationId": "StorageAccounts_ListKeys",
"description": "Lists the access keys or Kerberos keys (if active directory enabled) for the specified storage account.",
"x-ms-examples": {
"StorageAccountListKeys": {
"$ref": "./examples/StorageAccountListKeys.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/StorageAccountName"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
"enum": [
"kerb"
],
"x-ms-enum": {
"name": "ListKeyExpand"
},
"description": "Specifies type of the key to be listed. Possible value is kerb."
}
],
"responses": {
"200": {
"description": "OK -- list of keys retrieved and returned successfully.",
"schema": {
"$ref": "#/definitions/StorageAccountListKeysResult"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey": {
"post": {
"tags": [
"StorageAccounts"
],
"operationId": "StorageAccounts_RegenerateKey",
"description": "Regenerates one of the access keys or Kerberos keys for the specified storage account.",
"x-ms-examples": {
"StorageAccountRegenerateKey": {
"$ref": "./examples/StorageAccountRegenerateKey.json"
},
"StorageAccountRegenerateKerbKey": {
"$ref": "./examples/StorageAccountRegenerateKerbKey.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/StorageAccountName"
},
{
"name": "regenerateKey",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StorageAccountRegenerateKeyParameters"
},
"description": "Specifies name of the key which should be regenerated -- key1, key2, kerb1, kerb2."
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- specified key regenerated successfully.",
"schema": {
"$ref": "#/definitions/StorageAccountListKeysResult"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/usages": {
"get": {
"tags": [
"LocationUsage"
],
"operationId": "Usages_ListByLocation",
"description": "Gets the current usage count and the limit for the resources of the location under the subscription.",
"x-ms-examples": {
"UsageList": {
"$ref": "./examples/StorageAccountListLocationUsage.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "location",
"in": "path",
"required": true,
"type": "string",
"description": "The location of the Azure Storage resource."
}
],
"responses": {
"200": {
"description": "OK -- current usage count and limit retrieved and returned successfully.",
"schema": {
"$ref": "#/definitions/UsageListResult"
}
}
},
"x-ms-pageable": {
"nextLinkName": null
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListAccountSas": {
"post": {
"tags": [
"StorageAccounts"
],
"operationId": "StorageAccounts_ListAccountSAS",
"description": "List SAS credentials of a storage account.",
"x-ms-examples": {
"StorageAccountListAccountSAS": {
"$ref": "./examples/StorageAccountListAccountSAS.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/StorageAccountName"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AccountSasParameters"
},
"description": "The parameters to provide to list SAS credentials for the storage account."
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- returned the account SAS created for the storage account requested.",
"schema": {
"$ref": "#/definitions/ListAccountSasResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListServiceSas": {
"post": {
"tags": [
"StorageAccounts"
],
"operationId": "StorageAccounts_ListServiceSAS",
"description": "List service SAS credentials of a specific resource.",
"x-ms-examples": {
"StorageAccountListServiceSAS": {
"$ref": "./examples/StorageAccountListServiceSAS.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/StorageAccountName"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ServiceSasParameters"
},
"description": "The parameters to provide to list service SAS credentials."
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- returned the service SAS created for the storage service requested.",
"schema": {
"$ref": "#/definitions/ListServiceSasResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/failover": {
"post": {
"tags": [
"StorageAccounts"
],
"operationId": "StorageAccounts_Failover",
"description": "A failover request can be triggered for a storage account in the event a primary endpoint becomes unavailable for any reason. The failover occurs from the storage account's primary cluster to the secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover and the account is converted to LRS. In the case of a Planned Failover, the primary and secondary clusters are swapped after failover and the account remains geo-replicated. Failover should continue to be used in the event of availability issues as Planned failover is only available while the primary and secondary endpoints are available. The primary use case of a Planned Failover is disaster recovery testing drills. This type of failover is invoked by setting FailoverType parameter to 'Planned'. Learn more about the failover options here- https://learn.microsoft.com/en-us/azure/storage/common/storage-disaster-recovery-guidance",
"x-ms-examples": {
"StorageAccountFailover": {
"$ref": "./examples/StorageAccountFailover.json"
},
"StorageAccountFailoverPlanned": {
"$ref": "./examples/StorageAccountFailoverPlanned.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/StorageAccountName"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "failoverType",
"description": "The parameter is set to 'Planned' to indicate whether a Planned failover is requested.",
"in": "query",
"required": false,
"type": "string",
"enum": [
"Planned"
],
"x-ms-enum": {
"name": "failoverType",
"modelAsString": false
}
}
],
"responses": {
"200": {
"description": "OK -- Returned when the storage account failover is completed, and the secondary cluster has become primary."
},
"202": {
"description": "Accepted -- Failover request accepted; operation will complete asynchronously."
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
}
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/hnsonmigration": {
"post": {
"tags": [
"StorageAccounts"
],
"operationId": "StorageAccounts_HierarchicalNamespaceMigration",
"description": "Live Migration of storage account to enable Hns",
"x-ms-examples": {
"StorageAccountHierarchicalNamespaceMigration": {
"$ref": "./examples/StorageAccountHierarchicalNamespaceMigration.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/StorageAccountName"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "requestType",
"in": "query",
"required": true,
"type": "string",
"description": "Required. Hierarchical namespace migration type can either be a hierarchical namespace validation request 'HnsOnValidationRequest' or a hydration request 'HnsOnHydrationRequest'. The validation request will validate the migration whereas the hydration request will migrate the account."
}
],
"responses": {
"200": {
"description": "OK -- Returned when the storage account migration to hierarchical namespace is completed."
},
"202": {
"description": "Accepted -- Hierarchical namespace migration request accepted; operation will complete asynchronously."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
}
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/aborthnsonmigration": {
"post": {
"tags": [
"StorageAccounts"
],
"operationId": "StorageAccounts_AbortHierarchicalNamespaceMigration",
"description": "Abort live Migration of storage account to enable Hns",
"x-ms-examples": {
"StorageAccountAbortHierarchicalNamespaceMigration": {
"$ref": "./examples/StorageAccountAbortHierarchicalNamespaceMigration.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/StorageAccountName"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- Returned when the storage account migration to hierarchical namespace is aborted."
},
"202": {
"description": "Accepted -- Abort hierarchical namespace migration request accepted; operation will complete asynchronously."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/startAccountMigration": {
"post": {
"tags": [
"AccountMigrations"
],
"operationId": "StorageAccounts_CustomerInitiatedMigration",
"description": "Account Migration request can be triggered for a storage account to change its redundancy level. The migration updates the non-zonal redundant storage account to a zonal redundant account or vice-versa in order to have better reliability and availability. Zone-redundant storage (ZRS) replicates your storage account synchronously across three Azure availability zones in the primary region.",
"x-ms-examples": {
"StorageAccountPostMigration": {
"$ref": "./examples/StorageAccountPostMigration.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/StorageAccountName"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StorageAccountMigration"
},
"description": "The request parameters required to perform storage account migration."
}
],
"responses": {
"200": {
"description": "OK -- Returned when the request is just for validating the migration request, it does not actually initiate migration; applicable in cross region migration currently."
},
"202": {
"description": "Accepted -- Migration request accepted; operation will complete asynchronously.",
"headers": {
"Location": {
"type": "string"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/accountMigrations/{migrationName}": {
"get": {
"tags": [
"AccountMigrations"
],
"operationId": "StorageAccounts_GetCustomerInitiatedMigration",
"description": "Gets the status of the ongoing migration for the specified storage account.",
"x-ms-examples": {
"StorageAccountGetMigrationFailed": {
"$ref": "./examples/StorageAccountGetMigrationFailed.json"
},
"StorageAccountGetMigrationInProgress": {
"$ref": "./examples/StorageAccountGetMigrationInProgress.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/StorageAccountName"
},
{
"$ref": "#/parameters/MigrationName"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- Get the details of the ongoing or completed migration successfully.",
"schema": {
"$ref": "#/definitions/StorageAccountMigration"
}
},