KubernetesClustersOperations interface

Interface representing a KubernetesClusters operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginRestartNode
beginRestartNodeAndWait
beginUpdate
beginUpdateAndWait
createOrUpdate

Create a new Kubernetes cluster or update the properties of the existing one.

delete

Delete the provided Kubernetes cluster.

get

Get properties of the provided the Kubernetes cluster.

listByResourceGroup

Get a list of Kubernetes clusters in the provided resource group.

listBySubscription

Get a list of Kubernetes clusters in the provided subscription.

restartNode

Restart a targeted node of a Kubernetes cluster.

update

Patch the properties of the provided Kubernetes cluster, or update the tags associated with the Kubernetes cluster. Properties and tag updates can be done independently.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterParameters: KubernetesCluster, options?: KubernetesClustersCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<KubernetesCluster>, KubernetesCluster>>

Property Value

(resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterParameters: KubernetesCluster, options?: KubernetesClustersCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<KubernetesCluster>, KubernetesCluster>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterParameters: KubernetesCluster, options?: KubernetesClustersCreateOrUpdateOptionalParams) => Promise<KubernetesCluster>

Property Value

(resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterParameters: KubernetesCluster, options?: KubernetesClustersCreateOrUpdateOptionalParams) => Promise<KubernetesCluster>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

Property Value

(resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersDeleteOptionalParams) => Promise<OperationStatusResult>

Property Value

(resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersDeleteOptionalParams) => Promise<OperationStatusResult>

beginRestartNode

Warning

This API is now deprecated.

use restartNode instead

beginRestartNode: (resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterRestartNodeParameters: KubernetesClusterRestartNodeParameters, options?: KubernetesClustersRestartNodeOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

Property Value

(resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterRestartNodeParameters: KubernetesClusterRestartNodeParameters, options?: KubernetesClustersRestartNodeOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginRestartNodeAndWait

Warning

This API is now deprecated.

use restartNode instead

beginRestartNodeAndWait: (resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterRestartNodeParameters: KubernetesClusterRestartNodeParameters, options?: KubernetesClustersRestartNodeOptionalParams) => Promise<OperationStatusResult>

Property Value

(resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterRestartNodeParameters: KubernetesClusterRestartNodeParameters, options?: KubernetesClustersRestartNodeOptionalParams) => Promise<OperationStatusResult>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<KubernetesCluster>, KubernetesCluster>>

Property Value

(resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<KubernetesCluster>, KubernetesCluster>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersUpdateOptionalParams) => Promise<KubernetesCluster>

Property Value

(resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersUpdateOptionalParams) => Promise<KubernetesCluster>

createOrUpdate

Create a new Kubernetes cluster or update the properties of the existing one.

createOrUpdate: (resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterParameters: KubernetesCluster, options?: KubernetesClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<KubernetesCluster>, KubernetesCluster>

Property Value

(resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterParameters: KubernetesCluster, options?: KubernetesClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<KubernetesCluster>, KubernetesCluster>

delete

Delete the provided Kubernetes cluster.

delete: (resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersDeleteOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersDeleteOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

get

Get properties of the provided the Kubernetes cluster.

get: (resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersGetOptionalParams) => Promise<KubernetesCluster>

Property Value

(resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersGetOptionalParams) => Promise<KubernetesCluster>

listByResourceGroup

Get a list of Kubernetes clusters in the provided resource group.

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

Property Value

(resourceGroupName: string, options?: KubernetesClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<KubernetesCluster, KubernetesCluster[], PageSettings>

listBySubscription

Get a list of Kubernetes clusters in the provided subscription.

listBySubscription: (options?: KubernetesClustersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<KubernetesCluster, KubernetesCluster[], PageSettings>

Property Value

(options?: KubernetesClustersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<KubernetesCluster, KubernetesCluster[], PageSettings>

restartNode

Restart a targeted node of a Kubernetes cluster.

restartNode: (resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterRestartNodeParameters: KubernetesClusterRestartNodeParameters, options?: KubernetesClustersRestartNodeOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterRestartNodeParameters: KubernetesClusterRestartNodeParameters, options?: KubernetesClustersRestartNodeOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

update

Patch the properties of the provided Kubernetes cluster, or update the tags associated with the Kubernetes cluster. Properties and tag updates can be done independently.

update: (resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersUpdateOptionalParams) => PollerLike<OperationState<KubernetesCluster>, KubernetesCluster>

Property Value

(resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersUpdateOptionalParams) => PollerLike<OperationState<KubernetesCluster>, KubernetesCluster>