QueuesOperations Class

Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:queues> attribute.

Inheritance: builtins.object

QueuesOperations

Constructor

QueuesOperations(*args, **kwargs)

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_all	Gets the queues within a namespace.
list_authorization_rules	Gets all authorization rules for a queue.
list_keys	Primary and secondary connection strings to the queue.
post_authorization_rule	Gets an authorization rule for a queue by rule name.
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: _models.QueueCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.QueueResource

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
queue_name Required	str The queue name. Required.
parameters Required	QueueCreateOrUpdateParameters or IO[bytes] Parameters supplied to create or update a queue resource. Is either a QueueCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
QueueResource	QueueResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

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: _models.SharedAccessAuthorizationRuleCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SharedAccessAuthorizationRuleResource

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
queue_name Required	str The queue name. Required.
authorization_rule_name Required	str The authorization rule name. Required.
parameters Required	SharedAccessAuthorizationRuleCreateOrUpdateParameters or IO[bytes] The shared access authorization rule. Is either a SharedAccessAuthorizationRuleCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
SharedAccessAuthorizationRuleResource	SharedAccessAuthorizationRuleResource or the result of cls(response)

Exceptions

Type	Description
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: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
queue_name Required	str The queue name. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

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: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
queue_name Required	str The queue name. Required.
authorization_rule_name Required	str The authorization rule name. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

get

Returns a description for the specified queue.

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

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
queue_name Required	str The queue name. Required.

Returns

Type	Description
QueueResource	QueueResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

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: Any) -> SharedAccessAuthorizationRuleResource

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
queue_name Required	str The queue name. Required.
authorization_rule_name Required	str The authorization rule name. Required.

Returns

Type	Description
SharedAccessAuthorizationRuleResource	SharedAccessAuthorizationRuleResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

list_all

Gets the queues within a namespace.

list_all(resource_group_name: str, namespace_name: str, **kwargs: Any) -> AsyncIterable[QueueResource]

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.

Returns

Type	Description
AsyncItemPaged[QueueResource]	An iterator like instance of either QueueResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

list_authorization_rules

Gets all authorization rules for a queue.

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

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
queue_name Required	str The queue name. Required.

Returns

Type	Description
AsyncItemPaged[SharedAccessAuthorizationRuleResource]	An iterator like instance of either SharedAccessAuthorizationRuleResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

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: Any) -> ResourceListKeys

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
queue_name Required	str The queue name. Required.
authorization_rule_name Required	str The authorization rule name. Required.

Returns

Type	Description
ResourceListKeys	ResourceListKeys or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

post_authorization_rule

Gets an authorization rule for a queue by rule name.

async post_authorization_rule(resource_group_name: str, namespace_name: str, queue_name: str, authorization_rule_name: str, **kwargs: Any) -> SharedAccessAuthorizationRuleResource

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
queue_name Required	str The queue name. Required.
authorization_rule_name Required	str The authorization rule name. Required.

Returns

Type	Description
SharedAccessAuthorizationRuleResource	SharedAccessAuthorizationRuleResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

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: _models.RegenerateKeysParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceListKeys

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
queue_name Required	str The queue name. Required.
authorization_rule_name Required	str The authorization rule name. Required.
parameters Required	RegenerateKeysParameters or IO[bytes] Parameters supplied to regenerate the authorization rule. Is either a RegenerateKeysParameters type or a IO[bytes] type. Required.

Returns

Type	Description
ResourceListKeys	ResourceListKeys or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

Attributes

models

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

Share via

QueuesOperations Class

Constructor

Methods

create_or_update

Parameters

Returns

Exceptions

create_or_update_authorization_rule

Parameters

Returns

Exceptions

delete

Parameters

Returns

Exceptions

delete_authorization_rule

Parameters

Returns

Exceptions

get

Parameters

Returns

Exceptions

get_authorization_rule

Parameters

Returns

Exceptions

list_all

Parameters

Returns

Exceptions

list_authorization_rules

Parameters

Returns

Exceptions

list_keys

Parameters

Returns

Exceptions

post_authorization_rule

Parameters

Returns

Exceptions

regenerate_keys

Parameters

Returns

Exceptions

Attributes

models

Additional resources