azure.mgmt.eventhub.v2017_04_01.operations module

class azure.mgmt.eventhub.v2017_04_01.operations.ConsumerGroupsOperations(client, config, serializer, deserializer)[source]

Bases: object

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

Variables

models – Alias to model classes used in this operation group.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

create_or_update(resource_group_name: str, namespace_name: str, event_hub_name: str, consumer_group_name: str, parameters: ‘models.ConsumerGroup’, **kwargs: Any) → ’models.ConsumerGroup’[source]

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.

  • namespace_name (str) – The Namespace name.

  • event_hub_name (str) – The Event Hub name.

  • consumer_group_name (str) – The consumer group name.

  • parameters (ConsumerGroup) – Parameters supplied to create or update a consumer group resource.

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

ConsumerGroup

Raises

~azure.core.exceptions.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.

  • namespace_name (str) – The Namespace name.

  • event_hub_name (str) – The Event Hub name.

  • consumer_group_name (str) – The consumer group name.

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

None

Raises

~azure.core.exceptions.HttpResponseError

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

Gets a description for the specified consumer group.

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

  • namespace_name (str) – The Namespace name.

  • event_hub_name (str) – The Event Hub name.

  • consumer_group_name (str) – The consumer group name.

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

ConsumerGroup

Raises

~azure.core.exceptions.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[‘models.ConsumerGroupListResult’][source]

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

param resource_group_name

Name of the resource group within the azure subscription.

type resource_group_name

str

param namespace_name

The Namespace name.

type namespace_name

str

param event_hub_name

The Event Hub name.

type event_hub_name

str

param skip

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.

type skip

int

param top

May be used to limit the number of results to the most recent N usageDetails.

type top

int

keyword callable cls

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

return

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

rtype

~azure.core.paging.ItemPaged[~azure.mgmt.eventhub.v2017_04_01.models.ConsumerGroupListResult]

raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.eventhub.v2017_04_01.models' from '/home/vsts/work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/eventhub/v2017_04_01/models/__init__.py'>
class azure.mgmt.eventhub.v2017_04_01.operations.DisasterRecoveryConfigsOperations(client, config, serializer, deserializer)[source]

Bases: object

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

Variables

models – Alias to model classes used in this operation group.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

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.

  • namespace_name (str) – The Namespace name.

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

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

None

Raises

~azure.core.exceptions.HttpResponseError

check_name_availability(resource_group_name: str, namespace_name: str, parameters: ‘models.CheckNameAvailabilityParameter’, **kwargs: Any) → ’models.CheckNameAvailabilityResult’[source]

Check the give Namespace name availability.

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

  • namespace_name (str) – The Namespace name.

  • parameters (CheckNameAvailabilityParameter) – Parameters to check availability of the given Alias name.

Keyword Arguments

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

~azure.core.exceptions.HttpResponseError

create_or_update(resource_group_name: str, namespace_name: str, alias: str, parameters: ‘models.ArmDisasterRecovery’, **kwargs: Any) → ’models.ArmDisasterRecovery’[source]

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

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

  • namespace_name (str) – The Namespace name.

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

  • parameters (ArmDisasterRecovery) – Parameters required to create an Alias(Disaster Recovery configuration).

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 or None

Raises

~azure.core.exceptions.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.

  • namespace_name (str) – The Namespace name.

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

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

None

Raises

~azure.core.exceptions.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.

  • namespace_name (str) – The Namespace name.

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

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

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) → ’models.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.

  • namespace_name (str) – The Namespace name.

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

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

~azure.core.exceptions.HttpResponseError

get_authorization_rule(resource_group_name: str, namespace_name: str, alias: str, authorization_rule_name: str, **kwargs: Any) → ’models.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.

  • namespace_name (str) – The Namespace name.

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

  • authorization_rule_name (str) – The authorization rule name.

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

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[‘models.ArmDisasterRecoveryListResult’][source]

Gets all Alias(Disaster Recovery configurations).

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

  • namespace_name (str) – The Namespace name.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ArmDisasterRecoveryListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_authorization_rules(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) → Iterable[‘models.AuthorizationRuleListResult’][source]

Gets a list of authorization rules for a Namespace.

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

  • namespace_name (str) – The Namespace name.

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

Keyword Arguments

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]

Raises

~azure.core.exceptions.HttpResponseError

list_keys(resource_group_name: str, namespace_name: str, alias: str, authorization_rule_name: str, **kwargs: Any) → ’models.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.

  • namespace_name (str) – The Namespace name.

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

  • authorization_rule_name (str) – The authorization rule name.

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

AccessKeys

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.eventhub.v2017_04_01.models' from '/home/vsts/work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/eventhub/v2017_04_01/models/__init__.py'>
class azure.mgmt.eventhub.v2017_04_01.operations.EventHubsOperations(client, config, serializer, deserializer)[source]

Bases: object

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

Variables

models – Alias to model classes used in this operation group.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

