DataLakeServiceClient.GetUserDelegationKey Method

Definition

Namespace:

Azure.Storage.Files.DataLake

Assembly:

Azure.Storage.Files.DataLake.dll

Package:

Azure.Storage.Files.DataLake v12.20.1

Source:

DataLakeServiceClient.cs

The GetUserDelegationKey(Nullable<DateTimeOffset>, DateTimeOffset, 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 (DateTimeOffset? startsOn, DateTimeOffset expiresOn, System.Threading.CancellationToken cancellationToken = default);

abstract member GetUserDelegationKey : Nullable<DateTimeOffset> * DateTimeOffset * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.DataLake.Models.UserDelegationKey>
override this.GetUserDelegationKey : Nullable<DateTimeOffset> * DateTimeOffset * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.DataLake.Models.UserDelegationKey>

Public Overridable Function GetUserDelegationKey (startsOn As Nullable(Of DateTimeOffset), expiresOn As DateTimeOffset, Optional cancellationToken As CancellationToken = Nothing) As Response(Of UserDelegationKey)

Parameters

startsOn

Nullable<DateTimeOffset>

Start time for the key's validity, with null indicating an immediate start. The time should be specified in UTC.

expiresOn

DateTimeOffset

Expiration of the key's validity. The time should be specified in UTC.

cancellationToken

CancellationToken

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

Returns

Response<UserDelegationKey>

A Response<T> describing the use delegation key.

Remarks

A RequestFailedException will be thrown if a failure occurs.