azure.mgmt.eventhub.v2018_01_01_preview.operations module

class azure.mgmt.eventhub.v2018_01_01_preview.operations.ClustersOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventHubManagementClient’s clusters attribute.

begin_create_or_update(resource_group_name: str, cluster_name: str, parameters: _models.Cluster, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Cluster][source]
begin_create_or_update(resource_group_name: str, cluster_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Cluster]

Creates or updates an instance of an Event Hubs Cluster.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • cluster_name (str) – The name of the Event Hubs Cluster. Required.

  • parameters (Cluster or IO[bytes]) – Parameters for creating a eventhub cluster resource. Is either a Cluster type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[Cluster]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, cluster_name: str, **kwargs: Any) → LROPoller[None][source]

Deletes an existing Event Hubs Cluster. This operation is idempotent.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • cluster_name (str) – The name of the Event Hubs Cluster. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_update(resource_group_name: str, cluster_name: str, parameters: _models.Cluster, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Cluster][source]
begin_update(resource_group_name: str, cluster_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Cluster]

Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • cluster_name (str) – The name of the Event Hubs Cluster. Required.

  • parameters (Cluster or IO[bytes]) – The properties of the Event Hubs Cluster which should be updated. Is either a Cluster type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[Cluster]

Raises:

HttpResponseError –

get(resource_group_name: str, cluster_name: str, **kwargs: Any) → Cluster[source]

Gets the resource description of the specified Event Hubs Cluster.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • cluster_name (str) – The name of the Event Hubs Cluster. Required.

Returns:

Cluster or the result of cls(response)

Return type:

Cluster

Raises:

HttpResponseError –

list_available_cluster_region(**kwargs: Any) → AvailableClustersList[source]

List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.

Returns:

AvailableClustersList or the result of cls(response)

Return type:

AvailableClustersList

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[Cluster][source]

Lists the available Event Hubs Clusters within an ARM resource group.

Parameters:

resource_group_name (str) – Name of the resource group within the azure subscription. Required.

Returns:

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

Return type:

ItemPaged[Cluster]

Raises:

HttpResponseError –

list_namespaces(resource_group_name: str, cluster_name: str, **kwargs: Any) → EHNamespaceIdListResult[source]

List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • cluster_name (str) – The name of the Event Hubs Cluster. Required.

Returns:

EHNamespaceIdListResult or the result of cls(response)

Return type:

EHNamespaceIdListResult

Raises:

HttpResponseError –

models = <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>
class azure.mgmt.eventhub.v2018_01_01_preview.operations.ConfigurationOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventHubManagementClient’s configuration attribute.

get(resource_group_name: str, cluster_name: str, **kwargs: Any) → ClusterQuotaConfigurationProperties[source]

Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • cluster_name (str) – The name of the Event Hubs Cluster. Required.

Returns:

ClusterQuotaConfigurationProperties or the result of cls(response)

Return type:

ClusterQuotaConfigurationProperties

Raises:

HttpResponseError –

