Share via


QueueServiceClient.GetUserDelegationKeyAsync Method

Definition

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

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

Parameters

options
QueueGetUserDelegationKeyOptions

Optional parameters.

cancellationToken
CancellationToken

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

Returns

A Response<T> describing the service replication statistics.

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