-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
file.json
1046 lines (1046 loc) · 35.4 KB
/
file.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": "2021-08-01",
"title": "StorageManagementClient",
"description": "The Azure Storage Management API."
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices": {
"get": {
"tags": [
"FileService"
],
"operationId": "FileServices_List",
"x-ms-examples": {
"ListFileServices": {
"$ref": "./examples/FileServicesList.json"
}
},
"description": "List all file services in storage accounts",
"parameters": [
{
"$ref": "./storage.json#/parameters/ResourceGroupName"
},
{
"$ref": "./storage.json#/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 -- List file services operation completed successfully.",
"schema": {
"$ref": "#/definitions/FileServiceItems"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./common.json#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/{FileServicesName}": {
"put": {
"tags": [
"FileService"
],
"operationId": "FileServices_SetServiceProperties",
"x-ms-examples": {
"PutFileServices": {
"$ref": "./examples/FileServicesPut.json"
},
"PutFileServices_EnableSMBMultichannel": {
"$ref": "./examples/FileServicesPut_EnableSMBMultichannel.json"
},
"PutFileServices_EnableSecureSmbFeatures": {
"$ref": "./examples/FileServicesPut_EnableSecureSmbFeatures.json"
}
},
"description": "Sets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules. ",
"parameters": [
{
"$ref": "./storage.json#/parameters/ResourceGroupName"
},
{
"$ref": "./storage.json#/parameters/StorageAccountName"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/FileServicesName"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/FileServiceProperties"
},
"description": "The properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules."
}
],
"responses": {
"200": {
"description": "OK -- Sets The properties of a storage account’s File service successfully.",
"schema": {
"$ref": "#/definitions/FileServiceProperties"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./common.json#/definitions/CloudError"
}
}
}
},
"get": {
"tags": [
"FileService"
],
"operationId": "FileServices_GetServiceProperties",
"x-ms-examples": {
"GetFileServices": {
"$ref": "./examples/FileServicesGet.json"
}
},
"description": "Gets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.",
"parameters": [
{
"$ref": "./storage.json#/parameters/ResourceGroupName"
},
{
"$ref": "./storage.json#/parameters/StorageAccountName"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/FileServicesName"
}
],
"responses": {
"200": {
"description": "OK -- returned the properties of a storage account’s File service.",
"schema": {
"$ref": "#/definitions/FileServiceProperties"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./common.json#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares": {
"get": {
"tags": [
"FileShares"
],
"operationId": "FileShares_List",
"x-ms-examples": {
"ListShares": {
"$ref": "./examples/FileSharesList.json"
},
"ListDeletedShares": {
"$ref": "./examples/DeletedFileSharesList.json"
},
"ListShareSnapshots": {
"$ref": "./examples/FileShareSnapshotsList.json"
}
},
"description": "Lists all shares.",
"parameters": [
{
"$ref": "./storage.json#/parameters/ResourceGroupName"
},
{
"$ref": "./storage.json#/parameters/StorageAccountName"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "$maxpagesize",
"in": "query",
"type": "string",
"description": "Optional. Specified maximum number of shares that can be included in the list."
},
{
"name": "$filter",
"in": "query",
"type": "string",
"description": "Optional. When specified, only share names starting with the filter will be listed."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
"description": "Optional, used to expand the properties within share's properties. Valid values are: deleted, snapshots. Should be passed as a string with delimiter ','"
}
],
"responses": {
"200": {
"description": "OK -- List Shares operation completed successfully.",
"schema": {
"$ref": "#/definitions/FileShareItems"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./common.json#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}": {
"put": {
"tags": [
"FileShares"
],
"operationId": "FileShares_Create",
"x-ms-examples": {
"PutShares": {
"$ref": "./examples/FileSharesPut.json"
},
"Create NFS Shares": {
"$ref": "./examples/FileSharesPut_NFS.json"
},
"PutShares with Access Tier": {
"$ref": "./examples/FileSharesPut_AccessTier.json"
}
},
"description": "Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share. ",
"parameters": [
{
"$ref": "./storage.json#/parameters/ResourceGroupName"
},
{
"$ref": "./storage.json#/parameters/StorageAccountName"
},
{
"$ref": "#/parameters/ShareName"
},
{
"name": "fileShare",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/FileShare"
},
"description": "Properties of the file share to create."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
"description": "Optional, used to expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"201": {
"description": "Created -- Create Share operation completed successfully.",
"schema": {
"$ref": "#/definitions/FileShare"
}
},
"200": {
"description": "OK -- The Share is already created.",
"schema": {
"$ref": "#/definitions/FileShare"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./common.json#/definitions/CloudError"
}
}
}
},
"patch": {
"tags": [
"FileShares"
],
"operationId": "FileShares_Update",
"x-ms-examples": {
"UpdateShares": {
"$ref": "./examples/FileSharesPatch.json"
},
"UpdateShareAcls": {
"$ref": "./examples/FileShareAclsPatch.json"
}
},
"description": "Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist. ",
"parameters": [
{
"$ref": "./storage.json#/parameters/ResourceGroupName"
},
{
"$ref": "./storage.json#/parameters/StorageAccountName"
},
{
"$ref": "#/parameters/ShareName"
},
{
"name": "fileShare",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/FileShare"
},
"description": "Properties to update for the file share."
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- Update Share operation completed successfully.",
"schema": {
"$ref": "#/definitions/FileShare",
"description": "Properties of the updated file share."
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./common.json#/definitions/CloudError"
}
}
}
},
"get": {
"tags": [
"FileShares"
],
"operationId": "FileShares_Get",
"x-ms-examples": {
"GetShares": {
"$ref": "./examples/FileSharesGet.json"
},
"GetShareStats": {
"$ref": "./examples/FileSharesGet_Stats.json"
}
},
"description": "Gets properties of a specified share.",
"parameters": [
{
"$ref": "./storage.json#/parameters/ResourceGroupName"
},
{
"$ref": "./storage.json#/parameters/StorageAccountName"
},
{
"$ref": "#/parameters/ShareName"
},
{
"$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",
"description": "Optional, used to expand the properties within share's properties. Valid values are: stats. Should be passed as a string with delimiter ','."
},
{
"name": "x-ms-snapshot",
"in": "header",
"required": false,
"type": "string",
"description": "Optional, used to retrieve properties of a snapshot."
}
],
"responses": {
"200": {
"description": "OK -- Get Share operation completed successfully.",
"schema": {
"$ref": "#/definitions/FileShare"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./common.json#/definitions/CloudError"
}
}
}
},
"delete": {
"tags": [
"FileShares"
],
"operationId": "FileShares_Delete",
"x-ms-examples": {
"DeleteShares": {
"$ref": "./examples/FileSharesDelete.json"
}
},
"description": "Deletes specified share under its account.",
"parameters": [
{
"$ref": "./storage.json#/parameters/ResourceGroupName"
},
{
"$ref": "./storage.json#/parameters/StorageAccountName"
},
{
"$ref": "#/parameters/ShareName"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "x-ms-snapshot",
"in": "header",
"required": false,
"type": "string",
"description": "Optional, used to delete a snapshot."
},
{
"name": "$include",
"in": "query",
"required": false,
"type": "string",
"description": "Optional. Valid values are: snapshots, leased-snapshots, none. The default value is snapshots. For 'snapshots', the file share is deleted including all of its file share snapshots. If the file share contains leased-snapshots, the deletion fails. For 'leased-snapshots', the file share is deleted included all of its file share snapshots (leased/unleased). For 'none', the file share is deleted if it has no share snapshots. If the file share contains any snapshots (leased or unleased), the deletion fails."
}
],
"responses": {
"200": {
"description": "OK -- Delete Share operation completed successfully."
},
"204": {
"description": "No Content -- The Share not exist."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./common.json#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}/restore": {
"post": {
"tags": [
"FileShares"
],
"operationId": "FileShares_Restore",
"x-ms-examples": {
"RestoreShares": {
"$ref": "./examples/FileSharesRestore.json"
}
},
"description": "Restore a file share within a valid retention days if share soft delete is enabled",
"parameters": [
{
"$ref": "./storage.json#/parameters/ResourceGroupName"
},
{
"$ref": "./storage.json#/parameters/StorageAccountName"
},
{
"$ref": "#/parameters/ShareName"
},
{
"name": "deletedShare",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/DeletedShare"
}
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK -- The Share is successfully restored."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./common.json#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}/lease": {
"post": {
"tags": [
"FileShares"
],
"operationId": "FileShares_Lease",
"x-ms-examples": {
"Acquire a lease on a share": {
"$ref": "./examples/FileSharesLease_Acquire.json"
},
"Break a lease on a share": {
"$ref": "./examples/FileSharesLease_Break.json"
}
},
"description": "The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.",
"parameters": [
{
"$ref": "./storage.json#/parameters/ResourceGroupName"
},
{
"$ref": "./storage.json#/parameters/StorageAccountName"
},
{
"$ref": "#/parameters/ShareName"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "parameters",
"in": "body",
"schema": {
"$ref": "#/definitions/LeaseShareRequest"
},
"description": "Lease Share request body."
},
{
"name": "x-ms-snapshot",
"in": "header",
"required": false,
"type": "string",
"description": "Optional. Specify the snapshot time to lease a snapshot."
}
],
"responses": {
"200": {
"description": "OK -- Lease Share operation completed successfully.",
"schema": {
"$ref": "#/definitions/LeaseShareResponse"
},
"headers": {
"ETag": {
"description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.",
"type": "string"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./common.json#/definitions/CloudError"
}
}
}
}
}
},
"definitions": {
"FileServiceItems": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/FileServiceProperties"
},
"description": "List of file services returned.",
"readOnly": true
}
}
},
"FileServiceProperties": {
"properties": {
"properties": {
"properties": {
"cors": {
"$ref": "./common.json#/definitions/CorsRules",
"description": "Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service."
},
"shareDeleteRetentionPolicy": {
"$ref": "./common.json#/definitions/DeleteRetentionPolicy",
"description": "The file service properties for share soft delete."
},
"protocolSettings": {
"$ref": "#/definitions/ProtocolSettings",
"description": "Protocol settings for file service"
}
},
"x-ms-client-flatten": true,
"x-ms-client-name": "FileServiceProperties",
"description": "The properties of File services in storage account."
},
"sku": {
"$ref": "./common.json#/definitions/Sku",
"readOnly": true,
"description": "Sku name and tier."
}
},
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
}
],
"description": "The properties of File services in storage account."
},
"ProtocolSettings": {
"properties": {
"smb": {
"$ref": "#/definitions/SmbSetting",
"description": "Setting for SMB protocol"
}
},
"description": "Protocol settings for file service"
},
"SmbSetting": {
"properties": {
"multichannel": {
"$ref": "#/definitions/Multichannel",
"description": "Multichannel setting. Applies to Premium FileStorage only."
},
"versions": {
"type": "string",
"description": "SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'."
},
"authenticationMethods": {
"type": "string",
"description": "SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'."
},
"kerberosTicketEncryption": {
"type": "string",
"description": "Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';'"
},
"channelEncryption": {
"type": "string",
"description": "SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'."
}
},
"description": "Setting for SMB protocol"
},
"Multichannel": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether multichannel is enabled"
}
},
"description": "Multichannel setting. Applies to Premium FileStorage only."
},
"FileShare": {
"properties": {
"properties": {
"$ref": "#/definitions/FileShareProperties",
"x-ms-client-flatten": true,
"x-ms-client-name": "FileShareProperties",
"description": "Properties of the file share."
}
},
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource"
}
],
"description": "Properties of the file share, including Id, resource name, resource type, Etag."
},
"DeletedShare": {
"properties": {
"deletedShareName": {
"type": "string",
"description": "Required. Identify the name of the deleted share that will be restored."
},
"deletedShareVersion": {
"type": "string",
"description": "Required. Identify the version of the deleted share that will be restored."
}
},
"required": [
"deletedShareName",
"deletedShareVersion"
],
"description": "The deleted share to be restored."
},
"FileShareItem": {
"properties": {
"properties": {
"$ref": "#/definitions/FileShareProperties",
"x-ms-client-flatten": true,
"description": "The file share properties be listed out."
}
},
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource"
}
],
"description": "The file share properties be listed out."
},
"FileShareItems": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/FileShareItem"
},
"description": "List of file shares returned.",
"readOnly": true
},
"nextLink": {
"type": "string",
"description": "Request URL that can be used to query next page of shares. Returned when total number of requested shares exceed maximum page size.",
"readOnly": true
}
},
"description": "Response schema. Contains list of shares returned, and if paging is requested or required, a URL to next page of shares."
},
"FileShareProperties": {
"properties": {
"lastModifiedTime": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "Returns the date and time the share was last modified."
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A name-value pair to associate with the share as metadata."
},
"shareQuota": {
"type": "integer",
"minimum": 1,
"maximum": 102400,
"description": "The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400."
},
"enabledProtocols": {
"type": "string",
"enum": [
"SMB",
"NFS"
],
"x-ms-enum": {
"name": "EnabledProtocols",
"modelAsString": true
},
"description": "The authentication protocol that is used for the file share. Can only be specified when creating a share.",
"x-ms-mutability": [
"create",
"read"
]
},
"rootSquash": {
"type": "string",
"enum": [
"NoRootSquash",
"RootSquash",
"AllSquash"
],
"x-ms-enum": {
"name": "RootSquashType",
"modelAsString": true
},
"description": "The property is for NFS share only. The default is NoRootSquash."
},
"version": {
"type": "string",
"readOnly": true,
"description": "The version of the share."
},
"deleted": {
"type": "boolean",
"readOnly": true,
"description": "Indicates whether the share was deleted."
},
"deletedTime": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The deleted time if the share was deleted."
},
"remainingRetentionDays": {
"type": "integer",
"readOnly": true,
"description": "Remaining retention days for share that was soft deleted."
},
"accessTier": {
"type": "string",
"enum": [
"TransactionOptimized",
"Hot",
"Cool",
"Premium"
],
"x-ms-enum": {
"name": "ShareAccessTier",
"modelAsString": true
},
"description": "Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium."
},
"accessTierChangeTime": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "Indicates the last modification time for share access tier."
},
"accessTierStatus": {
"type": "string",
"readOnly": true,
"description": "Indicates if there is a pending transition for access tier."
},
"shareUsageBytes": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files."
},
"leaseStatus": {
"type": "string",
"readOnly": true,
"enum": [
"Locked",
"Unlocked"
],
"x-ms-enum": {
"name": "LeaseStatus",
"modelAsString": true
},
"description": "The lease status of the share."
},
"leaseState": {
"type": "string",
"readOnly": true,
"enum": [
"Available",
"Leased",
"Expired",
"Breaking",
"Broken"
],
"x-ms-enum": {
"name": "LeaseState",
"modelAsString": true
},
"description": "Lease state of the share."
},
"leaseDuration": {
"type": "string",
"readOnly": true,
"enum": [
"Infinite",
"Fixed"
],
"x-ms-enum": {
"name": "LeaseDuration",
"modelAsString": true
},
"description": "Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased."
},
"signedIdentifiers": {
"type": "array",
"items": {
"$ref": "#/definitions/SignedIdentifier"
},
"description": "List of stored access policies specified on the share."
},
"snapshotTime": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "Creation time of share snapshot returned in the response of list shares with expand param \"snapshots\"."
}
},
"description": "The properties of the file share."
},
"LeaseShareRequest": {
"properties": {
"action": {
"type": "string",
"enum": [
"Acquire",
"Renew",
"Change",
"Release",
"Break"
],
"x-ms-enum": {
"name": "LeaseShareAction",
"modelAsString": true
},
"description": "Specifies the lease action. Can be one of the available actions."
},
"leaseId": {
"type": "string",
"description": "Identifies the lease. Can be specified in any valid GUID string format."
},
"breakPeriod": {
"type": "integer",
"format": "int32",
"description": "Optional. For a break action, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60."
},
"leaseDuration": {
"type": "integer",
"format": "int32",
"description": "Required for acquire. Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires."
},
"proposedLeaseId": {
"type": "string",
"description": "Optional for acquire, required for change. Proposed lease ID, in a GUID string format."
}
},
"required": [
"action"
],
"description": "Lease Share request schema."
},
"LeaseShareResponse": {
"properties": {
"leaseId": {
"type": "string",
"description": "Returned unique lease ID that must be included with any request to delete the share, or to renew, change, or release the lease."
},
"leaseTimeSeconds": {
"type": "string",
"description": "Approximate time remaining in the lease period, in seconds."
}
},
"description": "Lease Share response schema."
},
"SignedIdentifier": {
"properties": {
"id": {
"type": "string",
"description": "An unique identifier of the stored access policy."
},
"accessPolicy": {
"$ref": "#/definitions/AccessPolicy",
"description": "Access policy"
}
}
},
"AccessPolicy": {
"properties": {
"startTime": {
"type": "string",
"format": "date-time",
"description": "Start time of the access policy"
},
"expiryTime": {
"type": "string",
"format": "date-time",
"description": "Expiry time of the access policy"
},
"permission": {
"type": "string",
"description": "List of abbreviated permissions."
}
}
}
},