NamespacesOperations Class

NamespacesOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
NamespacesOperations

Constructor

NamespacesOperations(client, config, serializer, deserializer) -> None

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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.

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_messaging_plan

Gets messaging plan for specified namespace.

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_sets

Gets list of 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: azure.mgmt.eventhub.v2017_04_01.models._models_py3.EHNamespace, **kwargs: typing.Any) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('_models.EHNamespace')]

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

parameters
EHNamespace
Required

Parameters for creating a namespace resource.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either EHNamespace or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.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: typing.Any) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

check_name_availability

Check the give Namespace name availability.

check_name_availability(parameters: azure.mgmt.eventhub.v2017_04_01.models._models_py3.CheckNameAvailabilityParameter, **kwargs: typing.Any) -> azure.mgmt.eventhub.v2017_04_01.models._models_py3.CheckNameAvailabilityResult

Parameters

parameters
CheckNameAvailabilityParameter
Required

Parameters to check availability of the given Namespace name.

cls
callable

A custom type or function that will be passed the direct response

Returns

CheckNameAvailabilityResult, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.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: azure.mgmt.eventhub.v2017_04_01.models._models_py3.AuthorizationRule, **kwargs: typing.Any) -> azure.mgmt.eventhub.v2017_04_01.models._models_py3.AuthorizationRule

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

authorization_rule_name
str
Required

The authorization rule name.

parameters
AuthorizationRule
Required

The shared access AuthorizationRule.

cls
callable

A custom type or function that will be passed the direct response

Returns

AuthorizationRule, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.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: azure.mgmt.eventhub.v2017_04_01.models._models_py3.NetworkRuleSet, **kwargs: typing.Any) -> azure.mgmt.eventhub.v2017_04_01.models._models_py3.NetworkRuleSet

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

parameters
NetworkRuleSet
Required

The Namespace IpFilterRule.

cls
callable

A custom type or function that will be passed the direct response

Returns

NetworkRuleSet, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.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: typing.Any) -> None

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

authorization_rule_name
str
Required

The authorization rule name.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

get

Gets the description of the specified namespace.

get(resource_group_name: str, namespace_name: str, **kwargs: typing.Any) -> azure.mgmt.eventhub.v2017_04_01.models._models_py3.EHNamespace

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

cls
callable

A custom type or function that will be passed the direct response

Returns

EHNamespace, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.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: typing.Any) -> azure.mgmt.eventhub.v2017_04_01.models._models_py3.AuthorizationRule

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

authorization_rule_name
str
Required

The authorization rule name.

cls
callable

A custom type or function that will be passed the direct response

Returns

AuthorizationRule, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

get_messaging_plan

Gets messaging plan for specified namespace.

get_messaging_plan(resource_group_name: str, namespace_name: str, **kwargs: typing.Any) -> azure.mgmt.eventhub.v2017_04_01.models._models_py3.MessagingPlan

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

cls
callable

A custom type or function that will be passed the direct response

Returns

MessagingPlan, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

get_network_rule_set

Gets NetworkRuleSet for a Namespace.

get_network_rule_set(resource_group_name: str, namespace_name: str, **kwargs: typing.Any) -> azure.mgmt.eventhub.v2017_04_01.models._models_py3.NetworkRuleSet

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

cls
callable

A custom type or function that will be passed the direct response

Returns

NetworkRuleSet, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list

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

list(**kwargs: typing.Any) -> typing.AsyncIterable[_ForwardRef('_models.EHNamespaceListResult')]

Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list_authorization_rules

Gets a list of authorization rules for a Namespace.

list_authorization_rules(resource_group_name: str, namespace_name: str, **kwargs: typing.Any) -> typing.AsyncIterable[_ForwardRef('_models.AuthorizationRuleListResult')]

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list_by_resource_group

Lists the available Namespaces within a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: typing.Any) -> typing.AsyncIterable[_ForwardRef('_models.EHNamespaceListResult')]

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

Exceptions

~azure.core.exceptions.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: typing.Any) -> azure.mgmt.eventhub.v2017_04_01.models._models_py3.AccessKeys

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

authorization_rule_name
str
Required

The authorization rule name.

cls
callable

A custom type or function that will be passed the direct response

Returns

AccessKeys, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list_network_rule_sets

Gets list of NetworkRuleSet for a Namespace.

list_network_rule_sets(resource_group_name: str, namespace_name: str, **kwargs: typing.Any) -> typing.AsyncIterable[_ForwardRef('_models.NetworkRuleSetListResult')]

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

Exceptions

~azure.core.exceptions.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: azure.mgmt.eventhub.v2017_04_01.models._models_py3.RegenerateAccessKeyParameters, **kwargs: typing.Any) -> azure.mgmt.eventhub.v2017_04_01.models._models_py3.AccessKeys

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

authorization_rule_name
str
Required

The authorization rule name.

parameters
RegenerateAccessKeyParameters
Required

Parameters required to regenerate the connection string.

cls
callable

A custom type or function that will be passed the direct response

Returns

AccessKeys, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.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: azure.mgmt.eventhub.v2017_04_01.models._models_py3.EHNamespace, **kwargs: typing.Any) -> typing.Union[_ForwardRef('_models.EHNamespace'), NoneType]

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

parameters
EHNamespace
Required

Parameters for updating a namespace resource.

cls
callable

A custom type or function that will be passed the direct response

Returns

EHNamespace, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

models = <module 'azure.mgmt.eventhub.v2017_04_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.6.8\\x64\\lib\\site-packages\\azure\\mgmt\\eventhub\\v2017_04_01\\models\\__init__.py'>