ConnectedClusterOperations interface

Package:

@azure/arm-hybridkubernetes

Interface representing a ConnectedClusterOperations.

Methods

beginCreate(string, string, ConnectedCluster, ConnectedClusterCreateOptionalParams)	API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM).
beginCreateAndWait(string, string, ConnectedCluster, ConnectedClusterCreateOptionalParams)	API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM).
beginDelete(string, string, ConnectedClusterDeleteOptionalParams)	Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).
beginDeleteAndWait(string, string, ConnectedClusterDeleteOptionalParams)	Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).
get(string, string, ConnectedClusterGetOptionalParams)	Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
listByResourceGroup(string, ConnectedClusterListByResourceGroupOptionalParams)	API to enumerate registered connected K8s clusters under a Resource Group
listBySubscription(ConnectedClusterListBySubscriptionOptionalParams)	API to enumerate registered connected K8s clusters under a Subscription
listClusterUserCredential(string, string, ListClusterUserCredentialProperties, ConnectedClusterListClusterUserCredentialOptionalParams)	Gets cluster user credentials of the connected cluster with a specified resource group and name.
update(string, string, ConnectedClusterPatch, ConnectedClusterUpdateOptionalParams)	API to update certain properties of the connected cluster resource

Method Details

beginCreate(string, string, ConnectedCluster, ConnectedClusterCreateOptionalParams)

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

function beginCreate(resourceGroupName: string, clusterName: string, connectedCluster: ConnectedCluster, options?: ConnectedClusterCreateOptionalParams): Promise<PollerLike<PollOperationState<ConnectedCluster>, ConnectedCluster>>

Parameters

resourceGroupName

string

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

clusterName

string

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

connectedCluster

ConnectedCluster

Parameters supplied to Create a Connected Cluster.

options

ConnectedClusterCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<ConnectedCluster>, ConnectedCluster>>

beginCreateAndWait(string, string, ConnectedCluster, ConnectedClusterCreateOptionalParams)

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

function beginCreateAndWait(resourceGroupName: string, clusterName: string, connectedCluster: ConnectedCluster, options?: ConnectedClusterCreateOptionalParams): Promise<ConnectedCluster>

Parameters

resourceGroupName

string

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

clusterName

string

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

connectedCluster

ConnectedCluster

Parameters supplied to Create a Connected Cluster.

options

ConnectedClusterCreateOptionalParams

The options parameters.

Returns

Promise<ConnectedCluster>

beginDelete(string, string, ConnectedClusterDeleteOptionalParams)

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

function beginDelete(resourceGroupName: string, clusterName: string, options?: ConnectedClusterDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

clusterName

string

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

options

ConnectedClusterDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, ConnectedClusterDeleteOptionalParams)

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

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: ConnectedClusterDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

clusterName

string

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

options

ConnectedClusterDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, ConnectedClusterGetOptionalParams)

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

function get(resourceGroupName: string, clusterName: string, options?: ConnectedClusterGetOptionalParams): Promise<ConnectedCluster>

Parameters

resourceGroupName

string

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

clusterName

string

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

options

ConnectedClusterGetOptionalParams

The options parameters.

Returns

Promise<ConnectedCluster>

listByResourceGroup(string, ConnectedClusterListByResourceGroupOptionalParams)

API to enumerate registered connected K8s clusters under a Resource Group

function listByResourceGroup(resourceGroupName: string, options?: ConnectedClusterListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ConnectedCluster, ConnectedCluster[], PageSettings>

Parameters

resourceGroupName

string

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

options

ConnectedClusterListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ConnectedCluster, ConnectedCluster[], PageSettings>

listBySubscription(ConnectedClusterListBySubscriptionOptionalParams)

API to enumerate registered connected K8s clusters under a Subscription

function listBySubscription(options?: ConnectedClusterListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ConnectedCluster, ConnectedCluster[], PageSettings>

Parameters

options

ConnectedClusterListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ConnectedCluster, ConnectedCluster[], PageSettings>

listClusterUserCredential(string, string, ListClusterUserCredentialProperties, ConnectedClusterListClusterUserCredentialOptionalParams)

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

function listClusterUserCredential(resourceGroupName: string, clusterName: string, properties: ListClusterUserCredentialProperties, options?: ConnectedClusterListClusterUserCredentialOptionalParams): Promise<CredentialResults>

Parameters

resourceGroupName

string

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

clusterName

string

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

properties

ListClusterUserCredentialProperties

ListClusterUserCredential properties

options

ConnectedClusterListClusterUserCredentialOptionalParams

The options parameters.

Returns

Promise<CredentialResults>

update(string, string, ConnectedClusterPatch, ConnectedClusterUpdateOptionalParams)

API to update certain properties of the connected cluster resource

function update(resourceGroupName: string, clusterName: string, connectedClusterPatch: ConnectedClusterPatch, options?: ConnectedClusterUpdateOptionalParams): Promise<ConnectedCluster>

Parameters

resourceGroupName

string

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

clusterName

string

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

connectedClusterPatch

ConnectedClusterPatch

Parameters supplied to update Connected Cluster.

options

ConnectedClusterUpdateOptionalParams

The options parameters.

Returns

Promise<ConnectedCluster>