NamespacesOperations Class

Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:namespaces> attribute.

Inheritance: builtins.object

NamespacesOperations

Constructor

NamespacesOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
begin_delete	Deletes an existing namespace. This operation also removes all associated resources under the namespace.
check_name_availability	Check the give namespace name availability.
create_or_update_authorization_rule	Creates or updates an authorization rule for a namespace.
delete_authorization_rule	Deletes a namespace authorization rule.
get	Gets a description for the specified namespace.
get_authorization_rule	Gets an authorization rule for a namespace by rule name.
list_authorization_rules	Gets the authorization rules for a namespace.
list_by_resource_group	Gets the available namespaces within a resource group.
list_by_subscription	Gets all the available namespaces within the subscription, irrespective of the resource groups.
list_keys	Gets the primary and secondary connection strings for the namespace.
regenerate_keys	Regenerates the primary or secondary connection strings for the namespace.
update	Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

begin_create_or_update

Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

async begin_create_or_update(resource_group_name: str, namespace_name: str, parameters: _models.NamespaceCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.NamespaceResource]

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.
parameters Required	NamespaceCreateOrUpdateParameters or IO[bytes] Parameters supplied to create a namespace resource. Is either a NamespaceCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[NamespaceResource]	An instance of AsyncLROPoller that returns either NamespaceResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

begin_delete

Deletes an existing namespace. This operation also removes all associated resources under the namespace.

async begin_delete(resource_group_name: str, namespace_name: str, **kwargs: Any) -> AsyncLROPoller[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.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

check_name_availability

Check the give namespace name availability.

async check_name_availability(parameters: _models.CheckNameAvailability, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CheckNameAvailabilityResult

Parameters

Name	Description
parameters Required	CheckNameAvailability or IO[bytes] Parameters to check availability of the given namespace name. Is either a CheckNameAvailability type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

create_or_update_authorization_rule

Creates or updates an authorization rule for a namespace.

async create_or_update_authorization_rule(resource_group_name: str, namespace_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.
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

See also

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

delete_authorization_rule

Deletes a namespace authorization rule.

async delete_authorization_rule(resource_group_name: str, namespace_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.
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/mt639417.aspx

get

Gets a description for the specified namespace.

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

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
NamespaceResource	NamespaceResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

get_authorization_rule

Gets an authorization rule for a namespace by rule name.

async get_authorization_rule(resource_group_name: str, namespace_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.
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/mt639392.aspx

list_authorization_rules

Gets the authorization rules for a namespace.

list_authorization_rules(resource_group_name: str, namespace_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.

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/mt639376.aspx

list_by_resource_group

Gets the available namespaces within a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[NamespaceResource]

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

See also

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

list_by_subscription

Gets all the available namespaces within the subscription, irrespective of the resource groups.

list_by_subscription(**kwargs: Any) -> AsyncIterable[NamespaceResource]

Returns

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

Exceptions

Type	Description
HttpResponseError

See also

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

list_keys

Gets the primary and secondary connection strings for the namespace.

async list_keys(resource_group_name: str, namespace_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.
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/mt639398.aspx

regenerate_keys

Regenerates the primary or secondary connection strings for the namespace.

async regenerate_keys(resource_group_name: str, namespace_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.
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/mt718977.aspx

update

Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

async update(resource_group_name: str, namespace_name: str, parameters: _models.NamespaceUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.NamespaceResource | 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.
parameters Required	NamespaceUpdateParameters or IO[bytes] Parameters supplied to update a namespace resource. Is either a NamespaceUpdateParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

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

NamespacesOperations Class

Constructor

Methods

begin_create_or_update

Parameters

Returns

Exceptions

begin_delete

Parameters

Returns

Exceptions

check_name_availability

Parameters

Returns

Exceptions

create_or_update_authorization_rule

Parameters

Returns

Exceptions

delete_authorization_rule

Parameters

Returns

Exceptions

get

Parameters

Returns

Exceptions

get_authorization_rule

Parameters

Returns

Exceptions

list_authorization_rules

Parameters

Returns

Exceptions

list_by_resource_group

Parameters

Returns

Exceptions

list_by_subscription

Returns

Exceptions

list_keys

Parameters

Returns

Exceptions

regenerate_keys

Parameters

Returns

Exceptions

update

Parameters

Returns

Exceptions

Attributes

models

Additional resources