BlobServiceClient.GetUserDelegationKeyAsync Method

Reference

Definition

Namespace:: Azure.Storage.Blobs

Assembly:: Azure.Storage.Blobs.dll

Package:: Azure.Storage.Blobs v12.19.1

Package:: Azure.Storage.Blobs v12.20.0-beta.2

Source:: BlobServiceClient.cs

Source:: BlobServiceClient.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 GetUserDelegationKeyAsync(Nullable<DateTimeOffset>, DateTimeOffset, CancellationToken) operation retrieves a key that can be used to delegate Active Directory authorization to shared access signatures created with BlobSasBuilder.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.UserDelegationKey>> GetUserDelegationKeyAsync (DateTimeOffset? startsOn, DateTimeOffset expiresOn, System.Threading.CancellationToken cancellationToken = default);

abstract member GetUserDelegationKeyAsync : Nullable<DateTimeOffset> * DateTimeOffset * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.UserDelegationKey>>
override this.GetUserDelegationKeyAsync : Nullable<DateTimeOffset> * DateTimeOffset * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.UserDelegationKey>>

Public Overridable Function GetUserDelegationKeyAsync (startsOn As Nullable(Of DateTimeOffset), expiresOn As DateTimeOffset, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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

Task<Response<UserDelegationKey>>

A Response<T> describing the service replication statistics.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to