create_or_update(resource_group_name: str, namespace_name: str, event_hub_name: str, parameters: ‘models.Eventhub’, **kwargs: Any) → ’models.Eventhub’[source]

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.

  • namespace_name (str) – The Namespace name.

  • event_hub_name (str) – The Event Hub name.

  • parameters (Eventhub) – Parameters supplied to create an Event Hub resource.

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

Eventhub

Raises

~azure.core.exceptions.HttpResponseError

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, parameters: ‘models.AuthorizationRule’, **kwargs: Any) → ’models.AuthorizationRule’[source]

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.

  • namespace_name (str) – The Namespace name.

  • event_hub_name (str) – The Event Hub name.

  • authorization_rule_name (str) – The authorization rule name.

  • parameters (AuthorizationRule) – The shared access AuthorizationRule.

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

~azure.core.exceptions.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.

  • namespace_name (str) – The Namespace name.

  • event_hub_name (str) – The Event Hub name.

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

None

Raises

~azure.core.exceptions.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.

  • namespace_name (str) – The Namespace name.

  • event_hub_name (str) – The Event Hub name.

  • authorization_rule_name (str) – The authorization rule name.

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

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, namespace_name: str, event_hub_name: str, **kwargs: Any) → ’models.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.

  • namespace_name (str) – The Namespace name.

  • event_hub_name (str) – The Event Hub name.

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

Eventhub

Raises

~azure.core.exceptions.HttpResponseError

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

  • namespace_name (str) – The Namespace name.

  • event_hub_name (str) – The Event Hub name.

  • authorization_rule_name (str) – The authorization rule name.

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

~azure.core.exceptions.HttpResponseError

list_authorization_rules(resource_group_name: str, namespace_name: str, event_hub_name: str, **kwargs: Any) → Iterable[‘models.AuthorizationRuleListResult’][source]

Gets the authorization rules for an Event Hub.

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

  • namespace_name (str) – The Namespace name.

  • event_hub_name (str) – The Event Hub name.

Keyword Arguments

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]

Raises

~azure.core.exceptions.HttpResponseError

list_by_namespace(resource_group_name: str, namespace_name: str, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[‘models.EventHubListResult’][source]

Gets all the Event Hubs in a Namespace.

param resource_group_name

Name of the resource group within the azure subscription.

type resource_group_name

str

param namespace_name

The Namespace name.

type namespace_name

str

param skip

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.

type skip

int

param top

May be used to limit the number of results to the most recent N usageDetails.

type top

int

keyword callable cls

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

return

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

rtype

~azure.core.paging.ItemPaged[~azure.mgmt.eventhub.v2017_04_01.models.EventHubListResult]

raises

~azure.core.exceptions.HttpResponseError

list_keys(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, **kwargs: Any) → ’models.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.

  • namespace_name (str) – The Namespace name.

  • event_hub_name (str) – The Event Hub name.

  • authorization_rule_name (str) – The authorization rule name.

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

AccessKeys

Raises

~azure.core.exceptions.HttpResponseError

regenerate_keys(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, parameters: ‘models.RegenerateAccessKeyParameters’, **kwargs: Any) → ’models.AccessKeys’[source]

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.

  • namespace_name (str) – The Namespace name.

  • event_hub_name (str) – The Event Hub name.

  • authorization_rule_name (str) – The authorization rule name.

  • parameters (RegenerateAccessKeyParameters) – Parameters supplied to regenerate the AuthorizationRule Keys (PrimaryKey/SecondaryKey).

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

AccessKeys

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.eventhub.v2017_04_01.models' from '/home/vsts/work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/eventhub/v2017_04_01/models/__init__.py'>
class azure.mgmt.eventhub.v2017_04_01.operations.NamespacesOperations(client, config, serializer, deserializer)[source]

Bases: object

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.

Variables

models – Alias to model classes used in this operation group.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, namespace_name: str, parameters: ‘models.EHNamespace’, **kwargs: Any) → LROPoller[source]

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

param resource_group_name

Name of the resource group within the azure subscription.

type resource_group_name

str

param namespace_name

The Namespace name.

type namespace_name

str

param parameters

Parameters for creating a namespace resource.

type parameters

~azure.mgmt.eventhub.v2017_04_01.models.EHNamespace

keyword callable cls

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

keyword str continuation_token

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

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

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

return

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

rtype

~azure.core.polling.LROPoller[~azure.mgmt.eventhub.v2017_04_01.models.EHNamespace]

raises ~azure.core.exceptions.HttpResponseError

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

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

param resource_group_name

Name of the resource group within the azure subscription.

type resource_group_name

str

param namespace_name

The Namespace name.

type namespace_name

str

keyword callable cls

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

keyword str continuation_token

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

keyword polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

paramtype polling

bool or ~azure.core.polling.PollingMethod

keyword int polling_interval

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

return

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

rtype

~azure.core.polling.LROPoller[None]

raises ~azure.core.exceptions.HttpResponseError

check_name_availability(parameters: ‘models.CheckNameAvailabilityParameter’, **kwargs: Any) → ’models.CheckNameAvailabilityResult’[source]

