Clusters Interface

Package:
com.azure.resourcemanager.azurestackhci.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-azurestackhci:1.1.0

public interface Clusters

Resource collection API of Clusters.

Method Summary

Modifier and Type Method and Description
abstract Cluster configureRemoteSupport(String resourceGroupName, String clusterName, RemoteSupportRequest remoteSupportRequest)

Configure RemoteSupport on a cluster.
abstract Cluster configureRemoteSupport(String resourceGroupName, String clusterName, RemoteSupportRequest remoteSupportRequest, Context context)

Configure RemoteSupport on a cluster.
abstract ClusterIdentityResponse createIdentity(String resourceGroupName, String clusterName)

Create cluster identity.
abstract ClusterIdentityResponse createIdentity(String resourceGroupName, String clusterName, Context context)

Create cluster identity.
abstract Blank define(String name)

Begins definition for a new Cluster resource.
abstract void delete(String resourceGroupName, String clusterName, Context context)

Delete an HCI cluster.
abstract void deleteById(String id)

Delete an HCI cluster.
abstract void deleteByIdWithResponse(String id, Context context)

Delete an HCI cluster.
abstract void deleteByResourceGroup(String resourceGroupName, String clusterName)

Delete an HCI cluster.
abstract Cluster extendSoftwareAssuranceBenefit(String resourceGroupName, String clusterName, SoftwareAssuranceChangeRequest softwareAssuranceChangeRequest)

Extends Software Assurance Benefit to a cluster.
abstract Cluster extendSoftwareAssuranceBenefit(String resourceGroupName, String clusterName, SoftwareAssuranceChangeRequest softwareAssuranceChangeRequest, Context context)

Extends Software Assurance Benefit to a cluster.
abstract Cluster getById(String id)

Get HCI cluster.
abstract Response<Cluster> getByIdWithResponse(String id, Context context)

Get HCI cluster.
abstract Cluster getByResourceGroup(String resourceGroupName, String clusterName)

Get HCI cluster.
abstract Response<Cluster> getByResourceGroupWithResponse(String resourceGroupName, String clusterName, Context context)

Get HCI cluster.
abstract PagedIterable<Cluster> list()

List all HCI clusters in a subscription.
abstract PagedIterable<Cluster> list(Context context)

List all HCI clusters in a subscription.
abstract PagedIterable<Cluster> listByResourceGroup(String resourceGroupName)

List all HCI clusters in a resource group.
abstract PagedIterable<Cluster> listByResourceGroup(String resourceGroupName, Context context)

List all HCI clusters in a resource group.
abstract Cluster triggerLogCollection(String resourceGroupName, String clusterName, LogCollectionRequest logCollectionRequest)

Trigger Log Collection on a cluster.
abstract Cluster triggerLogCollection(String resourceGroupName, String clusterName, LogCollectionRequest logCollectionRequest, Context context)

Trigger Log Collection on a cluster.
abstract Cluster updateSecretsLocations(String resourceGroupName, String clusterName, SecretsLocationsChangeRequest body)

Update cluster secrets locations.
abstract Cluster updateSecretsLocations(String resourceGroupName, String clusterName, SecretsLocationsChangeRequest body, Context context)

Update cluster secrets locations.
abstract void uploadCertificate(String resourceGroupName, String clusterName, UploadCertificateRequest uploadCertificateRequest)

Upload certificate.
abstract void uploadCertificate(String resourceGroupName, String clusterName, UploadCertificateRequest uploadCertificateRequest, Context context)

Upload certificate.

Method Details

configureRemoteSupport

public abstract Cluster configureRemoteSupport(String resourceGroupName, String clusterName, RemoteSupportRequest remoteSupportRequest)

Configure RemoteSupport on a cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
remoteSupportRequest - Configure Remote Support Request Payload.

Returns:

cluster details.

configureRemoteSupport

public abstract Cluster configureRemoteSupport(String resourceGroupName, String clusterName, RemoteSupportRequest remoteSupportRequest, Context context)

Configure RemoteSupport on a cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
remoteSupportRequest - Configure Remote Support Request Payload.
context - The context to associate with this operation.

Returns:

cluster details.

createIdentity

public abstract 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:

the response.

createIdentity

public abstract ClusterIdentityResponse createIdentity(String resourceGroupName, String clusterName, 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 response.

define

public abstract 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.

delete

public abstract void delete(String resourceGroupName, String clusterName, 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.

deleteById

public abstract void deleteById(String id)

Delete an HCI cluster.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete an HCI cluster.

Parameters:

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

deleteByResourceGroup

public abstract 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.

extendSoftwareAssuranceBenefit

public abstract Cluster extendSoftwareAssuranceBenefit(String resourceGroupName, String clusterName, SoftwareAssuranceChangeRequest softwareAssuranceChangeRequest)

Extends Software Assurance Benefit to a cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
softwareAssuranceChangeRequest - Software Assurance Change Request Payload.

Returns:

cluster details.

extendSoftwareAssuranceBenefit

public abstract Cluster extendSoftwareAssuranceBenefit(String resourceGroupName, String clusterName, SoftwareAssuranceChangeRequest softwareAssuranceChangeRequest, Context context)

Extends Software Assurance Benefit to a cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
softwareAssuranceChangeRequest - Software Assurance Change Request Payload.
context - The context to associate with this operation.

Returns:

cluster details.

getById

public abstract Cluster getById(String id)

Get HCI cluster.

Parameters:

id - the resource ID.

Returns:

hCI cluster along with Response<T>.

getByIdWithResponse

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

Get HCI cluster.

Parameters:

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

Returns:

hCI cluster along with Response<T>.

getByResourceGroup

public abstract 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.

getByResourceGroupWithResponse

public abstract Response<Cluster> getByResourceGroupWithResponse(String resourceGroupName, String clusterName, 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<T>.

list

public abstract PagedIterable<Cluster> list()

List all HCI clusters in a subscription.

Returns:

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

list

public abstract PagedIterable<Cluster> list(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<T>.

listByResourceGroup

public abstract 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<T>.

listByResourceGroup

public abstract PagedIterable<Cluster> listByResourceGroup(String resourceGroupName, 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<T>.

triggerLogCollection

public abstract Cluster triggerLogCollection(String resourceGroupName, String clusterName, LogCollectionRequest logCollectionRequest)

Trigger Log Collection on a cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
logCollectionRequest - Trigger Log Collection Request Payload.

Returns:

cluster details.

triggerLogCollection

public abstract Cluster triggerLogCollection(String resourceGroupName, String clusterName, LogCollectionRequest logCollectionRequest, Context context)

Trigger Log Collection on a cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
logCollectionRequest - Trigger Log Collection Request Payload.
context - The context to associate with this operation.

Returns:

cluster details.

updateSecretsLocations

public abstract Cluster updateSecretsLocations(String resourceGroupName, String clusterName, SecretsLocationsChangeRequest body)

Update cluster secrets locations.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
body - The content of the action request.

Returns:

cluster details.

updateSecretsLocations

public abstract Cluster updateSecretsLocations(String resourceGroupName, String clusterName, SecretsLocationsChangeRequest body, Context context)

Update cluster secrets locations.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
body - The content of the action request.
context - The context to associate with this operation.

Returns:

cluster details.

uploadCertificate

public abstract 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.

uploadCertificate

public abstract void uploadCertificate(String resourceGroupName, String clusterName, UploadCertificateRequest uploadCertificateRequest, 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.

Applies to