BlobServiceClient.GetUserDelegationKey Method
Definition
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 GetUserDelegationKey(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 Azure.Response<Azure.Storage.Blobs.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.Blobs.Models.UserDelegationKey>
override this.GetUserDelegationKey : Nullable<DateTimeOffset> * DateTimeOffset * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Blobs.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.
Note: If you set the start time to the current time, failures might occur intermittently for the first few minutes. This is due to different machines having slightly different current times (known as clock skew).
- 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
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.
