Share via

NamespacesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventHubManagementClient's

<xref:namespaces> attribute.

Inheritance
builtins.object
NamespacesOperations

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

Check the give Namespace name availability.
create_or_update_authorization_rule

Creates or updates an AuthorizationRule 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.
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_by_subscription

Lists all the available Namespaces within a 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 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.NamespaceCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_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 for creating a namespace resource. Is either a NamespaceCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[NamespaceResource]

An instance of LROPoller that returns either NamespaceResource or the result of cls(response)

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

Name of the resource group within the azure subscription. Required.
namespace_name
Required
str

The Namespace name. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

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 IO[bytes]

Parameters to check availability of the given Namespace name. Is either a CheckNameAvailabilityParameter 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 AuthorizationRule for a Namespace.

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

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

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

get

Gets the description of the specified namespace.

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

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

list_authorization_rules

Gets a list of authorization rules for a Namespace.

list_authorization_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) -> Iterable[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
ItemPaged[SharedAccessAuthorizationRuleResource]

An iterator like instance of either SharedAccessAuthorizationRuleResource or the result of cls(response)

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) -> Iterable[NamespaceResource]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

Returns

Type Description
ItemPaged[NamespaceResource]

An iterator like instance of either NamespaceResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_subscription

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

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

Returns

Type Description
ItemPaged[NamespaceResource]

An iterator like instance of either NamespaceResource or the result of cls(response)

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

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.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 required to regenerate the connection string. 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

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.NamespaceUpdateParameter, *, 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
NamespaceUpdateParameter or IO[bytes]

Parameters for updating a namespace resource. Is either a NamespaceUpdateParameter 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.eventhub.v2015_08_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventhub\\v2015_08_01\\models\\__init__.py'>