azure.mgmt.eventhub.v2015_08_01.operations module

class azure.mgmt.eventhub.v2015_08_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.ConsumerGroupCreateOrUpdateParameters’, **kwargs: Any) → ’models.ConsumerGroupResource’[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 (ConsumerGroupCreateOrUpdateParameters) – 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

ConsumerGroupResource, or the result of cls(response)

Return type

ConsumerGroupResource

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.ConsumerGroupResource’[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

ConsumerGroupResource, or the result of cls(response)

Return type

ConsumerGroupResource

Raises

~azure.core.exceptions.HttpResponseError

list_all(resource_group_name: str, namespace_name: str, event_hub_name: str, **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

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.v2015_08_01.models.ConsumerGroupListResult]

raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.eventhub.v2015_08_01.models' from '/home/vsts/work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/eventhub/v2015_08_01/models/__init__.py'>
class azure.mgmt.eventhub.v2015_08_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.EventHubCreateOrUpdateParameters’, **kwargs: Any) → ’models.EventHubResource’[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 (EventHubCreateOrUpdateParameters) – 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

EventHubResource, or the result of cls(response)

Return type

EventHubResource

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.SharedAccessAuthorizationRuleCreateOrUpdateParameters’, **kwargs: Any) → ’models.SharedAccessAuthorizationRuleResource’[source]

Creates or updates an AuthorizationRule 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.

  • authorization_rule_name (str) – The authorization rule name.

  • parameters (SharedAccessAuthorizationRuleCreateOrUpdateParameters) – The shared access AuthorizationRule.

Keyword Arguments

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

Returns

SharedAccessAuthorizationRuleResource, or the result of cls(response)

Return type

SharedAccessAuthorizationRuleResource

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.EventHubResource’[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

EventHubResource, or the result of cls(response)

Return type

EventHubResource

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.SharedAccessAuthorizationRuleResource’[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

SharedAccessAuthorizationRuleResource, or the result of cls(response)

Return type

SharedAccessAuthorizationRuleResource

Raises

~azure.core.exceptions.HttpResponseError

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

Gets all the Event Hubs in 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 EventHubListResult or the result of cls(response)

Return type

ItemPaged[EventHubListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_authorization_rules(resource_group_name: str, namespace_name: str, event_hub_name: str, **kwargs: Any) → Iterable[‘models.SharedAccessAuthorizationRuleListResult’][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 SharedAccessAuthorizationRuleListResult or the result of cls(response)

Return type

ItemPaged[SharedAccessAuthorizationRuleListResult]

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.ResourceListKeys’[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

ResourceListKeys, or the result of cls(response)

Return type

ResourceListKeys

Raises

~azure.core.exceptions.HttpResponseError

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

SharedAccessAuthorizationRuleResource, or the result of cls(response)

Return type

SharedAccessAuthorizationRuleResource

Raises

~azure.core.exceptions.HttpResponseError

regenerate_keys(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, parameters: ‘models.RegenerateKeysParameters’, **kwargs: Any) → ’models.ResourceListKeys’[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 (RegenerateKeysParameters) – 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

ResourceListKeys, or the result of cls(response)

Return type

ResourceListKeys

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.eventhub.v2015_08_01.models' from '/home/vsts/work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/eventhub/v2015_08_01/models/__init__.py'>
class azure.mgmt.eventhub.v2015_08_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.NamespaceCreateOrUpdateParameters’, **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.v2015_08_01.models.NamespaceCreateOrUpdateParameters

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

rtype

~azure.core.polling.LROPoller[~azure.mgmt.eventhub.v2015_08_01.models.NamespaceResource]

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.SharedAccessAuthorizationRuleCreateOrUpdateParameters’, **kwargs: Any) → ’models.SharedAccessAuthorizationRuleResource’[source]

Creates or updates an AuthorizationRule for a Namespace.

Parameters
Keyword Arguments

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

Returns

SharedAccessAuthorizationRuleResource, or the result of cls(response)

Return type

SharedAccessAuthorizationRuleResource

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.NamespaceResource’[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

NamespaceResource, or the result of cls(response)

Return type

NamespaceResource

Raises

~azure.core.exceptions.HttpResponseError

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

SharedAccessAuthorizationRuleResource, or the result of cls(response)

Return type

SharedAccessAuthorizationRuleResource

Raises

~azure.core.exceptions.HttpResponseError

list_authorization_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[‘models.SharedAccessAuthorizationRuleListResult’][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 SharedAccessAuthorizationRuleListResult or the result of cls(response)

Return type

ItemPaged[SharedAccessAuthorizationRuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

Return type

ItemPaged[NamespaceListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

Return type

ItemPaged[NamespaceListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

ResourceListKeys, or the result of cls(response)

Return type

ResourceListKeys

Raises

~azure.core.exceptions.HttpResponseError

regenerate_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: ‘models.RegenerateKeysParameters’, **kwargs: Any) → ’models.ResourceListKeys’[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 (RegenerateKeysParameters) – Parameters required to regenerate the connection string.

Keyword Arguments

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

Returns

ResourceListKeys, or the result of cls(response)

Return type

ResourceListKeys

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, namespace_name: str, parameters: ‘models.NamespaceUpdateParameter’, **kwargs: Any) → ’models.NamespaceResource’[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 (NamespaceUpdateParameter) – Parameters for updating a namespace resource.

Keyword Arguments

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

Returns

NamespaceResource, or the result of cls(response)

Return type

NamespaceResource or None

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.eventhub.v2015_08_01.models' from '/home/vsts/work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/eventhub/v2015_08_01/models/__init__.py'>
class azure.mgmt.eventhub.v2015_08_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.v2015_08_01.models' from '/home/vsts/work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/eventhub/v2015_08_01/models/__init__.py'>