Package com.azure.resourcemanager.avs.models

Interface Clusters

public interface Clusters

Resource collection API of Clusters.

Method Summary

Modifier and Type	Method	Description
Cluster.DefinitionStages.Blank	define(String name)	Begins definition for a new Cluster resource.
void	delete(String resourceGroupName, String privateCloudName, String clusterName)	Delete a cluster in a private cloud.
void	delete(String resourceGroupName, String privateCloudName, String clusterName, com.azure.core.util.Context context)	Delete a cluster in a private cloud.
void	deleteById(String id)	Delete a cluster in a private cloud.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete a cluster in a private cloud.
Cluster	get(String resourceGroupName, String privateCloudName, String clusterName)	Get a cluster by name in a private cloud.
Cluster	getById(String id)	Get a cluster by name in a private cloud.
com.azure.core.http.rest.Response<Cluster>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get a cluster by name in a private cloud.
com.azure.core.http.rest.Response<Cluster>	getWithResponse(String resourceGroupName, String privateCloudName, String clusterName, com.azure.core.util.Context context)	Get a cluster by name in a private cloud.
com.azure.core.http.rest.PagedIterable<Cluster>	list(String resourceGroupName, String privateCloudName)	List clusters in a private cloud.
com.azure.core.http.rest.PagedIterable<Cluster>	list(String resourceGroupName, String privateCloudName, com.azure.core.util.Context context)	List clusters in a private cloud.

Method Detail

list

com.azure.core.http.rest.PagedIterable<Cluster> list(String resourceGroupName,
                                                     String privateCloudName)

List clusters in a private cloud.

Parameters:

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

privateCloudName - Name of the private cloud.

Returns:

a paged list of clusters.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<Cluster> list(String resourceGroupName,
                                                     String privateCloudName,
                                                     com.azure.core.util.Context context)

List clusters in a private cloud.

Parameters:

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

privateCloudName - Name of the private cloud.

context - The context to associate with this operation.

Returns:

a paged list of clusters.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

Cluster get(String resourceGroupName,
            String privateCloudName,
            String clusterName)

Get a cluster by name in a private cloud.

Parameters:

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

privateCloudName - Name of the private cloud.

clusterName - Name of the cluster in the private cloud.

Returns:

a cluster by name in a private cloud.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

com.azure.core.http.rest.Response<Cluster> getWithResponse(String resourceGroupName,
                                                           String privateCloudName,
                                                           String clusterName,
                                                           com.azure.core.util.Context context)

Get a cluster by name in a private cloud.

Parameters:

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

privateCloudName - Name of the private cloud.

clusterName - Name of the cluster in the private cloud.

context - The context to associate with this operation.

Returns:

a cluster by name in a private cloud.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String privateCloudName,
            String clusterName)

Delete a cluster in a private cloud.

Parameters:

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

privateCloudName - Name of the private cloud.

clusterName - Name of the cluster in the private cloud.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String privateCloudName,
            String clusterName,
            com.azure.core.util.Context context)

Delete a cluster in a private cloud.

Parameters:

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

privateCloudName - Name of the private cloud.

clusterName - Name of the cluster in the private cloud.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getById

Cluster getById(String id)

Get a cluster by name in a private cloud.

Parameters:

id - the resource ID.

Returns:

a cluster by name in a private cloud.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByIdWithResponse

com.azure.core.http.rest.Response<Cluster> getByIdWithResponse(String id,
                                                               com.azure.core.util.Context context)

Get a cluster by name in a private cloud.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

a cluster by name in a private cloud.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteById

void deleteById(String id)

Delete a cluster in a private cloud.

Parameters:

id - the resource ID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteByIdWithResponse

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Delete a cluster in a private cloud.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

define

Cluster.DefinitionStages.Blank define(String name)

Begins definition for a new Cluster resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Cluster definition.