-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
DataLakeStorage.json
3612 lines (3612 loc) · 139 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": "2021-06-08",
"x-ms-code-generation-settings": {
"internalConstructors": true,
"name": "DataLakeStorageClient",
"header": "MIT",
"strictSpecAdherence": false
}
},
"x-ms-parameterized-host": {
"hostTemplate": "{url}",
"useSchemePrefix": false,
"positionInOperation": "first",
"parameters": [
{
"$ref": "#/parameters/Url"
}
]
},
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {},
"x-ms-paths": {
"/": {
"get": {
"operationId": "Service_ListFileSystems",
"summary": "List FileSystems",
"description": "List filesystems and their properties in given account.",
"x-ms-pageable": {
"itemName": "filesystems",
"nextLinkName": null
},
"tags": [
"Account Operations"
],
"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
}
},
{
"$ref": "#/parameters/Prefix"
},
{
"$ref": "#/parameters/Continuation"
},
{
"$ref": "#/parameters/MaxResults"
},
{
"$ref": "#/parameters/ClientRequestId"
},
{
"$ref": "#/parameters/Timeout"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"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",
"format": "date-time-rfc1123"
},
"x-ms-request-id": {
"x-ms-client-name": "RequestId",
"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": {
"x-ms-client-name": "Version",
"description": "The version of the REST protocol used to process the request.",
"type": "string"
},
"x-ms-continuation": {
"x-ms-client-name": "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": {
"description": "Failure",
"headers": {
"x-ms-error-code": {
"x-ms-client-name": "ErrorCode",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/StorageError"
}
}
}
}
},
"/{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"
],
"parameters": [
{
"$ref": "#/parameters/Properties"
}
],
"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",
"format": "date-time-rfc1123"
},
"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.",
"format": "date-time-rfc1123",
"type": "string"
},
"x-ms-request-id": {
"x-ms-client-name": "ClientRequestId",
"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": {
"x-ms-client-name": "Version",
"description": "The version of the REST protocol used to process the request.",
"type": "string"
},
"x-ms-namespace-enabled": {
"x-ms-client-name": "NamespaceEnabled",
"description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem.",
"type": "string"
}
}
},
"default": {
"description": "Failure",
"headers": {
"x-ms-error-code": {
"x-ms-client-name": "ErrorCode",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/StorageError"
}
}
}
},
"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"
],
"parameters": [
{
"$ref": "#/parameters/Properties"
},
{
"$ref": "#/parameters/IfModifiedSince"
},
{
"$ref": "#/parameters/IfUnmodifiedSince"
}
],
"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",
"format": "date-time-rfc1123"
},
"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.",
"format": "date-time-rfc1123",
"type": "string"
},
"x-ms-request-id": {
"x-ms-client-name": "RequestId",
"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": {
"x-ms-client-name": "Version",
"description": "The version of the REST protocol used to process the request.",
"type": "string"
}
}
},
"default": {
"description": "Failure",
"headers": {
"x-ms-error-code": {
"x-ms-client-name": "ErrorCode",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/StorageError"
}
}
}
},
"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",
"format": "date-time-rfc1123"
},
"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.",
"format": "date-time-rfc1123",
"type": "string"
},
"x-ms-request-id": {
"x-ms-client-name": "RequestId",
"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": {
"x-ms-client-name": "Version",
"description": "The version of the REST protocol used to process the request.",
"type": "string"
},
"x-ms-properties": {
"x-ms-client-name": "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": {
"x-ms-client-name": "NamespaceEnabled",
"description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem.",
"type": "string"
}
}
},
"default": {
"description": "Failure",
"headers": {
"x-ms-error-code": {
"x-ms-client-name": "ErrorCode",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/StorageError"
}
}
}
},
"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": {
"x-ms-client-name": "RequestId",
"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": {
"x-ms-client-name": "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",
"format": "date-time-rfc1123"
}
}
},
"default": {
"description": "Failure",
"headers": {
"x-ms-error-code": {
"x-ms-client-name": "ErrorCode",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/StorageError"
}
}
},
"parameters": [
{
"$ref": "#/parameters/IfModifiedSince"
},
{
"$ref": "#/parameters/IfUnmodifiedSince"
}
]
},
"parameters": [
{
"$ref": "#/parameters/FileSystem"
},
{
"$ref": "#/parameters/FileSystemResource"
},
{
"$ref": "#/parameters/ClientRequestId"
},
{
"$ref": "#/parameters/Timeout"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
]
},
"/{filesystem}?resource=filesystem": {
"get": {
"operationId": "FileSystem_ListPaths",
"summary": "List Paths",
"description": "List FileSystem paths and their properties.",
"x-ms-pageable": {
"itemName": "paths",
"nextLinkName": null
},
"tags": [
"FileSystem Operations"
],
"parameters": [
{
"$ref": "#/parameters/Continuation"
},
{
"$ref": "#/parameters/Directory"
},
{
"$ref": "#/parameters/RecursiveRequired"
},
{
"$ref": "#/parameters/MaxResults"
},
{
"$ref": "#/parameters/Upn"
}
],
"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",
"format": "date-time-rfc1123"
},
"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.",
"format": "date-time-rfc1123",
"type": "string"
},
"x-ms-request-id": {
"x-ms-client-name": "RequestId",
"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": {
"x-ms-client-name": "Version",
"description": "The version of the REST protocol used to process the request.",
"type": "string"
},
"x-ms-continuation": {
"x-ms-client-name": "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": {
"description": "Failure",
"headers": {
"x-ms-error-code": {
"x-ms-client-name": "ErrorCode",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/StorageError"
}
}
}
},
"parameters": [
{
"$ref": "#/parameters/FileSystem"
},
{
"$ref": "#/parameters/FileSystemResource"
},
{
"$ref": "#/parameters/ClientRequestId"
},
{
"$ref": "#/parameters/Timeout"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
]
},
"/{filesystem}?restype=container&comp=list&hierarchy": {
"get": {
"tags": [
"containers"
],
"produces": [
"application/xml"
],
"operationId": "FileSystem_ListBlobHierarchySegment",
"description": "The List Blobs operation returns a list of the blobs under the specified container",
"parameters": [
{
"$ref": "#/parameters/Prefix"
},
{
"$ref": "#/parameters/Delimiter"
},
{
"$ref": "#/parameters/Marker"
},
{
"$ref": "#/parameters/MaxResults"
},
{
"$ref": "#/parameters/ListBlobsInclude"
},
{
"$ref": "#/parameters/ListBlobsShowOnly"
},
{
"$ref": "#/parameters/Timeout"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/ClientRequestId"
}
],
"responses": {
"200": {
"description": "Success.",
"headers": {
"Content-Type": {
"type": "string",
"description": "The media type of the body of the response. For List Blobs this is 'application/xml'"
},
"x-ms-client-request-id": {
"x-ms-client-name": "ClientRequestId",
"type": "string",
"description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
},
"x-ms-request-id": {
"x-ms-client-name": "RequestId",
"type": "string",
"description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
},
"x-ms-version": {
"x-ms-client-name": "Version",
"type": "string",
"description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
},
"Date": {
"type": "string",
"format": "date-time-rfc1123",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
}
},
"schema": {
"$ref": "#/definitions/ListBlobsHierarchySegmentResponse"
}
},
"default": {
"description": "Failure",
"headers": {
"x-ms-error-code": {
"x-ms-client-name": "ErrorCode",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/StorageError"
}
}
},
"x-ms-pageable": {
"nextLinkName": "NextMarker"
}
},
"parameters": [
{
"$ref": "#/parameters/FileSystem"
},
{
"name": "restype",
"description": "restype",
"in": "query",
"required": true,
"type": "string",
"enum": [
"container"
]
},
{
"name": "comp",
"description": "comp",
"in": "query",
"required": true,
"type": "string",
"enum": [
"list"
]
}
]
},
"/{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"
],
"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
}
},
{
"$ref": "#/parameters/Continuation"
},
{
"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
}
},
{
"$ref": "#/parameters/CacheControl"
},
{
"$ref": "#/parameters/ContentEncoding"
},
{
"$ref": "#/parameters/ContentLanguage"
},
{
"$ref": "#/parameters/ContentDisposition"
},
{
"$ref": "#/parameters/ContentType"
},
{
"$ref": "#/parameters/RenameSource"
},
{
"$ref": "#/parameters/LeaseIdOptional"
},
{
"$ref": "#/parameters/SourceLeaseId"
},
{
"$ref": "#/parameters/Properties"
},
{
"$ref": "#/parameters/Permissions"
},
{
"$ref": "#/parameters/Umask"
},
{
"$ref": "#/parameters/IfMatch"
},
{
"$ref": "#/parameters/IfNoneMatch"
},
{
"$ref": "#/parameters/IfModifiedSince"
},
{
"$ref": "#/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/parameters/SourceIfMatch"
},
{
"$ref": "#/parameters/SourceIfNoneMatch"
},
{
"$ref": "#/parameters/SourceIfModifiedSince"
},
{
"$ref": "#/parameters/SourceIfUnmodifiedSince"
},
{
"$ref": "#/parameters/EncryptionKey"
},
{
"$ref": "#/parameters/EncryptionKeySha256"
},
{
"$ref": "#/parameters/EncryptionAlgorithm"
},
{
"$ref": "#/parameters/Owner"
},
{
"$ref": "#/parameters/Group"
},
{
"$ref": "#/parameters/Acl"
},
{
"$ref": "#/parameters/ProposedLeaseIdOptional"
},
{
"$ref": "#/parameters/LeaseDurationMethod"
},
{
"$ref": "#/parameters/PathExpiryOptionsOptional"
},
{
"$ref": "#/parameters/PathExpiryTime"
},
{
"$ref": "#/parameters/EncryptionContext"
}
],
"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",
"format": "date-time-rfc1123"
},
"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.",
"format": "date-time-rfc1123",
"type": "string"
},
"x-ms-request-id": {
"x-ms-client-name": "RequestId",
"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": {
"x-ms-client-name": "Version",
"description": "The version of the REST protocol used to process the request.",
"type": "string"
},
"x-ms-continuation": {
"x-ms-client-name": "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"
},
"x-ms-request-server-encrypted": {
"x-ms-client-name": "IsServerEncrypted",
"type": "boolean",
"description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise."
},
"x-ms-encryption-key-sha256": {
"x-ms-client-name": "EncryptionKeySha256",
"type": "string",
"description": "The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key."
}
}
},
"default": {
"description": "Failure",
"headers": {
"x-ms-error-code": {
"x-ms-client-name": "ErrorCode",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/StorageError"
}
}
}
},
"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. Concurrent writes to the same file using multiple clients are not supported. 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"
],
"tags": [
"File and Directory Operations"
],
"parameters": [
{
"name": "action",
"in": "query",
"description": "The action must be \"append\" to upload data to be appended to a file, \"flush\" to flush previously uploaded data to a file, \"setProperties\" to set the properties of a file or directory, \"setAccessControl\" to set the owner, group, permissions, or access control list for a file or directory, or \"setAccessControlRecursive\" to set the access control list for a directory recursively. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL) includes permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive.",
"required": true,
"type": "string",
"enum": [
"append",
"flush",
"setProperties",
"setAccessControl",
"setAccessControlRecursive"
],
"x-ms-enum": {
"name": "PathUpdateAction",
"modelAsString": false
}
},
{
"name": "maxRecords",
"in": "query",
"description": "Optional. Valid for \"SetAccessControlRecursive\" operation. It specifies the maximum number of files or directories on which the acl change will be applied. If omitted or greater than 2,000, the request will process up to 2,000 items",
"format": "int32",
"minimum": 1,
"required": false,
"type": "integer"
},
{
"name": "continuation",
"in": "query",
"description": "Optional. The number of paths processed with each invocation is limited. If the number of paths to be processed 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 percent-encoded and specified in a subsequent invocation of setAccessControlRecursive operation.",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/PathSetAccessControlRecursiveMode"
},
{
"$ref": "#/parameters/ForceFlag"
},
{
"$ref": "#/parameters/Position"
},
{
"$ref": "#/parameters/RetainUncommittedData"
},
{
"$ref": "#/parameters/Close"
},
{
"$ref": "#/parameters/ContentLength"
},
{
"$ref": "#/parameters/ContentMD5"
},
{
"$ref": "#/parameters/LeaseIdOptional"
},
{
"$ref": "#/parameters/CacheControl"
},
{
"$ref": "#/parameters/ContentType"
},
{
"$ref": "#/parameters/ContentDisposition"
},
{
"$ref": "#/parameters/ContentEncoding"
},
{
"$ref": "#/parameters/ContentLanguage"
},
{
"$ref": "#/parameters/Properties"
},
{
"$ref": "#/parameters/Owner"
},
{
"$ref": "#/parameters/Group"
},
{
"$ref": "#/parameters/Permissions"
},
{
"$ref": "#/parameters/Acl"
},
{
"$ref": "#/parameters/IfMatch"
},
{
"$ref": "#/parameters/IfNoneMatch"
},
{
"$ref": "#/parameters/IfModifiedSince"
},
{
"$ref": "#/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/parameters/Body"
}
],
"responses": {
"200": {
"description": "The data was flushed (written) to the file or the properties were set successfully. Response body is optional and is valid only for \"SetAccessControlRecursive\"",
"headers": {
"Date": {
"description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.",
"type": "string",
"format": "date-time-rfc1123"
},
"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.",
"format": "date-time-rfc1123",
"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": {
"x-ms-client-name": "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-continuation": {
"description": "When performing setAccessControlRecursive on a directory, the number of paths that are processed with each invocation is limited. If the number of paths to be processed 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 setAccessControlRecursive operation to continue the setAccessControlRecursive operation on the directory.",
"type": "string"
},
"x-ms-request-id": {
"x-ms-client-name": "RequestId",
"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": {
"x-ms-client-name": "Version",
"description": "The version of the REST protocol used to process the request.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/SetAccessControlRecursiveResponse"
}
},
"202": {
"description": "The uploaded data was accepted.",
"headers": {