Clusters Interface

Package:
com.azure.resourcemanager.cosmosdbforpostgresql.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cosmosdbforpostgresql:1.0.0

public interface Clusters

Resource collection API of Clusters.

Method Summary

Modifier and Type Method and Description
abstract NameAvailability checkNameAvailability(NameAvailabilityRequest nameAvailabilityRequest)

Checks availability of a cluster name.
abstract Response<NameAvailability> checkNameAvailabilityWithResponse(NameAvailabilityRequest nameAvailabilityRequest, Context context)

Checks availability of a cluster name.
abstract Blank define(String name)

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

Deletes a cluster together with servers in it.
abstract void deleteById(String id)

Deletes a cluster together with servers in it.
abstract void deleteByIdWithResponse(String id, Context context)

Deletes a cluster together with servers in it.
abstract void deleteByResourceGroup(String resourceGroupName, String clusterName)

Deletes a cluster together with servers in it.
abstract Cluster getById(String id)

Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.
abstract Response<Cluster> getByIdWithResponse(String id, Context context)

Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.
abstract Cluster getByResourceGroup(String resourceGroupName, String clusterName)

Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.
abstract Response<Cluster> getByResourceGroupWithResponse(String resourceGroupName, String clusterName, Context context)

Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.
abstract PagedIterable<Cluster> list()

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

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

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

Lists all clusters in a resource group.
abstract void promoteReadReplica(String resourceGroupName, String clusterName)

Promotes read replica cluster to an independent read-write cluster.
abstract void promoteReadReplica(String resourceGroupName, String clusterName, Context context)

Promotes read replica cluster to an independent read-write cluster.
abstract void restart(String resourceGroupName, String clusterName)

Restarts all nodes in the cluster.
abstract void restart(String resourceGroupName, String clusterName, Context context)

Restarts all nodes in the cluster.
abstract void start(String resourceGroupName, String clusterName)

Starts stopped compute on all cluster nodes.
abstract void start(String resourceGroupName, String clusterName, Context context)

Starts stopped compute on all cluster nodes.
abstract void stop(String resourceGroupName, String clusterName)

Stops compute on all cluster nodes.
abstract void stop(String resourceGroupName, String clusterName, Context context)

Stops compute on all cluster nodes.

Method Details

checkNameAvailability

public abstract NameAvailability checkNameAvailability(NameAvailabilityRequest nameAvailabilityRequest)

Checks availability of a cluster name. Cluster names should be globally unique; at least 3 characters and at most 40 characters long; they must only contain lowercase letters, numbers, and hyphens; and must not start or end with a hyphen.

Parameters:

nameAvailabilityRequest - The required parameters for checking if cluster name is available.

Returns:

represents cluster name availability.

checkNameAvailabilityWithResponse

public abstract Response<NameAvailability> checkNameAvailabilityWithResponse(NameAvailabilityRequest nameAvailabilityRequest, Context context)

Checks availability of a cluster name. Cluster names should be globally unique; at least 3 characters and at most 40 characters long; they must only contain lowercase letters, numbers, and hyphens; and must not start or end with a hyphen.

Parameters:

nameAvailabilityRequest - The required parameters for checking if cluster name is available.
context - The context to associate with this operation.

Returns:

represents cluster name availability along with Response<T>.

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)

Deletes a cluster together with servers in it.

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)

Deletes a cluster together with servers in it.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes a cluster together with servers in it.

Parameters:

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

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String clusterName)

Deletes a cluster together with servers in it.

Parameters:

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

getById

public abstract Cluster getById(String id)

Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.

Parameters:

id - the resource ID.

Returns:

information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time along with Response<T>.

getByIdWithResponse

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

Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.

Parameters:

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

Returns:

information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time along with Response<T>.

getByResourceGroup

public abstract Cluster getByResourceGroup(String resourceGroupName, String clusterName)

Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.

Parameters:

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

Returns:

information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.

getByResourceGroupWithResponse

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

Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.

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:

information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time along with Response<T>.

list

public abstract PagedIterable<Cluster> list()

Lists all clusters in a subscription.

Returns:

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

list

public abstract PagedIterable<Cluster> list(Context context)

Lists all clusters in a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

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

listByResourceGroup

public abstract PagedIterable<Cluster> listByResourceGroup(String resourceGroupName)

Lists all clusters in a resource group.

Parameters:

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

Returns:

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

listByResourceGroup

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

Lists all 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:

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

promoteReadReplica

public abstract void promoteReadReplica(String resourceGroupName, String clusterName)

Promotes read replica cluster to an independent read-write cluster.

Parameters:

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

promoteReadReplica

public abstract void promoteReadReplica(String resourceGroupName, String clusterName, Context context)

Promotes read replica cluster to an independent read-write 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.

restart

public abstract void restart(String resourceGroupName, String clusterName)

Restarts all nodes in the cluster.

Parameters:

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

restart

public abstract void restart(String resourceGroupName, String clusterName, Context context)

Restarts all nodes in the 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.

start

public abstract void start(String resourceGroupName, String clusterName)

Starts stopped compute on all cluster nodes.

Parameters:

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

start

public abstract void start(String resourceGroupName, String clusterName, Context context)

Starts stopped compute on all cluster nodes.

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.

stop

public abstract void stop(String resourceGroupName, String clusterName)

Stops compute on all cluster nodes.

Parameters:

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

stop

public abstract void stop(String resourceGroupName, String clusterName, Context context)

Stops compute on all cluster nodes.

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.

Applies to