EventHubsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:event_hubs> attribute.
- Inheritance
-
builtins.objectEventHubsOperations
Constructor
EventHubsOperations(*args, **kwargs)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: _models.Eventhub, *, content_type: str = 'application/json', **kwargs: Any) -> _models.EventhubParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
namespace_name
Required
|
The Namespace name. Required. |
|
event_hub_name
Required
|
The Event Hub name. Required. |
|
parameters
Required
|
Parameters supplied to create an Event Hub resource. Is either a Eventhub type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Eventhub or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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: _models.AuthorizationRule, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AuthorizationRuleParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
namespace_name
Required
|
The Namespace name. Required. |
|
event_hub_name
Required
|
The Event Hub name. Required. |
|
authorization_rule_name
Required
|
The authorization rule name. Required. |
|
parameters
Required
|
The shared access AuthorizationRule. Is either a AuthorizationRule type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
AuthorizationRule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
namespace_name
Required
|
The Namespace name. Required. |
|
event_hub_name
Required
|
The Event Hub name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
namespace_name
Required
|
The Namespace name. Required. |
|
event_hub_name
Required
|
The Event Hub name. Required. |
|
authorization_rule_name
Required
|
The authorization rule name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> EventhubParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
namespace_name
Required
|
The Namespace name. Required. |
|
event_hub_name
Required
|
The Event Hub name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Eventhub or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> AuthorizationRuleParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
namespace_name
Required
|
The Namespace name. Required. |
|
event_hub_name
Required
|
The Event Hub name. Required. |
|
authorization_rule_name
Required
|
The authorization rule name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
AuthorizationRule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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[AuthorizationRule]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
namespace_name
Required
|
The Namespace name. Required. |
|
event_hub_name
Required
|
The Event Hub name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either AuthorizationRule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_namespace
Gets all the Event Hubs in a Namespace.
list_by_namespace(resource_group_name: str, namespace_name: str, skip: int | None = None, top: int | None = None, **kwargs: Any) -> Iterable[Eventhub]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
namespace_name
Required
|
The Namespace name. Required. |
|
skip
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
Required
|
May be used to limit the number of results to the most recent N usageDetails. Default value is None. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Eventhub or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> AccessKeysParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
namespace_name
Required
|
The Namespace name. Required. |
|
event_hub_name
Required
|
The Event Hub name. Required. |
|
authorization_rule_name
Required
|
The authorization rule name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
AccessKeys or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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: _models.RegenerateAccessKeyParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AccessKeysParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
namespace_name
Required
|
The Namespace name. Required. |
|
event_hub_name
Required
|
The Event Hub name. Required. |
|
authorization_rule_name
Required
|
The authorization rule name. Required. |
|
parameters
Required
|
Parameters supplied to regenerate the AuthorizationRule Keys (PrimaryKey/SecondaryKey). Is either a RegenerateAccessKeyParameters type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
AccessKeys or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.eventhub.v2021_01_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventhub\\v2021_01_01_preview\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for