ContainerGetPropertiesHeaders interface

Package:

@azure/storage-blob

Defines headers for GetProperties operation.

Properties

blobPublicAccess	Indicated whether data in the container may be accessed publicly and the level of access. Possible values include: 'container', '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.
date	UTC date/time value generated by the service that indicates the time at which the response was initiated
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.
hasImmutabilityPolicy	Indicates whether the container has an immutability policy set on it.
hasLegalHold	Indicates whether the container has a legal hold.
lastModified	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.
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

blobPublicAccess

Indicated whether data in the container may be accessed publicly and the level of access. Possible values include: 'container', 'blob'

blobPublicAccess?: PublicAccessType

Property Value

PublicAccessType

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

date

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

date?: Date

Property Value

Date

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

hasImmutabilityPolicy

Indicates whether the container has an immutability policy set on it.

hasImmutabilityPolicy?: undefined | false | true

Property Value

undefined | false | true

hasLegalHold

Indicates whether the container has a legal hold.

hasLegalHold?: undefined | false | true

Property Value

undefined | false | true

lastModified

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

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