Check the give Namespace name availability.

Parameters

parameters (CheckNameAvailabilityParameter) – Parameters to check availability of the given Namespace name.

Keyword Arguments

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

~azure.core.exceptions.HttpResponseError

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: ‘models.AuthorizationRule’, **kwargs: Any) → ’models.AuthorizationRule’[source]

Creates or updates an AuthorizationRule for a Namespace.

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

  • namespace_name (str) – The Namespace name.

  • authorization_rule_name (str) – The authorization rule name.

  • parameters (AuthorizationRule) – The shared access AuthorizationRule.

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

~azure.core.exceptions.HttpResponseError

create_or_update_network_rule_set(resource_group_name: str, namespace_name: str, parameters: ‘models.NetworkRuleSet’, **kwargs: Any) → ’models.NetworkRuleSet’[source]

Create or update NetworkRuleSet for a Namespace.

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

  • namespace_name (str) – The Namespace name.

  • parameters (NetworkRuleSet) – The Namespace IpFilterRule.

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

NetworkRuleSet

Raises

~azure.core.exceptions.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.

  • namespace_name (str) – The Namespace name.

  • authorization_rule_name (str) – The authorization rule name.

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

None

Raises

~azure.core.exceptions.HttpResponseError

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

Gets the description of the specified namespace.

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

  • namespace_name (str) – The Namespace name.

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

EHNamespace

Raises

~azure.core.exceptions.HttpResponseError

get_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) → ’models.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.

  • namespace_name (str) – The Namespace name.

  • authorization_rule_name (str) – The authorization rule name.

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

~azure.core.exceptions.HttpResponseError

get_messaging_plan(resource_group_name: str, namespace_name: str, **kwargs: Any) → ’models.MessagingPlan’[source]

Gets messaging plan for specified namespace.

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

  • namespace_name (str) – The Namespace name.

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

MessagingPlan

Raises

~azure.core.exceptions.HttpResponseError

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

Gets NetworkRuleSet for a Namespace.

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

  • namespace_name (str) – The Namespace name.

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

NetworkRuleSet

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘models.EHNamespaceListResult’][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 EHNamespaceListResult or the result of cls(response)

Return type

ItemPaged[EHNamespaceListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_authorization_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[‘models.AuthorizationRuleListResult’][source]

Gets a list of authorization rules for a Namespace.

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

  • namespace_name (str) – The Namespace name.

Keyword Arguments

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]

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘models.EHNamespaceListResult’][source]

Lists the available Namespaces within a resource group.

Parameters

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

Keyword Arguments

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]

Raises

~azure.core.exceptions.HttpResponseError

list_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) → ’models.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.

  • namespace_name (str) – The Namespace name.

  • authorization_rule_name (str) – The authorization rule name.

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

AccessKeys

Raises

~azure.core.exceptions.HttpResponseError

list_network_rule_sets(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[‘models.NetworkRuleSetListResult’][source]

Gets list of NetworkRuleSet for a Namespace.

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

  • namespace_name (str) – The Namespace name.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[NetworkRuleSetListResult]

Raises

~azure.core.exceptions.HttpResponseError

regenerate_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: ‘models.RegenerateAccessKeyParameters’, **kwargs: Any) → ’models.AccessKeys’[source]

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.

  • namespace_name (str) – The Namespace name.

  • authorization_rule_name (str) – The authorization rule name.

  • parameters (RegenerateAccessKeyParameters) – Parameters required to regenerate the connection string.

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

AccessKeys

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, namespace_name: str, parameters: ‘models.EHNamespace’, **kwargs: Any) → ’models.EHNamespace’[source]

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.

  • namespace_name (str) – The Namespace name.

  • parameters (EHNamespace) – Parameters for updating a namespace resource.

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

EHNamespace or None

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.eventhub.v2017_04_01.models' from '/home/vsts/work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/eventhub/v2017_04_01/models/__init__.py'>
class azure.mgmt.eventhub.v2017_04_01.operations.Operations(client, config, serializer, deserializer)[source]

Bases: object

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

Variables

models – Alias to model classes used in this operation group.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

list(**kwargs: Any) → Iterable[‘models.OperationListResult’][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 OperationListResult or the result of cls(response)

Return type

ItemPaged[OperationListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.eventhub.v2017_04_01.models' from '/home/vsts/work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/eventhub/v2017_04_01/models/__init__.py'>
class azure.mgmt.eventhub.v2017_04_01.operations.RegionsOperations(client, config, serializer, deserializer)[source]

Bases: object

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

Variables

models – Alias to model classes used in this operation group.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

list_by_sku(sku: str, **kwargs: Any) → Iterable[‘models.MessagingRegionsListResult’][source]

Gets the available Regions for a given sku.

Parameters

sku (str) – The sku type.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MessagingRegionsListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.eventhub.v2017_04_01.models' from '/home/vsts/work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/eventhub/v2017_04_01/models/__init__.py'>