EventHubsOperations Class

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.

Inheritance

builtins.object

EventHubsOperations

Constructor

EventHubsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

create_or_update	Creates or updates a new Event Hub as a nested resource within a Namespace.
create_or_update_authorization_rule	Creates or updates an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.
delete	Deletes an Event Hub from the specified Namespace and resource group.
delete_authorization_rule	Deletes an Event Hub AuthorizationRule.
get	Gets an Event Hubs description for the specified Event Hub.
get_authorization_rule	Gets an AuthorizationRule for an Event Hub by rule name.
list_authorization_rules	Gets the authorization rules for an Event Hub.
list_by_namespace	Gets all the Event Hubs in a Namespace.
list_keys	Gets the ACS and SAS connection strings for the Event Hub.
regenerate_keys	Regenerates the ACS and SAS connection strings for the Event Hub.

create_or_update

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

create_or_update(resource_group_name: str, namespace_name: str, event_hub_name: str, parameters: azure.mgmt.eventhub.v2021_01_01_preview.models._models_py3.Eventhub, **kwargs: Any) -> azure.mgmt.eventhub.v2021_01_01_preview.models._models_py3.Eventhub

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

event_hub_name

str

Required

The Event Hub name.

parameters

Eventhub

Required

Parameters supplied to create an Event Hub resource.

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

Exceptions

HttpResponseError

create_or_update_authorization_rule

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

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, parameters: azure.mgmt.eventhub.v2021_01_01_preview.models._models_py3.AuthorizationRule, **kwargs: Any) -> azure.mgmt.eventhub.v2021_01_01_preview.models._models_py3.AuthorizationRule

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

event_hub_name

str

Required

The Event Hub name.

authorization_rule_name

str

Required

The authorization rule name.

parameters

AuthorizationRule

Required

The shared access AuthorizationRule.

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

Exceptions

HttpResponseError

delete

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

delete(resource_group_name: str, namespace_name: str, event_hub_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

event_hub_name

str

Required

The Event Hub name.

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

Exceptions

HttpResponseError

delete_authorization_rule

Deletes an Event Hub AuthorizationRule.

delete_authorization_rule(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

event_hub_name

str

Required

The Event Hub name.

authorization_rule_name

str

Required

The authorization rule name.

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

Exceptions

HttpResponseError

get

Gets an Event Hubs description for the specified Event Hub.

get(resource_group_name: str, namespace_name: str, event_hub_name: str, **kwargs: Any) -> azure.mgmt.eventhub.v2021_01_01_preview.models._models_py3.Eventhub

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

event_hub_name

str

Required

The Event Hub name.

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

Exceptions

HttpResponseError

get_authorization_rule

Gets an AuthorizationRule for an Event Hub by rule name.

get_authorization_rule(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, **kwargs: Any) -> azure.mgmt.eventhub.v2021_01_01_preview.models._models_py3.AuthorizationRule

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

event_hub_name

str

Required

The Event Hub name.

authorization_rule_name

str

Required

The authorization rule name.

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

Exceptions

HttpResponseError

list_authorization_rules

Gets the authorization rules for an Event Hub.

list_authorization_rules(resource_group_name: str, namespace_name: str, event_hub_name: str, **kwargs: Any) -> Iterable[azure.mgmt.eventhub.v2021_01_01_preview.models._models_py3.AuthorizationRuleListResult]

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

event_hub_name

str

Required

The Event Hub name.

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]

Exceptions

HttpResponseError

list_by_namespace

Gets all the Event Hubs in a Namespace.

list_by_namespace(resource_group_name: str, namespace_name: str, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.eventhub.v2021_01_01_preview.models._models_py3.EventHubListResult]

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

skip

int

Required

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

Required

May be used to limit the number of results to the most recent N usageDetails. Default value is None.

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]

Exceptions

HttpResponseError

list_keys

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

list_keys(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, **kwargs: Any) -> azure.mgmt.eventhub.v2021_01_01_preview.models._models_py3.AccessKeys

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

event_hub_name

str

Required

The Event Hub name.

authorization_rule_name

str

Required

The authorization rule name.

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

Exceptions

HttpResponseError

regenerate_keys

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

regenerate_keys(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, parameters: azure.mgmt.eventhub.v2021_01_01_preview.models._models_py3.RegenerateAccessKeyParameters, **kwargs: Any) -> azure.mgmt.eventhub.v2021_01_01_preview.models._models_py3.AccessKeys

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

event_hub_name

str

Required

The Event Hub name.

authorization_rule_name

str

Required

The authorization rule name.

parameters

RegenerateAccessKeyParameters

Required

Parameters supplied to regenerate the AuthorizationRule Keys (PrimaryKey/SecondaryKey).

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

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.eventhub.v2021_01_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\eventhub\\v2021_01_01_preview\\models\\__init__.py'>