Share via

ClustersOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventHubManagementClient's

<xref:clusters> attribute.

Inheritance
builtins.object
ClustersOperations

Constructor

ClustersOperations(*args, **kwargs)

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: _models.Cluster, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Cluster]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.
cluster_name
Required
str

The name of the Event Hubs Cluster. Required.
parameters
Required
Cluster or IO[bytes]

Parameters for creating a eventhub cluster resource. Is either a Cluster type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[Cluster]

An instance of LROPoller that returns either Cluster or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

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

begin_delete(resource_group_name: str, cluster_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.
cluster_name
Required
str

The name of the Event Hubs Cluster. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
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: _models.Cluster, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Cluster]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.
cluster_name
Required
str

The name of the Event Hubs Cluster. Required.
parameters
Required
Cluster or IO[bytes]

The properties of the Event Hubs Cluster which should be updated. Is either a Cluster type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[Cluster]

An instance of LROPoller that returns either Cluster or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets the resource description of the specified Event Hubs Cluster.

get(resource_group_name: str, cluster_name: str, **kwargs: Any) -> Cluster

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.
cluster_name
Required
str

The name of the Event Hubs Cluster. Required.

Returns

Type Description
Cluster

Cluster or the result of cls(response)

Exceptions

Type Description
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) -> AvailableClustersList

Returns

Type Description
AvailableClustersList

AvailableClustersList or the result of cls(response)

Exceptions

Type Description
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[Cluster]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

Returns

Type Description
ItemPaged[Cluster]

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

Exceptions

Type Description
HttpResponseError

list_by_subscription

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

list_by_subscription(**kwargs: Any) -> Iterable[Cluster]

Returns

Type Description
ItemPaged[Cluster]

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

Exceptions

Type Description
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) -> EHNamespaceIdListResult

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.
cluster_name
Required
str

The name of the Event Hubs Cluster. Required.

Returns

Type Description
EHNamespaceIdListResult

EHNamespaceIdListResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.eventhub.v2024_01_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventhub\\v2024_01_01\\models\\__init__.py'>