patch(resource_group_name: str, cluster_name: str, parameters: _models.ClusterQuotaConfigurationProperties, *, content_type: str = 'application/json', **kwargs: Any) → _models.ClusterQuotaConfigurationProperties | None[source]
patch(resource_group_name: str, cluster_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.ClusterQuotaConfigurationProperties | None

Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • cluster_name (str) – The name of the Event Hubs Cluster. Required.

  • parameters (ClusterQuotaConfigurationProperties or IO[bytes]) – Parameters for creating an Event Hubs Cluster resource. Is either a ClusterQuotaConfigurationProperties type or a IO[bytes] type. Required.

Returns:

ClusterQuotaConfigurationProperties or None or the result of cls(response)

Return type:

ClusterQuotaConfigurationProperties or None

Raises:

HttpResponseError –

models = <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>
class azure.mgmt.eventhub.v2018_01_01_preview.operations.ConsumerGroupsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventHubManagementClient’s consumer_groups attribute.

create_or_update(resource_group_name: str, namespace_name: str, event_hub_name: str, consumer_group_name: str, parameters: _models.ConsumerGroup, *, content_type: str = 'application/json', **kwargs: Any) → _models.ConsumerGroup[source]
create_or_update(resource_group_name: str, namespace_name: str, event_hub_name: str, consumer_group_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.ConsumerGroup

Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • event_hub_name (str) – The Event Hub name. Required.

  • consumer_group_name (str) – The consumer group name. Required.

  • parameters (ConsumerGroup or IO[bytes]) – Parameters supplied to create or update a consumer group resource. Is either a ConsumerGroup type or a IO[bytes] type. Required.

Returns:

ConsumerGroup or the result of cls(response)

Return type:

ConsumerGroup

Raises:

HttpResponseError –

delete(resource_group_name: str, namespace_name: str, event_hub_name: str, consumer_group_name: str, **kwargs: Any) → None[source]

Deletes a consumer group from the specified Event Hub and resource group.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • event_hub_name (str) – The Event Hub name. Required.

  • consumer_group_name (str) – The consumer group name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, namespace_name: str, event_hub_name: str, consumer_group_name: str, **kwargs: Any) → ConsumerGroup[source]

Gets a description for the specified consumer group.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • event_hub_name (str) – The Event Hub name. Required.

  • consumer_group_name (str) – The consumer group name. Required.

Returns:

ConsumerGroup or the result of cls(response)

Return type:

ConsumerGroup

Raises:

HttpResponseError –

list_by_event_hub(resource_group_name: str, namespace_name: str, event_hub_name: str, skip: int | None = None, top: int | None = None, **kwargs: Any) → Iterable[ConsumerGroup][source]

Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • event_hub_name (str) – The Event Hub name. Required.

  • skip (int) – Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. Default value is None.

  • top (int) – May be used to limit the number of results to the most recent N usageDetails. Default value is None.

Returns:

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

Return type:

ItemPaged[ConsumerGroup]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>
class azure.mgmt.eventhub.v2018_01_01_preview.operations.DisasterRecoveryConfigsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventHubManagementClient’s disaster_recovery_configs attribute.

break_pairing(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) → None[source]

This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • alias (str) – The Disaster Recovery configuration name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

check_name_availability(resource_group_name: str, namespace_name: str, parameters: _models.CheckNameAvailabilityParameter, *, content_type: str = 'application/json', **kwargs: Any) → _models.CheckNameAvailabilityResult[source]
check_name_availability(resource_group_name: str, namespace_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.CheckNameAvailabilityResult

Check the give Namespace name availability.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • parameters (CheckNameAvailabilityParameter or IO[bytes]) – Parameters to check availability of the given Alias name. Is either a CheckNameAvailabilityParameter type or a IO[bytes] type. Required.

Returns:

CheckNameAvailabilityResult or the result of cls(response)

Return type:

CheckNameAvailabilityResult

Raises:

HttpResponseError –

create_or_update(resource_group_name: str, namespace_name: str, alias: str, parameters: _models.ArmDisasterRecovery, *, content_type: str = 'application/json', **kwargs: Any) → _models.ArmDisasterRecovery | None[source]
create_or_update(resource_group_name: str, namespace_name: str, alias: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.ArmDisasterRecovery | None

Creates or updates a new Alias(Disaster Recovery configuration).

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • alias (str) – The Disaster Recovery configuration name. Required.

  • parameters (ArmDisasterRecovery or IO[bytes]) – Parameters required to create an Alias(Disaster Recovery configuration). Is either a ArmDisasterRecovery type or a IO[bytes] type. Required.

Returns:

ArmDisasterRecovery or None or the result of cls(response)

Return type:

ArmDisasterRecovery or None

Raises:

HttpResponseError –

delete(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) → None[source]

Deletes an Alias(Disaster Recovery configuration).

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • alias (str) – The Disaster Recovery configuration name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

fail_over(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) → None[source]

Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • alias (str) – The Disaster Recovery configuration name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) → ArmDisasterRecovery[source]

Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • alias (str) – The Disaster Recovery configuration name. Required.

Returns:

ArmDisasterRecovery or the result of cls(response)

Return type:

ArmDisasterRecovery

Raises:

HttpResponseError –

get_authorization_rule(resource_group_name: str, namespace_name: str, alias: str, authorization_rule_name: str, **kwargs: Any) → AuthorizationRule[source]

Gets an AuthorizationRule for a Namespace by rule name.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • alias (str) – The Disaster Recovery configuration name. Required.

  • authorization_rule_name (str) – The authorization rule name. Required.

Returns:

AuthorizationRule or the result of cls(response)

Return type:

AuthorizationRule

Raises:

HttpResponseError –

list(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[ArmDisasterRecovery][source]

Gets all Alias(Disaster Recovery configurations).

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

Returns:

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

Return type:

ItemPaged[ArmDisasterRecovery]

Raises:

HttpResponseError –

list_authorization_rules(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) → Iterable[AuthorizationRule][source]

Gets a list of authorization rules for a Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • alias (str) – The Disaster Recovery configuration name. Required.

Returns:

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

Return type:

ItemPaged[AuthorizationRule]

Raises:

HttpResponseError –

list_keys(resource_group_name: str, namespace_name: str, alias: str, authorization_rule_name: str, **kwargs: Any) → AccessKeys[source]

Gets the primary and secondary connection strings for the Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • alias (str) – The Disaster Recovery configuration name. Required.

  • authorization_rule_name (str) – The authorization rule name. Required.

Returns:

AccessKeys or the result of cls(response)

Return type:

AccessKeys

Raises:

HttpResponseError –

models = <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>
class azure.mgmt.eventhub.v2018_01_01_preview.operations.EventHubsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventHubManagementClient’s event_hubs attribute.

create_or_update(resource_group_name: str, namespace_name: str, event_hub_name: str, parameters: _models.Eventhub, *, content_type: str = 'application/json', **kwargs: Any) → _models.Eventhub[source]
create_or_update(resource_group_name: str, namespace_name: str, event_hub_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Eventhub

Creates or updates a new Event Hub as a nested resource within a Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • event_hub_name (str) – The Event Hub name. Required.

  • parameters (Eventhub or IO[bytes]) – Parameters supplied to create an Event Hub resource. Is either a Eventhub type or a IO[bytes] type. Required.

Returns:

Eventhub or the result of cls(response)

Return type:

Eventhub

Raises:

HttpResponseError –

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, parameters: _models.AuthorizationRule, *, content_type: str = 'application/json', **kwargs: Any) → _models.AuthorizationRule[source]
create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.AuthorizationRule

Creates or updates an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • event_hub_name (str) – The Event Hub name. Required.

  • authorization_rule_name (str) – The authorization rule name. Required.

  • parameters (AuthorizationRule or IO[bytes]) – The shared access AuthorizationRule. Is either a AuthorizationRule type or a IO[bytes] type. Required.

Returns:

AuthorizationRule or the result of cls(response)

Return type:

AuthorizationRule

Raises:

HttpResponseError –

delete(resource_group_name: str, namespace_name: str, event_hub_name: str, **kwargs: Any) → None[source]

Deletes an Event Hub from the specified Namespace and resource group.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • event_hub_name (str) – The Event Hub name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

delete_authorization_rule(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, **kwargs: Any) → None[source]

Deletes an Event Hub AuthorizationRule.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • event_hub_name (str) – The Event Hub name. Required.

  • authorization_rule_name (str) – The authorization rule name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, namespace_name: str, event_hub_name: str, **kwargs: Any) → Eventhub[source]

Gets an Event Hubs description for the specified Event Hub.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • event_hub_name (str) – The Event Hub name. Required.

Returns:

Eventhub or the result of cls(response)

Return type:

Eventhub

Raises:

HttpResponseError –

get_authorization_rule(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, **kwargs: Any) → AuthorizationRule[source]

Gets an AuthorizationRule for an Event Hub by rule name.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • event_hub_name (str) – The Event Hub name. Required.

  • authorization_rule_name (str) – The authorization rule name. Required.

Returns:

AuthorizationRule or the result of cls(response)

Return type:

AuthorizationRule

Raises:

HttpResponseError –

list_authorization_rules(resource_group_name: str, namespace_name: str, event_hub_name: str, **kwargs: Any) → Iterable[AuthorizationRule][source]

Gets the authorization rules for an Event Hub.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • event_hub_name (str) – The Event Hub name. Required.

Returns:

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

Return type:

ItemPaged[AuthorizationRule]

Raises:

HttpResponseError –

list_by_namespace(resource_group_name: str, namespace_name: str, skip: int | None = None, top: int | None = None, **kwargs: Any) → Iterable[Eventhub][source]

Gets all the Event Hubs in a Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • skip (int) – Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. Default value is None.

  • top (int) – May be used to limit the number of results to the most recent N usageDetails. Default value is None.

Returns:

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

Return type:

ItemPaged[Eventhub]

Raises:

HttpResponseError –

list_keys(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, **kwargs: Any) → AccessKeys[source]

Gets the ACS and SAS connection strings for the Event Hub.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • event_hub_name (str) – The Event Hub name. Required.

  • authorization_rule_name (str) – The authorization rule name. Required.

Returns:

AccessKeys or the result of cls(response)

Return type:

AccessKeys

Raises:

HttpResponseError –

regenerate_keys(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, parameters: _models.RegenerateAccessKeyParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.AccessKeys[source]
regenerate_keys(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.AccessKeys

Regenerates the ACS and SAS connection strings for the Event Hub.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • event_hub_name (str) – The Event Hub name. Required.

  • authorization_rule_name (str) – The authorization rule name. Required.

  • parameters (RegenerateAccessKeyParameters or IO[bytes]) – Parameters supplied to regenerate the AuthorizationRule Keys (PrimaryKey/SecondaryKey). Is either a RegenerateAccessKeyParameters type or a IO[bytes] type. Required.

Returns:

AccessKeys or the result of cls(response)

Return type:

AccessKeys

Raises:

HttpResponseError –

models = <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>
class azure.mgmt.eventhub.v2018_01_01_preview.operations.NamespacesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventHubManagementClient’s namespaces attribute.

begin_create_or_update(resource_group_name: str, namespace_name: str, parameters: _models.EHNamespace, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.EHNamespace][source]
begin_create_or_update(resource_group_name: str, namespace_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.EHNamespace]

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

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • parameters (EHNamespace or IO[bytes]) – Parameters for creating a namespace resource. Is either a EHNamespace type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[EHNamespace]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, namespace_name: str, **kwargs: Any) → LROPoller[None][source]

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

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

check_name_availability(parameters: _models.CheckNameAvailabilityParameter, *, content_type: str = 'application/json', **kwargs: Any) → _models.CheckNameAvailabilityResult[source]
check_name_availability(parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.CheckNameAvailabilityResult

Check the give Namespace name availability.

Parameters:

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

CheckNameAvailabilityResult or the result of cls(response)

Return type:

CheckNameAvailabilityResult

Raises:

HttpResponseError –

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[source]
create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.AuthorizationRule

Creates or updates an AuthorizationRule for a Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • authorization_rule_name (str) – The authorization rule name. Required.

  • parameters (AuthorizationRule or IO[bytes]) – The shared access AuthorizationRule. Is either a AuthorizationRule type or a IO[bytes] type. Required.

Returns:

AuthorizationRule or the result of cls(response)

Return type:

AuthorizationRule

Raises:

HttpResponseError –

create_or_update_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, parameters: _models.IpFilterRule, *, content_type: str = 'application/json', **kwargs: Any) → _models.IpFilterRule[source]
create_or_update_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.IpFilterRule

Creates or updates an IpFilterRule for a Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • ip_filter_rule_name (str) – The IP Filter Rule name. Required.

  • parameters (IpFilterRule or IO[bytes]) – The Namespace IpFilterRule. Is either a IpFilterRule type or a IO[bytes] type. Required.

Returns:

IpFilterRule or the result of cls(response)

Return type:

IpFilterRule

Raises:

HttpResponseError –

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[source]
create_or_update_network_rule_set(resource_group_name: str, namespace_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.NetworkRuleSet

Create or update NetworkRuleSet for a Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • parameters (NetworkRuleSet or IO[bytes]) – The Namespace IpFilterRule. Is either a NetworkRuleSet type or a IO[bytes] type. Required.

Returns:

NetworkRuleSet or the result of cls(response)

Return type:

NetworkRuleSet

Raises:

HttpResponseError –

create_or_update_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, parameters: _models.VirtualNetworkRule, *, content_type: str = 'application/json', **kwargs: Any) → _models.VirtualNetworkRule[source]
create_or_update_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.VirtualNetworkRule

Creates or updates an VirtualNetworkRule for a Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • virtual_network_rule_name (str) – The Virtual Network Rule name. Required.

  • parameters (VirtualNetworkRule or IO[bytes]) – The Namespace VirtualNetworkRule. Is either a VirtualNetworkRule type or a IO[bytes] type. Required.

Returns:

VirtualNetworkRule or the result of cls(response)

Return type:

VirtualNetworkRule

Raises:

HttpResponseError –

delete_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) → None[source]

Deletes an AuthorizationRule for a Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • authorization_rule_name (str) – The authorization rule name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

delete_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, **kwargs: Any) → None[source]

Deletes an IpFilterRule for a Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • ip_filter_rule_name (str) – The IP Filter Rule name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

delete_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, **kwargs: Any) → None[source]

