QueuesOperations Class

QueuesOperations async 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

QueuesOperations

Constructor

QueuesOperations(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_or_update	Creates or updates a Service Bus queue. This operation is idempotent.
create_or_update_authorization_rule	Creates an authorization rule for a queue.
delete	Deletes a queue from the specified namespace in a resource group.
delete_authorization_rule	Deletes a queue authorization rule.
get	Returns a description for the specified queue.
get_authorization_rule	Gets an authorization rule for a queue by rule name.
list_authorization_rules	Gets all authorization rules for a queue.
list_by_namespace	Gets the queues within a namespace.
list_keys	Primary and secondary connection strings to the queue.
regenerate_keys	Regenerates the primary or secondary connection strings to the queue.

create_or_update

Creates or updates a Service Bus queue. This operation is idempotent.

async create_or_update(resource_group_name: str, namespace_name: str, queue_name: str, parameters: azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBQueue, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBQueue

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

queue_name

str

Required

The queue name.

parameters

<xref:azure.mgmt.servicebus.models.SBQueue>

Required

Parameters supplied to create or update a queue resource.

cls

callable

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

Returns

SBQueue, or the result of cls(response)

Return type

<xref:azure.mgmt.servicebus.models.SBQueue>

Exceptions

HttpResponseError

create_or_update_authorization_rule

Creates an authorization rule for a queue.

async create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, queue_name: str, authorization_rule_name: str, parameters: azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBAuthorizationRule, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBAuthorizationRule

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

queue_name

str

Required

The queue name.

authorization_rule_name

str

Required

The authorization rule name.

parameters

<xref:azure.mgmt.servicebus.models.SBAuthorizationRule>

Required

The shared access authorization rule.

cls

callable

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

Returns

SBAuthorizationRule, or the result of cls(response)

Return type

<xref:azure.mgmt.servicebus.models.SBAuthorizationRule>

Exceptions

HttpResponseError

delete

Deletes a queue from the specified namespace in a resource group.

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

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

queue_name

str

Required

The queue name.

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

delete_authorization_rule

Deletes a queue authorization rule.

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

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

queue_name

str

Required

The queue name.

authorization_rule_name

str

Required

The authorization rule name.

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

Returns a description for the specified queue.

async get(resource_group_name: str, namespace_name: str, queue_name: str, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBQueue

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

queue_name

str

Required

The queue name.

cls

callable

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

Returns

SBQueue, or the result of cls(response)

Return type

<xref:azure.mgmt.servicebus.models.SBQueue>

Exceptions

HttpResponseError

get_authorization_rule

Gets an authorization rule for a queue by rule name.

async get_authorization_rule(resource_group_name: str, namespace_name: str, queue_name: str, authorization_rule_name: str, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBAuthorizationRule

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

queue_name

str

Required

The queue name.

authorization_rule_name

str

Required

The authorization rule name.

cls

callable

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

Returns

SBAuthorizationRule, or the result of cls(response)

Return type

<xref:azure.mgmt.servicebus.models.SBAuthorizationRule>

Exceptions

HttpResponseError

list_authorization_rules

Gets all authorization rules for a queue.

list_authorization_rules(resource_group_name: str, namespace_name: str, queue_name: str, **kwargs) -> AsyncIterable[azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBAuthorizationRuleListResult]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

queue_name

str

Required

The queue name.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[<xref:azure.mgmt.servicebus.models.SBAuthorizationRuleListResult>]

Exceptions

HttpResponseError

list_by_namespace

Gets the queues within a namespace.

list_by_namespace(resource_group_name: str, namespace_name: str, skip: Optional[int] = None, top: Optional[int] = None, **kwargs) -> AsyncIterable[azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBQueueListResult]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

skip

int

default value: None

Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.

top

int

default value: None

May be used to limit the number of results to the most recent N usageDetails.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[<xref:azure.mgmt.servicebus.models.SBQueueListResult>]

Exceptions

HttpResponseError

list_keys

Primary and secondary connection strings to the queue.

async list_keys(resource_group_name: str, namespace_name: str, queue_name: str, authorization_rule_name: str, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.AccessKeys

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

queue_name

str

Required

The queue name.

authorization_rule_name

str

Required

The authorization rule name.

cls

callable

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

Returns

AccessKeys, or the result of cls(response)

Return type

<xref:azure.mgmt.servicebus.models.AccessKeys>

Exceptions

HttpResponseError

regenerate_keys

Regenerates the primary or secondary connection strings to the queue.

async regenerate_keys(resource_group_name: str, namespace_name: str, queue_name: str, authorization_rule_name: str, parameters: azure.mgmt.servicebus.v2017_04_01.models._models_py3.RegenerateAccessKeyParameters, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.AccessKeys

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

queue_name

str

Required

The queue name.

authorization_rule_name

str

Required

The authorization rule name.

parameters

<xref:azure.mgmt.servicebus.models.RegenerateAccessKeyParameters>

Required

Parameters supplied to regenerate the authorization rule.

cls

callable

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

Returns

AccessKeys, or the result of cls(response)

Return type

<xref:azure.mgmt.servicebus.models.AccessKeys>

Exceptions

HttpResponseError

Attributes

models

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