NamespacesOperations Class

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

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_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 an AuthorizationRule for a Namespace.
delete_ip_filter_rule	Deletes an IpFilterRule for a Namespace.
delete_virtual_network_rule	Deletes an VirtualNetworkRule for a Namespace.
get	Gets the description of the specified namespace.
get_authorization_rule	Gets an AuthorizationRule 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	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_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_virtual_network_rules	Gets a list of VirtualNetwork rules 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.v2018_01_01_preview.models._models_py3.EHNamespace, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.eventhub.v2018_01_01_preview.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.

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 PollingMethod

By default, your polling method will be ARMPolling. 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 LROPoller that returns either EHNamespace or the result of cls(response)

Return type

LROPoller[EHNamespace]

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: Any) -> azure.core.polling._poller.LROPoller[None]

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 PollingMethod

By default, your polling method will be ARMPolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

check_name_availability

Check the give Namespace name availability.

check_name_availability(parameters: azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.CheckNameAvailabilityParameter, **kwargs: Any) -> azure.mgmt.eventhub.v2018_01_01_preview.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

CheckNameAvailabilityResult

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.v2018_01_01_preview.models._models_py3.AuthorizationRule, **kwargs: Any) -> azure.mgmt.eventhub.v2018_01_01_preview.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

AuthorizationRule

Exceptions

HttpResponseError

create_or_update_ip_filter_rule

Creates or updates an IpFilterRule for a Namespace.

create_or_update_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, parameters: azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.IpFilterRule, **kwargs: Any) -> azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.IpFilterRule

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

ip_filter_rule_name

str

Required

The IP Filter Rule name.

parameters

IpFilterRule

Required

The Namespace IpFilterRule.

cls

callable

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

Returns

IpFilterRule, or the result of cls(response)

Return type

IpFilterRule

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.v2018_01_01_preview.models._models_py3.NetworkRuleSet, **kwargs: Any) -> azure.mgmt.eventhub.v2018_01_01_preview.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

NetworkRuleSet

Exceptions

HttpResponseError

create_or_update_virtual_network_rule

Creates or updates an VirtualNetworkRule for a Namespace.

create_or_update_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, parameters: azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.VirtualNetworkRule, **kwargs: Any) -> azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.VirtualNetworkRule

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

virtual_network_rule_name

str

Required

The Virtual Network Rule name.

parameters

VirtualNetworkRule

Required

The Namespace VirtualNetworkRule.

cls

callable

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

Returns

VirtualNetworkRule, or the result of cls(response)

Return type

VirtualNetworkRule

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

None

Exceptions

HttpResponseError

delete_ip_filter_rule

Deletes an IpFilterRule for a Namespace.

delete_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

ip_filter_rule_name

str

Required

The IP Filter 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

None

Exceptions

HttpResponseError

delete_virtual_network_rule

Deletes an VirtualNetworkRule for a Namespace.

delete_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

virtual_network_rule_name

str

Required

The Virtual Network 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

None

Exceptions

HttpResponseError

get

Gets the description of the specified namespace.

get(resource_group_name: str, namespace_name: str, **kwargs: Any) -> azure.mgmt.eventhub.v2018_01_01_preview.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

EHNamespace

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: Any) -> azure.mgmt.eventhub.v2018_01_01_preview.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

AuthorizationRule

Exceptions

HttpResponseError

get_ip_filter_rule

Gets an IpFilterRule for a Namespace by rule name.

get_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, **kwargs: Any) -> azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.IpFilterRule

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

ip_filter_rule_name

str

Required

The IP Filter Rule name.

cls

callable

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

Returns

IpFilterRule, or the result of cls(response)

Return type

IpFilterRule

Exceptions

HttpResponseError

get_network_rule_set

Gets NetworkRuleSet for a Namespace.

get_network_rule_set(resource_group_name: str, namespace_name: str, **kwargs: Any) -> azure.mgmt.eventhub.v2018_01_01_preview.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

NetworkRuleSet

Exceptions

HttpResponseError

get_virtual_network_rule

Gets an VirtualNetworkRule for a Namespace by rule name.

get_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, **kwargs: Any) -> azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.VirtualNetworkRule

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

virtual_network_rule_name

str

Required

The Virtual Network Rule name.

cls

callable

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

Returns

VirtualNetworkRule, or the result of cls(response)

Return type

VirtualNetworkRule

Exceptions

HttpResponseError

list

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

list(**kwargs: Any) -> Iterable[azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.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

ItemPaged[EHNamespaceListResult]

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: Any) -> Iterable[azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.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

ItemPaged[AuthorizationRuleListResult]

Exceptions

HttpResponseError

list_by_resource_group

Lists the available Namespaces within a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.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

ItemPaged[EHNamespaceListResult]

Exceptions

HttpResponseError

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) -> Iterable[azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.IpFilterRuleListResult]

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

Return type

ItemPaged[IpFilterRuleListResult]

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: Any) -> azure.mgmt.eventhub.v2018_01_01_preview.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

AccessKeys

Exceptions

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) -> Iterable[azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.VirtualNetworkRuleListResult]

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

Return type

ItemPaged[VirtualNetworkRuleListResult]

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.v2018_01_01_preview.models._models_py3.RegenerateAccessKeyParameters, **kwargs: Any) -> azure.mgmt.eventhub.v2018_01_01_preview.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

AccessKeys

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.v2018_01_01_preview.models._models_py3.EHNamespace, **kwargs: Any) -> Optional[azure.mgmt.eventhub.v2018_01_01_preview.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.

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

EHNamespace,

None

Exceptions

HttpResponseError

Attributes

models

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