Clusters interface

Package:

@azure/arm-cosmosdbforpostgresql

Interface representing a Clusters.

Methods

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)	Creates a new cluster with servers.
beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)	Creates a new cluster with servers.
beginDelete(string, string, ClustersDeleteOptionalParams)	Deletes a cluster together with servers in it.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	Deletes a cluster together with servers in it.
beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)	Promotes read replica cluster to an independent read-write cluster.
beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)	Promotes read replica cluster to an independent read-write cluster.
beginRestart(string, string, ClustersRestartOptionalParams)	Restarts all nodes in the cluster.
beginRestartAndWait(string, string, ClustersRestartOptionalParams)	Restarts all nodes in the cluster.
beginStart(string, string, ClustersStartOptionalParams)	Starts stopped compute on all cluster nodes.
beginStartAndWait(string, string, ClustersStartOptionalParams)	Starts stopped compute on all cluster nodes.
beginStop(string, string, ClustersStopOptionalParams)	Stops compute on all cluster nodes.
beginStopAndWait(string, string, ClustersStopOptionalParams)	Stops compute on all cluster nodes.
beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)	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.
get(string, string, ClustersGetOptionalParams)	Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.
list(ClustersListOptionalParams)	Lists all clusters in a subscription.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	Lists all clusters in a resource group.

Method Details

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)

Creates a new cluster with servers.

function beginCreate(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

parameters

Cluster

The required parameters for creating or updating a cluster.

options

ClustersCreateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)

Creates a new cluster with servers.

function beginCreateAndWait(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

parameters

Cluster

The required parameters for creating or updating a cluster.

options

ClustersCreateOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Deletes a cluster together with servers in it.

function beginDelete(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Deletes a cluster together with servers in it.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)

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

function beginPromoteReadReplica(resourceGroupName: string, clusterName: string, options?: ClustersPromoteReadReplicaOptionalParams): Promise<SimplePollerLike<OperationState<ClustersPromoteReadReplicaHeaders>, ClustersPromoteReadReplicaHeaders>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ClustersPromoteReadReplicaOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ClustersPromoteReadReplicaHeaders>, ClustersPromoteReadReplicaHeaders>>

beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)

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

function beginPromoteReadReplicaAndWait(resourceGroupName: string, clusterName: string, options?: ClustersPromoteReadReplicaOptionalParams): Promise<ClustersPromoteReadReplicaHeaders>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ClustersPromoteReadReplicaOptionalParams

The options parameters.

Returns

Promise<ClustersPromoteReadReplicaHeaders>

beginRestart(string, string, ClustersRestartOptionalParams)

Restarts all nodes in the cluster.

function beginRestart(resourceGroupName: string, clusterName: string, options?: ClustersRestartOptionalParams): Promise<SimplePollerLike<OperationState<ClustersRestartHeaders>, ClustersRestartHeaders>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ClustersRestartOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ClustersRestartHeaders>, ClustersRestartHeaders>>

beginRestartAndWait(string, string, ClustersRestartOptionalParams)

Restarts all nodes in the cluster.

function beginRestartAndWait(resourceGroupName: string, clusterName: string, options?: ClustersRestartOptionalParams): Promise<ClustersRestartHeaders>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ClustersRestartOptionalParams

The options parameters.

Returns

Promise<ClustersRestartHeaders>

beginStart(string, string, ClustersStartOptionalParams)

Starts stopped compute on all cluster nodes.

function beginStart(resourceGroupName: string, clusterName: string, options?: ClustersStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ClustersStartOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginStartAndWait(string, string, ClustersStartOptionalParams)

Starts stopped compute on all cluster nodes.

function beginStartAndWait(resourceGroupName: string, clusterName: string, options?: ClustersStartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ClustersStartOptionalParams

The options parameters.

Returns

Promise<void>

beginStop(string, string, ClustersStopOptionalParams)

Stops compute on all cluster nodes.

function beginStop(resourceGroupName: string, clusterName: string, options?: ClustersStopOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ClustersStopOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginStopAndWait(string, string, ClustersStopOptionalParams)

Stops compute on all cluster nodes.

function beginStopAndWait(resourceGroupName: string, clusterName: string, options?: ClustersStopOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ClustersStopOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Updates an existing cluster. The request body can contain one or several properties from the cluster definition.

function beginUpdate(resourceGroupName: string, clusterName: string, parameters: ClusterForUpdate, options?: ClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

parameters

ClusterForUpdate

The parameters for updating a cluster.

options

ClustersUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Updates an existing cluster. The request body can contain one or several properties from the cluster definition.

function beginUpdateAndWait(resourceGroupName: string, clusterName: string, parameters: ClusterForUpdate, options?: ClustersUpdateOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

parameters

ClusterForUpdate

The parameters for updating a cluster.

options

ClustersUpdateOptionalParams

The options parameters.

Returns

Promise<Cluster>

checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)

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.

function checkNameAvailability(nameAvailabilityRequest: NameAvailabilityRequest, options?: ClustersCheckNameAvailabilityOptionalParams): Promise<NameAvailability>

Parameters

nameAvailabilityRequest

NameAvailabilityRequest

The required parameters for checking if cluster name is available.

options

ClustersCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<NameAvailability>

get(string, string, ClustersGetOptionalParams)

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

function get(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

ClustersGetOptionalParams

The options parameters.

Returns

Promise<Cluster>

list(ClustersListOptionalParams)

Lists all clusters in a subscription.

function list(options?: ClustersListOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameters

options

ClustersListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Lists all clusters in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameters

resourceGroupName

string

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

options

ClustersListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>