Deletes an VirtualNetworkRule for a Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • virtual_network_rule_name (str) – The Virtual Network Rule name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, namespace_name: str, **kwargs: Any) → EHNamespace[source]

Gets the description of the specified namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

Returns:

EHNamespace or the result of cls(response)

Return type:

EHNamespace

Raises:

HttpResponseError –

get_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) → AuthorizationRule[source]

Gets an AuthorizationRule for a Namespace by rule name.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • authorization_rule_name (str) – The authorization rule name. Required.

Returns:

AuthorizationRule or the result of cls(response)

Return type:

AuthorizationRule

Raises:

HttpResponseError –

get_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, **kwargs: Any) → IpFilterRule[source]

Gets an IpFilterRule for a Namespace by rule name.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • ip_filter_rule_name (str) – The IP Filter Rule name. Required.

Returns:

IpFilterRule or the result of cls(response)

Return type:

IpFilterRule

Raises:

HttpResponseError –

get_network_rule_set(resource_group_name: str, namespace_name: str, **kwargs: Any) → NetworkRuleSet[source]

Gets NetworkRuleSet for a Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

Returns:

NetworkRuleSet or the result of cls(response)

Return type:

NetworkRuleSet

Raises:

HttpResponseError –

get_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, **kwargs: Any) → VirtualNetworkRule[source]

