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.
create_or_update_ip_filter_rule	Creates or updates an IpFilterRule for a Namespace.
create_or_update_network_rule_set	Create or update NetworkRuleSet for a Namespace.
create_or_update_virtual_network_rule	Creates or updates an VirtualNetworkRule for a Namespace.
delete_authorization_rule	Deletes a namespace authorization rule.
delete_ip_filter_rule	Deletes an IpFilterRule for a Namespace.
delete_virtual_network_rule	Deletes an VirtualNetworkRule for a Namespace.
get	Gets a description for the specified namespace.
get_authorization_rule	Gets an authorization rule for a namespace by rule name.
get_ip_filter_rule	Gets an IpFilterRule for a Namespace by rule name.
get_network_rule_set	Gets NetworkRuleSet for a Namespace.
get_virtual_network_rule	Gets an VirtualNetworkRule for a Namespace by rule name.
list	Gets all the available namespaces within the subscription, irrespective of the resource groups.
list_authorization_rules	Gets the authorization rules for a namespace.
list_by_resource_group	Gets the available namespaces within a resource group.
list_ip_filter_rules	Gets a list of IP Filter rules for a Namespace.
list_keys	Gets the primary and secondary connection strings for the namespace.
list_network_rule_sets	Gets list of NetworkRuleSet for a Namespace.
list_virtual_network_rules	Gets a list of VirtualNetwork rules for a Namespace.
migrate	This operation Migrate the given namespace to provided name type.
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.SBNamespace, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.SBNamespace]

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

Returns

Type	Description
AsyncLROPoller[SBNamespace]	An instance of AsyncLROPoller that returns either SBNamespace 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.SBAuthorizationRule, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SBAuthorizationRule

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

Exceptions

Type	Description
HttpResponseError

See also

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

create_or_update_ip_filter_rule

Creates or updates an IpFilterRule for a Namespace.

async create_or_update_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, parameters: _models.IpFilterRule, *, content_type: str = 'application/json', **kwargs: Any) -> _models.IpFilterRule

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.
ip_filter_rule_name Required	str The IP Filter Rule name. Required.
parameters Required	IpFilterRule or IO[bytes] The Namespace IpFilterRule. Is either a IpFilterRule type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

create_or_update_network_rule_set

Create or update NetworkRuleSet for a Namespace.

async create_or_update_network_rule_set(resource_group_name: str, namespace_name: str, parameters: _models.NetworkRuleSet, *, content_type: str = 'application/json', **kwargs: Any) -> _models.NetworkRuleSet

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	NetworkRuleSet or IO[bytes] The Namespace IpFilterRule. Is either a NetworkRuleSet type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

create_or_update_virtual_network_rule

Creates or updates an VirtualNetworkRule for a Namespace.

async create_or_update_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, parameters: _models.VirtualNetworkRule, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VirtualNetworkRule

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.
virtual_network_rule_name Required	str The Virtual Network Rule name. Required.
parameters Required	VirtualNetworkRule or IO[bytes] The Namespace VirtualNetworkRule. Is either a VirtualNetworkRule type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

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

delete_ip_filter_rule

Deletes an IpFilterRule for a Namespace.

async delete_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_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.
ip_filter_rule_name Required	str The IP Filter Rule name. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

delete_virtual_network_rule

Deletes an VirtualNetworkRule for a Namespace.

async delete_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_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.
virtual_network_rule_name Required	str The Virtual Network Rule name. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets a description for the specified namespace.

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

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
SBNamespace	SBNamespace 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) -> SBAuthorizationRule

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

Exceptions

Type	Description
HttpResponseError

See also

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

get_ip_filter_rule

Gets an IpFilterRule for a Namespace by rule name.

async get_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, **kwargs: Any) -> IpFilterRule

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.
ip_filter_rule_name Required	str The IP Filter Rule name. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get_network_rule_set

Gets NetworkRuleSet for a Namespace.

async get_network_rule_set(resource_group_name: str, namespace_name: str, **kwargs: Any) -> NetworkRuleSet

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

Exceptions

Type	Description
HttpResponseError

get_virtual_network_rule

Gets an VirtualNetworkRule for a Namespace by rule name.

async get_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, **kwargs: Any) -> VirtualNetworkRule

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.
virtual_network_rule_name Required	str The Virtual Network Rule name. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list

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

list(**kwargs: Any) -> AsyncIterable[SBNamespace]

Returns

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

Exceptions

Type	Description
HttpResponseError

See also

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

list_authorization_rules

Gets the authorization rules for a namespace.

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

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[SBAuthorizationRule]	An iterator like instance of either SBAuthorizationRule 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[SBNamespace]

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

See also

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

list_ip_filter_rules

Gets a list of IP Filter rules for a Namespace.

list_ip_filter_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) -> AsyncIterable[IpFilterRule]

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[IpFilterRule]	An iterator like instance of either IpFilterRule or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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) -> AccessKeys

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

Exceptions

Type	Description
HttpResponseError

See also

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

list_network_rule_sets

Gets list of NetworkRuleSet for a Namespace.

list_network_rule_sets(resource_group_name: str, namespace_name: str, **kwargs: Any) -> AsyncIterable[NetworkRuleSet]

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[NetworkRuleSet]	An iterator like instance of either NetworkRuleSet or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_virtual_network_rules

Gets a list of VirtualNetwork rules for a Namespace.

list_virtual_network_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) -> AsyncIterable[VirtualNetworkRule]

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[VirtualNetworkRule]	An iterator like instance of either VirtualNetworkRule or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

migrate

This operation Migrate the given namespace to provided name type.

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

Returns

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

Exceptions

Type	Description
HttpResponseError

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

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

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.servicebus.v2018_01_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\servicebus\\v2018_01_01_preview\\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

create_or_update_ip_filter_rule

Parameters

Returns

Exceptions

create_or_update_network_rule_set

Parameters

Returns

Exceptions

create_or_update_virtual_network_rule

Parameters

Returns

Exceptions

delete_authorization_rule

Parameters

Returns

Exceptions

delete_ip_filter_rule

Parameters

Returns

Exceptions

delete_virtual_network_rule

Parameters

Returns

Exceptions

get

Parameters

Returns

Exceptions

get_authorization_rule

Parameters

Returns

Exceptions

get_ip_filter_rule

Parameters

Returns

Exceptions

get_network_rule_set

Parameters

Returns

Exceptions

get_virtual_network_rule

Parameters

Returns

Exceptions

list

Returns

Exceptions

list_authorization_rules

Parameters

Returns

Exceptions

list_by_resource_group

Parameters

Returns

Exceptions

list_ip_filter_rules

Parameters

Returns

Exceptions

list_keys