ClustersOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:clusters> attribute.
- Inheritance
-
builtins.objectClustersOperations
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_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.
async begin_create_or_update(resource_group_name: str, cluster_name: str, parameters: _models.Cluster, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Cluster]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
cluster_name
Required
|
The name of the Event Hubs Cluster. Required. |
|
parameters
Required
|
Parameters for creating a eventhub cluster resource. Is either a Cluster 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 |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either Cluster or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Deletes an existing Event Hubs Cluster. This operation is idempotent.
async begin_delete(resource_group_name: str, cluster_name: str, **kwargs: Any) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
cluster_name
Required
|
The name of the Event Hubs Cluster. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_update
Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.
async begin_update(resource_group_name: str, cluster_name: str, parameters: _models.Cluster, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Cluster]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
cluster_name
Required
|
The name of the Event Hubs Cluster. Required. |
|
parameters
Required
|
The properties of the Event Hubs Cluster which should be updated. Is either a Cluster 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 |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either Cluster or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets the resource description of the specified Event Hubs Cluster.
async get(resource_group_name: str, cluster_name: str, **kwargs: Any) -> ClusterParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
cluster_name
Required
|
The name of the Event Hubs Cluster. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Cluster or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_available_cluster_region
List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.
async list_available_cluster_region(**kwargs: Any) -> AvailableClustersListKeyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
AvailableClustersList or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> AsyncIterable[Cluster]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. 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 Cluster or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_namespaces
List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.
async list_namespaces(resource_group_name: str, cluster_name: str, **kwargs: Any) -> EHNamespaceIdListResultParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
cluster_name
Required
|
The name of the Event Hubs Cluster. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
EHNamespaceIdListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventhub\\v2018_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