ShareDirectoryClient.SetMetadata Method

Definition

The SetMetadata(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 Azure.Response<Azure.Storage.Files.Shares.Models.ShareDirectoryInfo> SetMetadata (System.Collections.Generic.IDictionary<string,string> metadata, System.Threading.CancellationToken cancellationToken = default);
abstract member SetMetadata : System.Collections.Generic.IDictionary<string, string> * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.Shares.Models.ShareDirectoryInfo>
override this.SetMetadata : System.Collections.Generic.IDictionary<string, string> * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.Shares.Models.ShareDirectoryInfo>
Public Overridable Function SetMetadata (metadata As IDictionary(Of String, String), Optional cancellationToken As CancellationToken = Nothing) As 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

A Response<T> if successful.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to