ConnectedClusterOperations Class

ConnectedClusterOperations async 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

ConnectedClusterOperations

Constructor

ConnectedClusterOperations(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	Register a new Kubernetes cluster with Azure Resource Manager. API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM).
begin_delete	Delete a connected cluster. Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).
get	Get the properties of the specified connected cluster. Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
list_by_resource_group	Lists all connected clusters. API to enumerate registered connected K8s clusters under a Resource Group.
list_by_subscription	Lists all connected clusters. API to enumerate registered connected K8s clusters under a Subscription.
list_cluster_user_credential	Gets cluster user credentials of a connected cluster. Gets cluster user credentials of the connected cluster with a specified resource group and name.
update	Updates a connected cluster. API to update certain properties of the connected cluster resource.

begin_create

Register a new Kubernetes cluster with Azure Resource Manager.

API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM).

async begin_create(resource_group_name: str, cluster_name: str, connected_cluster: azure.mgmt.hybridkubernetes.models._models_py3.ConnectedCluster, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.hybridkubernetes.models._models_py3.ConnectedCluster]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cluster_name

str

Required

The name of the Kubernetes cluster on which get is called.

connected_cluster

<xref:connected_kubernetes_client.models.ConnectedCluster>

Required

Parameters supplied to Create a Connected 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 AsyncPollingMethod

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

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either ConnectedCluster or the result of cls(response)

Return type

AsyncLROPoller[<xref:connected_kubernetes_client.models.ConnectedCluster>]

Exceptions

HttpResponseError

begin_delete

Delete a connected cluster.

Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).

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

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cluster_name

str

Required

The name of the Kubernetes cluster on which get is called.

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 AsyncPollingMethod

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

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

get

Get the properties of the specified connected cluster.

Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.

async get(resource_group_name: str, cluster_name: str, **kwargs: Any) -> azure.mgmt.hybridkubernetes.models._models_py3.ConnectedCluster

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cluster_name

str

Required

The name of the Kubernetes cluster on which get is called.

cls

callable

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

Returns

ConnectedCluster, or the result of cls(response)

Return type

<xref:connected_kubernetes_client.models.ConnectedCluster>

Exceptions

HttpResponseError

list_by_resource_group

Lists all connected clusters.

API to enumerate registered connected K8s clusters under a Resource Group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.hybridkubernetes.models._models_py3.ConnectedClusterList]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[<xref:connected_kubernetes_client.models.ConnectedClusterList>]

Exceptions

HttpResponseError

list_by_subscription

Lists all connected clusters.

API to enumerate registered connected K8s clusters under a Subscription.

list_by_subscription(**kwargs: Any) -> AsyncIterable[azure.mgmt.hybridkubernetes.models._models_py3.ConnectedClusterList]

Parameters

cls

callable

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

Returns

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

Return type

AsyncItemPaged[<xref:connected_kubernetes_client.models.ConnectedClusterList>]

Exceptions

HttpResponseError

list_cluster_user_credential

Gets cluster user credentials of a connected cluster.

Gets cluster user credentials of the connected cluster with a specified resource group and name.

async list_cluster_user_credential(resource_group_name: str, cluster_name: str, properties: azure.mgmt.hybridkubernetes.models._models_py3.ListClusterUserCredentialProperties, **kwargs: Any) -> azure.mgmt.hybridkubernetes.models._models_py3.CredentialResults

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cluster_name

str

Required

The name of the Kubernetes cluster on which get is called.

properties

<xref:connected_kubernetes_client.models.ListClusterUserCredentialProperties>

Required

ListClusterUserCredential properties.

cls

callable

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

Returns

CredentialResults, or the result of cls(response)

Return type

<xref:connected_kubernetes_client.models.CredentialResults>

Exceptions

HttpResponseError

update

Updates a connected cluster.

API to update certain properties of the connected cluster resource.

async update(resource_group_name: str, cluster_name: str, connected_cluster_patch: azure.mgmt.hybridkubernetes.models._models_py3.ConnectedClusterPatch, **kwargs: Any) -> azure.mgmt.hybridkubernetes.models._models_py3.ConnectedCluster

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cluster_name

str

Required

The name of the Kubernetes cluster on which get is called.

connected_cluster_patch

<xref:connected_kubernetes_client.models.ConnectedClusterPatch>

Required

Parameters supplied to update Connected Cluster.

cls

callable

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

Returns

ConnectedCluster, or the result of cls(response)

Return type

<xref:connected_kubernetes_client.models.ConnectedCluster>

Exceptions

HttpResponseError

Attributes

models

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