azure.mgmt.eventhub.v2018_01_01_preview.operations module¶
-
class
azure.mgmt.eventhub.v2018_01_01_preview.operations.ClustersOperations(*args, **kwargs)[source]¶ Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
EventHubManagementClient’sclustersattribute.-
begin_create_or_update(resource_group_name: str, cluster_name: str, parameters: _models.Cluster, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Cluster][source]¶ -
begin_create_or_update(resource_group_name: str, cluster_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Cluster] Creates or updates an instance of an Event Hubs Cluster.
- Parameters
- 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 Cluster or the result of cls(response)
- Return type
- Raises
-
begin_delete(resource_group_name: str, cluster_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes an existing Event Hubs Cluster. This operation is idempotent.
- 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
-
begin_update(resource_group_name: str, cluster_name: str, parameters: _models.Cluster, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Cluster][source]¶ -
begin_update(resource_group_name: str, cluster_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Cluster] Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.
- Parameters
resource_group_name (str) – Name of the resource group within the azure subscription. Required.
cluster_name (str) – The name of the Event Hubs Cluster. Required.
parameters (Cluster or IO) – The properties of the Event Hubs Cluster which should be updated. Is either a Cluster 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 Cluster or the result of cls(response)
- Return type
- Raises
-
get(resource_group_name: str, cluster_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.Cluster[source]¶ Gets the resource description of the specified Event Hubs Cluster.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Cluster or the result of cls(response)
- Return type
- Raises
-
list_available_cluster_region(**kwargs: Any) → azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.AvailableClustersList[source]¶ List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
AvailableClustersList or the result of cls(response)
- Return type
- Raises
-
list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.Cluster][source]¶ Lists the available Event Hubs Clusters within an ARM 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 Cluster or the result of cls(response)
- Return type
- Raises
-
list_namespaces(resource_group_name: str, cluster_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.EHNamespaceIdListResult[source]¶ List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
EHNamespaceIdListResult or the result of cls(response)
- Return type
- Raises
-
models= <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>¶
-
-
class
azure.mgmt.eventhub.v2018_01_01_preview.operations.ConfigurationOperations(*args, **kwargs)[source]¶ Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
EventHubManagementClient’sconfigurationattribute.-
get(resource_group_name: str, cluster_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.ClusterQuotaConfigurationProperties[source]¶ Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ClusterQuotaConfigurationProperties or the result of cls(response)
- Return type
- Raises
-
patch(resource_group_name: str, cluster_name: str, parameters: _models.ClusterQuotaConfigurationProperties, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_models.ClusterQuotaConfigurationProperties][source]¶ -
patch(resource_group_name: str, cluster_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_models.ClusterQuotaConfigurationProperties] Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.
- Parameters
resource_group_name (str) – Name of the resource group within the azure subscription. Required.
cluster_name (str) – The name of the Event Hubs Cluster. Required.
parameters (ClusterQuotaConfigurationProperties or IO) – Parameters for creating an Event Hubs Cluster resource. Is either a ClusterQuotaConfigurationProperties type or a IO type. Required.
- Keyword Arguments
- Returns
ClusterQuotaConfigurationProperties or None or the result of cls(response)
- Return type
- Raises
-
models= <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>¶
-
-
class
azure.mgmt.eventhub.v2018_01_01_preview.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.ConsumerGroup, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ConsumerGroup[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.ConsumerGroup 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 (ConsumerGroup or IO) – Parameters supplied to create or update a consumer group resource. Is either a ConsumerGroup type or a IO type. Required.
- Keyword Arguments
- Returns
ConsumerGroup 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.v2018_01_01_preview.models._models_py3.ConsumerGroup[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
ConsumerGroup or the result of cls(response)
- Return type
- Raises
-
list_by_event_hub(resource_group_name: str, namespace_name: str, event_hub_name: str, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.ConsumerGroup][source]¶ Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the 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.
skip (int) – 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) – May be used to limit the number of results to the most recent N usageDetails. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ConsumerGroup or the result of cls(response)
- Return type
- Raises
-
models= <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>¶
-
-
class
azure.mgmt.eventhub.v2018_01_01_preview.operations.DisasterRecoveryConfigsOperations(*args, **kwargs)[source]¶ Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
EventHubManagementClient’sdisaster_recovery_configsattribute.-
break_pairing(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) → None[source]¶ This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces.
- 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
-
check_name_availability(resource_group_name: str, namespace_name: str, parameters: _models.CheckNameAvailabilityParameter, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityResult[source]¶ -
check_name_availability(resource_group_name: str, namespace_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityResult Check the give Namespace name availability.
- Parameters
resource_group_name (str) – Name of the resource group within the azure subscription. Required.
namespace_name (str) – The Namespace name. Required.
parameters (CheckNameAvailabilityParameter or IO) – Parameters to check availability of the given Alias 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(resource_group_name: str, namespace_name: str, alias: str, parameters: _models.ArmDisasterRecovery, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_models.ArmDisasterRecovery][source]¶ -
create_or_update(resource_group_name: str, namespace_name: str, alias: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_models.ArmDisasterRecovery] Creates or updates a new Alias(Disaster Recovery configuration).
- Parameters
resource_group_name (str) – Name of the resource group within the azure subscription. Required.
namespace_name (str) – The Namespace name. Required.
alias (str) – The Disaster Recovery configuration name. Required.
parameters (ArmDisasterRecovery or IO) – Parameters required to create an Alias(Disaster Recovery configuration). Is either a ArmDisasterRecovery type or a IO type. Required.
- Keyword Arguments
- Returns
ArmDisasterRecovery or None or the result of cls(response)
- Return type
- Raises
-
delete(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) → None[source]¶ Deletes an Alias(Disaster Recovery configuration).
- 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
-
fail_over(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) → None[source]¶ Invokes GEO DR failover and reconfigure the alias to point to the secondary 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, alias: str, **kwargs: Any) → azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.ArmDisasterRecovery[source]¶ Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ArmDisasterRecovery 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
AuthorizationRule or the result of cls(response)
- Return type
- Raises
-
list(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.ArmDisasterRecovery][source]¶ Gets all Alias(Disaster Recovery configurations).
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ArmDisasterRecovery 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 AuthorizationRule or the result of cls(response)
- Return type
- Raises
-
list_keys(resource_group_name: str, namespace_name: str, alias: str, authorization_rule_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.AccessKeys[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
AccessKeys or the result of cls(response)
- Return type
- Raises
-
models= <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>¶
-
-
class
azure.mgmt.eventhub.v2018_01_01_preview.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.Eventhub, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Eventhub[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.Eventhub 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 (Eventhub or IO) – Parameters supplied to create an Event Hub resource. Is either a Eventhub type or a IO type. Required.
- Keyword Arguments
- Returns
Eventhub 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.AuthorizationRule Creates or updates an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.
- 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 (AuthorizationRule or IO) – The shared access AuthorizationRule. Is either a AuthorizationRule type or a IO type. Required.
- Keyword Arguments
- Returns
AuthorizationRule 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.v2018_01_01_preview.models._models_py3.Eventhub[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
Eventhub 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
AuthorizationRule 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 AuthorizationRule or the result of cls(response)
- Return type
- Raises
-
list_by_namespace(resource_group_name: str, namespace_name: str, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.Eventhub][source]¶ Gets all the Event Hubs in a Namespace.
- Parameters
resource_group_name (str) – Name of the resource group within the azure subscription. Required.
namespace_name (str) – The Namespace name. Required.
skip (int) – 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) – May be used to limit the number of results to the most recent N usageDetails. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Eventhub 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.v2018_01_01_preview.models._models_py3.AccessKeys[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
AccessKeys 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.RegenerateAccessKeyParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessKeys[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.AccessKeys 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 (RegenerateAccessKeyParameters or IO) – Parameters supplied to regenerate the AuthorizationRule Keys (PrimaryKey/SecondaryKey). Is either a RegenerateAccessKeyParameters type or a IO type. Required.
- Keyword Arguments
- Returns
AccessKeys or the result of cls(response)
- Return type
- Raises
-
models= <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>¶
-
-
class
azure.mgmt.eventhub.v2018_01_01_preview.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.EHNamespace, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EHNamespace][source]¶ -
begin_create_or_update(resource_group_name: str, namespace_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EHNamespace] 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 (EHNamespace or IO) – Parameters for creating a namespace resource. Is either a EHNamespace 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 EHNamespace 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.AuthorizationRule 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 (AuthorizationRule or IO) – The shared access AuthorizationRule. Is either a AuthorizationRule type or a IO type. Required.
- Keyword Arguments
- Returns
AuthorizationRule or the result of cls(response)
- Return type
- Raises
-
create_or_update_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, parameters: _models.IpFilterRule, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IpFilterRule[source]¶ -
create_or_update_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IpFilterRule Creates or updates an IpFilterRule 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.
ip_filter_rule_name (str) – The IP Filter Rule name. Required.
parameters (IpFilterRule or IO) – The Namespace IpFilterRule. Is either a IpFilterRule type or a IO type. Required.
- Keyword Arguments
- Returns
IpFilterRule or the result of cls(response)
- Return type
- Raises
-
create_or_update_network_rule_set(resource_group_name: str, namespace_name: str, parameters: _models.NetworkRuleSet, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NetworkRuleSet[source]¶ -
create_or_update_network_rule_set(resource_group_name: str, namespace_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NetworkRuleSet Create or update NetworkRuleSet 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.
parameters (NetworkRuleSet or IO) – The Namespace IpFilterRule. Is either a NetworkRuleSet type or a IO type. Required.
- Keyword Arguments
- Returns
NetworkRuleSet or the result of cls(response)
- Return type
- Raises
-
create_or_update_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, parameters: _models.VirtualNetworkRule, *, content_type: str = "'application/json'", **kwargs: Any) → _models.VirtualNetworkRule[source]¶ -
create_or_update_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.VirtualNetworkRule Creates or updates an VirtualNetworkRule 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.
virtual_network_rule_name (str) – The Virtual Network Rule name. Required.
parameters (VirtualNetworkRule or IO) – The Namespace VirtualNetworkRule. Is either a VirtualNetworkRule type or a IO type. Required.
- Keyword Arguments
- Returns
VirtualNetworkRule 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
-
delete_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, **kwargs: Any) → None[source]¶ Deletes an IpFilterRule 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
-
delete_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, **kwargs: Any) → None[source]¶ Deletes an VirtualNetworkRule 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.v2018_01_01_preview.models._models_py3.EHNamespace[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
EHNamespace 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
AuthorizationRule or the result of cls(response)
- Return type
- Raises
-
get_ip_filter_rule(resource_group_name: str, namespace_name: str, ip_filter_rule_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.IpFilterRule[source]¶ Gets an IpFilterRule for a Namespace by rule name.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
IpFilterRule or the result of cls(response)
- Return type
- Raises
-
get_network_rule_set(resource_group_name: str, namespace_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.NetworkRuleSet[source]¶ Gets NetworkRuleSet for a Namespace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
NetworkRuleSet or the result of cls(response)
- Return type
- Raises
-
get_virtual_network_rule(resource_group_name: str, namespace_name: str, virtual_network_rule_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.VirtualNetworkRule[source]¶ Gets an VirtualNetworkRule for a Namespace by rule name.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
VirtualNetworkRule or the result of cls(response)
- Return type
- Raises
-
list(**kwargs: Any) → Iterable[azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.EHNamespace][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 EHNamespace 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 AuthorizationRule or the result of cls(response)
- Return type
- Raises
-
list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.EHNamespace][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 EHNamespace or the result of cls(response)
- Return type
- Raises
-
list_ip_filter_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.IpFilterRule][source]¶ Gets a list of IP Filter 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 IpFilterRule 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.v2018_01_01_preview.models._models_py3.AccessKeys[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
AccessKeys or the result of cls(response)
- Return type
- Raises
-
list_virtual_network_rules(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.VirtualNetworkRule][source]¶ Gets a list of VirtualNetwork 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 VirtualNetworkRule or the result of cls(response)
- Return type
- Raises
-
regenerate_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: _models.RegenerateAccessKeyParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessKeys[source]¶ -
regenerate_keys(resource_group_name: str, namespace_name: str, authorization_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessKeys 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 (RegenerateAccessKeyParameters or IO) – Parameters required to regenerate the connection string. Is either a RegenerateAccessKeyParameters type or a IO type. Required.
- Keyword Arguments
- Returns
AccessKeys or the result of cls(response)
- Return type
- Raises
-
update(resource_group_name: str, namespace_name: str, parameters: _models.EHNamespace, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_models.EHNamespace][source]¶ -
update(resource_group_name: str, namespace_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_models.EHNamespace] 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 (EHNamespace or IO) – Parameters for updating a namespace resource. Is either a EHNamespace type or a IO type. Required.
- Keyword Arguments
- Returns
EHNamespace or None or the result of cls(response)
- Return type
EHNamespace or None
- Raises
-
models= <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>¶
-
-
class
azure.mgmt.eventhub.v2018_01_01_preview.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.v2018_01_01_preview.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.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>¶
-
-
class
azure.mgmt.eventhub.v2018_01_01_preview.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)[source]¶ Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
EventHubManagementClient’sprivate_endpoint_connectionsattribute.-
begin_delete(resource_group_name: str, namespace_name: str, private_endpoint_connection_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
-
create_or_update(resource_group_name: str, namespace_name: str, private_endpoint_connection_name: str, parameters: _models.PrivateEndpointConnection, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PrivateEndpointConnection[source]¶ -
create_or_update(resource_group_name: str, namespace_name: str, private_endpoint_connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PrivateEndpointConnection Creates or updates PrivateEndpointConnections of service namespace.
- Parameters
resource_group_name (str) – Name of the resource group within the azure subscription. Required.
namespace_name (str) – The Namespace name. Required.
private_endpoint_connection_name (str) – The PrivateEndpointConnection name. Required.
parameters (PrivateEndpointConnection or IO) – Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource. Is either a PrivateEndpointConnection type or a IO type. Required.
- Keyword Arguments
- Returns
PrivateEndpointConnection or the result of cls(response)
- Return type
- Raises
-
get(resource_group_name: str, namespace_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.PrivateEndpointConnection[source]¶ Gets a description for the specified Private Endpoint Connection name.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateEndpointConnection or the result of cls(response)
- Return type
- Raises
-
list(resource_group_name: str, namespace_name: str, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.PrivateEndpointConnection][source]¶ Gets the available PrivateEndpointConnections within 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 PrivateEndpointConnection or the result of cls(response)
- Return type
- Raises
-
models= <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>¶
-
-
class
azure.mgmt.eventhub.v2018_01_01_preview.operations.PrivateLinkResourcesOperations(*args, **kwargs)[source]¶ Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
EventHubManagementClient’sprivate_link_resourcesattribute.-
get(resource_group_name: str, namespace_name: str, **kwargs: Any) → azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.PrivateLinkResourcesListResult[source]¶ Gets lists of resources that supports Privatelinks.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateLinkResourcesListResult or the result of cls(response)
- Return type
- Raises
-
models= <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>¶
-
-
class
azure.mgmt.eventhub.v2018_01_01_preview.operations.RegionsOperations(*args, **kwargs)[source]¶ Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
EventHubManagementClient’sregionsattribute.-
list_by_sku(sku: str, **kwargs: Any) → Iterable[azure.mgmt.eventhub.v2018_01_01_preview.models._models_py3.MessagingRegions][source]¶ Gets the available Regions for a given sku.
-
models= <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from '/mnt/vss/_work/1/s/sdk/eventhub/azure-mgmt-eventhub/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventhub/v2018_01_01_preview/models/__init__.py'>¶
-