QueuesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ServiceBusManagementClient's

<xref:queues> attribute.

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_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.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
queue_name Required	str The queue name. Required.
parameters Required	SBQueue or SBQueue or IO[bytes] Parameters supplied to create or update a queue resource. Is either a SBQueue type or a IO[bytes] type. Required.

Returns

Type	Description
SBQueue	SBQueue. The SBQueue is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

create_or_update_authorization_rule

Creates an authorization rule for a queue.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. 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	SBAuthorizationRule or SBAuthorizationRule or IO[bytes] The shared access authorization rule. Is either a SBAuthorizationRule type or a IO[bytes] type. Required.

Returns

Type	Description
SBAuthorizationRule	SBAuthorizationRule. The SBAuthorizationRule is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

delete

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

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
queue_name Required	str The queue name. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

delete_authorization_rule

Deletes a queue authorization rule.

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 The name of the resource group. The name is case insensitive. 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

Exceptions

Type	Description
HttpResponseError

get

Returns a description for the specified queue.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
queue_name Required	str The queue name. Required.

Returns

Type	Description
SBQueue	SBQueue. The SBQueue is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_authorization_rule

Gets an authorization rule for a queue by rule name.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. 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
SBAuthorizationRule	SBAuthorizationRule. The SBAuthorizationRule is compatible with MutableMapping

Exceptions

Type	Description
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: Any) -> ItemPaged[SBAuthorizationRule]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
queue_name Required	str The queue name. Required.

Returns

Type	Description
ItemPaged[SBAuthorizationRule]	An iterator like instance of SBAuthorizationRule

Exceptions

Type	Description
HttpResponseError

list_by_namespace

Gets the queues within a namespace.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.

Keyword-Only Parameters

Name	Description
skip	int 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. Default value is None. Default value: None
top	int May be used to limit the number of results to the most recent N usageDetails. Default value is None. Default value: None

Returns

Type	Description
ItemPaged[SBQueue]	An iterator like instance of SBQueue

Exceptions

Type	Description
HttpResponseError

list_keys

Primary and secondary connection strings to the queue.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. 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
AccessKeys	AccessKeys. The AccessKeys is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

regenerate_keys

Regenerates the primary or secondary connection strings to the queue.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. 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	RegenerateAccessKeyParameters or RegenerateAccessKeyParameters or IO[bytes] Parameters supplied to regenerate the authorization rule. Is either a RegenerateAccessKeyParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AccessKeys	AccessKeys. The AccessKeys is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError