ClustersOperations Class

ClustersOperations 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

ClustersOperations

Constructor

ClustersOperations(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

begin_create_or_update	Creates or updates an instance of an Event Hubs Cluster.
begin_delete	Deletes an existing Event Hubs Cluster. This operation is idempotent.
begin_update	Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.
get	Gets the resource description of the specified Event Hubs Cluster.
list_available_cluster_region	List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.
list_by_resource_group	Lists the available Event Hubs Clusters within an ARM resource group.
list_by_subscription	Lists the available Event Hubs Clusters within an ARM resource group.
list_namespaces	List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.

begin_create_or_update

Creates or updates an instance of an Event Hubs Cluster.

begin_create_or_update(resource_group_name: str, cluster_name: str, parameters: azure.mgmt.eventhub.v2021_11_01.models._models_py3.Cluster, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.eventhub.v2021_11_01.models._models_py3.Cluster]

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

cluster_name

str

Required

The name of the Event Hubs Cluster.

parameters

Cluster

Required

Parameters for creating a eventhub cluster resource.

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

LROPoller[Cluster]

Exceptions

HttpResponseError

begin_delete

Deletes an existing Event Hubs Cluster. This operation is idempotent.

begin_delete(resource_group_name: str, cluster_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

cluster_name

str

Required

The name of the Event Hubs Cluster.

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

LROPoller[None]

Exceptions

HttpResponseError

begin_update

Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.

begin_update(resource_group_name: str, cluster_name: str, parameters: azure.mgmt.eventhub.v2021_11_01.models._models_py3.Cluster, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.eventhub.v2021_11_01.models._models_py3.Cluster]

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

cluster_name

str

Required

The name of the Event Hubs Cluster.

parameters

Cluster

Required

The properties of the Event Hubs Cluster which should be updated.

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

LROPoller[Cluster]

Exceptions

HttpResponseError

get

Gets the resource description of the specified Event Hubs Cluster.

get(resource_group_name: str, cluster_name: str, **kwargs: Any) -> azure.mgmt.eventhub.v2021_11_01.models._models_py3.Cluster

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

cluster_name

str

Required

The name of the Event Hubs Cluster.

cls

callable

A custom type or function that will be passed the direct response

Returns

Cluster, or the result of cls(response)

Return type

Cluster

Exceptions

HttpResponseError

list_available_cluster_region

List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.

list_available_cluster_region(**kwargs: Any) -> azure.mgmt.eventhub.v2021_11_01.models._models_py3.AvailableClustersList

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

AvailableClustersList, or the result of cls(response)

Return type

AvailableClustersList

Exceptions

HttpResponseError

list_by_resource_group

Lists the available Event Hubs Clusters within an ARM resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[azure.mgmt.eventhub.v2021_11_01.models._models_py3.ClusterListResult]

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ClusterListResult or the result of cls(response)

Return type

ItemPaged[ClusterListResult]

Exceptions

HttpResponseError

list_by_subscription

Lists the available Event Hubs Clusters within an ARM resource group.

list_by_subscription(**kwargs: Any) -> Iterable[azure.mgmt.eventhub.v2021_11_01.models._models_py3.ClusterListResult]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ClusterListResult or the result of cls(response)

Return type

ItemPaged[ClusterListResult]

Exceptions

HttpResponseError

list_namespaces

List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.

list_namespaces(resource_group_name: str, cluster_name: str, **kwargs: Any) -> azure.mgmt.eventhub.v2021_11_01.models._models_py3.EHNamespaceIdListResult

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

cluster_name

str

Required

The name of the Event Hubs Cluster.

cls

callable

A custom type or function that will be passed the direct response

Returns

EHNamespaceIdListResult, or the result of cls(response)

Return type

EHNamespaceIdListResult

Exceptions

HttpResponseError

Attributes

models

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