-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
index.ts
8459 lines (8142 loc) · 274 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";
/**
* Key information
*/
export interface KeyInfo {
/**
* The date-time the key is active in ISO 8601 UTC time
*/
startsOn: string;
/**
* The date-time the key expires in ISO 8601 UTC time
*/
expiresOn: string;
}
/**
* A user delegation key
*/
export interface UserDelegationKey {
/**
* The Azure Active Directory object ID in GUID format.
*/
signedObjectId: string;
/**
* The Azure Active Directory tenant ID in GUID format
*/
signedTenantId: string;
/**
* The date-time the key is active
* **NOTE: This entity will be treated as a string instead of a Date because the API can
* potentially deal with a higher precision value than what is supported by JavaScript.**
*/
signedStartsOn: string;
/**
* The date-time the key expires
* **NOTE: This entity will be treated as a string instead of a Date because the API can
* potentially deal with a higher precision value than what is supported by JavaScript.**
*/
signedExpiresOn: string;
/**
* Abbreviation of the Azure Storage service that accepts the key
*/
signedService: string;
/**
* The service version that created the key
*/
signedVersion: string;
/**
* The key as a base64 string
*/
value: string;
}
/**
* An interface representing StorageError.
*/
export interface StorageError {
message?: string;
code?: string;
}
/**
* The service error response object.
*/
export interface DataLakeStorageErrorError {
/**
* The service error code.
*/
code?: string;
/**
* The service error message.
*/
message?: string;
}
/**
* An interface representing DataLakeStorageError.
*/
export interface DataLakeStorageError {
/**
* The service error response object.
*/
dataLakeStorageErrorDetails?: DataLakeStorageErrorError;
}
/**
* An Access policy
*/
export interface AccessPolicy {
/**
* the date-time the policy is active
* **NOTE: This entity will be treated as a string instead of a Date because the API can
* potentially deal with a higher precision value than what is supported by JavaScript.**
*/
startsOn?: string;
/**
* the date-time the policy expires
* **NOTE: This entity will be treated as a string instead of a Date because the API can
* potentially deal with a higher precision value than what is supported by JavaScript.**
*/
expiresOn?: string;
/**
* the permissions for the acl policy
*/
permissions?: string;
}
/**
* Properties of a blob
*/
export interface BlobPropertiesInternal {
createdOn?: Date;
lastModified: Date;
etag: string;
/**
* Size in bytes
*/
contentLength?: number;
contentType?: string;
contentEncoding?: string;
contentLanguage?: string;
contentMD5?: Uint8Array;
contentDisposition?: string;
cacheControl?: string;
blobSequenceNumber?: number;
/**
* Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'
*/
blobType?: BlobType;
/**
* Possible values include: 'locked', 'unlocked'
*/
leaseStatus?: LeaseStatusType;
/**
* Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'
*/
leaseState?: LeaseStateType;
/**
* Possible values include: 'infinite', 'fixed'
*/
leaseDuration?: LeaseDurationType;
copyId?: string;
/**
* Possible values include: 'pending', 'success', 'aborted', 'failed'
*/
copyStatus?: CopyStatusType;
copySource?: string;
copyProgress?: string;
copyCompletedOn?: Date;
copyStatusDescription?: string;
serverEncrypted?: boolean;
incrementalCopy?: boolean;
destinationSnapshot?: string;
deletedOn?: Date;
remainingRetentionDays?: number;
/**
* Possible values include: 'P4', 'P6', 'P10', 'P15', 'P20', 'P30', 'P40', 'P50', 'P60', 'P70',
* 'P80', 'Hot', 'Cool', 'Archive'
*/
accessTier?: AccessTier;
accessTierInferred?: boolean;
/**
* Possible values include: 'rehydrate-pending-to-hot', 'rehydrate-pending-to-cool'
*/
archiveStatus?: ArchiveStatus;
customerProvidedKeySha256?: string;
/**
* The name of the encryption scope under which the blob is encrypted.
*/
encryptionScope?: string;
accessTierChangedOn?: Date;
tagCount?: number;
expiresOn?: Date;
isSealed?: boolean;
/**
* Possible values include: 'High', 'Standard'
*/
rehydratePriority?: RehydratePriority;
lastAccessedOn?: Date;
}
/**
* An interface representing BlobTag.
*/
export interface BlobTag {
key: string;
value: string;
}
/**
* Blob tags
*/
export interface BlobTags {
blobTagSet: BlobTag[];
}
/**
* An Azure Storage blob
*/
export interface BlobItemInternal {
name: string;
deleted: boolean;
snapshot: string;
versionId?: string;
isCurrentVersion?: boolean;
properties: BlobPropertiesInternal;
metadata?: { [propertyName: string]: string };
blobTags?: BlobTags;
objectReplicationMetadata?: { [propertyName: string]: string };
}
/**
* An interface representing BlobFlatListSegment.
*/
export interface BlobFlatListSegment {
blobItems: BlobItemInternal[];
}
/**
* An enumeration of blobs
*/
export interface ListBlobsFlatSegmentResponse {
serviceEndpoint: string;
containerName: string;
prefix?: string;
marker?: string;
maxPageSize?: number;
segment: BlobFlatListSegment;
continuationToken?: string;
}
/**
* An interface representing BlobPrefix.
*/
export interface BlobPrefix {
name: string;
}
/**
* An interface representing BlobHierarchyListSegment.
*/
export interface BlobHierarchyListSegment {
blobPrefixes?: BlobPrefix[];
blobItems: BlobItemInternal[];
}
/**
* An enumeration of blobs
*/
export interface ListBlobsHierarchySegmentResponse {
serviceEndpoint: string;
containerName: string;
prefix?: string;
marker?: string;
maxPageSize?: number;
delimiter?: string;
segment: BlobHierarchyListSegment;
continuationToken?: string;
}
/**
* Represents a single block in a block blob. It describes the block's ID and size.
*/
export interface Block {
/**
* The base64 encoded block ID.
*/
name: string;
/**
* The block size in bytes.
*/
size: number;
}
/**
* An interface representing BlockList.
*/
export interface BlockList {
committedBlocks?: Block[];
uncommittedBlocks?: Block[];
}
/**
* An interface representing BlockLookupList.
*/
export interface BlockLookupList {
committed?: string[];
uncommitted?: string[];
latest?: string[];
}
/**
* Properties of a container
*/
export interface ContainerProperties {
lastModified: Date;
etag: string;
/**
* Possible values include: 'locked', 'unlocked'
*/
leaseStatus?: LeaseStatusType;
/**
* Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'
*/
leaseState?: LeaseStateType;
/**
* Possible values include: 'infinite', 'fixed'
*/
leaseDuration?: LeaseDurationType;
/**
* Possible values include: 'container', 'blob'
*/
publicAccess?: PublicAccessType;
hasImmutabilityPolicy?: boolean;
hasLegalHold?: boolean;
defaultEncryptionScope?: string;
preventEncryptionScopeOverride?: boolean;
deletedOn?: Date;
remainingRetentionDays?: number;
}
/**
* An Azure Storage container
*/
export interface ContainerItem {
name: string;
deleted?: boolean;
version?: string;
properties: ContainerProperties;
metadata?: { [propertyName: string]: string };
}
/**
* delimited text configuration
*/
export interface DelimitedTextConfiguration {
/**
* column separator
*/
columnSeparator: string;
/**
* field quote
*/
fieldQuote: string;
/**
* record separator
*/
recordSeparator: string;
/**
* escape char
*/
escapeChar: string;
/**
* has headers
*/
headersPresent: boolean;
}
/**
* json text configuration
*/
export interface JsonTextConfiguration {
/**
* record separator
*/
recordSeparator: string;
}
/**
* field of an arrow schema
*/
export interface ArrowField {
type: string;
name?: string;
precision?: number;
scale?: number;
}
/**
* arrow configuration
*/
export interface ArrowConfiguration {
schema: ArrowField[];
}
/**
* An enumeration of containers
*/
export interface ListContainersSegmentResponse {
serviceEndpoint: string;
prefix?: string;
marker?: string;
maxPageSize?: number;
containerItems: ContainerItem[];
continuationToken?: string;
}
/**
* CORS is an HTTP feature that enables a web application running under one domain to access
* resources in another domain. Web browsers implement a security restriction known as same-origin
* policy that prevents a web page from calling APIs in a different domain; CORS provides a secure
* way to allow one domain (the origin domain) to call APIs in another domain
*/
export interface CorsRule {
/**
* The origin domains that are permitted to make a request against the storage service via CORS.
* The origin domain is the domain from which the request originates. Note that the origin must
* be an exact case-sensitive match with the origin that the user age sends to the service. You
* can also use the wildcard character '*' to allow all origin domains to make requests via CORS.
*/
allowedOrigins: string;
/**
* The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma
* separated)
*/
allowedMethods: string;
/**
* the request headers that the origin domain may specify on the CORS request.
*/
allowedHeaders: string;
/**
* The response headers that may be sent in the response to the CORS request and exposed by the
* browser to the request issuer
*/
exposedHeaders: string;
/**
* The maximum amount time that a browser should cache the preflight OPTIONS request.
*/
maxAgeInSeconds: number;
}
/**
* Blob info from a Filter Blobs API call
*/
export interface FilterBlobItem {
name: string;
containerName: string;
tags?: BlobTags;
}
/**
* The result of a Filter Blobs API call
*/
export interface FilterBlobSegment {
serviceEndpoint: string;
where: string;
blobs: FilterBlobItem[];
continuationToken?: string;
}
/**
* Geo-Replication information for the Secondary Storage Service
*/
export interface GeoReplication {
/**
* The status of the secondary location. Possible values include: 'live', 'bootstrap',
* 'unavailable'
*/
status: GeoReplicationStatusType;
/**
* A GMT date/time value, to the second. All primary writes preceding this value are guaranteed
* to be available for read operations at the secondary. Primary writes after this point in time
* may or may not be available for reads.
*/
lastSyncOn: Date;
}
/**
* the retention policy which determines how long the associated data should persist
*/
export interface RetentionPolicy {
/**
* Indicates whether a retention policy is enabled for the storage service
*/
enabled: boolean;
/**
* Indicates the number of days that metrics or logging or soft-deleted data should be retained.
* All data older than this value will be deleted
*/
days?: number;
}
/**
* Azure Analytics Logging settings.
*/
export interface Logging {
/**
* The version of Storage Analytics to configure.
*/
version: string;
/**
* Indicates whether all delete requests should be logged.
*/
deleteProperty: boolean;
/**
* Indicates whether all read requests should be logged.
*/
read: boolean;
/**
* Indicates whether all write requests should be logged.
*/
write: boolean;
retentionPolicy: RetentionPolicy;
}
/**
* a summary of request statistics grouped by API in hour or minute aggregates for blobs
*/
export interface Metrics {
/**
* The version of Storage Analytics to configure.
*/
version?: string;
/**
* Indicates whether metrics are enabled for the Blob service.
*/
enabled: boolean;
/**
* Indicates whether metrics should generate summary statistics for called API operations.
*/
includeAPIs?: boolean;
retentionPolicy?: RetentionPolicy;
}
/**
* An interface representing PageRange.
*/
export interface PageRange {
start: number;
end: number;
}
/**
* An interface representing ClearRange.
*/
export interface ClearRange {
start: number;
end: number;
}
/**
* the list of pages
*/
export interface PageList {
pageRange?: PageRange[];
clearRange?: ClearRange[];
}
/**
* An interface representing QueryFormat.
*/
export interface QueryFormat {
/**
* Possible values include: 'delimited', 'json', 'arrow'
*/
type?: QueryFormatType;
delimitedTextConfiguration?: DelimitedTextConfiguration;
jsonTextConfiguration?: JsonTextConfiguration;
arrowConfiguration?: ArrowConfiguration;
}
/**
* An interface representing QuerySerialization.
*/
export interface QuerySerialization {
format: QueryFormat;
}
/**
* the quick query body
*/
export interface QueryRequest {
/**
* a query statement
*/
expression: string;
inputSerialization?: QuerySerialization;
outputSerialization?: QuerySerialization;
}
/**
* signed identifier
*/
export interface SignedIdentifier {
/**
* a unique id
*/
id: string;
accessPolicy: AccessPolicy;
}
/**
* The properties that enable an account to host a static website
*/
export interface StaticWebsite {
/**
* Indicates whether this account is hosting a static website
*/
enabled: boolean;
/**
* The default name of the index page under each directory
*/
indexDocument?: string;
/**
* The absolute path of the custom 404 page
*/
errorDocument404Path?: string;
/**
* Absolute path of the default index page
*/
defaultIndexDocumentPath?: string;
}
/**
* Storage Service Properties.
*/
export interface BlobServiceProperties {
blobAnalyticsLogging?: Logging;
hourMetrics?: Metrics;
minuteMetrics?: Metrics;
/**
* The set of CORS rules.
*/
cors?: CorsRule[];
/**
* The default version to use for requests to the Blob service if an incoming request's version
* is not specified. Possible values include version 2008-10-27 and all more recent versions
*/
defaultServiceVersion?: string;
deleteRetentionPolicy?: RetentionPolicy;
staticWebsite?: StaticWebsite;
}
/**
* Stats for the storage service.
*/
export interface BlobServiceStatistics {
geoReplication?: GeoReplication;
}
/**
* Additional parameters for create operation.
*/
export interface ContainerEncryptionScope {
/**
* Optional. Version 2019-07-07 and later. Specifies the default encryption scope to set on the
* container and use for all future writes.
*/
defaultEncryptionScope?: string;
/**
* Optional. Version 2019-07-07 and newer. If true, prevents any request from specifying a
* different encryption scope than the scope set on the container.
*/
preventEncryptionScopeOverride?: boolean;
}
/**
* 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 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;
/**
* Specify a SQL where clause on blob tags to operate only on blobs with a matching value.
*/
ifTags?: string;
}
/**
* Additional parameters for a set of operations, such as: Directory_create, Directory_rename,
* Blob_rename.
*/
export interface DirectoryHttpHeaders {
/**
* Cache control for given resource
*/
cacheControl?: string;
/**
* Content type for given resource
*/
contentType?: string;
/**
* Content encoding for given resource
*/
contentEncoding?: string;
/**
* Content language for given resource
*/
contentLanguage?: string;
/**
* Content disposition for given resource
*/
contentDisposition?: string;
}
/**
* Additional parameters for a set of operations.
*/
export interface SourceModifiedAccessConditions {
/**
* 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;
/**
* 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 a SQL where clause on blob tags to operate only on blobs with a matching value.
*/
sourceIfTags?: string;
}
/**
* Additional parameters for a set of operations.
*/
export interface CpkInfo {
/**
* Optional. Specifies the encryption key to use to encrypt the data provided in the request. If
* not specified, encryption is performed with the root account encryption key. For more
* information, see Encryption at Rest for Azure Storage Services.
*/
encryptionKey?: string;
/**
* The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key
* header is provided.
*/
encryptionKeySha256?: string;
/**
* The algorithm used to produce the encryption key hash. Currently, the only accepted value is
* "AES256". Must be provided if the x-ms-encryption-key header is provided. Possible values
* include: 'AES256'
*/
encryptionAlgorithm?: EncryptionAlgorithmType;
}
/**
* Additional parameters for a set of operations.
*/
export interface BlobHTTPHeaders {
/**
* Optional. Sets the blob's cache control. If specified, this property is stored with the blob
* and returned with a read request.
*/
blobCacheControl?: string;
/**
* Optional. Sets the blob's content type. If specified, this property is stored with the blob
* and returned with a read request.
*/
blobContentType?: string;
/**
* Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes
* for the individual blocks were validated when each was uploaded.
*/
blobContentMD5?: Uint8Array;
/**
* Optional. Sets the blob's content encoding. If specified, this property is stored with the
* blob and returned with a read request.
*/
blobContentEncoding?: string;
/**
* Optional. Set the blob's content language. If specified, this property is stored with the blob
* and returned with a read request.
*/
blobContentLanguage?: string;
/**
* Optional. Sets the blob's Content-Disposition header.
*/
blobContentDisposition?: string;
}
/**
* Additional parameters for a set of operations, such as: PageBlob_uploadPages,
* PageBlob_clearPages, PageBlob_uploadPagesFromURL.
*/
export interface SequenceNumberAccessConditions {
/**
* Specify this header value to operate only on a blob if it has a sequence number less than or
* equal to the specified.
*/
ifSequenceNumberLessThanOrEqualTo?: number;
/**
* Specify this header value to operate only on a blob if it has a sequence number less than the
* specified.
*/
ifSequenceNumberLessThan?: number;
/**
* Specify this header value to operate only on a blob if it has the specified sequence number.
*/
ifSequenceNumberEqualTo?: number;
}
/**
* Additional parameters for a set of operations, such as: AppendBlob_appendBlock,
* AppendBlob_appendBlockFromUrl, AppendBlob_seal.
*/
export interface AppendPositionAccessConditions {
/**
* Optional conditional header. The max length in bytes permitted for the append blob. If the
* Append Block operation would cause the blob to exceed that limit or if the blob size is
* already greater than the value specified in this header, the request will fail with
* MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).
*/
maxSize?: number;
/**
* Optional conditional header, used only for the Append Block operation. A number indicating the
* byte offset to compare. Append Block will succeed only if the append position is equal to this
* number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP
* status code 412 - Precondition Failed).
*/
appendPosition?: number;
}
/**
* Optional Parameters.
*/
export interface ServiceSetPropertiesOptionalParams 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>
*/
timeoutInSeconds?: 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;
}
/**
* Optional Parameters.
*/
export interface ServiceGetPropertiesOptionalParams 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>
*/
timeoutInSeconds?: 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;
}
/**
* Optional Parameters.
*/
export interface ServiceGetStatisticsOptionalParams 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>
*/
timeoutInSeconds?: 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;
}
/**
* Optional Parameters.
*/
export interface ServiceListContainersSegmentOptionalParams extends coreHttp.RequestOptionsBase {
/**
* Filters the results to return only containers whose name begins with the specified prefix.
*/
prefix?: 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 ContinuationToken value within the response
* body if the listing operation did not return all containers remaining to be listed with the
* current page. The ContinuationToken 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;
/**
* Specifies the maximum number of containers to return. If the request does not specify
* maxresults, or specifies a value greater than 5000, the server will return up to 5000 items.
* Note that if the listing operation crosses a partition boundary, then the service will return
* a continuation token for retrieving the remainder of the results. For this reason, it is
* possible that the service will return fewer results than specified by maxresults, or than the
* default of 5000.
*/
maxPageSize?: number;
/**
* Include this parameter to specify that the container's metadata be returned as part of the
* response body.
*/
include?: ListContainersIncludeType[];
/**
* 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>
*/
timeoutInSeconds?: 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;
}
/**
* Optional Parameters.
*/
export interface ServiceGetUserDelegationKeyOptionalParams 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>
*/
timeoutInSeconds?: 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;
}
/**
* Optional Parameters.
*/
export interface ServiceSubmitBatchOptionalParams 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>
*/
timeoutInSeconds?: 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;
}
/**
* Optional Parameters.
*/
export interface ServiceFilterBlobsOptionalParams 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>
*/
timeoutInSeconds?: number;
/**