ClustersOperations interface

Package:

@azure/arm-postgresqlhsc

Interface representing a Clusters operations.

Properties

checkNameAvailability	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.
create	Creates a new cluster with servers.
delete	Deletes a cluster together with servers in it.
get	Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.
list	Lists all clusters in a subscription.
listByResourceGroup	Lists all clusters in a resource group.
promoteReadReplica	Promotes read replica cluster to an independent read-write cluster.
restart	Restarts all nodes in the cluster.
start	Starts stopped compute on all cluster nodes.
stop	Stops compute on all cluster nodes.
update	Updates an existing cluster. The request body can contain one or several properties from the cluster definition.

Property Details

checkNameAvailability

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.

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

Property Value

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

create

Creates a new cluster with servers.

create: (resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

Property Value

(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

delete

Deletes a cluster together with servers in it.

delete: (resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

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

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

Property Value

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

list

Lists all clusters in a subscription.

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

Property Value

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

listByResourceGroup

Lists all clusters in a resource group.

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

Property Value

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

promoteReadReplica

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

promoteReadReplica: (resourceGroupName: string, clusterName: string, options?: ClustersPromoteReadReplicaOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersPromoteReadReplicaOptionalParams) => PollerLike<OperationState<void>, void>

restart

Restarts all nodes in the cluster.

restart: (resourceGroupName: string, clusterName: string, options?: ClustersRestartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersRestartOptionalParams) => PollerLike<OperationState<void>, void>

start

Starts stopped compute on all cluster nodes.

start: (resourceGroupName: string, clusterName: string, options?: ClustersStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersStartOptionalParams) => PollerLike<OperationState<void>, void>

stop

Stops compute on all cluster nodes.

stop: (resourceGroupName: string, clusterName: string, options?: ClustersStopOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersStopOptionalParams) => PollerLike<OperationState<void>, void>

update

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

update: (resourceGroupName: string, clusterName: string, parameters: ClusterForUpdate, options?: ClustersUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

Property Value

(resourceGroupName: string, clusterName: string, parameters: ClusterForUpdate, options?: ClustersUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>