Class BlobProperties

Properties of a Blob.

Inheritance

System.Object

BlobProperties

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.Storage.Blobs.dll

Syntax

public class BlobProperties

Constructors

BlobProperties()

Constructor.

Declaration

public BlobProperties ();

Properties

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 . For general purpose v2 and blob storage account types, the valid values are:

Hot
Cool
Archive

Declaration

public string AccessTier { get; }

Property Value

System.String

AccessTierChangedOn

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

Declaration

public DateTimeOffset AccessTierChangedOn { get; }

Property Value

System.DateTimeOffset

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.

Declaration

public bool AccessTierInferred { get; }

Property Value

System.Boolean

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.

Declaration

public string ArchiveStatus { get; }

Property Value

System.String

BlobCommittedBlockCount

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

Declaration

public int BlobCommittedBlockCount { get; }

Property Value

System.Int32

BlobCopyStatus

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

Declaration

public Nullable<Azure.Storage.Blobs.Models.CopyStatus> BlobCopyStatus { get; }

Property Value

System.Nullable<CopyStatus>

BlobSequenceNumber

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

Declaration

public long BlobSequenceNumber { get; }

Property Value

System.Int64

BlobType

The blob's type.

Declaration

public Azure.Storage.Blobs.Models.BlobType BlobType { get; }

Property Value

BlobType

CacheControl

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

Declaration

public string CacheControl { get; }

Property Value

System.String

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.

Declaration

public string ContentDisposition { get; }

Property Value

System.String

ContentEncoding

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

Declaration

public string ContentEncoding { get; }

Property Value

System.String

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.

Declaration

public byte[] ContentHash { get; }

Property Value

System.Byte[]

ContentLanguage

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

Declaration

public string ContentLanguage { get; }

Property Value

System.String

ContentLength

The number of bytes present in the response body.

Declaration

public long ContentLength { get; }

Property Value

System.Int64

ContentType

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

Declaration

public string ContentType { get; }

Property Value

System.String

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.

Declaration

public DateTimeOffset CopyCompletedOn { get; }

Property Value

System.DateTimeOffset

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.

Declaration

public string CopyId { get; }

Property Value

System.String

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.

Declaration

public string CopyProgress { get; }

Property Value

System.String

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.

Declaration

public Uri CopySource { get; }

Property Value

System.Uri

CopyStatus

Legacy facade for BlobCopyStatus. State of the copy operation identified by x-ms-copy-id.

Declaration

[System.ComponentModel.EditorBrowsable]
public Azure.Storage.Blobs.Models.CopyStatus CopyStatus { get; }

Property Value

CopyStatus

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

Declaration

public string CopyStatusDescription { get; }

Property Value

System.String

CreatedOn

Returns the date and time the blob was created.

Declaration

public DateTimeOffset CreatedOn { get; }

Property Value

System.DateTimeOffset

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.

Declaration

public string DestinationSnapshot { get; }

Property Value

System.String

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.

Declaration

public string EncryptionKeySha256 { get; }

Property Value

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

Declaration

public string EncryptionScope { get; }

Property Value

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

Declaration

public Azure.ETag ETag { get; }

Property Value

Azure.ETag

ExpiresOn

The time this blob will expire.

Declaration

public DateTimeOffset ExpiresOn { get; }

Property Value

System.DateTimeOffset

HasLegalHold

Indicates if the blob has a legal hold.

Declaration

public bool HasLegalHold { get; }

Property Value

System.Boolean

ImmutabilityPolicy

The BlobImmutabilityPolicy associated with the blob.

Declaration

public Azure.Storage.Blobs.Models.BlobImmutabilityPolicy ImmutabilityPolicy { get; }

Property Value

BlobImmutabilityPolicy

IsIncrementalCopy

Included if the blob is incremental copy blob.

Declaration

public bool IsIncrementalCopy { get; }

Property Value

System.Boolean

IsLatestVersion

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

Declaration

public bool IsLatestVersion { get; }

Property Value

System.Boolean

IsSealed

If this blob has been sealed.

Declaration

public bool IsSealed { get; }

Property Value

System.Boolean

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

Declaration

public bool IsServerEncrypted { get; }

Property Value

System.Boolean

LastAccessed

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

Declaration

public DateTimeOffset LastAccessed { get; }

Property Value

System.DateTimeOffset

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.

Declaration

public DateTimeOffset LastModified { get; }

Property Value

System.DateTimeOffset

LeaseDuration

When a blob is leased, specifies whether the lease is of infinite or fixed duration.

Declaration

public Azure.Storage.Blobs.Models.LeaseDurationType LeaseDuration { get; }

Property Value

LeaseDurationType

LeaseState

Lease state of the blob.

Declaration

public Azure.Storage.Blobs.Models.LeaseState LeaseState { get; }

Property Value

LeaseState

LeaseStatus

The current lease status of the blob.

Declaration

public Azure.Storage.Blobs.Models.LeaseStatus LeaseStatus { get; }

Property Value

LeaseStatus

Metadata

Metadata.

Declaration

public System.Collections.Generic.IDictionary<string,string> Metadata { get; }

Property Value

System.Collections.Generic.IDictionary<System.String,System.String>

ObjectReplicationDestinationPolicyId

Object Replication Policy Id of the destination blob.

Declaration

public string ObjectReplicationDestinationPolicyId { get; }

Property Value

System.String

ObjectReplicationSourceProperties

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

Declaration

public System.Collections.Generic.IList<Azure.Storage.Blobs.Models.ObjectReplicationPolicy> ObjectReplicationSourceProperties { get; }

Property Value

System.Collections.Generic.IList<ObjectReplicationPolicy>

RehydratePriority

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

Declaration

public string RehydratePriority { get; }

Property Value

System.String

TagCount

The number of tags associated with the blob.

Declaration

public long TagCount { get; }

Property Value

System.Int64

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.

Declaration

public string VersionId { get; }

Property Value

System.String