Clusters interface

Paket:

@azure/arm-cosmosdbforpostgresql

Gränssnitt som representerar ett kluster.

Metoder

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)	Skapar ett nytt kluster med servrar.
beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)	Skapar ett nytt kluster med servrar.
beginDelete(string, string, ClustersDeleteOptionalParams)	Tar bort ett kluster tillsammans med servrar i det.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	Tar bort ett kluster tillsammans med servrar i det.
beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)	Höjer upp skrivskyddat replikkluster till ett oberoende skrivskyddat kluster.
beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)	Höjer upp skrivskyddat replikkluster till ett oberoende skrivskyddat kluster.
beginRestart(string, string, ClustersRestartOptionalParams)	Startar om alla noder i klustret.
beginRestartAndWait(string, string, ClustersRestartOptionalParams)	Startar om alla noder i klustret.
beginStart(string, string, ClustersStartOptionalParams)	Startar stoppad beräkning på alla klusternoder.
beginStartAndWait(string, string, ClustersStartOptionalParams)	Startar stoppad beräkning på alla klusternoder.
beginStop(string, string, ClustersStopOptionalParams)	Stoppar beräkning på alla klusternoder.
beginStopAndWait(string, string, ClustersStopOptionalParams)	Stoppar beräkning på alla klusternoder.
beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Uppdateringar ett befintligt kluster. Begärandetexten kan innehålla en eller flera egenskaper från klusterdefinitionen.
beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Uppdateringar ett befintligt kluster. Begärandetexten kan innehålla en eller flera egenskaper från klusterdefinitionen.
checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)	Kontrollerar tillgängligheten för ett klusternamn. Klusternamn bör vara globalt unika. minst 3 tecken och högst 40 tecken långa; De får endast innehålla gemener, siffror och bindestreck. och får inte börja eller sluta med ett bindestreck.
get(string, string, ClustersGetOptionalParams)	Hämtar information om ett kluster, till exempel beräknings- och lagringskonfiguration och metadata för klusterlivscykeln, till exempel datum och tid för klusterskapande.
list(ClustersListOptionalParams)	Visar en lista över alla kluster i en prenumeration.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	Visar en lista över alla kluster i en resursgrupp.

Metodinformation

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)

Skapar ett nytt kluster med servrar.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

clusterName

string

Namnet på klustret.

parameters

Cluster

De parametrar som krävs för att skapa eller uppdatera ett kluster.

options

ClustersCreateOptionalParams

Alternativparametrarna.

Returer

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)

Skapar ett nytt kluster med servrar.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

clusterName

string

Namnet på klustret.

parameters

Cluster

De parametrar som krävs för att skapa eller uppdatera ett kluster.

options

ClustersCreateOptionalParams

Alternativparametrarna.

Returer

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Tar bort ett kluster tillsammans med servrar i det.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

clusterName

string

Namnet på klustret.

options

ClustersDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Tar bort ett kluster tillsammans med servrar i det.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

clusterName

string

Namnet på klustret.

options

ClustersDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)

Höjer upp skrivskyddat replikkluster till ett oberoende skrivskyddat kluster.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

clusterName

string

Namnet på klustret.

options

ClustersPromoteReadReplicaOptionalParams

Alternativparametrarna.

Returer

Promise<@azure/core-lro.SimplePollerLike<OperationState<ClustersPromoteReadReplicaHeaders>, ClustersPromoteReadReplicaHeaders>>

beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)

Höjer upp skrivskyddat replikkluster till ett oberoende skrivskyddat kluster.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

clusterName

string

Namnet på klustret.

options

ClustersPromoteReadReplicaOptionalParams

Alternativparametrarna.

Returer

Promise<ClustersPromoteReadReplicaHeaders>

beginRestart(string, string, ClustersRestartOptionalParams)

Startar om alla noder i klustret.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

clusterName

string

Namnet på klustret.

options

ClustersRestartOptionalParams

Alternativparametrarna.

Returer

Promise<@azure/core-lro.SimplePollerLike<OperationState<ClustersRestartHeaders>, ClustersRestartHeaders>>

beginRestartAndWait(string, string, ClustersRestartOptionalParams)

Startar om alla noder i klustret.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

clusterName

string

Namnet på klustret.

options

ClustersRestartOptionalParams

Alternativparametrarna.

Returer

Promise<ClustersRestartHeaders>

beginStart(string, string, ClustersStartOptionalParams)

Startar stoppad beräkning på alla klusternoder.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

clusterName

string

Namnet på klustret.

options

ClustersStartOptionalParams

Alternativparametrarna.

Returer

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStartAndWait(string, string, ClustersStartOptionalParams)

Startar stoppad beräkning på alla klusternoder.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

clusterName

string

Namnet på klustret.

options

ClustersStartOptionalParams

Alternativparametrarna.

Returer

Promise<void>

beginStop(string, string, ClustersStopOptionalParams)

Stoppar beräkning på alla klusternoder.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

clusterName

string

Namnet på klustret.

options

ClustersStopOptionalParams

Alternativparametrarna.

Returer

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStopAndWait(string, string, ClustersStopOptionalParams)

Stoppar beräkning på alla klusternoder.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

clusterName

string

Namnet på klustret.

options

ClustersStopOptionalParams

Alternativparametrarna.

Returer

Promise<void>

beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Uppdateringar ett befintligt kluster. Begärandetexten kan innehålla en eller flera egenskaper från klusterdefinitionen.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

clusterName

string

Namnet på klustret.

parameters

ClusterForUpdate

Parametrarna för att uppdatera ett kluster.

options

ClustersUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Uppdateringar ett befintligt kluster. Begärandetexten kan innehålla en eller flera egenskaper från klusterdefinitionen.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

clusterName

string

Namnet på klustret.

parameters

ClusterForUpdate

Parametrarna för att uppdatera ett kluster.

options

ClustersUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<Cluster>

checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)

Kontrollerar tillgängligheten för ett klusternamn. Klusternamn bör vara globalt unika. minst 3 tecken och högst 40 tecken långa; De får endast innehålla gemener, siffror och bindestreck. och får inte börja eller sluta med ett bindestreck.

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

Parametrar

nameAvailabilityRequest

NameAvailabilityRequest

De parametrar som krävs för att kontrollera om klusternamnet är tillgängligt.

options

ClustersCheckNameAvailabilityOptionalParams

Alternativparametrarna.

Returer

Promise<NameAvailability>

get(string, string, ClustersGetOptionalParams)

Hämtar information om ett kluster, till exempel beräknings- och lagringskonfiguration och metadata för klusterlivscykeln, till exempel datum och tid för klusterskapande.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

clusterName

string

Namnet på klustret.

options

ClustersGetOptionalParams

Alternativparametrarna.

Returer

Promise<Cluster>

list(ClustersListOptionalParams)

Visar en lista över alla kluster i en prenumeration.

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

Parametrar

options

ClustersListOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Visar en lista över alla kluster i en resursgrupp.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

options

ClustersListByResourceGroupOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>