QueueOperations Class

QueueOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

QueueOperations

Constructor

QueueOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

create	Creates a new queue with the specified queue name, under the specified account.
delete	Deletes the queue with the specified queue name, under the specified account if it exists.
get	Gets the queue with the specified queue name, under the specified account if it exists.
list	Gets a list of all the queues under the specified storage account.
update	Creates a new queue with the specified queue name, under the specified account.

create

Creates a new queue with the specified queue name, under the specified account.

create(resource_group_name: str, account_name: str, queue_name: str, queue: azure.mgmt.storage.v2019_06_01.models._models_py3.StorageQueue, **kwargs: Any) -> azure.mgmt.storage.v2019_06_01.models._models_py3.StorageQueue

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription. The name is case insensitive.

account_name

str

Required

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.

queue_name

str

Required

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.

queue

StorageQueue

Required

Queue properties and metadata to be created with.

cls

callable

A custom type or function that will be passed the direct response

Returns

StorageQueue, or the result of cls(response)

Return type

StorageQueue

Exceptions

HttpResponseError

delete

Deletes the queue with the specified queue name, under the specified account if it exists.

delete(resource_group_name: str, account_name: str, queue_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription. The name is case insensitive.

account_name

str

Required

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.

queue_name

str

Required

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.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Gets the queue with the specified queue name, under the specified account if it exists.

get(resource_group_name: str, account_name: str, queue_name: str, **kwargs: Any) -> azure.mgmt.storage.v2019_06_01.models._models_py3.StorageQueue

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription. The name is case insensitive.

account_name

str

Required

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.

queue_name

str

Required

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.

cls

callable

A custom type or function that will be passed the direct response

Returns

StorageQueue, or the result of cls(response)

Return type

StorageQueue

Exceptions

HttpResponseError

list

Gets a list of all the queues under the specified storage account.

list(resource_group_name: str, account_name: str, maxpagesize: Optional[str] = None, filter: Optional[str] = None, **kwargs: Any) -> Iterable[azure.mgmt.storage.v2019_06_01.models._models_py3.ListQueueResource]

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription. The name is case insensitive.

account_name

str

Required

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.

maxpagesize

str

Required

Optional, a maximum number of queues that should be included in a list queue response.

filter

str

Required

Optional, When specified, only the queues with a name starting with the given filter will be listed.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ListQueueResource or the result of cls(response)

Return type

ItemPaged[ListQueueResource]

Exceptions

HttpResponseError

update

Creates a new queue with the specified queue name, under the specified account.

update(resource_group_name: str, account_name: str, queue_name: str, queue: azure.mgmt.storage.v2019_06_01.models._models_py3.StorageQueue, **kwargs: Any) -> azure.mgmt.storage.v2019_06_01.models._models_py3.StorageQueue

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription. The name is case insensitive.

account_name

str

Required

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.

queue_name

str

Required

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.

queue

StorageQueue

Required

Queue properties and metadata to be created with.

cls

callable

A custom type or function that will be passed the direct response

Returns

StorageQueue, or the result of cls(response)

Return type

StorageQueue

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.storage.v2019_06_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\storage\\v2019_06_01\\models\\__init__.py'>