azure.storage.queue.QueueSasPermissions.yml

### YamlMime:PythonClass
uid: azure.storage.queue.QueueSasPermissions
name: QueueSasPermissions
fullName: azure.storage.queue.QueueSasPermissions
module: azure.storage.queue
inheritances:
- builtins.object
summary: 'QueueSasPermissions class to be used with the

  <xref:azure.storage.queue.generate_queue_sas> function and for the AccessPolicies
  used with

  <xref:azure.storage.queue.QueueClient.set_queue_access_policy>.'
constructor:
  syntax: 'QueueSasPermissions(read: bool = False, add: bool = False, update: bool
    = False, process: bool = False)'
  parameters:
  - name: read
    description: Read metadata and properties, including message count. Peek at messages.
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: add
    description: Add messages to the queue.
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: update
    description: 'Update messages in the queue. Note: Use the Process permission with

      Update so you can first get the message you want to update.'
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: process
    description: Get and delete messages from the queue.
    defaultValue: 'False'
    types:
    - <xref:bool>
methods:
- uid: azure.storage.queue.QueueSasPermissions.from_string
  name: from_string
  summary: '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".'
  signature: 'from_string(permission: str) -> Self'
  parameters:
  - name: permission
    description: 'The string which dictates the

      read, add, update, or process permissions.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: A QueueSasPermissions object
    types:
    - <xref:azure.storage.queue.QueueSasPermissions>
attributes:
- uid: azure.storage.queue.QueueSasPermissions.add
  name: add
  summary: Add messages to the queue.
  signature: 'add: bool = False'
- uid: azure.storage.queue.QueueSasPermissions.process
  name: process
  summary: Get and delete messages from the queue.
  signature: 'process: bool = False'
- uid: azure.storage.queue.QueueSasPermissions.read
  name: read
  summary: Read metadata and properties, including message count.
  signature: 'read: bool = False'
- uid: azure.storage.queue.QueueSasPermissions.update
  name: update
  summary: Update messages in the queue.
  signature: 'update: bool = False'