EventHubsOperations Class

EventHubsOperations async 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) -> None

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.v2017_04_01.models._models_py3.Eventhub, **kwargs: typing.Any) -> azure.mgmt.eventhub.v2017_04_01.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

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.v2017_04_01.models._models_py3.AuthorizationRule, **kwargs: typing.Any) -> azure.mgmt.eventhub.v2017_04_01.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

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: typing.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

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: typing.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

get

Gets an Event Hubs description for the specified Event Hub.

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

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: typing.Any) -> azure.mgmt.eventhub.v2017_04_01.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

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: typing.Any) -> typing.AsyncIterable[_ForwardRef('_models.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

list_by_namespace

Gets all the Event Hubs in a Namespace.

list_by_namespace(resource_group_name: str, namespace_name: str, skip: typing.Union[int, NoneType] = None, top: typing.Union[int, NoneType] = None, **kwargs: typing.Any) -> typing.AsyncIterable[_ForwardRef('_models.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
default value: None

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.

top
int
default value: None

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

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

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: typing.Any) -> azure.mgmt.eventhub.v2017_04_01.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

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.v2017_04_01.models._models_py3.RegenerateAccessKeyParameters, **kwargs: typing.Any) -> azure.mgmt.eventhub.v2017_04_01.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

Attributes

models

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