azure.mgmt.storage.v2020_08_01_preview.operations.QueueOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.storage.v2020_08_01_preview.operations.QueueOperations
name: QueueOperations
fullName: azure.mgmt.storage.v2020_08_01_preview.operations.QueueOperations
module: azure.mgmt.storage.v2020_08_01_preview.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.storage.v2020_08_01_preview.StorageManagementClient>'s\n\
  >\n> <xref:queue> attribute.\n>"
constructor:
  syntax: QueueOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.storage.v2020_08_01_preview.operations.QueueOperations.create
  name: create
  summary: Creates a new queue with the specified queue name, under the specified
    account.
  signature: 'create(resource_group_name: str, account_name: str, queue_name: str,
    queue: _models.StorageQueue, *, content_type: str = ''application/json'', **kwargs:
    Any) -> _models.StorageQueue'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: 'The name of the storage account within the specified resource group.

      Storage account names must be between 3 and 24 characters in length and use
      numbers and

      lower-case letters only. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: queue_name
    description: 'A queue name must be unique within a storage account and must be
      between 3

      and 63 characters.The name must comprise of lowercase alphanumeric and dash(-)
      characters only,

      it should begin and end with an alphanumeric character and it cannot have two
      consecutive

      dash(-) characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: queue
    description: 'Queue properties and metadata to be created with. Is either a StorageQueue
      type

      or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.storage.v2020_08_01_preview.models.StorageQueue>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: StorageQueue or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2020_08_01_preview.models.StorageQueue>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2020_08_01_preview.operations.QueueOperations.delete
  name: delete
  summary: Deletes the queue with the specified queue name, under the specified account
    if it exists.
  signature: 'delete(resource_group_name: str, account_name: str, queue_name: str,
    **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: 'The name of the storage account within the specified resource group.

      Storage account names must be between 3 and 24 characters in length and use
      numbers and

      lower-case letters only. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: queue_name
    description: 'A queue name must be unique within a storage account and must be
      between 3

      and 63 characters.The name must comprise of lowercase alphanumeric and dash(-)
      characters only,

      it should begin and end with an alphanumeric character and it cannot have two
      consecutive

      dash(-) characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2020_08_01_preview.operations.QueueOperations.get
  name: get
  summary: Gets the queue with the specified queue name, under the specified account
    if it exists.
  signature: 'get(resource_group_name: str, account_name: str, queue_name: str, **kwargs:
    Any) -> StorageQueue'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: 'The name of the storage account within the specified resource group.

      Storage account names must be between 3 and 24 characters in length and use
      numbers and

      lower-case letters only. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: queue_name
    description: 'A queue name must be unique within a storage account and must be
      between 3

      and 63 characters.The name must comprise of lowercase alphanumeric and dash(-)
      characters only,

      it should begin and end with an alphanumeric character and it cannot have two
      consecutive

      dash(-) characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: StorageQueue or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2020_08_01_preview.models.StorageQueue>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2020_08_01_preview.operations.QueueOperations.list
  name: list
  summary: Gets a list of all the queues under the specified storage account.
  signature: 'list(resource_group_name: str, account_name: str, maxpagesize: str |
    None = None, filter: str | None = None, **kwargs: Any) -> Iterable[ListQueue]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: 'The name of the storage account within the specified resource group.

      Storage account names must be between 3 and 24 characters in length and use
      numbers and

      lower-case letters only. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: maxpagesize
    description: 'Optional, a maximum number of queues that should be included in
      a list

      queue response. Default value is None.'
    isRequired: true
    types:
    - <xref:str>
  - name: filter
    description: 'Optional, When specified, only the queues with a name starting with
      the given

      filter will be listed. Default value is None.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either ListQueue or the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.storage.v2020_08_01_preview.models.ListQueue>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2020_08_01_preview.operations.QueueOperations.update
  name: update
  summary: Creates a new queue with the specified queue name, under the specified
    account.
  signature: 'update(resource_group_name: str, account_name: str, queue_name: str,
    queue: _models.StorageQueue, *, content_type: str = ''application/json'', **kwargs:
    Any) -> _models.StorageQueue'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: 'The name of the storage account within the specified resource group.

      Storage account names must be between 3 and 24 characters in length and use
      numbers and

      lower-case letters only. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: queue_name
    description: 'A queue name must be unique within a storage account and must be
      between 3

      and 63 characters.The name must comprise of lowercase alphanumeric and dash(-)
      characters only,

      it should begin and end with an alphanumeric character and it cannot have two
      consecutive

      dash(-) characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: queue
    description: 'Queue properties and metadata to be created with. Is either a StorageQueue
      type

      or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.storage.v2020_08_01_preview.models.StorageQueue>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: StorageQueue or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2020_08_01_preview.models.StorageQueue>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.storage.v2020_08_01_preview.operations.QueueOperations.models
  name: models
  signature: models = <module 'azure.mgmt.storage.v2020_08_01_preview.models' from
    'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2020_08_01_preview\\models\\__init__.py'>