BlobProperties Class

Definition

Properties of a Blob.

public class BlobProperties
type BlobProperties = class
Public Class BlobProperties
Inheritance
BlobProperties

Constructors

BlobProperties()

Constructor.

Properties

AcceptRanges

Indicates that the service supports requests for partial blob content.

AccessTier

The tier of page blob on a premium storage account or tier of block blob on blob storage LRS accounts. For a list of allowed premium page blob tiers, see https://docs.microsoft.com/azure/virtual-machines/windows/premium-storage#features. For general purpose v2 and blob storage account types, the valid values are:

  • Hot
  • Cool
  • Archive
AccessTierChangedOn

The time the tier was changed on the object. This is only returned if the tier on the block blob was ever set.

AccessTierInferred

For page blobs on a premium storage account only. If the access tier is not explicitly set on the blob, the tier is inferred based on its content length and this header will be returned with true value.

ArchiveStatus

For blob storage LRS accounts, valid values are rehydrate-pending-to-hot/rehydrate-pending-to-cool. If the blob is being rehydrated and is not complete then this header is returned indicating that rehydrate is pending and also tells the destination tier.

BlobCommittedBlockCount

The number of committed blocks present in the blob. This header is returned only for append blobs.

BlobCopyStatus

State of the most recent copy operation identified by x-ms-copy-id, if any.

BlobSequenceNumber

The current sequence number for a page blob. This header is not returned for block blobs or append blobs.

BlobType

The blob's type.

CacheControl

This header is returned if it was previously specified for the blob.

ContentDisposition

This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified.

ContentEncoding

This header returns the value that was specified for the Content-Encoding request header.

ContentHash

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.

ContentLanguage

This header returns the value that was specified for the Content-Language request header.

ContentLength

The number of bytes present in the response body.

ContentType

The content type specified for the blob. The default content type is 'application/octet-stream'.

CopyCompletedOn

Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

CopyId

String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy.

CopyProgress

Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

CopySource

URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

CopyStatusDescription

Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List

CreatedOn

Returns the date and time the blob was created.

DestinationSnapshot

Included if the blob is incremental copy blob or incremental copy snapshot, if x-ms-copy-status is success. Snapshot time of the last successful incremental copy snapshot for this blob.

EncryptionKeySha256

The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata 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.

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.

ExpiresOn

The time this blob will expire.

HasLegalHold

Indicates if the blob has a legal hold.

ImmutabilityPolicy

The BlobImmutabilityPolicy associated with the blob.

IsIncrementalCopy

Included if the blob is incremental copy blob.

IsLatestVersion

The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header.

IsSealed

If this blob has been sealed.

IsServerEncrypted

The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted).

LastAccessed

Returns the date and time the blob was read or written to.

LastModified

Returns the date and time the blob 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

Metadata.

ObjectReplicationDestinationPolicyId

Object Replication Policy Id of the destination blob.

ObjectReplicationSourceProperties

Parsed Object Replication Policy Id, Rule Id(s) and status of the source blob.

RehydratePriority

If this blob is in rehydrate pending state, this indicates the rehydrate priority.

TagCount

The number of tags associated with the blob.

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.

Applies to