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 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 AuthorizationRule for a Namespace.
create_or_update_network_rule_set	Create or update NetworkRuleSet for a Namespace.
delete_authorization_rule	Deletes an AuthorizationRule for a Namespace.
get	Gets the description of the specified namespace.
get_authorization_rule	Gets an AuthorizationRule for a Namespace by rule name.
get_network_rule_set	Gets NetworkRuleSet for a Namespace.
list	Lists all the available Namespaces within a subscription, irrespective of the resource groups.
list_authorization_rules	Gets a list of authorization rules for a Namespace.
list_by_resource_group	Lists the available Namespaces within a resource group.
list_keys	Gets the primary and secondary connection strings for the Namespace.
list_network_rule_set	Gets NetworkRuleSet for a Namespace.
regenerate_keys	Regenerates the primary or secondary connection strings for the specified Namespace.
update	Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

begin_create_or_update

Creates or updates a 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.EHNamespace, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.EHNamespace]

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

Returns

Type	Description
LROPoller[EHNamespace]	An instance of LROPoller that returns EHNamespace. The EHNamespace 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.CheckNameAvailabilityParameter, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CheckNameAvailabilityResult

Parameters

Name	Description
parameters Required	CheckNameAvailabilityParameter or CheckNameAvailabilityParameter or IO[bytes] The request body. Is either a CheckNameAvailabilityParameter 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 AuthorizationRule for a Namespace.

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: _models.AuthorizationRule, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AuthorizationRule

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	AuthorizationRule or AuthorizationRule or IO[bytes] The shared access AuthorizationRule. Is either a AuthorizationRule type or a IO[bytes] type. Required.

Returns

Type	Description
AuthorizationRule	AuthorizationRule. The AuthorizationRule 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 an AuthorizationRule for a Namespace.

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 the description of the specified namespace.

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

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
EHNamespace	EHNamespace. The EHNamespace is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_authorization_rule

Gets an AuthorizationRule for a Namespace by rule name.

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

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
AuthorizationRule	AuthorizationRule. The AuthorizationRule 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

Lists all the available Namespaces within a subscription, irrespective of the resource groups.

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_authorization_rules

Gets a list of authorization rules for a Namespace.

list_authorization_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) -> ItemPaged[AuthorizationRule]

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[AuthorizationRule]	An iterator like instance of AuthorizationRule

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Lists the available Namespaces within a resource group.

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

Parameters

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

Returns

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

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_set

Gets NetworkRuleSet for a Namespace.

list_network_rule_set(resource_group_name: str, namespace_name: str, **kwargs: Any) -> NetworkRuleSetListResult

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
NetworkRuleSetListResult	NetworkRuleSetListResult. The NetworkRuleSetListResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

regenerate_keys

Regenerates the primary or secondary connection strings for the specified 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 required to regenerate the connection string. 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

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

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

Returns

Type	Description
EHNamespace, None	EHNamespace or None. The EHNamespace is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?