Share via


DataLakeServiceClient.GetUserDelegationKeyAsync Method

Definition

The GetUserDelegationKeyAsync(DataLakeGetUserDelegationKeyOptions, CancellationToken) operation retrieves a key that can be used to delegate Active Directory authorization to shared access signatures created with DataLakeSasBuilder.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.UserDelegationKey>> GetUserDelegationKeyAsync(Azure.Storage.Files.DataLake.Models.DataLakeGetUserDelegationKeyOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member GetUserDelegationKeyAsync : Azure.Storage.Files.DataLake.Models.DataLakeGetUserDelegationKeyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.UserDelegationKey>>
override this.GetUserDelegationKeyAsync : Azure.Storage.Files.DataLake.Models.DataLakeGetUserDelegationKeyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.UserDelegationKey>>
Public Overridable Function GetUserDelegationKeyAsync (options As DataLakeGetUserDelegationKeyOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of UserDelegationKey))

Parameters

options
DataLakeGetUserDelegationKeyOptions

Optional parameters.

cancellationToken
CancellationToken

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

Returns

A Response<T> describing the use delegation key.

Remarks

A RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an AggregateException will be thrown, containing each failure instance.

Applies to