BlobBaseClient.SetAccessTierAsync Method

Reference

Definition

Namespace:: Azure.Storage.Blobs.Specialized

Assembly:: Azure.Storage.Blobs.dll

Package:: Azure.Storage.Blobs v12.22.2

Package:: Azure.Storage.Blobs v12.23.0-beta.2

Source:: BlobBaseClient.cs

Source:: BlobBaseClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The SetAccessTierAsync(AccessTier, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken) operation sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage or general purpose v2 account.

A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. For detailed information about block blob level tiering Blob Storage Tiers.

For more information about setting the tier, see Blob Storage Tiers.

public virtual System.Threading.Tasks.Task<Azure.Response> SetAccessTierAsync (Azure.Storage.Blobs.Models.AccessTier accessTier, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = default, Azure.Storage.Blobs.Models.RehydratePriority? rehydratePriority = default, System.Threading.CancellationToken cancellationToken = default);

abstract member SetAccessTierAsync : Azure.Storage.Blobs.Models.AccessTier * Azure.Storage.Blobs.Models.BlobRequestConditions * Nullable<Azure.Storage.Blobs.Models.RehydratePriority> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.SetAccessTierAsync : Azure.Storage.Blobs.Models.AccessTier * Azure.Storage.Blobs.Models.BlobRequestConditions * Nullable<Azure.Storage.Blobs.Models.RehydratePriority> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function SetAccessTierAsync (accessTier As AccessTier, Optional conditions As BlobRequestConditions = Nothing, Optional rehydratePriority As Nullable(Of RehydratePriority) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

accessTier: AccessTier

Indicates the tier to be set on the blob.

conditions: BlobRequestConditions

Optional BlobRequestConditions to add conditions on setting the access tier.

rehydratePriority: Nullable<RehydratePriority>

Optional RehydratePriority Indicates the priority with which to rehydrate an archived blob.

cancellationToken: CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Task<Response>

A Response on successfully setting the tier.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to

Share via