BlobContainerClient.SetMetadataAsync Method

Reference

Definition

Namespace:: Azure.Storage.Blobs

Assembly:: Azure.Storage.Blobs.dll

Package:: Azure.Storage.Blobs v12.19.1

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

Source:: BlobContainerClient.cs

Source:: BlobContainerClient.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 SetMetadataAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken) operation sets one or more user-defined name-value pairs for the specified container.

For more information, see Set Container Metadata.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo>> SetMetadataAsync (System.Collections.Generic.IDictionary<string,string> metadata, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member SetMetadataAsync : System.Collections.Generic.IDictionary<string, string> * Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo>>
override this.SetMetadataAsync : System.Collections.Generic.IDictionary<string, string> * Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo>>

Public Overridable Function SetMetadataAsync (metadata As IDictionary(Of String, String), Optional conditions As BlobRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of BlobContainerInfo))

Parameters

metadata: IDictionary<String,String>

Custom metadata to set for this container.

conditions: BlobRequestConditions

Optional BlobRequestConditions to add conditions on the deletion of this container.

cancellationToken: CancellationToken

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

Returns

Task<Response<BlobContainerInfo>>

A Response<T> if successful.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to