Package com.azure.resourcemanager.azurestackhci.fluent

Interface ClustersClient

public interface ClustersClient

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

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterIdentityResponseInner>,ClusterIdentityResponseInner>	beginCreateIdentity(String resourceGroupName, String clusterName)	Create cluster identity.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterIdentityResponseInner>,ClusterIdentityResponseInner>	beginCreateIdentity(String resourceGroupName, String clusterName, com.azure.core.util.Context context)	Create cluster identity.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String clusterName)	Delete an HCI cluster.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String clusterName, com.azure.core.util.Context context)	Delete an HCI cluster.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginUploadCertificate(String resourceGroupName, String clusterName, UploadCertificateRequest uploadCertificateRequest)	Upload certificate.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginUploadCertificate(String resourceGroupName, String clusterName, UploadCertificateRequest uploadCertificateRequest, com.azure.core.util.Context context)	Upload certificate.
ClusterInner	create(String resourceGroupName, String clusterName, ClusterInner cluster)	Create an HCI cluster.
ClusterIdentityResponseInner	createIdentity(String resourceGroupName, String clusterName)	Create cluster identity.
ClusterIdentityResponseInner	createIdentity(String resourceGroupName, String clusterName, com.azure.core.util.Context context)	Create cluster identity.
com.azure.core.http.rest.Response<ClusterInner>	createWithResponse(String resourceGroupName, String clusterName, ClusterInner cluster, com.azure.core.util.Context context)	Create an HCI cluster.
void	delete(String resourceGroupName, String clusterName)	Delete an HCI cluster.
void	delete(String resourceGroupName, String clusterName, com.azure.core.util.Context context)	Delete an HCI cluster.
ClusterInner	getByResourceGroup(String resourceGroupName, String clusterName)	Get HCI cluster.
com.azure.core.http.rest.Response<ClusterInner>	getByResourceGroupWithResponse(String resourceGroupName, String clusterName, com.azure.core.util.Context context)	Get HCI cluster.
com.azure.core.http.rest.PagedIterable<ClusterInner>	list()	List all HCI clusters in a subscription.
com.azure.core.http.rest.PagedIterable<ClusterInner>	list(com.azure.core.util.Context context)	List all HCI clusters in a subscription.
com.azure.core.http.rest.PagedIterable<ClusterInner>	listByResourceGroup(String resourceGroupName)	List all HCI clusters in a resource group.
com.azure.core.http.rest.PagedIterable<ClusterInner>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	List all HCI clusters in a resource group.
ClusterInner	update(String resourceGroupName, String clusterName, ClusterPatch cluster)	Update an HCI cluster.
com.azure.core.http.rest.Response<ClusterInner>	updateWithResponse(String resourceGroupName, String clusterName, ClusterPatch cluster, com.azure.core.util.Context context)	Update an HCI cluster.
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<ClusterInner> 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<ClusterInner> 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<ClusterInner> 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<ClusterInner> 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

ClusterInner 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<ClusterInner> 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.

create

ClusterInner create(String resourceGroupName,
                    String clusterName,
                    ClusterInner cluster)

Create an HCI cluster.

Parameters:

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

clusterName - The name of the cluster.

cluster - Details of the HCI cluster.

Returns:

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

createWithResponse

com.azure.core.http.rest.Response<ClusterInner> createWithResponse(String resourceGroupName,
                                                                   String clusterName,
                                                                   ClusterInner cluster,
                                                                   com.azure.core.util.Context context)

Create an HCI cluster.

Parameters:

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

clusterName - The name of the cluster.

cluster - Details of the HCI cluster.

context - The context to associate with this operation.

Returns:

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

update

ClusterInner update(String resourceGroupName,
                    String clusterName,
                    ClusterPatch cluster)

Update an HCI cluster.

Parameters:

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

clusterName - The name of the cluster.

cluster - Details of the HCI cluster.

Returns:

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

updateWithResponse

com.azure.core.http.rest.Response<ClusterInner> updateWithResponse(String resourceGroupName,
                                                                   String clusterName,
                                                                   ClusterPatch cluster,
                                                                   com.azure.core.util.Context context)

Update an HCI cluster.

Parameters:

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

clusterName - The name of the cluster.

cluster - Details of the HCI cluster.

context - The context to associate with this operation.

Returns:

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

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(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.

Returns:

the SyncPoller for polling of long-running 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.

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(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.

Returns:

the SyncPoller for polling of long-running 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.

delete

void delete(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.

beginUploadCertificate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginUploadCertificate(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.

Returns:

the SyncPoller for polling of long-running 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.

beginUploadCertificate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginUploadCertificate(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.

Returns:

the SyncPoller for polling of long-running 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.

beginCreateIdentity

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterIdentityResponseInner>,ClusterIdentityResponseInner> beginCreateIdentity(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:

the SyncPoller for polling of 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.

beginCreateIdentity

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ClusterIdentityResponseInner>,ClusterIdentityResponseInner> beginCreateIdentity(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:

the SyncPoller for polling of 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

ClusterIdentityResponseInner 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

ClusterIdentityResponseInner 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.