你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

QueueOperations 类

警告

请勿直接实例化此类。

相反,应通过以下方式访问以下操作:

StorageManagementClient

queue 属性。

继承
builtins.object
QueueOperations

构造函数

QueueOperations(*args, **kwargs)

方法

create

在指定的帐户下创建具有指定队列名称的新队列。

delete

删除指定帐户下具有指定队列名称的队列(如果存在)。

get

获取具有指定队列名称的队列,该队列位于指定的帐户下(如果存在)。

list

获取指定存储帐户下的所有队列的列表。

update

在指定的帐户下创建具有指定队列名称的新队列。

create

在指定的帐户下创建具有指定队列名称的新队列。

create(resource_group_name: str, account_name: str, queue_name: str, queue: _models.StorageQueue, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StorageQueue

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

queue_name
str
必需

队列名称在存储帐户中必须唯一,并且必须介于 3 到 63 个字符之间。名称只能包含小写字母数字和短划线 ( ) 字符,它应以字母数字字符开头和结尾,并且不能有两个连续的短划线 ( ) 字符。 必需。

queue
StorageQueueIO
必需

要用于创建的队列属性和元数据。 是 StorageQueue 类型还是 IO 类型。 必需。

content_type
str

正文参数内容类型。 已知值为:“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

StorageQueue 或 cls 的结果 (响应)

返回类型

例外

delete

删除指定帐户下具有指定队列名称的队列(如果存在)。

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

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

queue_name
str
必需

队列名称在存储帐户中必须唯一,并且必须介于 3 到 63 个字符之间。名称只能包含小写字母数字和短划线 ( ) 字符,它应以字母数字字符开头和结尾,并且不能有两个连续的短划线 ( ) 字符。 必需。

cls
callable

将传递直接响应的自定义类型或函数

返回

无响应或 cls 的结果 (响应)

返回类型

例外

get

获取具有指定队列名称的队列,该队列位于指定的帐户下(如果存在)。

get(resource_group_name: str, account_name: str, queue_name: str, **kwargs: Any) -> StorageQueue

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

queue_name
str
必需

队列名称在存储帐户中必须唯一,并且必须介于 3 到 63 个字符之间。名称只能包含小写字母数字和短划线 ( ) 字符,它应以字母数字字符开头和结尾,并且不能有两个连续的短划线 ( ) 字符。 必需。

cls
callable

将传递直接响应的自定义类型或函数

返回

StorageQueue 或 cls 的结果 (响应)

返回类型

例外

list

获取指定存储帐户下的所有队列的列表。

list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[ListQueue]

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

maxpagesize
str
必需

可选,列表队列响应中应包含的最大队列数。 默认值为 None。

filter
str
必需

可选,指定时,仅列出名称以给定筛选器开头的队列。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

一个迭代器,如 ListQueue 的实例或 cls 的结果 (响应)

返回类型

例外

update

在指定的帐户下创建具有指定队列名称的新队列。

update(resource_group_name: str, account_name: str, queue_name: str, queue: _models.StorageQueue, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StorageQueue

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

queue_name
str
必需

队列名称在存储帐户中必须唯一,并且必须介于 3 到 63 个字符之间。名称只能包含小写字母数字和短划线 ( ) 字符,它应以字母数字字符开头和结尾,并且不能有两个连续的短划线 ( ) 字符。 必需。

queue
StorageQueueIO
必需

要用于创建的队列属性和元数据。 是 StorageQueue 类型还是 IO 类型。 必需。

content_type
str

正文参数内容类型。 已知值为:“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

StorageQueue 或 cls 的结果 (响应)

返回类型

例外

属性

models

models = <module 'azure.mgmt.storage.v2023_01_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2023_01_01\\models\\__init__.py'>