Share via


DataLakeServiceClient.GetUserDelegationKey Method

Definition

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

public virtual Azure.Response<Azure.Storage.Files.DataLake.Models.UserDelegationKey> GetUserDelegationKey(Azure.Storage.Files.DataLake.Models.DataLakeGetUserDelegationKeyOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member GetUserDelegationKey : Azure.Storage.Files.DataLake.Models.DataLakeGetUserDelegationKeyOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.DataLake.Models.UserDelegationKey>
override this.GetUserDelegationKey : Azure.Storage.Files.DataLake.Models.DataLakeGetUserDelegationKeyOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.DataLake.Models.UserDelegationKey>
Public Overridable Function GetUserDelegationKey (options As DataLakeGetUserDelegationKeyOptions, Optional cancellationToken As CancellationToken = Nothing) As 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