BlobGetPropertiesHeaders interface

Package:

@azure/storage-blob

Defines headers for Blob_getProperties operation.

Properties

acceptRanges	Indicates that the service supports requests for partial blob content.
accessTier	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.
accessTierChangedOn	The time the tier was changed on the object. This is only returned if the tier on the block blob was ever set.
accessTierInferred	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.
archiveStatus	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.
blobCommittedBlockCount	The number of committed blocks present in the blob. This header is returned only for append blobs.
blobSequenceNumber	The current sequence number for a page blob. This header is not returned for block blobs or append blobs
blobType	The blob's type.
cacheControl	This header is returned if it was previously specified for the blob.
clientRequestId	If a client request id header is sent in the request, this header will be present in the response with the same value.
contentDisposition	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.
contentEncoding	This header returns the value that was specified for the Content-Encoding request header
contentLanguage	This header returns the value that was specified for the Content-Language request header.
contentLength	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.
contentMD5	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.
contentType	The content type specified for the blob. The default content type is 'application/octet-stream'
copyCompletedOn	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.
copyId	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.
copyProgress	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
copySource	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.
copyStatus	State of the copy operation identified by x-ms-copy-id.
copyStatusDescription	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
createdOn	Returns the date and time the blob was created.
date	UTC date/time value generated by the service that indicates the time at which the response was initiated
destinationSnapshot	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.
encryptionKeySha256	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.
encryptionScope	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.
errorCode	Error Code
etag	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.
expiresOn	The time this blob will expire.
immutabilityPolicyExpiresOn	UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire.
immutabilityPolicyMode	Indicates immutability policy mode.
isCurrentVersion	The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header.
isIncrementalCopy	Included if the blob is incremental copy blob.
isSealed	If this blob has been sealed
isServerEncrypted	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).
lastAccessed	UTC date/time value generated by the service that indicates the time at which the blob was last read or written to
lastModified	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.
leaseDuration	When a blob is leased, specifies whether the lease is of infinite or fixed duration.
leaseState	Lease state of the blob.
leaseStatus	The current lease status of the blob.
legalHold	Indicates if a legal hold is present on the blob.
metadata
objectReplicationPolicyId	Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication.
objectReplicationRules	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).
rehydratePriority	If an object is in rehydrate pending state then this header is returned with priority of rehydrate.
requestId	This header uniquely identifies the request that was made and can be used for troubleshooting the request.
tagCount	The number of tags associated with the blob
version	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.
versionId	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.

Property Details

acceptRanges

Indicates that the service supports requests for partial blob content.

acceptRanges?: string

Property Value

string

accessTier

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.

accessTier?: string

Property Value

string

accessTierChangedOn

The time the tier was changed on the object. This is only returned if the tier on the block blob was ever set.

accessTierChangedOn?: Date

Property Value

Date

accessTierInferred

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.

accessTierInferred?: boolean

Property Value

boolean

archiveStatus

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.

archiveStatus?: string

Property Value

string

blobCommittedBlockCount

The number of committed blocks present in the blob. This header is returned only for append blobs.

blobCommittedBlockCount?: number

Property Value

number

blobSequenceNumber

The current sequence number for a page blob. This header is not returned for block blobs or append blobs

blobSequenceNumber?: number

Property Value

number

blobType

The blob's type.

blobType?: BlobType

Property Value

BlobType

cacheControl

This header is returned if it was previously specified for the blob.

cacheControl?: string

Property Value

string

clientRequestId

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

Property Value

string

contentDisposition

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

Property Value

string

contentEncoding

This header returns the value that was specified for the Content-Encoding request header

contentEncoding?: string

Property Value

string

contentLanguage

This header returns the value that was specified for the Content-Language request header.

contentLanguage?: string

Property Value

string

contentLength

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.

contentLength?: number

Property Value

number

contentMD5

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

Property Value

Uint8Array

contentType

The content type specified for the blob. The default content type is 'application/octet-stream'

contentType?: string

Property Value

string

copyCompletedOn

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

Property Value

Date

copyId

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

Property Value

string

copyProgress

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

Property Value

string

copySource

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.

copySource?: string

Property Value

string

copyStatus

State of the copy operation identified by x-ms-copy-id.

copyStatus?: CopyStatusType

Property Value

CopyStatusType

copyStatusDescription

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

Property Value

string

createdOn

Returns the date and time the blob was created.

createdOn?: Date

Property Value

Date

date

UTC date/time value generated by the service that indicates the time at which the response was initiated

date?: Date

Property Value

Date

destinationSnapshot

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.

destinationSnapshot?: string

Property Value

string

encryptionKeySha256

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.

encryptionKeySha256?: string

Property Value

string

encryptionScope

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.

encryptionScope?: string

Property Value

string

errorCode

Error Code

errorCode?: string

Property Value

string

etag

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

Property Value

string

expiresOn

The time this blob will expire.

expiresOn?: Date

Property Value

Date

immutabilityPolicyExpiresOn

UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire.

immutabilityPolicyExpiresOn?: Date

Property Value

Date

immutabilityPolicyMode

Indicates immutability policy mode.

immutabilityPolicyMode?: BlobImmutabilityPolicyMode

Property Value

BlobImmutabilityPolicyMode

isCurrentVersion

The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header.

isCurrentVersion?: boolean

Property Value

boolean

isIncrementalCopy

Included if the blob is incremental copy blob.

isIncrementalCopy?: boolean

Property Value

boolean

isSealed

If this blob has been sealed

isSealed?: boolean

Property Value

boolean

isServerEncrypted

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).

isServerEncrypted?: boolean

Property Value

boolean

lastAccessed

UTC date/time value generated by the service that indicates the time at which the blob was last read or written to

lastAccessed?: Date

Property Value

Date

lastModified

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.

lastModified?: Date

Property Value

Date

leaseDuration

When a blob is leased, specifies whether the lease is of infinite or fixed duration.

leaseDuration?: LeaseDurationType

Property Value

LeaseDurationType

leaseState

Lease state of the blob.

leaseState?: LeaseStateType

Property Value

LeaseStateType

leaseStatus

The current lease status of the blob.

leaseStatus?: LeaseStatusType

Property Value

LeaseStatusType

legalHold

Indicates if a legal hold is present on the blob.

legalHold?: boolean

Property Value

boolean

metadata

metadata?: [key: string]: string

Property Value

[key: string]: string

objectReplicationPolicyId

Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication.

objectReplicationPolicyId?: string

Property Value

string

objectReplicationRules

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?: [key: string]: string

Property Value

[key: string]: string

rehydratePriority

If an object is in rehydrate pending state then this header is returned with priority of rehydrate.

rehydratePriority?: RehydratePriority

Property Value

RehydratePriority

requestId

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

requestId?: string

Property Value

string

tagCount

The number of tags associated with the blob

tagCount?: number

Property Value

number

version

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

Property Value

string

versionId

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.

versionId?: string

Property Value

string