NamespacesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:namespaces> attribute.

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.
begin_failover	GeoDR Failover.
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_network_rule_set	Create or update NetworkRuleSet 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.
get_network_rule_set	Gets NetworkRuleSet for a Namespace.
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_keys	Gets the primary and secondary connection strings for the namespace.
list_network_rule_sets	Gets list of NetworkRuleSet for a 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.

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

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.
parameters Required	SBNamespace or 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
LROPoller[SBNamespace]	An instance of LROPoller that returns SBNamespace. The SBNamespace is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_delete

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

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

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_failover

GeoDR Failover.

begin_failover(resource_group_name: str, namespace_name: str, parameters: _models.FailOver, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.FailOver]

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.
parameters Required	FailOver or FailOver or IO[bytes] Parameters for updating a namespace resource. Is either a FailOver type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[FailOver]	An instance of LROPoller that returns FailOver. The FailOver is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

check_name_availability

Check the give namespace name availability.

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

Parameters

Name	Description
parameters Required	CheckNameAvailability or CheckNameAvailability or IO[bytes] The request body. Is either a CheckNameAvailability type or a IO[bytes] type. Required.

Returns

Type	Description
CheckNameAvailabilityResult	CheckNameAvailabilityResult. The CheckNameAvailabilityResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

create_or_update_authorization_rule

Creates or updates an authorization rule for a namespace.

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

create_or_update_network_rule_set

Create or update NetworkRuleSet for a Namespace.

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 The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
parameters Required	NetworkRuleSet or NetworkRuleSet or IO[bytes] The Namespace IpFilterRule. Is either a NetworkRuleSet type or a IO[bytes] type. Required.

Returns

Type	Description
NetworkRuleSet	NetworkRuleSet. The NetworkRuleSet is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

delete_authorization_rule

Deletes a namespace authorization rule.

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 The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
authorization_rule_name Required	str The authorization rule name. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

get

Gets a description for the specified namespace.

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

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.

Returns

Type	Description
SBNamespace	SBNamespace. The SBNamespace is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_authorization_rule

Gets an authorization rule for a namespace by rule name.

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

get_network_rule_set

Gets NetworkRuleSet for a Namespace.

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

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.

Returns

Type	Description
NetworkRuleSet	NetworkRuleSet. The NetworkRuleSet is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

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

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_authorization_rules

Gets the authorization rules for a namespace.

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Gets the available namespaces within a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> ItemPaged[SBNamespace]

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_keys

Gets the primary and secondary connection strings for the namespace.

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

list_network_rule_sets

Gets list of NetworkRuleSet for a Namespace.

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

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.

Returns

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

Exceptions

Type	Description
HttpResponseError

regenerate_keys

Regenerates the primary or secondary connection strings for the namespace.

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

update

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

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 The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
parameters Required	SBNamespaceUpdateParameters or 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. The SBNamespace is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?