azure.mgmt.eventhub.v2015_08_01.operations module¶
-
class
azure.mgmt.eventhub.v2015_08_01.operations.ConsumerGroupsOperations(*args, **kwargs)[source]¶ Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
EventHubManagementClient’sconsumer_groupsattribute.-
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, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ConsumerGroupResource 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. 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) – Parameters supplied to create or update a consumer group resource. Is either a ConsumerGroupCreateOrUpdateParameters type or a IO type. Required.
- Keyword Arguments
- Returns
ConsumerGroupResource or the result of cls(response)
- Return type
- Raises
-
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
- 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
- Raises
-
get(resource_group_name: str, namespace_name: str, event_hub_name: str, consumer_group_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2015_08_01.models._models_py3.ConsumerGroupResource[source]¶ Gets a description for the specified consumer group.
- Parameters
- 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
- Raises
-
list_all(resource_group_name: str, namespace_name: str, event_hub_name: str, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2015_08_01.models._models_py3.ConsumerGroupResource][source]¶ Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ConsumerGroupResource or the result of cls(response)
- Return type
- Raises
-
models= <module 'azure.mgmt.eventhub.v2015_08_01.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2015_08_01/models/__init__.py'>¶
-
-
class
azure.mgmt.eventhub.v2015_08_01.operations.EventHubsOperations(*args, **kwargs)[source]¶ Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
EventHubManagementClient’sevent_hubsattribute.-
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, *, content_type: str = "'application/json'", **kwargs: Any) → _models.EventHubResource 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. Required.
namespace_name (str) – The Namespace name. Required.
event_hub_name (str) – The Event Hub name. Required.
parameters (EventHubCreateOrUpdateParameters or IO) – Parameters supplied to create an Event Hub resource. Is either a EventHubCreateOrUpdateParameters type or a IO type. Required.
- Keyword Arguments
- Returns
EventHubResource or the result of cls(response)
- Return type
- Raises
-
create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SharedAccessAuthorizationRuleResource Creates or updates an AuthorizationRule for the specified 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.
authorization_rule_name (str) – The authorization rule name. Required.
parameters (SharedAccessAuthorizationRuleCreateOrUpdateParameters or IO) – The shared access AuthorizationRule. Is either a SharedAccessAuthorizationRuleCreateOrUpdateParameters type or a IO type. Required.
- Keyword Arguments
- Returns
SharedAccessAuthorizationRuleResource or the result of cls(response)
- Return type
- Raises
-
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
- 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
- Raises
Deletes an Event Hub AuthorizationRule.
- Parameters
- 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
- Raises
-
get(resource_group_name: str, namespace_name: str, event_hub_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2015_08_01.models._models_py3.EventHubResource[source]¶ Gets an Event Hubs description for the specified Event Hub.
- Parameters
- 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
- Raises
Gets an AuthorizationRule for an Event Hub by rule name.
- 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
- Raises
-
list_all(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2015_08_01.models._models_py3.EventHubResource][source]¶ Gets all the Event Hubs in a Namespace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either EventHubResource or the result of cls(response)
- Return type
- Raises
Gets the authorization rules for an Event Hub.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either SharedAccessAuthorizationRuleResource or the result of cls(response)
- Return type
- Raises
-
list_keys(resource_group_name: str, namespace_name: str, event_hub_name: str, authorization_rule_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2015_08_01.models._models_py3.ResourceListKeys[source]¶ Gets the ACS and SAS connection strings for the Event Hub.
- Parameters
- 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
- Raises
Gets an AuthorizationRule for an Event Hub by rule name.
- 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
- Raises
-
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, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ResourceListKeys 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. 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) – Parameters supplied to regenerate the AuthorizationRule Keys (PrimaryKey/SecondaryKey). Is either a RegenerateKeysParameters type or a IO type. Required.
- Keyword Arguments
- Returns
ResourceListKeys or the result of cls(response)
- Return type
- Raises
-
models= <module 'azure.mgmt.eventhub.v2015_08_01.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2015_08_01/models/__init__.py'>¶
-
-
class
azure.mgmt.eventhub.v2015_08_01.operations.NamespacesOperations(*args, **kwargs)[source]¶ Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
EventHubManagementClient’snamespacesattribute.-
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, *, 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) – Parameters for creating a namespace resource. Is either a NamespaceCreateOrUpdateParameters type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either NamespaceResource or the result of cls(response)
- Return type
- Raises
-
begin_delete(resource_group_name: str, namespace_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes an existing namespace. This operation also removes all associated resources under the namespace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
check_name_availability(parameters: _models.CheckNameAvailabilityParameter, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityResult[source]¶ -
check_name_availability(parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityResult Check the give Namespace name availability.
- Parameters
parameters (CheckNameAvailabilityParameter or IO) – Parameters to check availability of the given Namespace name. Is either a CheckNameAvailabilityParameter type or a IO type. Required.
- Keyword Arguments
- Returns
CheckNameAvailabilityResult or the result of cls(response)
- Return type
- Raises
-
create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: IO, *, 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) – The shared access AuthorizationRule. Is either a SharedAccessAuthorizationRuleCreateOrUpdateParameters type or a IO type. Required.
- Keyword Arguments
- Returns
SharedAccessAuthorizationRuleResource or the result of cls(response)
- Return type
- Raises
Deletes an AuthorizationRule for a Namespace.
- Parameters
- 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
- Raises
-
get(resource_group_name: str, namespace_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2015_08_01.models._models_py3.NamespaceResource[source]¶ Gets the description of the specified namespace.
- Parameters
- 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
- Raises
Gets an AuthorizationRule for a Namespace by rule name.
- 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
- Raises
Gets a list of authorization rules for a Namespace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either SharedAccessAuthorizationRuleResource or the result of cls(response)
- Return type
- Raises
-
list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2015_08_01.models._models_py3.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.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either NamespaceResource or the result of cls(response)
- Return type
- Raises
-
list_by_subscription(**kwargs: Any) → Iterable[azure.mgmt.eventhub.v2015_08_01.models._models_py3.NamespaceResource][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 NamespaceResource or the result of cls(response)
- Return type
- Raises
-
list_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2015_08_01.models._models_py3.ResourceListKeys[source]¶ Gets the primary and secondary connection strings for the Namespace.
- Parameters
- 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
- Raises
-
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, *, 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) – Parameters required to regenerate the connection string. Is either a RegenerateKeysParameters type or a IO type. Required.
- Keyword Arguments
- Returns
ResourceListKeys or the result of cls(response)
- Return type
- Raises
-
update(resource_group_name: str, namespace_name: str, parameters: _models.NamespaceUpdateParameter, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_models.NamespaceResource][source]¶ -
update(resource_group_name: str, namespace_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_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 (NamespaceUpdateParameter or IO) – Parameters for updating a namespace resource. Is either a NamespaceUpdateParameter type or a IO type. Required.
- Keyword Arguments
- Returns
NamespaceResource or None or the result of cls(response)
- Return type
- Raises
-
models= <module 'azure.mgmt.eventhub.v2015_08_01.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2015_08_01/models/__init__.py'>¶
-
-
class
azure.mgmt.eventhub.v2015_08_01.operations.Operations(*args, **kwargs)[source]¶ Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
EventHubManagementClient’soperationsattribute.-
list(**kwargs: Any) → Iterable[azure.mgmt.eventhub.v2015_08_01.models._models_py3.Operation][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 Operation or the result of cls(response)
- Return type
- Raises
-
models= <module 'azure.mgmt.eventhub.v2015_08_01.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2015_08_01/models/__init__.py'>¶
-