Share via

PageBlobCreateIfNotExistsResponse interface

  • Reference
Package:
@azure/storage-blob

Contains response data for the <xref:PageBlobClient.createIfNotExists> operation.

Extends

PageBlobCreateHeaders & Object

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

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

The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key.
encryptionScope

Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope.
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

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.
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.
succeeded

Indicate whether the blob is successfully created. Is false when the blob is not changed as it already exists.
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

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

date

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

date?: Date

Property Value

Date

encryptionKeySha256

The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key.

encryptionKeySha256?: string

Property Value

string

encryptionScope

Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope.

encryptionScope?: string

Property Value

string

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

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

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

succeeded

Indicate whether the blob is successfully created. Is false when the blob is not changed as it already exists.

succeeded: boolean

Property Value

boolean

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