/
index.ts
2118 lines (2036 loc) · 70.4 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. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*
* 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";
/**
* An interface representing AclFailedEntry.
*/
export interface AclFailedEntry {
name?: string;
type?: string;
errorMessage?: string;
}
/**
* An interface representing SetAccessControlRecursiveResponse.
*/
export interface SetAccessControlRecursiveResponse {
directoriesSuccessful?: number;
filesSuccessful?: number;
failureCount?: number;
failedEntries?: AclFailedEntry[];
}
/**
* An interface representing Path.
*/
export interface Path {
name?: string;
/**
* Default value: false.
*/
isDirectory?: boolean;
lastModified?: Date;
etag?: string;
contentLength?: number;
owner?: string;
group?: string;
permissions?: string;
}
/**
* An interface representing PathList.
*/
export interface PathList {
paths?: Path[];
}
/**
* An interface representing FileSystem.
*/
export interface FileSystem {
name?: string;
lastModified?: Date;
etag?: string;
}
/**
* An interface representing FileSystemList.
*/
export interface FileSystemList {
filesystems?: FileSystem[];
}
/**
* The service error response object.
*/
export interface StorageErrorError {
/**
* The service error code.
*/
code?: string;
/**
* The service error message.
*/
message?: string;
}
/**
* An interface representing StorageError.
*/
export interface StorageError {
/**
* The service error response object.
*/
error?: StorageErrorError;
code?: string;
}
/**
* Additional parameters for a set of operations.
*/
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;
}
/**
* Additional parameters for a set of operations, such as: Path_create, Path_update,
* Path_flushData, Path_appendData.
*/
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;
}
/**
* Additional parameters for a set of operations.
*/
export interface LeaseAccessConditions {
/**
* If specified, the operation only succeeds if the resource's lease is active and matches this
* ID.
*/
leaseId?: string;
}
/**
* Additional parameters for create operation.
*/
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;
}
/**
* Optional Parameters.
*/
export interface ServiceListFileSystemsOptionalParams extends coreHttp.RequestOptionsBase {
/**
* 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>
*/
timeoutParameter?: number;
}
/**
* Optional Parameters.
*/
export interface FileSystemCreateOptionalParams extends coreHttp.RequestOptionsBase {
/**
* 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;
/**
* 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>
*/
timeoutParameter?: number;
}
/**
* Optional Parameters.
*/
export interface FileSystemSetPropertiesOptionalParams extends coreHttp.RequestOptionsBase {
/**
* 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;
/**
* 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>
*/
timeoutParameter?: number;
/**
* Additional parameters for the operation
*/
modifiedAccessConditions?: ModifiedAccessConditions;
}
/**
* Optional Parameters.
*/
export interface FileSystemGetPropertiesOptionalParams extends coreHttp.RequestOptionsBase {
/**
* 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>
*/
timeoutParameter?: number;
}
/**
* Optional Parameters.
*/
export interface FileSystemDeleteMethodOptionalParams extends coreHttp.RequestOptionsBase {
/**
* 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>
*/
timeoutParameter?: number;
/**
* Additional parameters for the operation
*/
modifiedAccessConditions?: ModifiedAccessConditions;
}
/**
* Optional Parameters.
*/
export interface FileSystemListPathsOptionalParams extends coreHttp.RequestOptionsBase {
/**
* 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;
/**
* Optional. Filters results to paths within the specified directory. An error occurs if the
* directory does not exist.
*/
path?: 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;
/**
* 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;
/**
* 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>
*/
timeoutParameter?: number;
}
/**
* Optional Parameters.
*/
export interface PathCreateOptionalParams extends coreHttp.RequestOptionsBase {
/**
* Required only for Create File and Create Directory. The value must be "file" or "directory".
* Possible values include: 'directory', 'file'
*/
resource?: PathResourceType;
/**
* 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;
/**
* 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". Possible values include: 'legacy', '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. 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 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;
/**
* 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>
*/
timeoutParameter?: number;
/**
* Additional parameters for the operation
*/
pathHttpHeaders?: PathHttpHeaders;
/**
* Additional parameters for the operation
*/
leaseAccessConditions?: LeaseAccessConditions;
/**
* Additional parameters for the operation
*/
modifiedAccessConditions?: ModifiedAccessConditions;
/**
* Additional parameters for the operation
*/
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
}
/**
* Optional Parameters.
*/
export interface PathUpdateOptionalParams extends coreHttp.RequestOptionsBase {
/**
* 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. 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 setAcessControlRecursive
* operation.
*/
continuation?: string;
/**
* 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. 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. The owner of the blob or directory.
*/
owner?: string;
/**
* Optional. The owning group of the blob or directory.
*/
group?: 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;
/**
* 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;
/**
* 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>
*/
timeoutParameter?: number;
/**
* Additional parameters for the operation
*/
pathHttpHeaders?: PathHttpHeaders;
/**
* Additional parameters for the operation
*/
leaseAccessConditions?: LeaseAccessConditions;
/**
* Additional parameters for the operation
*/
modifiedAccessConditions?: ModifiedAccessConditions;
}
/**
* Optional Parameters.
*/
export interface PathLeaseOptionalParams extends coreHttp.RequestOptionsBase {
/**
* The lease duration is required to acquire a lease, and specifies the duration of the lease in
* seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.
*/
xMsLeaseDuration?: number;
/**
* The lease break period duration is optional to break a lease, and specifies the break period
* of the lease in seconds. The lease break duration must be between 0 and 60 seconds.
*/
xMsLeaseBreakPeriod?: number;
/**
* Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if
* the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list
* of valid GUID string formats.
*/
proposedLeaseId?: 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>
*/
timeoutParameter?: number;
/**
* Additional parameters for the operation
*/
leaseAccessConditions?: LeaseAccessConditions;
/**
* Additional parameters for the operation
*/
modifiedAccessConditions?: ModifiedAccessConditions;
}
/**
* Optional Parameters.
*/
export interface PathReadOptionalParams extends coreHttp.RequestOptionsBase {
/**
* The HTTP Range request header specifies one or more byte ranges of the resource to be
* retrieved.
*/
range?: string;
/**
* Optional. When this header is set to "true" and specified together with the Range header, the
* service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB
* in size. If this header is specified without the Range header, the service returns status code
* 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the
* service returns status code 400 (Bad Request).
*/
xMsRangeGetContentMd5?: boolean;
/**
* 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>
*/
timeoutParameter?: number;
/**
* Additional parameters for the operation
*/
leaseAccessConditions?: LeaseAccessConditions;
/**
* Additional parameters for the operation
*/
modifiedAccessConditions?: ModifiedAccessConditions;
}
/**
* Optional Parameters.
*/
export interface PathGetPropertiesOptionalParams extends coreHttp.RequestOptionsBase {
/**
* Optional. If the value is "getStatus" only the system defined properties for the path are
* returned. If the value is "getAccessControl" the access control list is returned in the
* response headers (Hierarchical Namespace must be enabled for the account), otherwise the
* properties are returned. Possible values include: 'getAccessControl', 'getStatus'
*/
action?: PathGetPropertiesAction;
/**
* 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;
/**
* 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>
*/
timeoutParameter?: number;
/**
* Additional parameters for the operation
*/
leaseAccessConditions?: LeaseAccessConditions;
/**
* Additional parameters for the operation
*/
modifiedAccessConditions?: ModifiedAccessConditions;
}
/**
* Optional Parameters.
*/
export interface PathDeleteMethodOptionalParams extends coreHttp.RequestOptionsBase {
/**
* Required
*/
recursive?: boolean;
/**
* 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>
*/
timeoutParameter?: number;
/**
* Additional parameters for the operation
*/
leaseAccessConditions?: LeaseAccessConditions;
/**
* Additional parameters for the operation
*/
modifiedAccessConditions?: ModifiedAccessConditions;
}
/**
* Optional Parameters.
*/
export interface PathSetAccessControlOptionalParams extends coreHttp.RequestOptionsBase {
/**
* 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>
*/
timeoutParameter?: number;
/**
* Optional. The owner of the blob or directory.
*/
owner?: string;
/**
* Optional. The owning group of the blob or directory.
*/
group?: 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;
/**
* 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;
/**
* 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;
/**
* Additional parameters for the operation
*/
leaseAccessConditions?: LeaseAccessConditions;
/**
* Additional parameters for the operation
*/
modifiedAccessConditions?: ModifiedAccessConditions;
}
/**
* Optional Parameters.
*/
export interface PathSetAccessControlRecursiveOptionalParams extends coreHttp.RequestOptionsBase {
/**
* 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>
*/
timeoutParameter?: number;
/**
* 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;
/**
* 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;
/**
* Optional. 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;
/**
* 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;
/**
* 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;
}
/**
* Optional Parameters.
*/
export interface PathFlushDataOptionalParams extends coreHttp.RequestOptionsBase {
/**
* 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>
*/
timeoutParameter?: number;
/**
* 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;
/**
* 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;
/**
* Additional parameters for the operation
*/
pathHttpHeaders?: PathHttpHeaders;
/**
* Additional parameters for the operation
*/
leaseAccessConditions?: LeaseAccessConditions;
/**
* Additional parameters for the operation
*/
modifiedAccessConditions?: ModifiedAccessConditions;
}
/**
* Optional Parameters.
*/
export interface PathAppendDataOptionalParams extends coreHttp.RequestOptionsBase {
/**
* 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;
/**
* 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>
*/
timeoutParameter?: number;
/**
* 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;
/**
* Specify the transactional crc64 for the body, to be validated by the service.
*/
transactionalContentCrc64?: Uint8Array;
/**
* 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;
/**
* Additional parameters for the operation
*/
pathHttpHeaders?: PathHttpHeaders;
/**
* Additional parameters for the operation
*/
leaseAccessConditions?: LeaseAccessConditions;
}
/**
* Optional Parameters.
*/
export interface PathSetExpiryOptionalParams extends coreHttp.RequestOptionsBase {
/**
* 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>
*/
timeoutParameter?: 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 time to set the blob to expiry
*/
expiresOn?: string;
}
/**
* Defines headers for 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;
errorCode?: string;
}
/**
* Defines headers for 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