/
index.ts
1278 lines (1176 loc) · 74.3 KB
/
index.ts
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
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
import * as coreHttp from "@azure/core-http";
export interface FileSystemList {
filesystems?: FileSystem[];
}
export interface FileSystem {
name?: string;
lastModified?: Date;
etag?: string;
}
export interface StorageError {
/** The service error response object. */
error?: StorageErrorError;
code?: string;
}
/** The service error response object. */
export interface StorageErrorError {
/** The service error code. */
code?: string;
/** The service error message. */
message?: string;
}
export interface PathList {
paths?: Path[];
}
export interface Path {
name?: string;
isDirectory?: boolean;
lastModified?: Date;
etag?: string;
contentLength?: number;
owner?: string;
group?: string;
permissions?: string;
}
/** An enumeration of blobs */
export interface ListBlobsHierarchySegmentResponse {
serviceEndpoint: string;
containerName: string;
prefix?: string;
marker?: string;
maxResults?: number;
delimiter?: string;
segment: BlobHierarchyListSegment;
nextMarker?: string;
}
export interface BlobHierarchyListSegment {
blobPrefixes?: BlobPrefix[];
blobItems: BlobItemModel[];
}
export interface BlobPrefix {
name: string;
}
/** An Azure Storage blob */
export interface BlobItemModel {
name: string;
deleted: boolean;
snapshot: string;
versionId?: string;
isCurrentVersion?: boolean;
/** Properties of a blob */
properties: BlobPropertiesModel;
deletionId?: string;
}
/** Properties of a blob */
export interface BlobPropertiesModel {
creationTime?: Date;
lastModified: Date;
etag: string;
/** Size in bytes */
contentLength?: number;
contentType?: string;
contentEncoding?: string;
contentLanguage?: string;
contentMD5?: Uint8Array;
contentDisposition?: string;
cacheControl?: string;
blobSequenceNumber?: number;
copyId?: string;
copySource?: string;
copyProgress?: string;
copyCompletionTime?: Date;
copyStatusDescription?: string;
serverEncrypted?: boolean;
incrementalCopy?: boolean;
destinationSnapshot?: string;
deletedTime?: Date;
remainingRetentionDays?: number;
accessTierInferred?: boolean;
customerProvidedKeySha256?: string;
/** The name of the encryption scope under which the blob is encrypted. */
encryptionScope?: string;
accessTierChangeTime?: Date;
tagCount?: number;
expiresOn?: Date;
sealed?: boolean;
lastAccessedOn?: Date;
}
export interface SetAccessControlRecursiveResponse {
directoriesSuccessful?: number;
filesSuccessful?: number;
failureCount?: number;
failedEntries?: AclFailedEntry[];
}
export interface AclFailedEntry {
name?: string;
type?: string;
errorMessage?: string;
}
/** Defines headers for Service_listFileSystems operation. */
export interface ServiceListFileSystemsHeaders {
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
/** 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. */
continuation?: string;
/** The content type of list filesystem response. The default content type is application/json. */
contentType?: string;
}
/** Defines headers for Service_listFileSystems operation. */
export interface ServiceListFileSystemsExceptionHeaders {
errorCode?: string;
}
/** Defines headers for FileSystem_create operation. */
export interface FileSystemCreateHeaders {
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** An HTTP entity tag associated with the FileSystem. */
etag?: string;
/** The data and time the filesystem was last modified. Operations on files and directories do not affect the last modified time. */
lastModified?: Date;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
clientRequestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
/** A bool string indicates whether the namespace feature is enabled. If "true", the namespace is enabled for the filesystem. */
namespaceEnabled?: string;
}
/** Defines headers for FileSystem_create operation. */
export interface FileSystemCreateExceptionHeaders {
errorCode?: string;
}
/** Defines headers for FileSystem_setProperties operation. */
export interface FileSystemSetPropertiesHeaders {
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not. */
etag?: string;
/** 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. */
lastModified?: Date;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
}
/** Defines headers for FileSystem_setProperties operation. */
export interface FileSystemSetPropertiesExceptionHeaders {
errorCode?: string;
}
/** Defines headers for FileSystem_getProperties operation. */
export interface FileSystemGetPropertiesHeaders {
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not. */
etag?: string;
/** 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. */
lastModified?: Date;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
/** 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. */
properties?: string;
/** A bool string indicates whether the namespace feature is enabled. If "true", the namespace is enabled for the filesystem. */
namespaceEnabled?: string;
}
/** Defines headers for FileSystem_getProperties operation. */
export interface FileSystemGetPropertiesExceptionHeaders {
errorCode?: string;
}
/** Defines headers for FileSystem_delete operation. */
export interface FileSystemDeleteHeaders {
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
}
/** Defines headers for FileSystem_delete operation. */
export interface FileSystemDeleteExceptionHeaders {
errorCode?: string;
}
/** Defines headers for FileSystem_listPaths operation. */
export interface FileSystemListPathsHeaders {
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not. */
etag?: string;
/** 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. */
lastModified?: Date;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
/** 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. */
continuation?: string;
/** Error Code */
errorCode?: string;
}
/** Defines headers for FileSystem_listPaths operation. */
export interface FileSystemListPathsExceptionHeaders {
errorCode?: string;
}
/** Defines headers for FileSystem_listBlobHierarchySegment operation. */
export interface FileSystemListBlobHierarchySegmentHeaders {
/** The media type of the body of the response. For List Blobs this is 'application/xml' */
contentType?: string;
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
clientRequestId?: string;
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
requestId?: string;
/** 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. */
version?: string;
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
date?: Date;
/** Error Code */
errorCode?: string;
}
/** Defines headers for FileSystem_listBlobHierarchySegment operation. */
export interface FileSystemListBlobHierarchySegmentExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Path_create operation. */
export interface PathCreateHeaders {
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** An HTTP entity tag associated with the file or directory. */
etag?: string;
/** The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. */
lastModified?: Date;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
/** 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. */
continuation?: string;
/** The size of the resource in bytes. */
contentLength?: number;
/** Error Code */
errorCode?: string;
}
/** Defines headers for Path_create operation. */
export interface PathCreateExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Path_update operation. */
export interface PathUpdateHeaders {
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** An HTTP entity tag associated with the file or directory. */
etag?: string;
/** The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. */
lastModified?: Date;
/** Indicates that the service supports requests for partial file content. */
acceptRanges?: string;
/** If the Cache-Control request header has previously been set for the resource, that value is returned in this header. */
cacheControl?: string;
/** If the Content-Disposition request header has previously been set for the resource, that value is returned in this header. */
contentDisposition?: string;
/** If the Content-Encoding request header has previously been set for the resource, that value is returned in this header. */
contentEncoding?: string;
/** If the Content-Language request header has previously been set for the resource, that value is returned in this header. */
contentLanguage?: string;
/** The size of the resource in bytes. */
contentLength?: number;
/** Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header. */
contentRange?: string;
/** The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream. */
contentType?: string;
/** 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. */
contentMD5?: string;
/** 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. */
properties?: string;
/** 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. */
xMsContinuation?: string;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
/** Error Code */
errorCode?: string;
}
/** Defines headers for Path_update operation. */
export interface PathUpdateExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Path_lease operation. */
export interface PathLeaseHeaders {
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** An HTTP entity tag associated with the file. */
etag?: string;
/** The data and time the file was last modified. Write operations on the file update the last modified time. */
lastModified?: Date;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
/** A successful "renew" action returns the lease ID. */
leaseId?: string;
}
/** Defines headers for Path_lease operation. */
export interface PathLeaseExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Path_read operation. */
export interface PathReadHeaders {
/** Indicates that the service supports requests for partial file content. */
acceptRanges?: string;
/** If the Cache-Control request header has previously been set for the resource, that value is returned in this header. */
cacheControl?: string;
/** If the Content-Disposition request header has previously been set for the resource, that value is returned in this header. */
contentDisposition?: string;
/** If the Content-Encoding request header has previously been set for the resource, that value is returned in this header. */
contentEncoding?: string;
/** If the Content-Language request header has previously been set for the resource, that value is returned in this header. */
contentLanguage?: string;
/** The size of the resource in bytes. */
contentLength?: number;
/** Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header. */
contentRange?: string;
/** The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream. */
contentType?: string;
/** The MD5 hash of complete file. If the file has an MD5 hash and this read operation is to read the complete file, this response header is returned so that the client can check for message content integrity. */
contentMD5?: string;
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** An HTTP entity tag associated with the file or directory. */
etag?: string;
/** The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. */
lastModified?: Date;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
/** The type of the resource. The value may be "file" or "directory". If not set, the value is "file". */
resourceType?: string;
/** The 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. */
properties?: string;
/** When a resource is leased, specifies whether the lease is of infinite or fixed duration. */
leaseDuration?: string;
/** Lease state of the resource. */
leaseState?: string;
/** The lease status of the resource. */
leaseStatus?: string;
}
/** Defines headers for Path_read operation. */
export interface PathReadExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Path_getProperties operation. */
export interface PathGetPropertiesHeaders {
/** Indicates that the service supports requests for partial file content. */
acceptRanges?: string;
/** If the Cache-Control request header has previously been set for the resource, that value is returned in this header. */
cacheControl?: string;
/** If the Content-Disposition request header has previously been set for the resource, that value is returned in this header. */
contentDisposition?: string;
/** If the Content-Encoding request header has previously been set for the resource, that value is returned in this header. */
contentEncoding?: string;
/** If the Content-Language request header has previously been set for the resource, that value is returned in this header. */
contentLanguage?: string;
/** The size of the resource in bytes. */
contentLength?: number;
/** Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header. */
contentRange?: string;
/** The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream. */
contentType?: string;
/** The MD5 hash of complete file stored in storage. This header is returned only for "GetProperties" operation. If the Content-MD5 header has been set for the file, this response header is returned for GetProperties call so that the client can check for message content integrity. */
contentMD5?: string;
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** An HTTP entity tag associated with the file or directory. */
etag?: string;
/** The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. */
lastModified?: Date;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
/** The type of the resource. The value may be "file" or "directory". If not set, the value is "file". */
resourceType?: string;
/** The 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. */
properties?: string;
/** The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account. */
owner?: string;
/** The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account. */
group?: string;
/** The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account. */
permissions?: string;
/** The POSIX access control list for the file or directory. Included in the response only if the action is "getAccessControl" and Hierarchical Namespace is enabled for the account. */
acl?: string;
/** When a resource is leased, specifies whether the lease is of infinite or fixed duration. */
leaseDuration?: string;
/** Lease state of the resource. */
leaseState?: string;
/** The lease status of the resource. */
leaseStatus?: string;
/** Error Code */
errorCode?: string;
}
/** Defines headers for Path_getProperties operation. */
export interface PathGetPropertiesExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Path_delete operation. */
export interface PathDeleteHeaders {
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
/** When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted 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 delete operation to continue deleting the directory. */
continuation?: string;
/** Returned only for hierarchical namespace space enabled accounts when soft delete is enabled. A unique identifier for the entity that can be used to restore it. See the Undelete REST API for more information. */
deletionId?: string;
/** Error Code */
errorCode?: string;
}
/** Defines headers for Path_delete operation. */
export interface PathDeleteExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Path_setAccessControl operation. */
export interface PathSetAccessControlHeaders {
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** An HTTP entity tag associated with the file or directory. */
etag?: string;
/** The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. */
lastModified?: Date;
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
clientRequestId?: string;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
}
/** Defines headers for Path_setAccessControl operation. */
export interface PathSetAccessControlExceptionHeaders {
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
clientRequestId?: string;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
}
/** Defines headers for Path_setAccessControlRecursive operation. */
export interface PathSetAccessControlRecursiveHeaders {
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
clientRequestId?: string;
/** 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. */
continuation?: string;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
}
/** Defines headers for Path_setAccessControlRecursive operation. */
export interface PathSetAccessControlRecursiveExceptionHeaders {
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
clientRequestId?: string;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
}
/** Defines headers for Path_flushData operation. */
export interface PathFlushDataHeaders {
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** An HTTP entity tag associated with the file or directory. */
etag?: string;
/** The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. */
lastModified?: Date;
/** The size of the resource in bytes. */
contentLength?: number;
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
clientRequestId?: string;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
}
/** Defines headers for Path_flushData operation. */
export interface PathFlushDataExceptionHeaders {
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
clientRequestId?: string;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
}
/** Defines headers for Path_appendData operation. */
export interface PathAppendDataHeaders {
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
clientRequestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
/** An HTTP entity tag associated with the file or directory. */
etag?: string;
/** If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. */
contentMD5?: Uint8Array;
/** This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. */
xMsContentCrc64?: Uint8Array;
/** 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. */
isServerEncrypted?: boolean;
}
/** Defines headers for Path_appendData operation. */
export interface PathAppendDataExceptionHeaders {
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
clientRequestId?: string;
/** A server-generated UUID recorded in the analytics logs for troubleshooting and correlation. */
requestId?: string;
/** The version of the REST protocol used to process the request. */
version?: string;
}
/** Defines headers for Path_setExpiry operation. */
export interface PathSetExpiryHeaders {
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
etag?: string;
/** Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
lastModified?: Date;
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
clientRequestId?: string;
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
requestId?: string;
/** 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. */
version?: string;
/** UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
/** Error Code */
errorCode?: string;
}
/** Defines headers for Path_setExpiry operation. */
export interface PathSetExpiryExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Path_undelete operation. */
export interface PathUndeleteHeaders {
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
clientRequestId?: string;
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
requestId?: string;
/** The type of the resource. The value may be "file" or "directory". If not set, the value is "file". */
resourceType?: string;
/** 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. */
version?: string;
/** UTC date/time value generated by the service that indicates the time at which the response was initiated. */
date?: Date;
}
/** Defines headers for Path_undelete operation. */
export interface PathUndeleteExceptionHeaders {
errorCode?: string;
}
/** Parameter group */
export interface ModifiedAccessConditions {
/** Specify this header value to operate only on a blob if it has been modified since the specified date/time. */
ifModifiedSince?: Date;
/** Specify this header value to operate only on a blob if it has not been modified since the specified date/time. */
ifUnmodifiedSince?: Date;
/** Specify an ETag value to operate only on blobs with a matching value. */
ifMatch?: string;
/** Specify an ETag value to operate only on blobs without a matching value. */
ifNoneMatch?: string;
}
/** Parameter group */
export interface PathHttpHeaders {
/** Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. */
cacheControl?: string;
/** Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. */
contentEncoding?: string;
/** Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. */
contentLanguage?: string;
/** Optional. Sets the blob's Content-Disposition header. */
contentDisposition?: string;
/** Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. */
contentType?: string;
/** Specify the transactional md5 for the body, to be validated by the service. */
contentMD5?: Uint8Array;
/** Specify the transactional md5 for the body, to be validated by the service. */
transactionalContentHash?: Uint8Array;
}
/** Parameter group */
export interface LeaseAccessConditions {
/** If specified, the operation only succeeds if the resource's lease is active and matches this ID. */
leaseId?: string;
}
/** Parameter group */
export interface SourceModifiedAccessConditions {
/** Specify an ETag value to operate only on blobs with a matching value. */
sourceIfMatch?: string;
/** Specify an ETag value to operate only on blobs without a matching value. */
sourceIfNoneMatch?: string;
/** Specify this header value to operate only on a blob if it has been modified since the specified date/time. */
sourceIfModifiedSince?: Date;
/** Specify this header value to operate only on a blob if it has not been modified since the specified date/time. */
sourceIfUnmodifiedSince?: Date;
}
/** Defines values for ListBlobsIncludeItem. */
export type ListBlobsIncludeItem =
| "copy"
| "deleted"
| "metadata"
| "snapshots"
| "uncommittedblobs"
| "versions"
| "tags";
/** Defines values for PathResourceType. */
export type PathResourceType = "directory" | "file";
/** Defines values for PathRenameMode. */
export type PathRenameMode = "legacy" | "posix";
/** Defines values for PathUpdateAction. */
export type PathUpdateAction =
| "append"
| "flush"
| "setProperties"
| "setAccessControl"
| "setAccessControlRecursive";
/** Defines values for PathSetAccessControlRecursiveMode. */
export type PathSetAccessControlRecursiveMode = "set" | "modify" | "remove";
/** Defines values for PathLeaseAction. */
export type PathLeaseAction =
| "acquire"
| "break"
| "change"
| "renew"
| "release";
/** Defines values for PathGetPropertiesAction. */
export type PathGetPropertiesAction = "getAccessControl" | "getStatus";
/** Defines values for PathExpiryOptions. */
export type PathExpiryOptions =
| "NeverExpire"
| "RelativeToCreation"
| "RelativeToNow"
| "Absolute";
/** Optional parameters. */
export interface ServiceListFileSystemsOptionalParams
extends coreHttp.OperationOptions {
/** Filters results to filesystems within the specified prefix. */
prefix?: string;
/** Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted 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 delete operation to continue deleting the directory. */
continuation?: string;
/** 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. */
maxResults?: number;
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
requestId?: string;
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
timeout?: number;
}
/** Contains response data for the listFileSystems operation. */
export type ServiceListFileSystemsResponse = ServiceListFileSystemsHeaders &
FileSystemList & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: FileSystemList;
/** The parsed HTTP response headers. */
parsedHeaders: ServiceListFileSystemsHeaders;
};
};
/** Optional parameters. */
export interface FileSystemCreateOptionalParams
extends coreHttp.OperationOptions {
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
requestId?: string;
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
timeout?: number;
/** 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. */
properties?: string;
}
/** Contains response data for the create operation. */
export type FileSystemCreateResponse = FileSystemCreateHeaders & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The parsed HTTP response headers. */
parsedHeaders: FileSystemCreateHeaders;
};
};
/** Optional parameters. */
export interface FileSystemSetPropertiesOptionalParams
extends coreHttp.OperationOptions {
/** Parameter group */
modifiedAccessConditions?: ModifiedAccessConditions;
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
requestId?: string;
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
timeout?: number;
/** 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. */
properties?: string;
}
/** Contains response data for the setProperties operation. */
export type FileSystemSetPropertiesResponse = FileSystemSetPropertiesHeaders & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The parsed HTTP response headers. */
parsedHeaders: FileSystemSetPropertiesHeaders;
};
};
/** Optional parameters. */
export interface FileSystemGetPropertiesOptionalParams
extends coreHttp.OperationOptions {
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
requestId?: string;
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
timeout?: number;
}
/** Contains response data for the getProperties operation. */
export type FileSystemGetPropertiesResponse = FileSystemGetPropertiesHeaders & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The parsed HTTP response headers. */
parsedHeaders: FileSystemGetPropertiesHeaders;
};
};
/** Optional parameters. */
export interface FileSystemDeleteOptionalParams
extends coreHttp.OperationOptions {
/** Parameter group */
modifiedAccessConditions?: ModifiedAccessConditions;
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
requestId?: string;
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
timeout?: number;
}
/** Contains response data for the delete operation. */
export type FileSystemDeleteResponse = FileSystemDeleteHeaders & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The parsed HTTP response headers. */
parsedHeaders: FileSystemDeleteHeaders;
};
};
/** Optional parameters. */
export interface FileSystemListPathsOptionalParams
extends coreHttp.OperationOptions {
/** Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted 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 delete operation to continue deleting the directory. */
continuation?: string;
/** 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. */
maxResults?: number;
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
requestId?: string;
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
timeout?: number;
/** Optional. Filters results to paths within the specified directory. An error occurs if the directory does not exist. */
path?: string;
/** Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers 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. */
upn?: boolean;
}
/** Contains response data for the listPaths operation. */
export type FileSystemListPathsResponse = FileSystemListPathsHeaders &
PathList & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: PathList;
/** The parsed HTTP response headers. */
parsedHeaders: FileSystemListPathsHeaders;
};
};
/** Optional parameters. */
export interface FileSystemListBlobHierarchySegmentOptionalParams
extends coreHttp.OperationOptions {
/** Filters results to filesystems within the specified prefix. */
prefix?: string;
/** 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. */
maxResults?: number;
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
requestId?: string;
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
timeout?: number;
/** When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string. */
delimiter?: string;
/** A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. */
marker?: string;
/** Include this parameter to specify one or more datasets to include in the response. */
include?: ListBlobsIncludeItem[];
}
/** Contains response data for the listBlobHierarchySegment operation. */
export type FileSystemListBlobHierarchySegmentResponse = FileSystemListBlobHierarchySegmentHeaders &
ListBlobsHierarchySegmentResponse & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: ListBlobsHierarchySegmentResponse;
/** The parsed HTTP response headers. */
parsedHeaders: FileSystemListBlobHierarchySegmentHeaders;
};
};
/** Optional parameters. */
export interface PathCreateOptionalParams extends coreHttp.OperationOptions {
/** Parameter group */
modifiedAccessConditions?: ModifiedAccessConditions;
/** Parameter group */
pathHttpHeaders?: PathHttpHeaders;
/** Parameter group */
leaseAccessConditions?: LeaseAccessConditions;
/** Parameter group */
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
/** Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted 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 delete operation to continue deleting the directory. */
continuation?: string;
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
requestId?: string;
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
timeout?: number;
/** 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. */
properties?: string;
/** Required only for Create File and Create Directory. The value must be "file" or "directory". */
resource?: PathResourceType;
/** 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". */
mode?: PathRenameMode;
/** 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. */
renameSource?: string;
/** A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match. */
sourceLeaseId?: string;
/** 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. */
permissions?: string;
/** 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 bitwise and not 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). */
umask?: string;
}
/** Contains response data for the create operation. */
export type PathCreateResponse = PathCreateHeaders & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The parsed HTTP response headers. */
parsedHeaders: PathCreateHeaders;
};
};
/** Optional parameters. */
export interface PathUpdateOptionalParams extends coreHttp.OperationOptions {
/** Parameter group */
modifiedAccessConditions?: ModifiedAccessConditions;
/** Parameter group */
pathHttpHeaders?: PathHttpHeaders;
/** Parameter group */
leaseAccessConditions?: LeaseAccessConditions;
/** 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. */
continuation?: string;
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
requestId?: string;
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
timeout?: number;
/** 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. */
properties?: string;
/** 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. */
permissions?: string;
/** 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 */
maxRecords?: number;
/** Optional. Valid for "SetAccessControlRecursive" operation. If set to false, the operation will terminate quickly on encountering user errors (4XX). If true, the operation will ignore user errors and proceed with the operation on other sub-entities of the directory. Continuation token will only be returned when forceFlag is true in case of user errors. If not set the default value is false for this. */
forceFlag?: boolean;
/** This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request. */
position?: number;
/** Valid only for flush operations. If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation. */
retainUncommittedData?: boolean;
/** Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are enabled. If the value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If "false" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed." */
close?: boolean;
/** Required for "Append Data" and "Flush Data". Must be 0 for "Flush Data". Must be the length of the request content in bytes for "Append Data". */
contentLength?: number;
/** Optional. The owner of the blob or directory. */
owner?: string;
/** Optional. The owning group of the blob or directory. */
group?: string;
/** Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". */
acl?: string;
}
/** Contains response data for the update operation. */
export type PathUpdateResponse = PathUpdateHeaders &
SetAccessControlRecursiveResponse & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: SetAccessControlRecursiveResponse;
/** The parsed HTTP response headers. */
parsedHeaders: PathUpdateHeaders;
};
};
/** Optional parameters. */
export interface PathLeaseOptionalParams extends coreHttp.OperationOptions {
/** Parameter group */
modifiedAccessConditions?: ModifiedAccessConditions;
/** Parameter group */
leaseAccessConditions?: LeaseAccessConditions;
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
requestId?: string;
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */