KubernetesClusters Interface

public interface KubernetesClusters

Resource collection API of KubernetesClusters.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new KubernetesCluster resource.

abstract OperationStatusResult delete(String resourceGroupName, String kubernetesClusterName, String ifMatch, String ifNoneMatch, Context context)

Delete the Kubernetes cluster.

abstract OperationStatusResult deleteById(String id)

Delete the Kubernetes cluster.

abstract OperationStatusResult deleteByIdWithResponse(String id, String ifMatch, String ifNoneMatch, Context context)

Delete the Kubernetes cluster.

abstract OperationStatusResult deleteByResourceGroup(String resourceGroupName, String kubernetesClusterName)

Delete the Kubernetes cluster.

abstract KubernetesCluster getById(String id)

Retrieve the Kubernetes cluster.

abstract Response<KubernetesCluster> getByIdWithResponse(String id, Context context)

Retrieve the Kubernetes cluster.

abstract KubernetesCluster getByResourceGroup(String resourceGroupName, String kubernetesClusterName)

Retrieve the Kubernetes cluster.

abstract Response<KubernetesCluster> getByResourceGroupWithResponse(String resourceGroupName, String kubernetesClusterName, Context context)

Retrieve the Kubernetes cluster.

abstract PagedIterable<KubernetesCluster> list()

List Kubernetes clusters in the subscription.

abstract PagedIterable<KubernetesCluster> list(Integer top, String skipToken, Context context)

List Kubernetes clusters in the subscription.

abstract PagedIterable<KubernetesCluster> listByResourceGroup(String resourceGroupName)

List Kubernetes clusters in the resource group.

abstract PagedIterable<KubernetesCluster> listByResourceGroup(String resourceGroupName, Integer top, String skipToken, Context context)

List Kubernetes clusters in the resource group.

abstract OperationStatusResult restartNode(String resourceGroupName, String kubernetesClusterName, KubernetesClusterRestartNodeParameters kubernetesClusterRestartNodeParameters)

Restart a targeted node.

abstract OperationStatusResult restartNode(String resourceGroupName, String kubernetesClusterName, KubernetesClusterRestartNodeParameters kubernetesClusterRestartNodeParameters, Context context)

Restart a targeted node.

Method Details

define

public abstract KubernetesCluster.DefinitionStages.Blank define(String name)

Begins definition for a new KubernetesCluster resource.

Parameters:

name - resource name.

Returns:

the first stage of the new KubernetesCluster definition.

delete

public abstract OperationStatusResult delete(String resourceGroupName, String kubernetesClusterName, String ifMatch, String ifNoneMatch, Context context)

Delete the Kubernetes cluster. Delete the provided Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

the current status of an async operation.

deleteById

public abstract OperationStatusResult deleteById(String id)

Delete the Kubernetes cluster. Delete the provided Kubernetes cluster.

Parameters:

id - the resource ID.

Returns:

the current status of an async operation.

deleteByIdWithResponse

public abstract OperationStatusResult deleteByIdWithResponse(String id, String ifMatch, String ifNoneMatch, Context context)

Delete the Kubernetes cluster. Delete the provided Kubernetes cluster.

Parameters:

id - the resource ID.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

the current status of an async operation.

deleteByResourceGroup

public abstract OperationStatusResult deleteByResourceGroup(String resourceGroupName, String kubernetesClusterName)

Delete the Kubernetes cluster. Delete the provided Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.

Returns:

the current status of an async operation.

getById

public abstract KubernetesCluster getById(String id)

Retrieve the Kubernetes cluster. Get properties of the provided the Kubernetes cluster.

Parameters:

id - the resource ID.

Returns:

properties of the provided the Kubernetes cluster along with Response<T>.

getByIdWithResponse

public abstract Response<KubernetesCluster> getByIdWithResponse(String id, Context context)

Retrieve the Kubernetes cluster. Get properties of the provided the Kubernetes cluster.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

properties of the provided the Kubernetes cluster along with Response<T>.

getByResourceGroup

public abstract KubernetesCluster getByResourceGroup(String resourceGroupName, String kubernetesClusterName)

Retrieve the Kubernetes cluster. Get properties of the provided the Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.

Returns:

properties of the provided the Kubernetes cluster.

getByResourceGroupWithResponse

public abstract Response<KubernetesCluster> getByResourceGroupWithResponse(String resourceGroupName, String kubernetesClusterName, Context context)

Retrieve the Kubernetes cluster. Get properties of the provided the Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
context - The context to associate with this operation.

Returns:

properties of the provided the Kubernetes cluster along with Response<T>.

list

public abstract PagedIterable<KubernetesCluster> list()

List Kubernetes clusters in the subscription. Get a list of Kubernetes clusters in the provided subscription.

Returns:

a list of Kubernetes clusters in the provided subscription as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<KubernetesCluster> list(Integer top, String skipToken, Context context)

List Kubernetes clusters in the subscription. Get a list of Kubernetes clusters in the provided subscription.

Parameters:

top - The maximum number of resources to return from the operation. Example: '$top=10'.
skipToken - The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets.
context - The context to associate with this operation.

Returns:

a list of Kubernetes clusters in the provided subscription as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<KubernetesCluster> listByResourceGroup(String resourceGroupName)

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

Parameters:

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

Returns:

a list of Kubernetes clusters in the provided resource group as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<KubernetesCluster> listByResourceGroup(String resourceGroupName, Integer top, String skipToken, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
top - The maximum number of resources to return from the operation. Example: '$top=10'.
skipToken - The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets.
context - The context to associate with this operation.

Returns:

a list of Kubernetes clusters in the provided resource group as paginated response with PagedIterable<T>.

restartNode

public abstract OperationStatusResult restartNode(String resourceGroupName, String kubernetesClusterName, KubernetesClusterRestartNodeParameters kubernetesClusterRestartNodeParameters)

Restart a targeted node. Restart a targeted node of a Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
kubernetesClusterRestartNodeParameters - The request body.

Returns:

the current status of an async operation.

restartNode

public abstract OperationStatusResult restartNode(String resourceGroupName, String kubernetesClusterName, KubernetesClusterRestartNodeParameters kubernetesClusterRestartNodeParameters, Context context)

Restart a targeted node. Restart a targeted node of a Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
kubernetesClusterRestartNodeParameters - The request body.
context - The context to associate with this operation.

Returns:

the current status of an async operation.

Applies to