Gets an VirtualNetworkRule for a Namespace by rule name.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • virtual_network_rule_name (str) – The Virtual Network Rule name. Required.

Returns:

VirtualNetworkRule or the result of cls(response)

Return type:

VirtualNetworkRule

Raises:

HttpResponseError –

list(**kwargs: Any) → Iterable[EHNamespace][source]

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

Returns:

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

Return type:

ItemPaged[EHNamespace]

Raises:

HttpResponseError –

list_authorization_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[AuthorizationRule][source]

Gets a list of authorization rules for a Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

Returns:

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

Return type:

ItemPaged[AuthorizationRule]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[EHNamespace][source]

Lists the available Namespaces within a resource group.

Parameters:

resource_group_name (str) – Name of the resource group within the azure subscription. Required.

Returns:

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

Return type:

ItemPaged[EHNamespace]

Raises:

HttpResponseError –

list_ip_filter_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[IpFilterRule][source]

Gets a list of IP Filter rules for a Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

Returns:

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

Return type:

ItemPaged[IpFilterRule]

Raises:

HttpResponseError –

list_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) → AccessKeys[source]

Gets the primary and secondary connection strings for the Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • authorization_rule_name (str) – The authorization rule name. Required.

Returns:

AccessKeys or the result of cls(response)

Return type:

