ClustersClient Interface

public interface ClustersClient

An instance of this class provides access to all the operations defined in ClustersClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginCreate(String resourceGroupName, String clusterName, ClusterInner body)

Implements cluster PUT method.

abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginCreate(String resourceGroupName, String clusterName, ClusterInner body, Context context)

Implements cluster PUT method.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String clusterName, Boolean force)

Deletes an cluster.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String clusterName, Boolean force, Context context)

Deletes an cluster.

abstract ClusterInner create(String resourceGroupName, String clusterName)

Implements cluster PUT method.

abstract ClusterInner create(String resourceGroupName, String clusterName, ClusterInner body)

Implements cluster PUT method.

abstract ClusterInner create(String resourceGroupName, String clusterName, ClusterInner body, Context context)

Implements cluster PUT method.

abstract void delete(String resourceGroupName, String clusterName)

Deletes an cluster.

abstract void delete(String resourceGroupName, String clusterName, Boolean force)

Deletes an cluster.

abstract void delete(String resourceGroupName, String clusterName, Boolean force, Context context)

Deletes an cluster.

abstract ClusterInner getByResourceGroup(String resourceGroupName, String clusterName)

Gets a cluster.

abstract Response<ClusterInner> getByResourceGroupWithResponse(String resourceGroupName, String clusterName, Context context)

Gets a cluster.

abstract PagedIterable<ClusterInner> list()

Implements GET clusters in a subscription.

abstract PagedIterable<ClusterInner> list(Context context)

Implements GET clusters in a subscription.

abstract PagedIterable<ClusterInner> listByResourceGroup(String resourceGroupName)

Implements GET clusters in a resource group.

abstract PagedIterable<ClusterInner> listByResourceGroup(String resourceGroupName, Context context)

Implements GET clusters in a resource group.

abstract ClusterInner update(String resourceGroupName, String clusterName)

Updates a cluster.

abstract Response<ClusterInner> updateWithResponse(String resourceGroupName, String clusterName, ResourcePatch body, Context context)

Updates a cluster.

Method Details

beginCreate

public abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginCreate(String resourceGroupName, String clusterName, ClusterInner body)

Implements cluster PUT method.

Create Or Update cluster.

Parameters:

resourceGroupName - The Resource Group Name.
clusterName - Name of the cluster.
body - Request payload.

Returns:

the SyncPoller<T,U> for polling of define the cluster.

beginCreate

public abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginCreate(String resourceGroupName, String clusterName, ClusterInner body, Context context)

Implements cluster PUT method.

Create Or Update cluster.

Parameters:

resourceGroupName - The Resource Group Name.
clusterName - Name of the cluster.
body - Request payload.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of define the cluster.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String clusterName, Boolean force)

Deletes an cluster.

Implements cluster DELETE method.

Parameters:

resourceGroupName - The Resource Group Name.
clusterName - Name of the cluster.
force - Whether force delete was specified.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String clusterName, Boolean force, Context context)

Deletes an cluster.

Implements cluster DELETE method.

Parameters:

resourceGroupName - The Resource Group Name.
clusterName - Name of the cluster.
force - Whether force delete was specified.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

create

public abstract ClusterInner create(String resourceGroupName, String clusterName)

Implements cluster PUT method.

Create Or Update cluster.

Parameters:

resourceGroupName - The Resource Group Name.
clusterName - Name of the cluster.

Returns:

define the cluster.

create

public abstract ClusterInner create(String resourceGroupName, String clusterName, ClusterInner body)

Implements cluster PUT method.

Create Or Update cluster.

Parameters:

resourceGroupName - The Resource Group Name.
clusterName - Name of the cluster.
body - Request payload.

Returns:

define the cluster.

create

public abstract ClusterInner create(String resourceGroupName, String clusterName, ClusterInner body, Context context)

Implements cluster PUT method.

Create Or Update cluster.

Parameters:

resourceGroupName - The Resource Group Name.
clusterName - Name of the cluster.
body - Request payload.
context - The context to associate with this operation.

Returns:

define the cluster.

delete

public abstract void delete(String resourceGroupName, String clusterName)

Deletes an cluster.

Implements cluster DELETE method.

Parameters:

resourceGroupName - The Resource Group Name.
clusterName - Name of the cluster.

delete

public abstract void delete(String resourceGroupName, String clusterName, Boolean force)

Deletes an cluster.

Implements cluster DELETE method.

Parameters:

resourceGroupName - The Resource Group Name.
clusterName - Name of the cluster.
force - Whether force delete was specified.

delete

public abstract void delete(String resourceGroupName, String clusterName, Boolean force, Context context)

Deletes an cluster.

Implements cluster DELETE method.

Parameters:

resourceGroupName - The Resource Group Name.
clusterName - Name of the cluster.
force - Whether force delete was specified.
context - The context to associate with this operation.

getByResourceGroup

public abstract ClusterInner getByResourceGroup(String resourceGroupName, String clusterName)

Gets a cluster.

Implements cluster GET method.

Parameters:

resourceGroupName - The Resource Group Name.
clusterName - Name of the cluster.

Returns:

define the cluster.

getByResourceGroupWithResponse

public abstract Response<ClusterInner> getByResourceGroupWithResponse(String resourceGroupName, String clusterName, Context context)

Gets a cluster.

Implements cluster GET method.

Parameters:

resourceGroupName - The Resource Group Name.
clusterName - Name of the cluster.
context - The context to associate with this operation.

Returns:

define the cluster along with Response<T>.

list

public abstract PagedIterable<ClusterInner> list()

Implements GET clusters in a subscription.

List of clusters in a subscription.

Returns:

list of Clusters as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<ClusterInner> list(Context context)

Implements GET clusters in a subscription.

List of clusters in a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

list of Clusters as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<ClusterInner> listByResourceGroup(String resourceGroupName)

Implements GET clusters in a resource group.

List of clusters in a resource group.

Parameters:

resourceGroupName - The Resource Group Name.

Returns:

list of Clusters as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<ClusterInner> listByResourceGroup(String resourceGroupName, Context context)

Implements GET clusters in a resource group.

List of clusters in a resource group.

Parameters:

resourceGroupName - The Resource Group Name.
context - The context to associate with this operation.

Returns:

list of Clusters as paginated response with PagedIterable<T>.

update

public abstract ClusterInner update(String resourceGroupName, String clusterName)

Updates a cluster.

API to update certain properties of the cluster resource.

Parameters:

resourceGroupName - The Resource Group Name.
clusterName - Name of the cluster.

Returns:

define the cluster.

updateWithResponse

public abstract Response<ClusterInner> updateWithResponse(String resourceGroupName, String clusterName, ResourcePatch body, Context context)

Updates a cluster.

API to update certain properties of the cluster resource.

Parameters:

resourceGroupName - The Resource Group Name.
clusterName - Name of the cluster.
body - Resource properties to update.
context - The context to associate with this operation.

Returns:

define the cluster along with Response<T>.

Applies to