QueueSharedAccessSignature Class

Provides a factory for creating queue shares access signature tokens with a common account name and account key. Users can either use the factory or can construct the appropriate service and use the generate_*_shared_access_signature method directly.

Inheritance

SharedAccessSignature

QueueSharedAccessSignature

Constructor

QueueSharedAccessSignature(account_name, account_key)

Parameters

account_name

account_key

Methods

generate_queue

Generates a shared access signature for the queue. Use the returned signature with the sas_token parameter of QueueService.

generate_queue

Generates a shared access signature for the queue. Use the returned signature with the sas_token parameter of QueueService.

generate_queue(queue_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None)

Parameters

queue_name

str

Required

Name of queue.

permission

QueuePermissions

default value: None

The permissions associated with the shared access signature. The user is restricted to operations allowed by the permissions. Permissions must be ordered read, add, update, process. Required unless an id is given referencing a stored access policy which contains this field. This field must be omitted if it has been specified in an associated stored access policy.

expiry

datetime or str

default value: None

The time at which the shared access signature becomes invalid. Required unless an id is given referencing a stored access policy which contains this field. This field must be omitted if it has been specified in an associated stored access policy. Azure will always convert values to UTC. If a date is passed in without timezone info, it is assumed to be UTC.

start

datetime or str

default value: None

The time at which the shared access signature becomes valid. If omitted, start time for this call is assumed to be the time when the storage service receives the request. Azure will always convert values to UTC. If a date is passed in without timezone info, it is assumed to be UTC.

id

str

default value: None

A unique value up to 64 characters in length that correlates to a stored access policy. To create a stored access policy, use set_blob_service_properties.

ip

str

default value: None

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. For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS restricts the request to those IP addresses.

protocol

str

default value: None

Specifies the protocol permitted for a request made. The default value is https,http. See Protocol for possible values.