ContainerGetPropertiesHeaders interface
Defines headers for GetProperties operation.
Properties
blob |
Indicated whether data in the container may be accessed publicly and the level of access. Possible values include: 'container', 'blob' |
client |
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 |
error |
|
e |
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. |
has |
Indicates whether the container has an immutability policy set on it. |
has |
Indicates whether the container has a legal hold. |
last |
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. |
lease |
When a blob is leased, specifies whether the lease is of infinite or fixed duration. Possible values include: 'infinite', 'fixed' |
lease |
Lease state of the blob. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken' |
lease |
The current lease status of the blob. Possible values include: 'locked', 'unlocked' |
metadata | |
request |
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
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
errorCode
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
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
leaseState
Lease state of the blob. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'
leaseState?: LeaseStateType
Property Value
leaseStatus
The current lease status of the blob. Possible values include: 'locked', 'unlocked'
leaseStatus?: LeaseStatusType
Property Value
metadata
metadata?: {[propertyName: string]: string}
Property Value
{[propertyName: 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
Azure SDK for JavaScript
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for