-
Notifications
You must be signed in to change notification settings - Fork 5.2k
/
Copy pathDataLakeStorage.json
1921 lines (1921 loc) · 103 KB
/
DataLakeStorage.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": {
"description": "Azure Data Lake Storage provides storage for Hadoop and other big data workloads.",
"title": "Azure Data Lake Storage REST API",
"version": "2019-10-31",
"x-ms-code-generation-settings": {
"internalConstructors": true,
"name": "DataLakeStorageClient"
}
},
"x-ms-parameterized-host": {
"hostTemplate": "{accountName}.{dnsSuffix}",
"parameters": [
{
"$ref": "#/parameters/accountName"
},
{
"$ref": "#/parameters/dnsSuffix"
}
]
},
"schemes": [
"https"
],
"produces": [
"application/json"
],
"tags": [
{
"name": "Account Operations"
},
{
"name": "Filesystem Operations"
},
{
"name": "File and Directory Operations"
}
],
"parameters": {
"Version": {
"description": "Specifies the version of the REST protocol used for processing the request. This is required when using shared key authorization.",
"in": "header",
"name": "x-ms-version",
"required": false,
"type": "string",
"x-ms-parameter-location": "client"
},
"accountName": {
"description": "The Azure Storage account name.",
"in": "path",
"name": "accountName",
"required": true,
"type": "string",
"x-ms-skip-url-encoding": true,
"x-ms-parameter-location": "client"
},
"dnsSuffix": {
"default": "dfs.core.windows.net",
"description": "The DNS suffix for the Azure Data Lake Storage endpoint.",
"in": "path",
"name": "dnsSuffix",
"required": true,
"type": "string",
"x-ms-skip-url-encoding": true,
"x-ms-parameter-location": "client"
}
},
"definitions": {
"DataLakeStorageError": {
"properties": {
"error": {
"description": "The service error response object.",
"properties": {
"code": {
"description": "The service error code.",
"type": "string"
},
"message": {
"description": "The service error message.",
"type": "string"
}
}
}
}
},
"Path": {
"properties": {
"name": {
"type": "string"
},
"isDirectory": {
"default": false,
"type": "boolean"
},
"lastModified": {
"type": "string"
},
"eTag": {
"type": "string"
},
"contentLength": {
"type": "integer",
"format": "int64"
},
"owner": {
"type": "string"
},
"group": {
"type": "string"
},
"permissions": {
"type": "string"
}
}
},
"PathList": {
"properties": {
"paths": {
"type": "array",
"items": {
"$ref": "#/definitions/Path"
}
}
}
},
"Filesystem": {
"properties": {
"name": {
"type": "string"
},
"lastModified": {
"type": "string"
},
"eTag": {
"type": "string"
}
}
},
"FilesystemList": {
"properties": {
"filesystems": {
"type": "array",
"items": {
"$ref": "#/definitions/Filesystem"
}
}
}
}
},
"responses": {
"ErrorResponse": {
"description": "An error occurred. The possible HTTP status, code, and message strings are listed below:\n* 400 Bad Request, ContentLengthMustBeZero, \"The Content-Length request header must be zero.\"\n* 400 Bad Request, InvalidAuthenticationInfo, \"Authentication information is not given in the correct format. Check the value of Authorization header.\"\n* 400 Bad Request, InvalidFlushPosition, \"The uploaded data is not contiguous or the position query parameter value is not equal to the length of the file after appending the uploaded data.\"\n* 400 Bad Request, InvalidHeaderValue, \"The value for one of the HTTP headers is not in the correct format.\"\n* 400 Bad Request, InvalidHttpVerb, \"The HTTP verb specified is invalid - it is not recognized by the server.\"\n* 400 Bad Request, InvalidInput, \"One of the request inputs is not valid.\"\n* 400 Bad Request, InvalidPropertyName, \"A property name cannot be empty.\"\n* 400 Bad Request, InvalidPropertyName, \"The property name contains invalid characters.\"\n* 400 Bad Request, InvalidQueryParameterValue, \"Value for one of the query parameters specified in the request URI is invalid.\"\n* 400 Bad Request, InvalidResourceName, \"The specified resource name contains invalid characters.\"\n* 400 Bad Request, InvalidSourceUri, \"The source URI is invalid.\"\n* 400 Bad Request, InvalidUri, \"The request URI is invalid.\"\n* 400 Bad Request, MissingRequiredHeader, \"An HTTP header that's mandatory for this request is not specified.\"\n* 400 Bad Request, MissingRequiredQueryParameter, \"A query parameter that's mandatory for this request is not specified.\"\n* 400 Bad Request, MultipleConditionHeadersNotSupported, \"Multiple condition headers are not supported.\"\n* 400 Bad Request, OutOfRangeInput, \"One of the request inputs is out of range.\"\n* 400 Bad Request, OutOfRangeQueryParameterValue, \"One of the query parameters specified in the request URI is outside the permissible range.\"\n* 400 Bad Request, UnsupportedHeader, \"One of the headers specified in the request is not supported.\"\n* 400 Bad Request, UnsupportedQueryParameter, \"One of the query parameters specified in the request URI is not supported.\"\n* 400 Bad Request, UnsupportedRestVersion, \"The specified Rest Version is Unsupported.\"\n* 403 Forbidden, AccountIsDisabled, \"The specified account is disabled.\"\n* 403 Forbidden, AuthorizationFailure, \"This request is not authorized to perform this operation.\"\n* 403 Forbidden, InsufficientAccountPermissions, \"The account being accessed does not have sufficient permissions to execute this operation.\"\n* 404 Not Found, FilesystemNotFound, \"The specified filesystem does not exist.\"\n* 404 Not Found, PathNotFound, \"The specified path does not exist.\"\n* 404 Not Found, RenameDestinationParentPathNotFound, \"The parent directory of the destination path does not exist.\"\n* 404 Not Found, ResourceNotFound, \"The specified resource does not exist.\"\n* 404 Not Found, SourcePathNotFound, \"The source path for a rename operation does not exist.\"\n* 405 Method Not Allowed, UnsupportedHttpVerb, \"The resource doesn't support the specified HTTP verb.\"\n* 409 Conflict, DestinationPathIsBeingDeleted, \"The specified destination path is marked to be deleted.\"\n* 409 Conflict, DirectoryNotEmpty, \"The recursive query parameter value must be true to delete a non-empty directory.\"\n* 409 Conflict, FilesystemAlreadyExists, \"The specified filesystem already exists.\"\n* 409 Conflict, FilesystemBeingDeleted, \"The specified filesystem is being deleted.\"\n* 409 Conflict, InvalidDestinationPath, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"* 409 Conflict, InvalidFlushOperation, \"The resource was created or modified by the Blob Service API and cannot be written to by the Data Lake Storage Service API.\"\n* 409 Conflict, InvalidRenameSourcePath, \"The source directory cannot be the same as the destination directory, nor can the destination be a subdirectory of the source directory.\"\n* 409 Conflict, InvalidSourceOrDestinationResourceType, \"The source and destination resource type must be identical.\"\n* 409 Conflict, LeaseAlreadyPresent, \"There is already a lease present.\"\n* 409 Conflict, LeaseIdMismatchWithLeaseOperation, \"The lease ID specified did not match the lease ID for the resource with the specified lease operation.\"\n* 409 Conflict, LeaseIsAlreadyBroken, \"The lease has already been broken and cannot be broken again.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, \"The lease ID matched, but the lease is currently in breaking state and cannot be acquired until it is broken.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeChanged, \"The lease ID matched, but the lease is currently in breaking state and cannot be changed.\"\n* 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, \"The lease ID matched, but the lease has been broken explicitly and cannot be renewed.\"\n* 409 Conflict, LeaseNameMismatch, \"The lease name specified did not match the existing lease name.\"\n* 409 Conflict, LeaseNotPresentWithLeaseOperation, \"The lease ID is not present with the specified lease operation.\"\n* 409 Conflict, PathAlreadyExists, \"The specified path already exists.\"\n* 409 Conflict, PathConflict, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"\n* 409 Conflict, SourcePathIsBeingDeleted, \"The specified source path is marked to be deleted.\"\n* 409 Conflict, ResourceTypeMismatch, \"The resource type specified in the request does not match the type of the resource.\"\n* 412 Precondition Failed, ConditionNotMet, \"The condition specified using HTTP conditional header(s) is not met.\"\n* 412 Precondition Failed, LeaseIdMismatch, \"The lease ID specified did not match the lease ID for the resource.\"\n* 412 Precondition Failed, LeaseIdMissing, \"There is currently a lease on the resource and no lease ID was specified in the request.\"\n* 412 Precondition Failed, LeaseNotPresent, \"There is currently no lease on the resource.\"\n* 412 Precondition Failed, LeaseLost, \"A lease ID was specified, but the lease for the resource has expired.\"\n* 412 Precondition Failed, SourceConditionNotMet, \"The source condition specified using HTTP conditional header(s) is not met.\"\n* 413 Request Entity Too Large, RequestBodyTooLarge, \"The request body is too large and exceeds the maximum permissible limit.\"\n* 416 Requested Range Not Satisfiable, InvalidRange, \"The range specified is invalid for the current size of the resource.\"\n* 500 Internal Server Error, InternalError, \"The server encountered an internal error. Please retry the request.\"\n* 500 Internal Server Error, OperationTimedOut, \"The operation could not be completed within the permitted time.\"\n* 503 Service Unavailable, ServerBusy, \"Egress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Ingress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Operations per second is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"The server is currently unable to receive requests. Please retry your request.\"",
"headers": {
"x-ms-request-id": {
"description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.",
"pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$",
"type": "string"
},
"x-ms-version": {
"description": "The version of the REST protocol used to process the request.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/DataLakeStorageError"
}
}
},
"paths": {
"/": {
"get": {
"operationId": "Filesystem_List",
"summary": "List Filesystems",
"description": "List filesystems and their properties in given account.",
"x-ms-pageable": {
"itemName": "filesystems",
"nextLinkName": null
},
"tags": [
"Account Operations"
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.",
"type": "string"
},
"x-ms-request-id": {
"description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.",
"pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$",
"type": "string"
},
"x-ms-version": {
"description": "The version of the REST protocol used to process the request.",
"type": "string"
},
"x-ms-continuation": {
"description": "If the number of filesystems to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.",
"type": "string"
},
"Content-Type": {
"description": "The content type of list filesystem response. The default content type is application/json.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/FilesystemList"
}
},
"default": {
"$ref": "#/responses/ErrorResponse"
}
},
"parameters": [
{
"name": "resource",
"in": "query",
"description": "The value must be \"account\" for all account operations.",
"required": true,
"type": "string",
"enum": [
"account"
],
"x-ms-enum": {
"name": "AccountResourceType",
"modelAsString": false
}
},
{
"name": "prefix",
"in": "query",
"description": "Filters results to filesystems within the specified prefix.",
"required": false,
"type": "string"
},
{
"name": "continuation",
"in": "query",
"description": "The number of filesystems returned with each invocation is limited. If the number of filesystems to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.",
"required": false,
"type": "string"
},
{
"name": "maxResults",
"in": "query",
"description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.",
"format": "int32",
"minimum": 1,
"required": false,
"type": "integer"
},
{
"name": "x-ms-client-request-id",
"description": "A UUID recorded in the analytics logs for troubleshooting and correlation.",
"in": "header",
"pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$",
"required": false,
"type": "string",
"x-ms-client-request-id": true
},
{
"name": "timeout",
"in": "query",
"description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.",
"format": "int32",
"minimum": 1,
"required": false,
"type": "integer"
},
{
"name": "x-ms-date",
"in": "header",
"description": "Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/Version"
}
]
}
},
"/{filesystem}": {
"put": {
"operationId": "Filesystem_Create",
"summary": "Create Filesystem",
"description": "Create a filesystem rooted at the specified location. If the filesystem already exists, the operation fails. This operation does not support conditional HTTP requests.",
"tags": [
"Filesystem Operations"
],
"responses": {
"201": {
"description": "Created",
"headers": {
"Date": {
"description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.",
"type": "string"
},
"ETag": {
"description": "An HTTP entity tag associated with the filesystem.",
"type": "string"
},
"Last-Modified": {
"description": "The data and time the filesystem was last modified. Operations on files and directories do not affect the last modified time.",
"type": "string"
},
"x-ms-request-id": {
"description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.",
"pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$",
"type": "string"
},
"x-ms-version": {
"description": "The version of the REST protocol used to process the request.",
"type": "string"
},
"x-ms-namespace-enabled": {
"description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem. ",
"type": "string"
}
}
},
"default": {
"$ref": "#/responses/ErrorResponse"
}
},
"parameters": [
{
"name": "x-ms-properties",
"description": "User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.",
"in": "header",
"required": false,
"type": "string"
}
]
},
"patch": {
"operationId": "Filesystem_SetProperties",
"summary": "Set Filesystem Properties",
"description": "Set properties for the filesystem. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).",
"tags": [
"Filesystem Operations"
],
"responses": {
"200": {
"description": "Ok",
"headers": {
"Date": {
"description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.",
"type": "string"
},
"ETag": {
"description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.",
"type": "string"
},
"Last-Modified": {
"description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.",
"type": "string"
},
"x-ms-request-id": {
"description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.",
"pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$",
"type": "string"
},
"x-ms-version": {
"description": "The version of the REST protocol used to process the request.",
"type": "string"
}
}
},
"default": {
"$ref": "#/responses/ErrorResponse"
}
},
"parameters": [
{
"name": "x-ms-properties",
"description": "Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.",
"in": "header",
"required": false,
"type": "string"
},
{
"name": "If-Modified-Since",
"description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.",
"in": "header",
"required": false,
"type": "string"
},
{
"name": "If-Unmodified-Since",
"description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.",
"in": "header",
"required": false,
"type": "string"
}
]
},
"get": {
"operationId": "Path_List",
"summary": "List Paths",
"description": "List filesystem paths and their properties.",
"x-ms-pageable": {
"itemName": "paths",
"nextLinkName": null
},
"tags": [
"Filesystem Operations"
],
"responses": {
"200": {
"description": "Ok",
"headers": {
"Date": {
"description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.",
"type": "string"
},
"ETag": {
"description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.",
"type": "string"
},
"Last-Modified": {
"description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.",
"type": "string"
},
"x-ms-request-id": {
"description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.",
"pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$",
"type": "string"
},
"x-ms-version": {
"description": "The version of the REST protocol used to process the request.",
"type": "string"
},
"x-ms-continuation": {
"description": "If the number of paths to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/PathList"
}
},
"default": {
"$ref": "#/responses/ErrorResponse"
}
},
"parameters": [
{
"name": "directory",
"in": "query",
"description": "Filters results to paths within the specified directory. An error occurs if the directory does not exist.",
"required": false,
"type": "string"
},
{
"name": "recursive",
"in": "query",
"description": "If \"true\", all paths are listed; otherwise, only paths at the root of the filesystem are listed. If \"directory\" is specified, the list will only include paths that share the same root.",
"required": true,
"type": "boolean"
},
{
"name": "continuation",
"in": "query",
"description": "The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.",
"required": false,
"type": "string"
},
{
"name": "maxResults",
"in": "query",
"description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.",
"format": "int32",
"minimum": 1,
"required": false,
"type": "integer"
},
{
"name": "upn",
"in": "query",
"description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.",
"required": false,
"type": "boolean"
}
]
},
"head": {
"operationId": "Filesystem_GetProperties",
"summary": "Get Filesystem Properties.",
"description": "All system and user-defined filesystem properties are specified in the response headers.",
"tags": [
"Filesystem Operations"
],
"responses": {
"200": {
"description": "Ok",
"headers": {
"Date": {
"description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.",
"type": "string"
},
"ETag": {
"description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.",
"type": "string"
},
"Last-Modified": {
"description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.",
"type": "string"
},
"x-ms-request-id": {
"description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.",
"pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$",
"type": "string"
},
"x-ms-version": {
"description": "The version of the REST protocol used to process the request.",
"type": "string"
},
"x-ms-properties": {
"description": "The user-defined properties associated with the filesystem. A comma-separated list of name and value pairs in the format \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.",
"type": "string"
},
"x-ms-namespace-enabled": {
"description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem. ",
"type": "string"
}
}
},
"default": {
"$ref": "#/responses/ErrorResponse"
}
}
},
"delete": {
"operationId": "Filesystem_Delete",
"summary": "Delete Filesystem",
"description": "Marks the filesystem for deletion. When a filesystem is deleted, a filesystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).",
"tags": [
"Filesystem Operations"
],
"responses": {
"202": {
"description": "Accepted",
"headers": {
"x-ms-request-id": {
"description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.",
"pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$",
"type": "string"
},
"x-ms-version": {
"description": "The version of the REST protocol used to process the request.",
"type": "string"
},
"Date": {
"description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.",
"type": "string"
}
}
},
"default": {
"$ref": "#/responses/ErrorResponse"
}
},
"parameters": [
{
"name": "If-Modified-Since",
"description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.",
"in": "header",
"required": false,
"type": "string"
},
{
"name": "If-Unmodified-Since",
"description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.",
"in": "header",
"required": false,
"type": "string"
}
]
},
"parameters": [
{
"name": "filesystem",
"in": "path",
"description": "The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters.",
"pattern": "^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$",
"minLength": 3,
"maxLength": 63,
"required": true,
"type": "string"
},
{
"name": "resource",
"in": "query",
"description": "The value must be \"filesystem\" for all filesystem operations.",
"required": true,
"type": "string",
"enum": [
"filesystem"
],
"x-ms-enum": {
"name": "FilesystemResourceType",
"modelAsString": false
}
},
{
"name": "x-ms-client-request-id",
"description": "A UUID recorded in the analytics logs for troubleshooting and correlation.",
"in": "header",
"pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$",
"required": false,
"type": "string",
"x-ms-client-request-id": true
},
{
"name": "timeout",
"in": "query",
"description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.",
"format": "int32",
"minimum": 1,
"required": false,
"type": "integer"
},
{
"name": "x-ms-date",
"in": "header",
"description": "Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/Version"
}
]
},
"/{filesystem}/{path}": {
"put": {
"operationId": "Path_Create",
"summary": "Create File | Create Directory | Rename File | Rename Directory",
"description": "Create or rename a file or directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination already exists, use a conditional request with If-None-Match: \"*\".",
"consumes": [
"application/octet-stream"
],
"tags": [
"File and Directory Operations"
],
"responses": {
"201": {
"description": "The file or directory was created.",
"headers": {
"Date": {
"description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.",
"type": "string"
},
"ETag": {
"description": "An HTTP entity tag associated with the file or directory.",
"type": "string"
},
"Last-Modified": {
"description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.",
"type": "string"
},
"x-ms-request-id": {
"description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.",
"pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$",
"type": "string"
},
"x-ms-version": {
"description": "The version of the REST protocol used to process the request.",
"type": "string"
},
"x-ms-continuation": {
"description": "When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.",
"type": "string"
},
"Content-Length": {
"description": "The size of the resource in bytes.",
"type": "integer",
"format": "int64"
}
}
},
"default": {
"$ref": "#/responses/ErrorResponse"
}
},
"parameters": [
{
"name": "resource",
"in": "query",
"description": "Required only for Create File and Create Directory. The value must be \"file\" or \"directory\".",
"required": false,
"type": "string",
"enum": [
"directory",
"file"
],
"x-ms-enum": {
"name": "PathResourceType",
"modelAsString": false
}
},
{
"name": "continuation",
"in": "query",
"description": "Optional. When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.",
"required": false,
"type": "string"
},
{
"name": "mode",
"in": "query",
"description": "Optional. Valid only when namespace is enabled. This parameter determines the behavior of the rename operation. The value must be \"legacy\" or \"posix\", and the default value will be \"posix\". ",
"required": false,
"type": "string",
"enum": [
"legacy",
"posix"
],
"x-ms-enum": {
"name": "PathRenameMode",
"modelAsString": false
}
},
{
"name": "Cache-Control",
"in": "header",
"description": "Optional. The service stores this value and includes it in the \"Cache-Control\" response header for \"Read File\" operations for \"Read File\" operations.",
"required": false,
"type": "string"
},
{
"name": "Content-Encoding",
"in": "header",
"description": "Optional. Specifies which content encodings have been applied to the file. This value is returned to the client when the \"Read File\" operation is performed.",
"required": false,
"type": "string"
},
{
"name": "Content-Language",
"in": "header",
"description": "Optional. Specifies the natural language used by the intended audience for the file.",
"required": false,
"type": "string"
},
{
"name": "Content-Disposition",
"in": "header",
"description": "Optional. The service stores this value and includes it in the \"Content-Disposition\" response header for \"Read File\" operations.",
"required": false,
"type": "string"
},
{
"name": "x-ms-cache-control",
"in": "header",
"description": "Optional. The service stores this value and includes it in the \"Cache-Control\" response header for \"Read File\" operations.",
"required": false,
"type": "string"
},
{
"name": "x-ms-content-type",
"in": "header",
"description": "Optional. The service stores this value and includes it in the \"Content-Type\" response header for \"Read File\" operations.",
"required": false,
"type": "string"
},
{
"name": "x-ms-content-encoding",
"in": "header",
"description": "Optional. The service stores this value and includes it in the \"Content-Encoding\" response header for \"Read File\" operations.",
"required": false,
"type": "string"
},
{
"name": "x-ms-content-language",
"in": "header",
"description": "Optional. The service stores this value and includes it in the \"Content-Language\" response header for \"Read File\" operations.",
"required": false,
"type": "string"
},
{
"name": "x-ms-content-disposition",
"in": "header",
"description": "Optional. The service stores this value and includes it in the \"Content-Disposition\" response header for \"Read File\" operations.",
"required": false,
"type": "string"
},
{
"name": "x-ms-rename-source",
"in": "header",
"description": "An optional file or directory to be renamed. The value must have the following format: \"/{filesystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.",
"required": false,
"type": "string"
},
{
"name": "x-ms-lease-id",
"in": "header",
"description": "Optional. A lease ID for the path specified in the URI. The path to be overwritten must have an active lease and the lease ID must match.",
"pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$",
"required": false,
"type": "string"
},
{
"name": "x-ms-source-lease-id",
"in": "header",
"description": "Optional for rename operations. A lease ID for the source path. The source path must have an active lease and the lease ID must match.",
"pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$",
"required": false,
"type": "string"
},
{
"name": "x-ms-properties",
"description": "Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.",
"in": "header",
"required": false,
"type": "string"
},
{
"name": "x-ms-permissions",
"description": "Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.",
"in": "header",
"required": false,
"type": "string"
},
{
"name": "x-ms-umask",
"description": "Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to be created. The resulting permission is given by p & ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).",
"in": "header",
"required": false,
"type": "string"
},
{
"name": "If-Match",
"description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.",
"in": "header",
"required": false,
"type": "string"
},
{
"name": "If-None-Match",
"description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.",
"in": "header",
"required": false,
"type": "string"
},
{
"name": "If-Modified-Since",
"description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.",
"in": "header",
"required": false,
"type": "string"
},
{
"name": "If-Unmodified-Since",
"description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.",
"in": "header",
"required": false,
"type": "string"
},
{
"name": "x-ms-source-if-match",
"description": "Optional. An ETag value. Specify this header to perform the rename operation only if the source's ETag matches the value specified. The ETag must be specified in quotes.",
"in": "header",
"required": false,
"type": "string"
},
{
"name": "x-ms-source-if-none-match",
"description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the rename operation only if the source's ETag does not match the value specified. The ETag must be specified in quotes.",
"in": "header",
"required": false,
"type": "string"
},
{
"name": "x-ms-source-if-modified-since",
"description": "Optional. A date and time value. Specify this header to perform the rename operation only if the source has been modified since the specified date and time.",
"in": "header",
"required": false,
"type": "string"
},
{
"name": "x-ms-source-if-unmodified-since",
"description": "Optional. A date and time value. Specify this header to perform the rename operation only if the source has not been modified since the specified date and time.",
"in": "header",
"required": false,
"type": "string"
}
]
},
"patch": {
"operationId": "Path_Update",
"summary": "Append Data | Flush Data | Set Properties | Set Access Control",
"description": "Uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).",
"consumes": [
"application/octet-stream",
"text/plain"
],
"tags": [
"File and Directory Operations"
],
"responses": {
"200": {
"description": "The data was flushed (written) to the file or the properties were set successfully.",
"headers": {
"Date": {
"description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.",
"type": "string"
},
"ETag": {
"description": "An HTTP entity tag associated with the file or directory.",
"type": "string"
},
"Last-Modified": {
"description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.",
"type": "string"
},
"Accept-Ranges": {
"description": "Indicates that the service supports requests for partial file content.",
"type": "string"
},
"Cache-Control": {
"description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.",
"type": "string"
},
"Content-Disposition": {
"description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.",
"type": "string"
},
"Content-Encoding": {
"description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.",
"type": "string"
},
"Content-Language": {
"description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.",
"type": "string"
},
"Content-Length": {
"description": "The size of the resource in bytes.",
"type": "integer",
"format": "int64"
},
"Content-Range": {
"description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.",
"type": "string"
},
"Content-Type": {
"description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.",
"type": "string"
},
"Content-MD5": {
"description": "An MD5 hash of the request content. This header is only returned for \"Flush\" operation. This header is returned so that the client can check for message content integrity. This header refers to the content of the request, not actual file content.",
"type": "string"
},
"x-ms-properties": {
"description": "User-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.",
"type": "string"
},
"x-ms-request-id": {
"description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.",
"pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$",
"type": "string"
},
"x-ms-version": {
"description": "The version of the REST protocol used to process the request.",
"type": "string"
}
}
},
"202": {
"description": "The uploaded data was accepted.",
"headers": {
"Content-MD5": {
"description": "An MD5 hash of the request content. This header is only returned for \"Append\" operation. This header is returned so that the client can check for message content integrity. The value of this header is computed by the service; it is not necessarily the same value specified in the request headers.",
"type": "string"
},
"Date": {
"description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.",
"type": "string"
},
"x-ms-request-id": {
"description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.",
"pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$",
"type": "string"
},
"x-ms-version": {
"description": "The version of the REST protocol used to process the request.",
"type": "string"
}
}
},
"default": {
"$ref": "#/responses/ErrorResponse"
}
},
"parameters": [
{
"name": "action",