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

QueuesOperations 类

警告

请勿直接实例化此类。

相反，应通过以下方式访问以下操作：

ServiceBusManagementClient's

<xref:queues> 属性。

继承

builtins.object

QueuesOperations

构造函数

QueuesOperations(*args, **kwargs)

方法

create_or_update	创建或更新服务总线队列。 此操作是幂等的。
create_or_update_authorization_rule	为队列创建授权规则。
delete	从资源组中的指定命名空间中删除队列。
delete_authorization_rule	删除队列授权规则。
get	返回指定队列的说明。
get_authorization_rule	按规则名称获取队列的授权规则。
list_authorization_rules	获取队列的所有授权规则。
list_by_namespace	获取命名空间中的队列。
list_keys	队列的主连接字符串和辅助连接字符串。
regenerate_keys	将主连接字符串或辅助连接字符串重新生成到队列。

create_or_update

创建或更新服务总线队列。 此操作是幂等的。

create_or_update(resource_group_name: str, namespace_name: str, queue_name: str, parameters: _models.SBQueue, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SBQueue

参数

resource_group_name

str

必需

Azure 订阅中的资源组的名称。 必需。

namespace_name

str

必需

命名空间名称。 必需。

queue_name

str

必需

队列名称。 必需。

parameters

SBQueue 或 IO

必需

为创建或更新队列资源提供的参数。 是 SBQueue 类型还是 IO 类型。 必需。

content_type

str

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

cls

callable

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

返回

SBQueue 或 cls 的结果 (响应)

返回类型

SBQueue

例外

HttpResponseError

另请参阅

• https://msdn.microsoft.com/en-us/library/azure/mt639395.aspx

create_or_update_authorization_rule

为队列创建授权规则。

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, queue_name: str, authorization_rule_name: str, parameters: _models.SBAuthorizationRule, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SBAuthorizationRule

参数

resource_group_name

str

必需

Azure 订阅中的资源组的名称。 必需。

namespace_name

str

必需

命名空间名称。 必需。

queue_name

str

必需

队列名称。 必需。

authorization_rule_name

str

必需

授权规则名称。 必需。

parameters

SBAuthorizationRule 或 IO

必需

共享访问授权规则。 是 SBAuthorizationRule 类型还是 IO 类型。 必需。

content_type

str

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

cls

callable

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

返回

SBAuthorizationRule 或 cls 的结果 (响应)

返回类型

SBAuthorizationRule

例外

HttpResponseError

delete

从资源组中的指定命名空间中删除队列。

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

参数

resource_group_name

str

必需

Azure 订阅中的资源组的名称。 必需。

namespace_name

str

必需

命名空间名称。 必需。

queue_name

str

必需

队列名称。 必需。

cls

callable

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

返回

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

另请参阅

• https://msdn.microsoft.com/en-us/library/azure/mt639411.aspx

delete_authorization_rule

删除队列授权规则。

delete_authorization_rule(resource_group_name: str, namespace_name: str, queue_name: str, authorization_rule_name: str, **kwargs: Any) -> None

参数

resource_group_name

str

必需

Azure 订阅中的资源组的名称。 必需。

namespace_name

str

必需

命名空间名称。 必需。

queue_name

str

必需

队列名称。 必需。

authorization_rule_name

str

必需

授权规则名称。 必需。

cls

callable

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

返回

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

另请参阅

• https://msdn.microsoft.com/en-us/library/azure/mt705609.aspx

get

返回指定队列的说明。

get(resource_group_name: str, namespace_name: str, queue_name: str, **kwargs: Any) -> SBQueue

参数

resource_group_name

str

必需

Azure 订阅中的资源组的名称。 必需。

namespace_name

str

必需

命名空间名称。 必需。

queue_name

str

必需

队列名称。 必需。

cls

callable

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

返回

SBQueue 或 cls 的结果 (响应)

返回类型

SBQueue

例外

HttpResponseError

另请参阅

• https://msdn.microsoft.com/en-us/library/azure/mt639380.aspx

get_authorization_rule

按规则名称获取队列的授权规则。

get_authorization_rule(resource_group_name: str, namespace_name: str, queue_name: str, authorization_rule_name: str, **kwargs: Any) -> SBAuthorizationRule

参数

resource_group_name

str

必需

Azure 订阅中的资源组的名称。 必需。

namespace_name

str

必需

命名空间名称。 必需。

queue_name

str

必需

队列名称。 必需。

authorization_rule_name

str

必需

授权规则名称。 必需。

cls

callable

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

返回

SBAuthorizationRule 或 cls 的结果 (响应)

返回类型

SBAuthorizationRule

例外

HttpResponseError

另请参阅

• https://msdn.microsoft.com/en-us/library/azure/mt705611.aspx

list_authorization_rules

获取队列的所有授权规则。

list_authorization_rules(resource_group_name: str, namespace_name: str, queue_name: str, **kwargs: Any) -> Iterable[SBAuthorizationRule]

参数

resource_group_name

str

必需

Azure 订阅中的资源组的名称。 必需。

namespace_name

str

必需

命名空间名称。 必需。

queue_name

str

必需

队列名称。 必需。

cls

callable

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

返回

迭代器，如 SBAuthorizationRule 的实例或 cls (响应的结果)

返回类型

ItemPaged[SBAuthorizationRule]

例外

HttpResponseError

另请参阅

• https://msdn.microsoft.com/en-us/library/azure/mt705607.aspx

list_by_namespace

获取命名空间中的队列。

list_by_namespace(resource_group_name: str, namespace_name: str, skip: int | None = None, top: int | None = None, **kwargs: Any) -> Iterable[SBQueue]

参数

resource_group_name

str

必需

Azure 订阅中的资源组的名称。 必需。

namespace_name

str

必需

命名空间名称。 必需。

skip

int

必需

仅当上一个操作返回了部分结果时，才使用 Skip。 如果以前的响应包含 nextLink 元素，则 nextLink 元素的值将包含一个 skip 参数，该参数指定要用于后续调用的起点。 默认值为 None。

top

int

必需

可用于将结果数限制为最近的 N usageDetails。 默认值为 None。

cls

callable

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

返回

迭代器，例如 SBQueue 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[SBQueue]

例外

HttpResponseError

另请参阅

• https://msdn.microsoft.com/en-us/library/azure/mt639415.aspx

list_keys

队列的主连接字符串和辅助连接字符串。

list_keys(resource_group_name: str, namespace_name: str, queue_name: str, authorization_rule_name: str, **kwargs: Any) -> AccessKeys

参数

resource_group_name

str

必需

Azure 订阅中资源组的名称。 必需。

namespace_name

str

必需

命名空间名称。 必需。

queue_name

str

必需

队列名称。 必需。

authorization_rule_name

str

必需

授权规则名称。 必需。

cls

callable

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

返回

AccessKeys 或 cls 的结果 (响应)

返回类型

AccessKeys

例外

HttpResponseError

另请参阅

• https://msdn.microsoft.com/en-us/library/azure/mt705608.aspx

regenerate_keys

将主连接字符串或辅助连接字符串重新生成到队列。

regenerate_keys(resource_group_name: str, namespace_name: str, queue_name: str, authorization_rule_name: str, parameters: _models.RegenerateAccessKeyParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AccessKeys

参数

resource_group_name

str

必需

Azure 订阅中资源组的名称。 必需。

namespace_name

str

必需

命名空间名称。 必需。

queue_name

str

必需

队列名称。 必需。

authorization_rule_name

str

必需

授权规则名称。 必需。

parameters

RegenerateAccessKeyParameters 或 IO

必需

提供用于重新生成授权规则的参数。 是 RegenerateAccessKeyParameters 类型或 IO 类型。 必需。

content_type

str

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls

callable

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

返回

AccessKeys 或 cls 的结果 (响应)

返回类型

AccessKeys

例外

HttpResponseError

另请参阅

• https://msdn.microsoft.com/en-us/library/azure/mt705606.aspx

属性

models

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