KubernetesClusters interface
Interface representing a KubernetesClusters.
Methods
Method Details
beginCreateOrUpdate(string, string, KubernetesCluster, KubernetesClustersCreateOrUpdateOptionalParams)
Create a new Kubernetes cluster or update the properties of the existing one.
function beginCreateOrUpdate(resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterParameters: KubernetesCluster, options?: KubernetesClustersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<KubernetesCluster>, KubernetesCluster>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
- kubernetesClusterParameters
- KubernetesCluster
The request body.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<KubernetesCluster>, KubernetesCluster>>
beginCreateOrUpdateAndWait(string, string, KubernetesCluster, KubernetesClustersCreateOrUpdateOptionalParams)
Create a new Kubernetes cluster or update the properties of the existing one.
function beginCreateOrUpdateAndWait(resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterParameters: KubernetesCluster, options?: KubernetesClustersCreateOrUpdateOptionalParams): Promise<KubernetesCluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
- kubernetesClusterParameters
- KubernetesCluster
The request body.
The options parameters.
Returns
Promise<KubernetesCluster>
beginDelete(string, string, KubernetesClustersDeleteOptionalParams)
Delete the provided Kubernetes cluster.
function beginDelete(resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginDeleteAndWait(string, string, KubernetesClustersDeleteOptionalParams)
Delete the provided Kubernetes cluster.
function beginDeleteAndWait(resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersDeleteOptionalParams): Promise<OperationStatusResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
The options parameters.
Returns
Promise<OperationStatusResult>
beginRestartNode(string, string, KubernetesClusterRestartNodeParameters, KubernetesClustersRestartNodeOptionalParams)
Restart a targeted node of a Kubernetes cluster.
function beginRestartNode(resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterRestartNodeParameters: KubernetesClusterRestartNodeParameters, options?: KubernetesClustersRestartNodeOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
- kubernetesClusterRestartNodeParameters
- KubernetesClusterRestartNodeParameters
The request body.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginRestartNodeAndWait(string, string, KubernetesClusterRestartNodeParameters, KubernetesClustersRestartNodeOptionalParams)
Restart a targeted node of a Kubernetes cluster.
function beginRestartNodeAndWait(resourceGroupName: string, kubernetesClusterName: string, kubernetesClusterRestartNodeParameters: KubernetesClusterRestartNodeParameters, options?: KubernetesClustersRestartNodeOptionalParams): Promise<OperationStatusResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
- kubernetesClusterRestartNodeParameters
- KubernetesClusterRestartNodeParameters
The request body.
The options parameters.
Returns
Promise<OperationStatusResult>
beginUpdate(string, string, KubernetesClustersUpdateOptionalParams)
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.
function beginUpdate(resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<KubernetesCluster>, KubernetesCluster>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<KubernetesCluster>, KubernetesCluster>>
beginUpdateAndWait(string, string, KubernetesClustersUpdateOptionalParams)
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.
function beginUpdateAndWait(resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersUpdateOptionalParams): Promise<KubernetesCluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
The options parameters.
Returns
Promise<KubernetesCluster>
get(string, string, KubernetesClustersGetOptionalParams)
Get properties of the provided the Kubernetes cluster.
function get(resourceGroupName: string, kubernetesClusterName: string, options?: KubernetesClustersGetOptionalParams): Promise<KubernetesCluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
The options parameters.
Returns
Promise<KubernetesCluster>
listByResourceGroup(string, KubernetesClustersListByResourceGroupOptionalParams)
Get a list of Kubernetes clusters in the provided resource group.
function listByResourceGroup(resourceGroupName: string, options?: KubernetesClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<KubernetesCluster, KubernetesCluster[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(KubernetesClustersListBySubscriptionOptionalParams)
Get a list of Kubernetes clusters in the provided subscription.
function listBySubscription(options?: KubernetesClustersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<KubernetesCluster, KubernetesCluster[], PageSettings>Parameters
The options parameters.