azure.mgmt.eventhub.v2015_08_01.operations module¶

class azure.mgmt.eventhub.v2015_08_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.ConsumerGroupCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.ConsumerGroupResource[source]¶

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

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

See also

https://msdn.microsoft.com/en-us/library/azure/mt639498.aspx

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 (ConsumerGroupCreateOrUpdateParameters or IO[bytes]) – Parameters supplied to create or update a consumer group resource. Is either a ConsumerGroupCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

ConsumerGroupResource or the result of cls(response)

Return type:

ConsumerGroupResource

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.

See also

https://msdn.microsoft.com/en-us/library/azure/mt639491.aspx

Parameters:

resource_group_name (str) – Name of the resource group within the azure subscription. Required.
namespace_name (str) – The Namespace name. Required.
event_hub_name (str) – The Event Hub name. Required.
consumer_group_name (str) – The consumer group name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

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

Gets a description for the specified consumer group.

See also

https://msdn.microsoft.com/en-us/library/azure/mt639488.aspx

Parameters:

resource_group_name (str) – Name of the resource group within the azure subscription. Required.
namespace_name (str) – The Namespace name. Required.
event_hub_name (str) – The Event Hub name. Required.
consumer_group_name (str) – The consumer group name. Required.

Returns:

ConsumerGroupResource or the result of cls(response)

Return type:

ConsumerGroupResource

Raises:

HttpResponseError –

list_all(resource_group_name: str, namespace_name: str, event_hub_name: str, **kwargs: Any) → Iterable[ConsumerGroupResource][source]¶

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

See also

https://msdn.microsoft.com/en-us/library/azure/mt639503.aspx

Parameters:

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

Returns:

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

Return type:

ItemPaged[ConsumerGroupResource]

Raises:

HttpResponseError –

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

class azure.mgmt.eventhub.v2015_08_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.EventHubCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.EventHubResource[source]¶

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

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

See also

https://msdn.microsoft.com/en-us/library/azure/mt639497.aspx

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 (EventHubCreateOrUpdateParameters or IO[bytes]) – Parameters supplied to create an Event Hub resource. Is either a EventHubCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

EventHubResource or the result of cls(response)

Return type:

EventHubResource

Raises:

HttpResponseError –

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

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

Creates or updates an AuthorizationRule for the specified Event Hub.

See also

https://msdn.microsoft.com/en-us/library/azure/mt706096.aspx

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 (SharedAccessAuthorizationRuleCreateOrUpdateParameters or IO[bytes]) – The shared access AuthorizationRule. Is either a SharedAccessAuthorizationRuleCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

SharedAccessAuthorizationRuleResource or the result of cls(response)

Return type:

SharedAccessAuthorizationRuleResource

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.

See also

https://msdn.microsoft.com/en-us/library/azure/mt639496.aspx

Parameters:

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

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

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

Deletes an Event Hub AuthorizationRule.

See also

https://msdn.microsoft.com/en-us/library/azure/mt706100.aspx

Parameters:

resource_group_name (str) – Name of the resource group within the azure subscription. Required.
namespace_name (str) – The Namespace name. Required.
event_hub_name (str) – The Event Hub name. Required.
authorization_rule_name (str) – The authorization rule name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

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

Gets an Event Hubs description for the specified Event Hub.

See also

https://msdn.microsoft.com/en-us/library/azure/mt639501.aspx

Parameters:

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

Returns:

EventHubResource or the result of cls(response)

Return type:

EventHubResource

Raises:

HttpResponseError –

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

Gets an AuthorizationRule for an Event Hub by rule name.

See also

https://msdn.microsoft.com/en-us/library/azure/mt706097.aspx

Parameters:

resource_group_name (str) – Name of the resource group within the azure subscription. Required.
namespace_name (str) – The Namespace name. Required.
event_hub_name (str) – The Event Hub name. Required.
authorization_rule_name (str) – The authorization rule name. Required.

Returns:

SharedAccessAuthorizationRuleResource or the result of cls(response)

Return type:

SharedAccessAuthorizationRuleResource

Raises:

HttpResponseError –

