QueueSasBuilder Class

Definition

Namespace:

Azure.Storage.Sas

Assembly:

Azure.Storage.Queues.dll

Package:

Azure.Storage.Queues v12.20.1

Source:

QueueSasBuilder.cs

QueueSasBuilder is used to generate a Shared Access Signature (SAS) for an Azure Storage queue.

   For more information, see

Create a Service SAS.

public class QueueSasBuilder

type QueueSasBuilder = class

Public Class QueueSasBuilder

Inheritance

Object

QueueSasBuilder

Constructors

QueueSasBuilder(QueueAccountSasPermissions, DateTimeOffset)	Initializes a new instance of the QueueSasBuilder class.
QueueSasBuilder(QueueSasPermissions, DateTimeOffset)	Initializes a new instance of the QueueSasBuilder class.

Properties

ExpiresOn	The time at which the shared access signature becomes invalid. This field must be omitted if it has been specified in an associated stored access policy.
Identifier	An optional unique value up to 64 characters in length that correlates to an access policy specified for the container.
IPRange	Specifies an IP address or a range of IP addresses from which to accept requests. If the IP address from which the request originates does not match the IP address or address range specified on the SAS token, the request is not authenticated. When specifying a range of IP addresses, note that the range is inclusive.
Permissions	The permissions associated with the shared access signature. The user is restricted to operations allowed by the permissions. This field must be omitted if it has been specified in an associated stored access policy. QueueSasPermissions and QueueAccountSasPermissions can be used to create the permissions string.
Protocol	The optional signed protocol field specifies the protocol permitted for a request made with the SAS. Possible values are HttpsAndHttp, Https, and None.
QueueName	The optional name of the blob being made accessible.
StartsOn	Optionally specify the time at which the shared access signature becomes valid. If omitted when DateTimeOffset.MinValue is used, start time for this call is assumed to be the time when the storage service receives the request.

Methods

SetPermissions(QueueAccountSasPermissions)	Sets the permissions for a queue account level SAS.
SetPermissions(QueueSasPermissions)	Sets the permissions for a queue SAS.
SetPermissions(String)	Sets the permissions for the SAS using a raw permissions string.
SetPermissions(String, Boolean)	Sets the permissions for the SAS using a raw permissions string.
ToSasQueryParameters(StorageSharedKeyCredential)	Use an account's StorageSharedKeyCredential to sign this shared access signature values to produce the proper SAS query parameters for authenticating requests.
ToSasQueryParameters(StorageSharedKeyCredential, String)	Use an account's StorageSharedKeyCredential to sign this shared access signature values to produce the proper SAS query parameters for authenticating requests.