/
BlobGetPropertiesResponse.yml
802 lines (802 loc) · 26.6 KB
/
BlobGetPropertiesResponse.yml
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
### YamlMime:TSType
name: BlobGetPropertiesResponse
uid: '@azure/storage-blob.BlobGetPropertiesResponse'
package: '@azure/storage-blob'
summary: 'Contains response data for the <xref:BlobClient.getProperties> operation.'
fullName: BlobGetPropertiesResponse
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: acceptRanges
uid: '@azure/storage-blob.BlobGetPropertiesResponse.acceptRanges'
package: '@azure/storage-blob'
summary: Indicates that the service supports requests for partial blob content.
fullName: acceptRanges
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'acceptRanges?: string'
return:
type: string
description: ''
- name: accessTier
uid: '@azure/storage-blob.BlobGetPropertiesResponse.accessTier'
package: '@azure/storage-blob'
summary: >-
The tier of page blob on a premium storage account or tier of block blob
on blob storage LRS accounts. For a list of allowed premium page blob
tiers, see
https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage#features.
For blob storage LRS accounts, valid values are Hot/Cool/Archive.
fullName: accessTier
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'accessTier?: string'
return:
type: string
description: ''
- name: accessTierChangedOn
uid: '@azure/storage-blob.BlobGetPropertiesResponse.accessTierChangedOn'
package: '@azure/storage-blob'
summary: >-
The time the tier was changed on the object. This is only returned if the
tier on the block blob was ever set.
fullName: accessTierChangedOn
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'accessTierChangedOn?: Date'
return:
type: Date
description: ''
- name: accessTierInferred
uid: '@azure/storage-blob.BlobGetPropertiesResponse.accessTierInferred'
package: '@azure/storage-blob'
summary: >-
For page blobs on a premium storage account only. If the access tier is
not explicitly set on the blob, the tier is inferred based on its content
length and this header will be returned with true value.
fullName: accessTierInferred
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'accessTierInferred?: boolean'
return:
type: boolean
description: ''
- name: archiveStatus
uid: '@azure/storage-blob.BlobGetPropertiesResponse.archiveStatus'
package: '@azure/storage-blob'
summary: >-
For blob storage LRS accounts, valid values are
rehydrate-pending-to-hot/rehydrate-pending-to-cool. If the blob is being
rehydrated and is not complete then this header is returned indicating
that rehydrate is pending and also tells the destination tier.
fullName: archiveStatus
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'archiveStatus?: string'
return:
type: string
description: ''
- name: blobCommittedBlockCount
uid: '@azure/storage-blob.BlobGetPropertiesResponse.blobCommittedBlockCount'
package: '@azure/storage-blob'
summary: >-
The number of committed blocks present in the blob. This header is
returned only for append blobs.
fullName: blobCommittedBlockCount
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'blobCommittedBlockCount?: number'
return:
type: number
description: ''
- name: blobSequenceNumber
uid: '@azure/storage-blob.BlobGetPropertiesResponse.blobSequenceNumber'
package: '@azure/storage-blob'
summary: >-
The current sequence number for a page blob. This header is not returned
for block blobs or append blobs
fullName: blobSequenceNumber
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'blobSequenceNumber?: number'
return:
type: number
description: ''
- name: blobType
uid: '@azure/storage-blob.BlobGetPropertiesResponse.blobType'
package: '@azure/storage-blob'
summary: The blob's type.
fullName: blobType
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'blobType?: BlobType'
return:
type: <xref uid="@azure/storage-blob.BlobType" />
description: ''
- name: cacheControl
uid: '@azure/storage-blob.BlobGetPropertiesResponse.cacheControl'
package: '@azure/storage-blob'
summary: This header is returned if it was previously specified for the blob.
fullName: cacheControl
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'cacheControl?: string'
return:
type: string
description: ''
- name: clientRequestId
uid: '@azure/storage-blob.BlobGetPropertiesResponse.clientRequestId'
package: '@azure/storage-blob'
summary: >-
If a client request id header is sent in the request, this header will be
present in the response with the same value.
fullName: clientRequestId
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'clientRequestId?: string'
return:
type: string
description: ''
- name: contentDisposition
uid: '@azure/storage-blob.BlobGetPropertiesResponse.contentDisposition'
package: '@azure/storage-blob'
summary: >-
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.
fullName: contentDisposition
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'contentDisposition?: string'
return:
type: string
description: ''
- name: contentEncoding
uid: '@azure/storage-blob.BlobGetPropertiesResponse.contentEncoding'
package: '@azure/storage-blob'
summary: >-
This header returns the value that was specified for the Content-Encoding
request header
fullName: contentEncoding
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'contentEncoding?: string'
return:
type: string
description: ''
- name: contentLanguage
uid: '@azure/storage-blob.BlobGetPropertiesResponse.contentLanguage'
package: '@azure/storage-blob'
summary: >-
This header returns the value that was specified for the Content-Language
request header.
fullName: contentLanguage
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'contentLanguage?: string'
return:
type: string
description: ''
- name: contentLength
uid: '@azure/storage-blob.BlobGetPropertiesResponse.contentLength'
package: '@azure/storage-blob'
summary: >-
The size of the blob in bytes. For a page blob, this header returns the
value of the x-ms-blob-content-length header that is stored with the blob.
fullName: contentLength
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'contentLength?: number'
return:
type: number
description: ''
- name: contentMD5
uid: '@azure/storage-blob.BlobGetPropertiesResponse.contentMD5'
package: '@azure/storage-blob'
summary: >-
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.
fullName: contentMD5
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'contentMD5?: Uint8Array'
return:
type: Uint8Array
description: ''
- name: contentType
uid: '@azure/storage-blob.BlobGetPropertiesResponse.contentType'
package: '@azure/storage-blob'
summary: >-
The content type specified for the blob. The default content type is
'application/octet-stream'
fullName: contentType
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'contentType?: string'
return:
type: string
description: ''
- name: copyCompletedOn
uid: '@azure/storage-blob.BlobGetPropertiesResponse.copyCompletedOn'
package: '@azure/storage-blob'
summary: >-
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.
fullName: copyCompletedOn
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'copyCompletedOn?: Date'
return:
type: Date
description: ''
- name: copyId
uid: '@azure/storage-blob.BlobGetPropertiesResponse.copyId'
package: '@azure/storage-blob'
summary: >-
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.
fullName: copyId
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'copyId?: string'
return:
type: string
description: ''
- name: copyProgress
uid: '@azure/storage-blob.BlobGetPropertiesResponse.copyProgress'
package: '@azure/storage-blob'
summary: >-
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
fullName: copyProgress
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'copyProgress?: string'
return:
type: string
description: ''
- name: copySource
uid: '@azure/storage-blob.BlobGetPropertiesResponse.copySource'
package: '@azure/storage-blob'
summary: >-
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.
fullName: copySource
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'copySource?: string'
return:
type: string
description: ''
- name: copyStatus
uid: '@azure/storage-blob.BlobGetPropertiesResponse.copyStatus'
package: '@azure/storage-blob'
summary: State of the copy operation identified by x-ms-copy-id.
fullName: copyStatus
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'copyStatus?: CopyStatusType'
return:
type: <xref uid="@azure/storage-blob.CopyStatusType" />
description: ''
- name: copyStatusDescription
uid: '@azure/storage-blob.BlobGetPropertiesResponse.copyStatusDescription'
package: '@azure/storage-blob'
summary: >-
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
fullName: copyStatusDescription
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'copyStatusDescription?: string'
return:
type: string
description: ''
- name: createdOn
uid: '@azure/storage-blob.BlobGetPropertiesResponse.createdOn'
package: '@azure/storage-blob'
summary: Returns the date and time the blob was created.
fullName: createdOn
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'createdOn?: Date'
return:
type: Date
description: ''
- name: date
uid: '@azure/storage-blob.BlobGetPropertiesResponse.date'
package: '@azure/storage-blob'
summary: >-
UTC date/time value generated by the service that indicates the time at
which the response was initiated
fullName: date
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'date?: Date'
return:
type: Date
description: ''
- name: destinationSnapshot
uid: '@azure/storage-blob.BlobGetPropertiesResponse.destinationSnapshot'
package: '@azure/storage-blob'
summary: >-
Included if the blob is incremental copy blob or incremental copy
snapshot, if x-ms-copy-status is success. Snapshot time of the last
successful incremental copy snapshot for this blob.
fullName: destinationSnapshot
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'destinationSnapshot?: string'
return:
type: string
description: ''
- name: encryptionKeySha256
uid: '@azure/storage-blob.BlobGetPropertiesResponse.encryptionKeySha256'
package: '@azure/storage-blob'
summary: >-
The SHA-256 hash of the encryption key used to encrypt the metadata. This
header is only returned when the metadata was encrypted with a
customer-provided key.
fullName: encryptionKeySha256
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'encryptionKeySha256?: string'
return:
type: string
description: ''
- name: encryptionScope
uid: '@azure/storage-blob.BlobGetPropertiesResponse.encryptionScope'
package: '@azure/storage-blob'
summary: >-
Returns the name of the encryption scope used to encrypt the blob contents
and application metadata. Note that the absence of this header implies
use of the default account encryption scope.
fullName: encryptionScope
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'encryptionScope?: string'
return:
type: string
description: ''
- name: errorCode
uid: '@azure/storage-blob.BlobGetPropertiesResponse.errorCode'
package: '@azure/storage-blob'
summary: Error Code
fullName: errorCode
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'errorCode?: string'
return:
type: string
description: ''
- name: etag
uid: '@azure/storage-blob.BlobGetPropertiesResponse.etag'
package: '@azure/storage-blob'
summary: >-
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.
fullName: etag
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'etag?: string'
return:
type: string
description: ''
- name: expiresOn
uid: '@azure/storage-blob.BlobGetPropertiesResponse.expiresOn'
package: '@azure/storage-blob'
summary: The time this blob will expire.
fullName: expiresOn
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'expiresOn?: Date'
return:
type: Date
description: ''
- name: immutabilityPolicyExpiresOn
uid: '@azure/storage-blob.BlobGetPropertiesResponse.immutabilityPolicyExpiresOn'
package: '@azure/storage-blob'
summary: >-
UTC date/time value generated by the service that indicates the time at
which the blob immutability policy will expire.
fullName: immutabilityPolicyExpiresOn
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'immutabilityPolicyExpiresOn?: Date'
return:
type: Date
description: ''
- name: immutabilityPolicyMode
uid: '@azure/storage-blob.BlobGetPropertiesResponse.immutabilityPolicyMode'
package: '@azure/storage-blob'
summary: Indicates immutability policy mode.
fullName: immutabilityPolicyMode
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'immutabilityPolicyMode?: BlobImmutabilityPolicyMode'
return:
type: <xref uid="@azure/storage-blob.BlobImmutabilityPolicyMode" />
description: ''
- name: isCurrentVersion
uid: '@azure/storage-blob.BlobGetPropertiesResponse.isCurrentVersion'
package: '@azure/storage-blob'
summary: >-
The value of this header indicates whether version of this blob is a
current version, see also x-ms-version-id header.
fullName: isCurrentVersion
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'isCurrentVersion?: boolean'
return:
type: boolean
description: ''
- name: isIncrementalCopy
uid: '@azure/storage-blob.BlobGetPropertiesResponse.isIncrementalCopy'
package: '@azure/storage-blob'
summary: Included if the blob is incremental copy blob.
fullName: isIncrementalCopy
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'isIncrementalCopy?: boolean'
return:
type: boolean
description: ''
- name: isSealed
uid: '@azure/storage-blob.BlobGetPropertiesResponse.isSealed'
package: '@azure/storage-blob'
summary: If this blob has been sealed
fullName: isSealed
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'isSealed?: boolean'
return:
type: boolean
description: ''
- name: isServerEncrypted
uid: '@azure/storage-blob.BlobGetPropertiesResponse.isServerEncrypted'
package: '@azure/storage-blob'
summary: >-
The value of this header is set to true if the blob data and application
metadata are completely encrypted using the specified algorithm.
Otherwise, the value is set to false (when the blob is unencrypted, or if
only parts of the blob/application metadata are encrypted).
fullName: isServerEncrypted
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'isServerEncrypted?: boolean'
return:
type: boolean
description: ''
- name: lastAccessed
uid: '@azure/storage-blob.BlobGetPropertiesResponse.lastAccessed'
package: '@azure/storage-blob'
summary: >-
UTC date/time value generated by the service that indicates the time at
which the blob was last read or written to
fullName: lastAccessed
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'lastAccessed?: Date'
return:
type: Date
description: ''
- name: lastModified
uid: '@azure/storage-blob.BlobGetPropertiesResponse.lastModified'
package: '@azure/storage-blob'
summary: >-
Returns the date and time the blob 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.
fullName: lastModified
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'lastModified?: Date'
return:
type: Date
description: ''
- name: leaseDuration
uid: '@azure/storage-blob.BlobGetPropertiesResponse.leaseDuration'
package: '@azure/storage-blob'
summary: >-
When a blob is leased, specifies whether the lease is of infinite or fixed
duration.
fullName: leaseDuration
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'leaseDuration?: LeaseDurationType'
return:
type: <xref uid="@azure/storage-blob.LeaseDurationType" />
description: ''
- name: leaseState
uid: '@azure/storage-blob.BlobGetPropertiesResponse.leaseState'
package: '@azure/storage-blob'
summary: Lease state of the blob.
fullName: leaseState
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'leaseState?: LeaseStateType'
return:
type: <xref uid="@azure/storage-blob.LeaseStateType" />
description: ''
- name: leaseStatus
uid: '@azure/storage-blob.BlobGetPropertiesResponse.leaseStatus'
package: '@azure/storage-blob'
summary: The current lease status of the blob.
fullName: leaseStatus
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'leaseStatus?: LeaseStatusType'
return:
type: <xref uid="@azure/storage-blob.LeaseStatusType" />
description: ''
- name: legalHold
uid: '@azure/storage-blob.BlobGetPropertiesResponse.legalHold'
package: '@azure/storage-blob'
summary: Indicates if a legal hold is present on the blob.
fullName: legalHold
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'legalHold?: boolean'
return:
type: boolean
description: ''
- name: metadata
uid: '@azure/storage-blob.BlobGetPropertiesResponse.metadata'
package: '@azure/storage-blob'
summary: ''
fullName: metadata
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'metadata?: [key: string]: string'
return:
type: '[key: string]\: string'
description: ''
- name: objectReplicationDestinationPolicyId
uid: >-
@azure/storage-blob.BlobGetPropertiesResponse.objectReplicationDestinationPolicyId
package: '@azure/storage-blob'
summary: Object Replication Policy Id of the destination blob.
fullName: objectReplicationDestinationPolicyId
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'objectReplicationDestinationPolicyId?: string'
return:
type: string
description: ''
- name: objectReplicationPolicyId
uid: '@azure/storage-blob.BlobGetPropertiesResponse.objectReplicationPolicyId'
package: '@azure/storage-blob'
summary: >-
Optional. Only valid when Object Replication is enabled for the storage
container and on the destination blob of the replication.
fullName: objectReplicationPolicyId
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'objectReplicationPolicyId?: string'
return:
type: string
description: ''
- name: objectReplicationRules
uid: '@azure/storage-blob.BlobGetPropertiesResponse.objectReplicationRules'
package: '@azure/storage-blob'
summary: >-
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).
fullName: objectReplicationRules
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'objectReplicationRules?: [key: string]: string'
return:
type: '[key: string]\: string'
description: ''
- name: objectReplicationSourceProperties
uid: >-
@azure/storage-blob.BlobGetPropertiesResponse.objectReplicationSourceProperties
package: '@azure/storage-blob'
summary: >-
Parsed Object Replication Policy Id, Rule Id(s) and status of the source
blob.
fullName: objectReplicationSourceProperties
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'objectReplicationSourceProperties?: ObjectReplicationPolicy[]'
return:
type: '<xref uid="@azure/storage-blob.ObjectReplicationPolicy" />[]'
description: ''
- name: rehydratePriority
uid: '@azure/storage-blob.BlobGetPropertiesResponse.rehydratePriority'
package: '@azure/storage-blob'
summary: >-
If an object is in rehydrate pending state then this header is returned
with priority of rehydrate.
fullName: rehydratePriority
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'rehydratePriority?: RehydratePriority'
return:
type: <xref uid="@azure/storage-blob.RehydratePriority" />
description: ''
- name: requestId
uid: '@azure/storage-blob.BlobGetPropertiesResponse.requestId'
package: '@azure/storage-blob'
summary: >-
This header uniquely identifies the request that was made and can be used
for troubleshooting the request.
fullName: requestId
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'requestId?: string'
return:
type: string
description: ''
- name: tagCount
uid: '@azure/storage-blob.BlobGetPropertiesResponse.tagCount'
package: '@azure/storage-blob'
summary: The number of tags associated with the blob
fullName: tagCount
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'tagCount?: number'
return:
type: number
description: ''
- name: version
uid: '@azure/storage-blob.BlobGetPropertiesResponse.version'
package: '@azure/storage-blob'
summary: >-
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.
fullName: version
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'version?: string'
return:
type: string
description: ''
- name: versionId
uid: '@azure/storage-blob.BlobGetPropertiesResponse.versionId'
package: '@azure/storage-blob'
summary: >-
A DateTime value returned by the service that uniquely identifies the
blob. The value of this header indicates the blob version, and may be used
in subsequent requests to access this version of the blob.
fullName: versionId
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'versionId?: string'
return:
type: string
description: ''
extends: <xref uid="@azure/storage-blob.BlobGetPropertiesHeaders" /> & Object