AccessKeys

Raises:

HttpResponseError –

list_virtual_network_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[VirtualNetworkRule][source]

Gets a list of VirtualNetwork rules for a Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

Returns:

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

Return type:

ItemPaged[VirtualNetworkRule]

Raises:

HttpResponseError –

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[source]
regenerate_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.AccessKeys

Regenerates the primary or secondary connection strings for the specified Namespace.

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • authorization_rule_name (str) – The authorization rule name. Required.

  • parameters (RegenerateAccessKeyParameters or IO[bytes]) – Parameters required to regenerate the connection string. Is either a RegenerateAccessKeyParameters type or a IO[bytes] type. Required.

Returns:

AccessKeys or the result of cls(response)

Return type:

AccessKeys

Raises:

HttpResponseError –

update(resource_group_name: str, namespace_name: str, parameters: _models.EHNamespace, *, content_type: str = 'application/json', **kwargs: Any) → _models.EHNamespace | None[source]
update(resource_group_name: str, namespace_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.EHNamespace | None

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

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • parameters (EHNamespace or IO[bytes]) – Parameters for updating a namespace resource. Is either a EHNamespace type or a IO[bytes] type. Required.

Returns:

EHNamespace or None or the result of cls(response)

Return type:

EHNamespace or None

Raises:

HttpResponseError –

models = <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>
class azure.mgmt.eventhub.v2018_01_01_preview.operations.Operations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventHubManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[Operation][source]

Lists all of the available Event Hub REST API operations.

Returns:

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

Return type:

ItemPaged[Operation]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>
class azure.mgmt.eventhub.v2018_01_01_preview.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventHubManagementClient’s private_endpoint_connections attribute.

begin_delete(resource_group_name: str, namespace_name: str, private_endpoint_connection_name: str, **kwargs: Any) → LROPoller[None][source]

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

See also

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • private_endpoint_connection_name (str) – The PrivateEndpointConnection name. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

create_or_update(resource_group_name: str, namespace_name: str, private_endpoint_connection_name: str, parameters: _models.PrivateEndpointConnection, *, content_type: str = 'application/json', **kwargs: Any) → _models.PrivateEndpointConnection[source]
create_or_update(resource_group_name: str, namespace_name: str, private_endpoint_connection_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.PrivateEndpointConnection

Creates or updates PrivateEndpointConnections of service namespace.

See also

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • private_endpoint_connection_name (str) – The PrivateEndpointConnection name. Required.

  • parameters (PrivateEndpointConnection or IO[bytes]) – Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns:

PrivateEndpointConnection or the result of cls(response)

Return type:

PrivateEndpointConnection

Raises:

HttpResponseError –

get(resource_group_name: str, namespace_name: str, private_endpoint_connection_name: str, **kwargs: Any) → PrivateEndpointConnection[source]

Gets a description for the specified Private Endpoint Connection name.

See also

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

  • private_endpoint_connection_name (str) – The PrivateEndpointConnection name. Required.

Returns:

PrivateEndpointConnection or the result of cls(response)

Return type:

PrivateEndpointConnection

Raises:

HttpResponseError –

list(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[PrivateEndpointConnection][source]

Gets the available PrivateEndpointConnections within a namespace.

See also

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

Returns:

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

Return type:

ItemPaged[PrivateEndpointConnection]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>
class azure.mgmt.eventhub.v2018_01_01_preview.operations.PrivateLinkResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventHubManagementClient’s private_link_resources attribute.

get(resource_group_name: str, namespace_name: str, **kwargs: Any) → PrivateLinkResourcesListResult[source]

Gets lists of resources that supports Privatelinks.

See also

Parameters:

  • resource_group_name (str) – Name of the resource group within the azure subscription. Required.

  • namespace_name (str) – The Namespace name. Required.

Returns:

PrivateLinkResourcesListResult or the result of cls(response)

Return type:

PrivateLinkResourcesListResult

Raises:

HttpResponseError –

models = <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>
class azure.mgmt.eventhub.v2018_01_01_preview.operations.RegionsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventHubManagementClient’s regions attribute.

list_by_sku(sku: str, **kwargs: Any) → Iterable[MessagingRegions][source]

Gets the available Regions for a given sku.

Parameters:

sku (str) – The sku type. Required.

Returns:

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

Return type:

ItemPaged[MessagingRegions]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>