QueueClient.GenerateUserDelegationSasUri 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.
Overloads
| Name | Description |
|---|---|
| GenerateUserDelegationSasUri(QueueSasBuilder, UserDelegationKey) |
The GenerateUserDelegationSasUri(QueueSasBuilder, UserDelegationKey) returns a Uri representing a Queue Service Shared Access Signature (SAS) Uri based on the Client properties and builder passed. The SAS is signed by the user delegation key that is passed in. For more information, see Creating an user delegation SAS. |
| GenerateUserDelegationSasUri(QueueSasPermissions, DateTimeOffset, UserDelegationKey) |
The GenerateUserDelegationSasUri(QueueSasPermissions, DateTimeOffset, UserDelegationKey) returns a Uri representing a Queue Service Shared Access Signature (SAS) Uri based on the Client properties and parameters passed. The SAS is signed by the user delegation key that is passed in. For more information, see Creating an user delegation SAS. |
GenerateUserDelegationSasUri(QueueSasBuilder, UserDelegationKey)
- Source:
- QueueClient.cs
The GenerateUserDelegationSasUri(QueueSasBuilder, UserDelegationKey) returns a Uri representing a Queue Service Shared Access Signature (SAS) Uri based on the Client properties and builder passed. The SAS is signed by the user delegation key that is passed in.
For more information, see Creating an user delegation SAS.
public virtual Uri GenerateUserDelegationSasUri(Azure.Storage.Sas.QueueSasBuilder builder, Azure.Storage.Queues.Models.UserDelegationKey userDelegationKey);abstract member GenerateUserDelegationSasUri : Azure.Storage.Sas.QueueSasBuilder * Azure.Storage.Queues.Models.UserDelegationKey -> Uri
override this.GenerateUserDelegationSasUri : Azure.Storage.Sas.QueueSasBuilder * Azure.Storage.Queues.Models.UserDelegationKey -> UriPublic Overridable Function GenerateUserDelegationSasUri (builder As QueueSasBuilder, userDelegationKey As UserDelegationKey) As UriParameters
- builder
- QueueSasBuilder
Required. Used to generate a Shared Access Signature (SAS).
- userDelegationKey
- UserDelegationKey
Required. A UserDelegationKey returned from GetUserDelegationKeyAsync(Nullable<DateTimeOffset>, DateTimeOffset, CancellationToken).
Returns
A Uri containing the SAS Uri.
Remarks
A Exception will be thrown if a failure occurs.
Applies to
GenerateUserDelegationSasUri(QueueSasPermissions, DateTimeOffset, UserDelegationKey)
- Source:
- QueueClient.cs
The GenerateUserDelegationSasUri(QueueSasPermissions, DateTimeOffset, UserDelegationKey) returns a Uri representing a Queue Service Shared Access Signature (SAS) Uri based on the Client properties and parameters passed. The SAS is signed by the user delegation key that is passed in.
For more information, see Creating an user delegation SAS.
public virtual Uri GenerateUserDelegationSasUri(Azure.Storage.Sas.QueueSasPermissions permissions, DateTimeOffset expiresOn, Azure.Storage.Queues.Models.UserDelegationKey userDelegationKey);abstract member GenerateUserDelegationSasUri : Azure.Storage.Sas.QueueSasPermissions * DateTimeOffset * Azure.Storage.Queues.Models.UserDelegationKey -> Uri
override this.GenerateUserDelegationSasUri : Azure.Storage.Sas.QueueSasPermissions * DateTimeOffset * Azure.Storage.Queues.Models.UserDelegationKey -> UriPublic Overridable Function GenerateUserDelegationSasUri (permissions As QueueSasPermissions, expiresOn As DateTimeOffset, userDelegationKey As UserDelegationKey) As UriParameters
- permissions
- QueueSasPermissions
Required. Specifies the list of permissions to be associated with the SAS. See QueueSasPermissions.
- expiresOn
- DateTimeOffset
Required. Specifies the time at which the SAS becomes invalid. This field must be omitted if it has been specified in an associated stored access policy.
- userDelegationKey
- UserDelegationKey
Required. A UserDelegationKey returned from GetUserDelegationKeyAsync(Nullable<DateTimeOffset>, DateTimeOffset, CancellationToken).
Returns
A Uri containing the SAS Uri.
Remarks
A Exception will be thrown if a failure occurs.
