BlobGetPropertiesHeaders interface

Package:

@azure/storage-blob

Defines headers for 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.
accessTierChangeTime	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. Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'
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 number of bytes present in the response body.
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'
copyCompletionTime	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. Possible values include: 'pending', 'success', 'aborted', 'failed'
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
creationTime	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.
errorCode
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.
isIncrementalCopy	Included if the blob is incremental copy blob.
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).
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. Possible values include: 'infinite', 'fixed'
leaseState	Lease state of the blob. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'
leaseStatus	The current lease status of the blob. Possible values include: 'locked', 'unlocked'
metadata
requestId	This header uniquely identifies the request that was made and can be used for troubleshooting the request.
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.

Property Details

acceptRanges

Indicates that the service supports requests for partial blob content.

acceptRanges?: undefined | string

Property Value

undefined | 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?: undefined | string

Property Value

undefined | string

accessTierChangeTime

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

accessTierChangeTime?: 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?: undefined | false | true

Property Value

undefined | false | true

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?: undefined | string

Property Value

undefined | string

blobCommittedBlockCount

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

blobCommittedBlockCount?: undefined | number

Property Value

undefined | number

blobSequenceNumber

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

blobSequenceNumber?: undefined | number

Property Value

undefined | number

blobType

The blob's type. Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'

blobType?: BlobType

Property Value

BlobType

cacheControl

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

cacheControl?: undefined | string

Property Value

undefined | 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?: undefined | string

Property Value

undefined | 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?: undefined | string

Property Value

undefined | string

contentEncoding

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

contentEncoding?: undefined | string

Property Value

undefined | string

contentLanguage

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

contentLanguage?: undefined | string

Property Value

undefined | string

contentLength

The number of bytes present in the response body.

contentLength?: undefined | number

Property Value

undefined | 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?: undefined | string

Property Value

undefined | string

copyCompletionTime

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.

copyCompletionTime?: 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?: undefined | string

Property Value

undefined | 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?: undefined | string

Property Value

undefined | 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?: undefined | string

Property Value

undefined | string

copyStatus

State of the copy operation identified by x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted', 'failed'

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?: undefined | string

Property Value

undefined | string

creationTime

Returns the date and time the blob was created.

creationTime?: 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?: undefined | string

Property Value

undefined | 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?: undefined | string

Property Value

undefined | string

errorCode

errorCode?: undefined | string

Property Value

undefined | 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?: undefined | string

Property Value

undefined | string

isIncrementalCopy

Included if the blob is incremental copy blob.

isIncrementalCopy?: undefined | false | true

Property Value

undefined | false | true

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?: undefined | false | true

Property Value

undefined | false | true

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. Possible values include: 'infinite', 'fixed'

leaseDuration?: LeaseDurationType

Property Value

LeaseDurationType

leaseState

Lease state of the blob. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'

leaseState?: LeaseStateType

Property Value

LeaseStateType

leaseStatus

The current lease status of the blob. Possible values include: 'locked', 'unlocked'

leaseStatus?: LeaseStatusType

Property Value

LeaseStatusType

metadata

metadata?: undefined | [key: string]: string

Property Value

undefined | [key: string]: string

requestId

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

requestId?: undefined | string

Property Value

undefined | string

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?: undefined | string

Property Value

undefined | string