QueueSasPermissions Class

QueueSasPermissions class to be used with the generate_queue_sas function and for the AccessPolicies used with set_queue_access_policy.

Inheritance

builtins.object

QueueSasPermissions

Constructor

QueueSasPermissions(read: bool = False, add: bool = False, update: bool = False, process: bool = False)

Parameters

Name	Description
read	bool Read metadata and properties, including message count. Peek at messages. default value: False
add	bool Add messages to the queue. default value: False
update	bool Update messages in the queue. Note: Use the Process permission with Update so you can first get the message you want to update. default value: False
process	bool Get and delete messages from the queue. default value: False

Methods

from_string

Create a QueueSasPermissions from a string. To specify read, add, update, or process permissions you need only to include the first letter of the word in the string. E.g. For read and update permissions, you would provide a string "ru".

from_string

Create a QueueSasPermissions from a string.

To specify read, add, update, or process permissions you need only to include the first letter of the word in the string. E.g. For read and update permissions, you would provide a string "ru".

from_string(permission: str) -> Self

Parameters

Name	Description
permission Required	str The string which dictates the read, add, update, or process permissions.

Returns

Type	Description
QueueSasPermissions	A QueueSasPermissions object

Attributes

add

Add messages to the queue.

add: bool = False

process

Get and delete messages from the queue.

process: bool = False

read

Read metadata and properties, including message count.

read: bool = False

update

Update messages in the queue.

update: bool = False