azure.mgmt.eventhub.v2017_04_01.operations module¶

class azure.mgmt.eventhub.v2017_04_01.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, *, 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) – Parameters supplied to create or update a consumer group resource. Is either a ConsumerGroup type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

ConsumerGroup or the result of cls(response)

Return type

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, namespace_name: str, event_hub_name: str, consumer_group_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2017_04_01.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ConsumerGroup or the result of cls(response)

Return type

Raises

HttpResponseError –

list_by_event_hub(resource_group_name: str, namespace_name: str, event_hub_name: str, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2017_04_01.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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.v2017_04_01.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2017_04_01/models/__init__.py'>¶

class azure.mgmt.eventhub.v2017_04_01.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

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, *, 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) – Parameters to check availability of the given Alias name. Is either a CheckNameAvailabilityParameter type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

Raises

HttpResponseError –

create_or_update(resource_group_name: str, namespace_name: str, alias: str, parameters: _models.ArmDisasterRecovery, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_models.ArmDisasterRecovery][source]¶

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

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) – Parameters required to create an Alias(Disaster Recovery configuration). Is either a ArmDisasterRecovery type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) → azure.mgmt.eventhub.v2017_04_01.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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) → azure.mgmt.eventhub.v2017_04_01.models._models_py3.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.

Keyword Arguments

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

Raises

HttpResponseError –

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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[azure.mgmt.eventhub.v2017_04_01.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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) → azure.mgmt.eventhub.v2017_04_01.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessKeys or the result of cls(response)

Return type

Raises

HttpResponseError –

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

class azure.mgmt.eventhub.v2017_04_01.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, *, 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) – Parameters supplied to create an Event Hub resource. Is either a Eventhub type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Eventhub or the result of cls(response)

Return type

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, *, 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) – The shared access AuthorizationRule. Is either a AuthorizationRule type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, namespace_name: str, event_hub_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2017_04_01.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Eventhub or the result of cls(response)

Return type

Raises

HttpResponseError –

get_authorization_rule(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2017_04_01.models._models_py3.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.

Keyword Arguments

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

Raises

HttpResponseError –

list_authorization_rules(resource_group_name: str, namespace_name: str, event_hub_name: str, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2017_04_01.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2017_04_01.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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) → azure.mgmt.eventhub.v2017_04_01.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessKeys or the result of cls(response)

Return type

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, *, 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) – Parameters supplied to regenerate the AuthorizationRule Keys (PrimaryKey/SecondaryKey). Is either a RegenerateAccessKeyParameters type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessKeys or the result of cls(response)

Return type

Raises

HttpResponseError –

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

class azure.mgmt.eventhub.v2017_04_01.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, *, 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) – Parameters for creating a namespace resource. Is either a EHNamespace type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, namespace_name: str, **kwargs: Any) → azure.core.polling._poller.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.

Keyword Arguments

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]

Raises

HttpResponseError –

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

check_name_availability(parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityResult

Check the give Namespace name availability.

Parameters

parameters (CheckNameAvailabilityParameter or IO) – Parameters to check availability of the given Namespace name. Is either a CheckNameAvailabilityParameter type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

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, *, 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) – The shared access AuthorizationRule. Is either a AuthorizationRule type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

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, *, 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) – The Namespace IpFilterRule. Is either a NetworkRuleSet type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

NetworkRuleSet or the result of cls(response)

Return type

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EHNamespace or the result of cls(response)

Return type

Raises

HttpResponseError –

get_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2017_04_01.models._models_py3.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.

Keyword Arguments

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

Raises

HttpResponseError –

get_messaging_plan(resource_group_name: str, namespace_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2017_04_01.models._models_py3.MessagingPlan[source]¶

Gets messaging plan for specified namespace.

Parameters

resource_group_name (str) – Name of the resource group within the azure subscription. Required.
namespace_name (str) – The Namespace name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

MessagingPlan or the result of cls(response)

Return type

Raises

HttpResponseError –

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NetworkRuleSet or the result of cls(response)

Return type

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.eventhub.v2017_04_01.models._models_py3.EHNamespace][source]¶

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

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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[azure.mgmt.eventhub.v2017_04_01.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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[azure.mgmt.eventhub.v2017_04_01.models._models_py3.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.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either EHNamespace or the result of cls(response)
Return type: ItemPaged[EHNamespace]
Raises: HttpResponseError –

list_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2017_04_01.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessKeys or the result of cls(response)

Return type

Raises

HttpResponseError –

list_network_rule_sets(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2017_04_01.models._models_py3.NetworkRuleSet][source]¶

Gets list of 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[NetworkRuleSet]

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, *, 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) – Parameters required to regenerate the connection string. Is either a RegenerateAccessKeyParameters type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessKeys or the result of cls(response)

Return type

Raises

HttpResponseError –

update(resource_group_name: str, namespace_name: str, parameters: _models.EHNamespace, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_models.EHNamespace][source]¶

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

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

EHNamespace or None or the result of cls(response)

Return type

EHNamespace or None

Raises

HttpResponseError –

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

class azure.mgmt.eventhub.v2017_04_01.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[azure.mgmt.eventhub.v2017_04_01.models._models_py3.Operation][source]¶

Lists all of the available Event Hub REST API operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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.v2017_04_01.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2017_04_01/models/__init__.py'>¶

class azure.mgmt.eventhub.v2017_04_01.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[azure.mgmt.eventhub.v2017_04_01.models._models_py3.MessagingRegions][source]¶

Gets the available Regions for a given sku.

Parameters: sku (str) – The sku type. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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.v2017_04_01.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2017_04_01/models/__init__.py'>¶