Package com.azure.resourcemanager.azurestackhci.models

Interface Clusters

public interface Clusters

Resource collection API of Clusters.

Method Summary

Modifier and Type	Method	Description
ClusterIdentityResponse	createIdentity(String resourceGroupName, String clusterName)	Create cluster identity.
ClusterIdentityResponse	createIdentity(String resourceGroupName, String clusterName, com.azure.core.util.Context context)	Create cluster identity.
Cluster.DefinitionStages.Blank	define(String name)	Begins definition for a new Cluster resource.
void	delete(String resourceGroupName, String clusterName, com.azure.core.util.Context context)	Delete an HCI cluster.
void	deleteById(String id)	Delete an HCI cluster.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete an HCI cluster.
void	deleteByResourceGroup(String resourceGroupName, String clusterName)	Delete an HCI cluster.
Cluster	getById(String id)	Get HCI cluster.
com.azure.core.http.rest.Response<Cluster>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get HCI cluster.
Cluster	getByResourceGroup(String resourceGroupName, String clusterName)	Get HCI cluster.
com.azure.core.http.rest.Response<Cluster>	getByResourceGroupWithResponse(String resourceGroupName, String clusterName, com.azure.core.util.Context context)	Get HCI cluster.
com.azure.core.http.rest.PagedIterable<Cluster>	list()	List all HCI clusters in a subscription.
com.azure.core.http.rest.PagedIterable<Cluster>	list(com.azure.core.util.Context context)	List all HCI clusters in a subscription.
com.azure.core.http.rest.PagedIterable<Cluster>	listByResourceGroup(String resourceGroupName)	List all HCI clusters in a resource group.
com.azure.core.http.rest.PagedIterable<Cluster>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	List all HCI clusters in a resource group.
void	uploadCertificate(String resourceGroupName, String clusterName, UploadCertificateRequest uploadCertificateRequest)	Upload certificate.
void	uploadCertificate(String resourceGroupName, String clusterName, UploadCertificateRequest uploadCertificateRequest, com.azure.core.util.Context context)	Upload certificate.

Method Detail

list

com.azure.core.http.rest.PagedIterable<Cluster> list()

List all HCI clusters in a subscription.

Returns:

list of clusters as paginated response with PagedIterable.

Throws:

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(com.azure.core.util.Context context)

List all HCI clusters in a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

list of clusters as paginated response with PagedIterable.

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.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<Cluster> listByResourceGroup(String resourceGroupName)

List all HCI clusters in a resource group.

Parameters:

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

Returns:

list of clusters as paginated response with PagedIterable.

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.

listByResourceGroup

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

List all HCI clusters in a resource group.

Parameters:

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

context - The context to associate with this operation.

Returns:

list of clusters as paginated response with PagedIterable.

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.

getByResourceGroup

Cluster getByResourceGroup(String resourceGroupName,
                           String clusterName)

Get HCI cluster.

Parameters:

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

clusterName - The name of the cluster.

Returns:

hCI cluster.

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.

getByResourceGroupWithResponse

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

Get HCI cluster.

Parameters:

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

clusterName - The name of the cluster.

context - The context to associate with this operation.

Returns:

hCI cluster along with Response.

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.

deleteByResourceGroup

void deleteByResourceGroup(String resourceGroupName,
                           String clusterName)

Delete an HCI cluster.

Parameters:

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

clusterName - The name of the cluster.

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 clusterName,
            com.azure.core.util.Context context)

Delete an HCI cluster.

Parameters:

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

clusterName - The name of the cluster.

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.

uploadCertificate

void uploadCertificate(String resourceGroupName,
                       String clusterName,
                       UploadCertificateRequest uploadCertificateRequest)

Upload certificate.

Parameters:

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

clusterName - The name of the cluster.

uploadCertificateRequest - Upload certificate request.

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.

uploadCertificate

void uploadCertificate(String resourceGroupName,
                       String clusterName,
                       UploadCertificateRequest uploadCertificateRequest,
                       com.azure.core.util.Context context)

Upload certificate.

Parameters:

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

clusterName - The name of the cluster.

uploadCertificateRequest - Upload certificate request.

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.

createIdentity

ClusterIdentityResponse createIdentity(String resourceGroupName,
                                       String clusterName)

Create cluster identity.

Parameters:

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

clusterName - The name of the cluster.

Returns:

cluster Identity details.

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.

createIdentity

ClusterIdentityResponse createIdentity(String resourceGroupName,
                                       String clusterName,
                                       com.azure.core.util.Context context)

Create cluster identity.

Parameters:

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

clusterName - The name of the cluster.

context - The context to associate with this operation.

Returns:

cluster Identity details.

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 HCI cluster.

Parameters:

id - the resource ID.

Returns:

hCI cluster along with Response.

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 HCI cluster.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

hCI cluster along with Response.

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 an HCI cluster.

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 an HCI cluster.

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.