Share via

BlobCreateSnapshotHeaders interface

  • Reference
Package:
@azure/storage-blob

Defines headers for Blob_createSnapshot operation.

Properties

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

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

True if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. For a snapshot request, this header is set to true when metadata was provided in the request and encrypted with a customer-provided key.
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.
requestId

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

Uniquely identifies the snapshot and indicates the snapshot version. It may be used in subsequent requests to access the snapshot
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

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

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

isServerEncrypted

True if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. For a snapshot request, this header is set to true when metadata was provided in the request and encrypted with a customer-provided key.

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

requestId

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

requestId?: string

Property Value

string

snapshot

Uniquely identifies the snapshot and indicates the snapshot version. It may be used in subsequent requests to access the snapshot

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

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