-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
index.ts
4572 lines (4232 loc) · 251 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";
/** Storage Service Properties. */
export interface BlobServiceProperties {
/** Azure Analytics Logging settings. */
blobAnalyticsLogging?: Logging;
/** a summary of request statistics grouped by API in hour or minute aggregates for blobs */
hourMetrics?: Metrics;
/** a summary of request statistics grouped by API in hour or minute aggregates for blobs */
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;
/** the retention policy which determines how long the associated data should persist */
deleteRetentionPolicy?: RetentionPolicy;
/** The properties that enable an account to host a static website */
staticWebsite?: StaticWebsite;
}
/** 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;
/** the retention policy which determines how long the associated data should persist */
retentionPolicy: RetentionPolicy;
}
/** 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;
}
/** 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;
/** the retention policy which determines how long the associated data should persist */
retentionPolicy?: RetentionPolicy;
}
/** 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;
}
/** 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;
}
export interface StorageError {
message?: string;
code?: string;
}
/** Stats for the storage service. */
export interface BlobServiceStatistics {
/** Geo-Replication information for the Secondary Storage Service */
geoReplication?: GeoReplication;
}
/** Geo-Replication information for the Secondary Storage Service */
export interface GeoReplication {
/** The status of the secondary location */
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;
}
/** An enumeration of containers */
export interface ListContainersSegmentResponse {
serviceEndpoint: string;
prefix?: string;
marker?: string;
maxPageSize?: number;
containerItems: ContainerItem[];
continuationToken?: string;
}
/** An Azure Storage container */
export interface ContainerItem {
name: string;
deleted?: boolean;
version?: string;
/** Properties of a container */
properties: ContainerProperties;
/** Dictionary of <string> */
metadata?: { [propertyName: string]: string };
}
/** Properties of a container */
export interface ContainerProperties {
lastModified: Date;
etag: string;
leaseStatus?: LeaseStatusType;
leaseState?: LeaseStateType;
leaseDuration?: LeaseDurationType;
publicAccess?: PublicAccessType;
hasImmutabilityPolicy?: boolean;
hasLegalHold?: boolean;
defaultEncryptionScope?: string;
preventEncryptionScopeOverride?: boolean;
deletedOn?: Date;
remainingRetentionDays?: number;
/** Indicates if version level worm is enabled on this container. */
isImmutableStorageWithVersioningEnabled?: boolean;
}
/** 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 */
signedStartsOn: string;
/** The date-time the key expires */
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;
}
/** The result of a Filter Blobs API call */
export interface FilterBlobSegment {
serviceEndpoint: string;
where: string;
blobs: FilterBlobItem[];
continuationToken?: string;
}
/** Blob info from a Filter Blobs API call */
export interface FilterBlobItem {
name: string;
containerName: string;
/** Blob tags */
tags?: BlobTags;
}
/** Blob tags */
export interface BlobTags {
blobTagSet: BlobTag[];
}
export interface BlobTag {
key: string;
value: string;
}
/** signed identifier */
export interface SignedIdentifier {
/** a unique id */
id: string;
/** An Access policy */
accessPolicy: AccessPolicy;
}
/** An Access policy */
export interface AccessPolicy {
/** the date-time the policy is active */
startsOn?: string;
/** the date-time the policy expires */
expiresOn?: string;
/** the permissions for the acl policy */
permissions?: string;
}
/** An enumeration of blobs */
export interface ListBlobsFlatSegmentResponse {
serviceEndpoint: string;
containerName: string;
prefix?: string;
marker?: string;
maxPageSize?: number;
segment: BlobFlatListSegment;
continuationToken?: string;
}
export interface BlobFlatListSegment {
blobItems: BlobItemInternal[];
}
/** An Azure Storage blob */
export interface BlobItemInternal {
name: BlobName;
deleted: boolean;
snapshot: string;
versionId?: string;
isCurrentVersion?: boolean;
/** Properties of a blob */
properties: BlobPropertiesInternal;
/** Dictionary of <string> */
metadata?: { [propertyName: string]: string };
/** Blob tags */
blobTags?: BlobTags;
/** Dictionary of <string> */
objectReplicationMetadata?: { [propertyName: string]: string };
/** Inactive root blobs which have any versions would have such tag with value true. */
hasVersionsOnly?: boolean;
}
export interface BlobName {
/** Indicates if the blob name is encoded. */
encoded?: boolean;
/** The name of the blob. */
content?: 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;
blobType?: BlobType;
leaseStatus?: LeaseStatusType;
leaseState?: LeaseStateType;
leaseDuration?: LeaseDurationType;
copyId?: string;
copyStatus?: CopyStatusType;
copySource?: string;
copyProgress?: string;
copyCompletedOn?: Date;
copyStatusDescription?: string;
serverEncrypted?: boolean;
incrementalCopy?: boolean;
destinationSnapshot?: string;
deletedOn?: Date;
remainingRetentionDays?: number;
accessTier?: AccessTier;
accessTierInferred?: boolean;
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;
/** If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard. */
rehydratePriority?: RehydratePriority;
lastAccessedOn?: Date;
/** UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire. */
immutabilityPolicyExpiresOn?: Date;
/** Indicates immutability policy mode. */
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
/** Indicates if a legal hold is present on the blob. */
legalHold?: boolean;
}
/** An enumeration of blobs */
export interface ListBlobsHierarchySegmentResponse {
serviceEndpoint: string;
containerName: string;
prefix?: string;
marker?: string;
maxPageSize?: number;
delimiter?: string;
segment: BlobHierarchyListSegment;
continuationToken?: string;
}
export interface BlobHierarchyListSegment {
[x: string]: any;
blobPrefixes?: BlobPrefix[];
blobItems: BlobItemInternal[];
}
export interface BlobPrefix {
name: BlobName;
}
export interface BlockLookupList {
committed?: string[];
uncommitted?: string[];
latest?: string[];
}
export interface BlockList {
committedBlocks?: Block[];
uncommittedBlocks?: Block[];
}
/** 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;
}
/** the list of pages */
export interface PageList {
pageRange?: PageRange[];
clearRange?: ClearRange[];
}
export interface PageRange {
start: number;
end: number;
}
export interface ClearRange {
start: number;
end: number;
}
/** Groups the set of query request settings. */
export interface QueryRequest {
/** Required. The type of the provided query expression. */
queryType: string;
/** The query expression in SQL. The maximum size of the query expression is 256KiB. */
expression: string;
inputSerialization?: QuerySerialization;
outputSerialization?: QuerySerialization;
}
export interface QuerySerialization {
format: QueryFormat;
}
export interface QueryFormat {
/** The quick query format type. */
type: QueryFormatType;
/** Groups the settings used for interpreting the blob data if the blob is delimited text formatted. */
delimitedTextConfiguration?: DelimitedTextConfiguration;
/** json text configuration */
jsonTextConfiguration?: JsonTextConfiguration;
/** Groups the settings used for formatting the response if the response should be Arrow formatted. */
arrowConfiguration?: ArrowConfiguration;
/** Any object */
parquetTextConfiguration?: any;
}
/** Groups the settings used for interpreting the blob data if the blob is delimited text formatted. */
export interface DelimitedTextConfiguration {
/** The string used to separate columns. */
columnSeparator?: string;
/** The string used to quote a specific field. */
fieldQuote?: string;
/** The string used to separate records. */
recordSeparator?: string;
/** The string used as an escape character. */
escapeChar?: string;
/** Represents whether the data has headers. */
headersPresent?: boolean;
}
/** json text configuration */
export interface JsonTextConfiguration {
/** The string used to separate records. */
recordSeparator?: string;
}
/** Groups the settings used for formatting the response if the response should be Arrow formatted. */
export interface ArrowConfiguration {
schema: ArrowField[];
}
/** Groups settings regarding specific field of an arrow schema */
export interface ArrowField {
type: string;
name?: string;
precision?: number;
scale?: number;
}
/** Defines headers for Service_setProperties operation. */
export interface ServiceSetPropertiesHeaders {
/** 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;
/** Error Code */
errorCode?: string;
}
/** Defines headers for Service_setProperties operation. */
export interface ServiceSetPropertiesExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Service_getProperties operation. */
export interface ServiceGetPropertiesHeaders {
/** 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;
/** Error Code */
errorCode?: string;
}
/** Defines headers for Service_getProperties operation. */
export interface ServiceGetPropertiesExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Service_getStatistics operation. */
export interface ServiceGetStatisticsHeaders {
/** 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 Service_getStatistics operation. */
export interface ServiceGetStatisticsExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Service_listContainersSegment operation. */
export interface ServiceListContainersSegmentHeaders {
/** 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;
/** Error Code */
errorCode?: string;
}
/** Defines headers for Service_listContainersSegment operation. */
export interface ServiceListContainersSegmentExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Service_getUserDelegationKey operation. */
export interface ServiceGetUserDelegationKeyHeaders {
/** 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 Service_getUserDelegationKey operation. */
export interface ServiceGetUserDelegationKeyExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Service_getAccountInfo operation. */
export interface ServiceGetAccountInfoHeaders {
/** 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;
/** Identifies the sku name of the account */
skuName?: SkuName;
/** Identifies the account kind */
accountKind?: AccountKind;
/** Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled. */
isHierarchicalNamespaceEnabled?: boolean;
/** Error Code */
errorCode?: string;
}
/** Defines headers for Service_getAccountInfo operation. */
export interface ServiceGetAccountInfoExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Service_submitBatch operation. */
export interface ServiceSubmitBatchHeaders {
/** The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID */
contentType?: 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;
/** 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;
/** Error Code */
errorCode?: string;
}
/** Defines headers for Service_submitBatch operation. */
export interface ServiceSubmitBatchExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Service_filterBlobs operation. */
export interface ServiceFilterBlobsHeaders {
/** 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 Service_filterBlobs operation. */
export interface ServiceFilterBlobsExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_create operation. */
export interface ContainerCreateHeaders {
/** 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 Container_create operation. */
export interface ContainerCreateExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_getProperties operation. */
export interface ContainerGetPropertiesHeaders {
metadata?: { [propertyName: string]: string };
/** 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;
/** When a blob is leased, specifies whether the lease is of infinite or fixed duration. */
leaseDuration?: LeaseDurationType;
/** Lease state of the blob. */
leaseState?: LeaseStateType;
/** The current lease status of the blob. */
leaseStatus?: LeaseStatusType;
/** 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;
/** Indicated whether data in the container may be accessed publicly and the level of access */
blobPublicAccess?: PublicAccessType;
/** Indicates whether the container has an immutability policy set on it. */
hasImmutabilityPolicy?: boolean;
/** Indicates whether the container has a legal hold. */
hasLegalHold?: boolean;
/** The default encryption scope for the container. */
defaultEncryptionScope?: string;
/** Indicates whether the container's default encryption scope can be overriden. */
denyEncryptionScopeOverride?: boolean;
/** Indicates whether version level worm is enabled on a container. */
isImmutableStorageWithVersioningEnabled?: boolean;
/** Error Code */
errorCode?: string;
}
/** Defines headers for Container_getProperties operation. */
export interface ContainerGetPropertiesExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_delete operation. */
export interface ContainerDeleteHeaders {
/** 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 Container_delete operation. */
export interface ContainerDeleteExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_setMetadata operation. */
export interface ContainerSetMetadataHeaders {
/** 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 Container_setMetadata operation. */
export interface ContainerSetMetadataExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_getAccessPolicy operation. */
export interface ContainerGetAccessPolicyHeaders {
/** Indicated whether data in the container may be accessed publicly and the level of access */
blobPublicAccess?: PublicAccessType;
/** 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 Container_getAccessPolicy operation. */
export interface ContainerGetAccessPolicyExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_setAccessPolicy operation. */
export interface ContainerSetAccessPolicyHeaders {
/** 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 Container_setAccessPolicy operation. */
export interface ContainerSetAccessPolicyExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_restore operation. */
export interface ContainerRestoreHeaders {
/** 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 Container_restore operation. */
export interface ContainerRestoreExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_rename operation. */
export interface ContainerRenameHeaders {
/** 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 Container_rename operation. */
export interface ContainerRenameExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_submitBatch operation. */
export interface ContainerSubmitBatchHeaders {
/** The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID */
contentType?: 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;
}
/** Defines headers for Container_submitBatch operation. */
export interface ContainerSubmitBatchExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_acquireLease operation. */
export interface ContainerAcquireLeaseHeaders {
/** 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;
/** Uniquely identifies a container's lease */
leaseId?: 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;
}
/** Defines headers for Container_acquireLease operation. */
export interface ContainerAcquireLeaseExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_releaseLease operation. */
export interface ContainerReleaseLeaseHeaders {
/** 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;
}
/** Defines headers for Container_releaseLease operation. */
export interface ContainerReleaseLeaseExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_renewLease operation. */
export interface ContainerRenewLeaseHeaders {
/** 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;
/** Uniquely identifies a container's lease */
leaseId?: 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;
}
/** Defines headers for Container_renewLease operation. */
export interface ContainerRenewLeaseExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_breakLease operation. */
export interface ContainerBreakLeaseHeaders {
/** 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;
/** Approximate time remaining in the lease period, in seconds. */
leaseTime?: 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;
/** 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;
}
/** Defines headers for Container_breakLease operation. */
export interface ContainerBreakLeaseExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_changeLease operation. */
export interface ContainerChangeLeaseHeaders {
/** 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;
/** Uniquely identifies a container's lease */
leaseId?: 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;
}
/** Defines headers for Container_changeLease operation. */
export interface ContainerChangeLeaseExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_listBlobFlatSegment operation. */
export interface ContainerListBlobFlatSegmentHeaders {
/** 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 Container_listBlobFlatSegment operation. */
export interface ContainerListBlobFlatSegmentExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_listBlobHierarchySegment operation. */
export interface ContainerListBlobHierarchySegmentHeaders {
/** 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 Container_listBlobHierarchySegment operation. */
export interface ContainerListBlobHierarchySegmentExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Container_getAccountInfo operation. */
export interface ContainerGetAccountInfoHeaders {
/** 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;
/** Identifies the sku name of the account */
skuName?: SkuName;
/** Identifies the account kind */
accountKind?: AccountKind;
}
/** Defines headers for Container_getAccountInfo operation. */
export interface ContainerGetAccountInfoExceptionHeaders {
errorCode?: string;
}
/** Defines headers for Blob_download operation. */
export interface BlobDownloadHeaders {
/** 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;
metadata?: { [propertyName: string]: string };
/** Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication. */
objectReplicationPolicyId?: string;
/** Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed). */
objectReplicationRules?: { [propertyName: string]: string };
/** The number of bytes present in the response body. */
contentLength?: number;
/** The media type of the body of the response. For Download Blob this is 'application/octet-stream' */
contentType?: string;
/** Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header. */
contentRange?: string;
/** 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;
/** 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 returns the value that was specified for the Content-Encoding request header */
contentEncoding?: string;
/** This header is returned if it was previously specified for the blob. */
cacheControl?: string;
/** This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified. */
contentDisposition?: string;
/** This header returns the value that was specified for the Content-Language request header. */
contentLanguage?: string;
/** The current sequence number for a page blob. This header is not returned for block blobs or append blobs */
blobSequenceNumber?: number;
/** The blob's type. */
blobType?: BlobType;
/** Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. */
copyCompletedOn?: Date;
/** Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List */
copyStatusDescription?: string;
/** String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. */
copyId?: string;
/** Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List */
copyProgress?: string;
/** URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. */