DataLakeFileClient.SetMetadata Method

Reference

Definition

Namespace:: Azure.Storage.Files.DataLake

Assembly:: Azure.Storage.Files.DataLake.dll

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

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

Source:: DataLakeFileClient.cs

Source:: DataLakeFileClient.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 SetMetadata(IDictionary<String,String>, DataLakeRequestConditions, CancellationToken) operation sets user-defined metadata for the specified path as one or more name-value pairs.

For more information, see Set Metadata.

public override Azure.Response<Azure.Storage.Files.DataLake.Models.PathInfo> SetMetadata (System.Collections.Generic.IDictionary<string,string> metadata, Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

override this.SetMetadata : System.Collections.Generic.IDictionary<string, string> * Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.DataLake.Models.PathInfo>

Public Overrides Function SetMetadata (metadata As IDictionary(Of String, String), Optional conditions As DataLakeRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of PathInfo)

Parameters

metadata: IDictionary<String,String>

Custom metadata to set for this path.

conditions: DataLakeRequestConditions

Optional DataLakeRequestConditions to add conditions on setting the path's metadata.

cancellationToken: CancellationToken

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

Returns

Response<PathInfo>

A Response<T> describing the updated path.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to