ContainerGetPropertiesHeaders interface

Package:

@azure/storage-blob

Defines headers for Container_getProperties operation.

Properties

blobPublicAccess	Indicated whether data in the container may be accessed publicly and the level of access
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
defaultEncryptionScope	The default encryption scope for the container.
denyEncryptionScopeOverride	Indicates whether the container's default encryption scope can be overriden.
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.
hasImmutabilityPolicy	Indicates whether the container has an immutability policy set on it.
hasLegalHold	Indicates whether the container has a legal hold.
isImmutableStorageWithVersioningEnabled	Indicates whether version level worm is enabled on a container.
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.
leaseState	Lease state of the blob.
leaseStatus	The current lease status of the blob.
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

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

Property Value

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

defaultEncryptionScope

The default encryption scope for the container.

defaultEncryptionScope?: string

Property Value

string

denyEncryptionScopeOverride

Indicates whether the container's default encryption scope can be overriden.

denyEncryptionScopeOverride?: boolean

Property Value

boolean

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

hasImmutabilityPolicy

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

hasImmutabilityPolicy?: boolean

Property Value

boolean

hasLegalHold

Indicates whether the container has a legal hold.

hasLegalHold?: boolean

Property Value

boolean

isImmutableStorageWithVersioningEnabled

Indicates whether version level worm is enabled on a container.

isImmutableStorageWithVersioningEnabled?: boolean

Property Value

boolean

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.

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

metadata

metadata?: [key: string]: string

Property Value

[key: string]: string

requestId

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

requestId?: string

Property Value

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

Property Value

string