ShareDirectoryClient.SetMetadataAsync Method

Reference

Definition

Namespace:: Azure.Storage.Files.Shares

Assembly:: Azure.Storage.Files.Shares.dll

Package:: Azure.Storage.Files.Shares v12.17.1

Package:: Azure.Storage.Files.Shares v12.18.0-beta.2

Source:: ShareDirectoryClient.cs

Source:: ShareDirectoryClient.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>, CancellationToken) operation sets one or more user-defined name-value pairs for the specified directory.

For more information, see Set Directory Metadata.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareDirectoryInfo>> SetMetadataAsync (System.Collections.Generic.IDictionary<string,string> metadata, System.Threading.CancellationToken cancellationToken = default);

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

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

Parameters

metadata: IDictionary<String,String>

Custom metadata to set for this directory.

cancellationToken: CancellationToken

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

Returns

Task<Response<ShareDirectoryInfo>>

A Response<T> if successful.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to