list_all(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[EventHubResource][source]¶

Gets all the Event Hubs in a Namespace.

See also

https://msdn.microsoft.com/en-us/library/azure/mt639493.aspx

Parameters:

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

Returns:

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

Return type:

ItemPaged[EventHubResource]

Raises:

HttpResponseError –

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

Gets the authorization rules for an Event Hub.

Parameters:

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

Returns:

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

Return type:

ItemPaged[SharedAccessAuthorizationRuleResource]

Raises:

HttpResponseError –

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

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

See also

https://msdn.microsoft.com/en-us/library/azure/mt706098.aspx

Parameters:

resource_group_name (str) – Name of the resource group within the azure subscription. Required.
namespace_name (str) – The Namespace name. Required.
event_hub_name (str) – The Event Hub name. Required.
authorization_rule_name (str) – The authorization rule name. Required.

Returns:

ResourceListKeys or the result of cls(response)

Return type:

ResourceListKeys

Raises:

HttpResponseError –

post_authorization_rule(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, **kwargs: Any) → SharedAccessAuthorizationRuleResource[source]¶

Gets an AuthorizationRule for an Event Hub by rule name.

See also

https://msdn.microsoft.com/en-us/library/azure/mt706097.aspx

Parameters:

resource_group_name (str) – Name of the resource group within the azure subscription. Required.
namespace_name (str) – The Namespace name. Required.
event_hub_name (str) – The Event Hub name. Required.
authorization_rule_name (str) – The authorization rule name. Required.

Returns:

SharedAccessAuthorizationRuleResource or the result of cls(response)

Return type:

SharedAccessAuthorizationRuleResource

Raises:

HttpResponseError –

regenerate_keys(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, parameters: _models.RegenerateKeysParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.ResourceListKeys[source]¶

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

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

See also

https://msdn.microsoft.com/en-us/library/azure/mt706099.aspx

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

Returns:

ResourceListKeys or the result of cls(response)

Return type:

ResourceListKeys

Raises:

HttpResponseError –

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

class azure.mgmt.eventhub.v2015_08_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.NamespaceCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.NamespaceResource][source]¶

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

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 (NamespaceCreateOrUpdateParameters or IO[bytes]) – Parameters for creating a namespace resource. Is either a NamespaceCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[NamespaceResource]

Raises:

HttpResponseError –

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

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

Parameters:

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

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

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

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

Check the give Namespace name availability.

Parameters:: parameters (CheckNameAvailabilityParameter or IO[bytes]) – Parameters to check availability of the given Namespace name. Is either a CheckNameAvailabilityParameter type or a IO[bytes] type. Required.
Returns:: CheckNameAvailabilityResult or the result of cls(response)
Return type:: CheckNameAvailabilityResult
Raises:: HttpResponseError –

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: _models.SharedAccessAuthorizationRuleCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.SharedAccessAuthorizationRuleResource[source]¶

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

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 (SharedAccessAuthorizationRuleCreateOrUpdateParameters or IO[bytes]) – The shared access AuthorizationRule. Is either a SharedAccessAuthorizationRuleCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

SharedAccessAuthorizationRuleResource or the result of cls(response)

Return type:

SharedAccessAuthorizationRuleResource

Raises:

HttpResponseError –

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

Deletes an AuthorizationRule for a Namespace.

Parameters:

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

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

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

Gets the description of the specified namespace.

Parameters:

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

Returns:

NamespaceResource or the result of cls(response)

Return type:

NamespaceResource

Raises:

HttpResponseError –

get_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) → 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. Required.
namespace_name (str) – The Namespace name. Required.
authorization_rule_name (str) – The authorization rule name. Required.

Returns:

SharedAccessAuthorizationRuleResource or the result of cls(response)

Return type:

SharedAccessAuthorizationRuleResource

Raises:

HttpResponseError –

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

Gets a list of authorization rules for a Namespace.

Parameters:

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

Returns:

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

Return type:

ItemPaged[SharedAccessAuthorizationRuleResource]

Raises:

HttpResponseError –

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

Lists the available Namespaces within a resource group.

Parameters:: resource_group_name (str) – Name of the resource group within the azure subscription. Required.
Returns:: An iterator like instance of either NamespaceResource or the result of cls(response)
Return type:: ItemPaged[NamespaceResource]
Raises:: HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[NamespaceResource][source]¶

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

Returns:: An iterator like instance of either NamespaceResource or the result of cls(response)
Return type:: ItemPaged[NamespaceResource]
Raises:: HttpResponseError –

list_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) → 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. Required.
namespace_name (str) – The Namespace name. Required.
authorization_rule_name (str) – The authorization rule name. Required.

Returns:

ResourceListKeys or the result of cls(response)

Return type:

ResourceListKeys

Raises:

HttpResponseError –

regenerate_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: _models.RegenerateKeysParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.ResourceListKeys[source]¶

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

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 (RegenerateKeysParameters or IO[bytes]) – Parameters required to regenerate the connection string. Is either a RegenerateKeysParameters type or a IO[bytes] type. Required.

Returns:

ResourceListKeys or the result of cls(response)

Return type:

ResourceListKeys

Raises:

HttpResponseError –

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

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

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

Parameters:

resource_group_name (str) – Name of the resource group within the azure subscription. Required.
namespace_name (str) – The Namespace name. Required.
parameters (NamespaceUpdateParameter or IO[bytes]) – Parameters for updating a namespace resource. Is either a NamespaceUpdateParameter type or a IO[bytes] type. Required.

Returns:

NamespaceResource or None or the result of cls(response)

Return type:

NamespaceResource or None

Raises:

HttpResponseError –

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

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

Lists all of the available Event Hub REST API operations.

Returns:: An iterator like instance of either Operation or the result of cls(response)
Return type:: ItemPaged[Operation]
Raises:: HttpResponseError –

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