ConnectedClusterOperationsOperations interface

Package:

@azure/arm-hybridkubernetes

Interface representing a ConnectedClusterOperations operations.

Properties

beginCreateOrReplace
beginCreateOrReplaceAndWait
beginDelete
beginDeleteAndWait
beginUpdateAsync
beginUpdateAsyncAndWait
createOrReplace	API to register a new Kubernetes cluster and create or replace a connected cluster tracked resource in Azure Resource Manager (ARM).
delete	Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).
get	Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
listByResourceGroup	API to enumerate registered connected K8s clusters under a Resource Group
listBySubscription	API to enumerate registered connected K8s clusters under a Subscription
listClusterUserCredential	Gets cluster user credentials of the connected cluster with a specified resource group and name.
updateAsync	API to update certain properties of the connected cluster resource

Property Details

beginCreateOrReplace

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplace: (resourceGroupName: string, clusterName: string, connectedCluster: ConnectedCluster, options?: ConnectedClusterOperationsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<ConnectedCluster>, ConnectedCluster>>

Property Value

(resourceGroupName: string, clusterName: string, connectedCluster: ConnectedCluster, options?: ConnectedClusterOperationsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<ConnectedCluster>, ConnectedCluster>>

beginCreateOrReplaceAndWait

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplaceAndWait: (resourceGroupName: string, clusterName: string, connectedCluster: ConnectedCluster, options?: ConnectedClusterOperationsCreateOrReplaceOptionalParams) => Promise<ConnectedCluster>

Property Value

(resourceGroupName: string, clusterName: string, connectedCluster: ConnectedCluster, options?: ConnectedClusterOperationsCreateOrReplaceOptionalParams) => Promise<ConnectedCluster>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, clusterName: string, options?: ConnectedClusterOperationsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, options?: ConnectedClusterOperationsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, clusterName: string, options?: ConnectedClusterOperationsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, options?: ConnectedClusterOperationsDeleteOptionalParams) => Promise<void>

beginUpdateAsync

Warning

This API is now deprecated.

use updateAsync instead

beginUpdateAsync: (resourceGroupName: string, clusterName: string, connectedClusterPatch: ConnectedClusterPatch, options?: ConnectedClusterOperationsUpdateAsyncOptionalParams) => Promise<SimplePollerLike<OperationState<ConnectedCluster>, ConnectedCluster>>

Property Value

(resourceGroupName: string, clusterName: string, connectedClusterPatch: ConnectedClusterPatch, options?: ConnectedClusterOperationsUpdateAsyncOptionalParams) => Promise<SimplePollerLike<OperationState<ConnectedCluster>, ConnectedCluster>>

beginUpdateAsyncAndWait

Warning

This API is now deprecated.

use updateAsync instead

beginUpdateAsyncAndWait: (resourceGroupName: string, clusterName: string, connectedClusterPatch: ConnectedClusterPatch, options?: ConnectedClusterOperationsUpdateAsyncOptionalParams) => Promise<ConnectedCluster>

Property Value

(resourceGroupName: string, clusterName: string, connectedClusterPatch: ConnectedClusterPatch, options?: ConnectedClusterOperationsUpdateAsyncOptionalParams) => Promise<ConnectedCluster>

createOrReplace

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

createOrReplace: (resourceGroupName: string, clusterName: string, connectedCluster: ConnectedCluster, options?: ConnectedClusterOperationsCreateOrReplaceOptionalParams) => PollerLike<OperationState<ConnectedCluster>, ConnectedCluster>

Property Value

(resourceGroupName: string, clusterName: string, connectedCluster: ConnectedCluster, options?: ConnectedClusterOperationsCreateOrReplaceOptionalParams) => PollerLike<OperationState<ConnectedCluster>, ConnectedCluster>

delete

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

delete: (resourceGroupName: string, clusterName: string, options?: ConnectedClusterOperationsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: ConnectedClusterOperationsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

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

get: (resourceGroupName: string, clusterName: string, options?: ConnectedClusterOperationsGetOptionalParams) => Promise<ConnectedCluster>

Property Value

(resourceGroupName: string, clusterName: string, options?: ConnectedClusterOperationsGetOptionalParams) => Promise<ConnectedCluster>

listByResourceGroup

API to enumerate registered connected K8s clusters under a Resource Group

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

Property Value

(resourceGroupName: string, options?: ConnectedClusterOperationsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ConnectedCluster, ConnectedCluster[], PageSettings>

listBySubscription

API to enumerate registered connected K8s clusters under a Subscription

listBySubscription: (options?: ConnectedClusterOperationsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ConnectedCluster, ConnectedCluster[], PageSettings>

Property Value

(options?: ConnectedClusterOperationsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ConnectedCluster, ConnectedCluster[], PageSettings>

listClusterUserCredential

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

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

Property Value

(resourceGroupName: string, clusterName: string, properties: ListClusterUserCredentialProperties, options?: ConnectedClusterOperationsListClusterUserCredentialOptionalParams) => Promise<CredentialResults>

updateAsync

API to update certain properties of the connected cluster resource

updateAsync: (resourceGroupName: string, clusterName: string, connectedClusterPatch: ConnectedClusterPatch, options?: ConnectedClusterOperationsUpdateAsyncOptionalParams) => PollerLike<OperationState<ConnectedCluster>, ConnectedCluster>

Property Value

(resourceGroupName: string, clusterName: string, connectedClusterPatch: ConnectedClusterPatch, options?: ConnectedClusterOperationsUpdateAsyncOptionalParams) => PollerLike<OperationState<ConnectedCluster>, ConnectedCluster>