Clusters interface

Pakket:

@azure/arm-cosmosdbforpostgresql

Interface die een cluster vertegenwoordigt.

Methoden

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)	Hiermee maakt u een nieuw cluster met servers.
beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)	Hiermee maakt u een nieuw cluster met servers.
beginDelete(string, string, ClustersDeleteOptionalParams)	Hiermee verwijdert u een cluster samen met servers erin.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	Hiermee verwijdert u een cluster samen met servers erin.
beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)	Bevordert het leesreplicacluster naar een onafhankelijk cluster voor lezen/schrijven.
beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)	Bevordert het leesreplicacluster naar een onafhankelijk cluster voor lezen/schrijven.
beginRestart(string, string, ClustersRestartOptionalParams)	Start alle knooppunten in het cluster opnieuw op.
beginRestartAndWait(string, string, ClustersRestartOptionalParams)	Start alle knooppunten in het cluster opnieuw op.
beginStart(string, string, ClustersStartOptionalParams)	Start gestopte berekening op alle clusterknooppunten.
beginStartAndWait(string, string, ClustersStartOptionalParams)	Start gestopte berekening op alle clusterknooppunten.
beginStop(string, string, ClustersStopOptionalParams)	Hiermee stopt u de berekening op alle clusterknooppunten.
beginStopAndWait(string, string, ClustersStopOptionalParams)	Hiermee stopt u de berekening op alle clusterknooppunten.
beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Hiermee wordt een bestaand cluster bijgewerkt. De hoofdtekst van de aanvraag kan een of meer eigenschappen uit de clusterdefinitie bevatten.
beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Hiermee wordt een bestaand cluster bijgewerkt. De hoofdtekst van de aanvraag kan een of meer eigenschappen uit de clusterdefinitie bevatten.
checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)	Controleert de beschikbaarheid van een clusternaam. Clusternamen moeten wereldwijd uniek zijn; ten minste 3 tekens en maximaal 40 tekens lang; ze mogen alleen kleine letters, cijfers en afbreekstreepjes bevatten; en mag niet beginnen of eindigen met een afbreekstreepje.
get(string, string, ClustersGetOptionalParams)	Hiermee wordt informatie opgehaald over een cluster, zoals reken- en opslagconfiguratie en metagegevens van de levenscyclus van clusters, zoals de aanmaakdatum en -tijd van het cluster.
list(ClustersListOptionalParams)	Geeft een lijst weer van alle clusters in een abonnement.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	Een lijst met alle clusters in een resourcegroep.

Methodedetails

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)

Hiermee maakt u een nieuw cluster met servers.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

clusterName

string

De naam van het cluster.

parameters

Cluster

De vereiste parameters voor het maken of bijwerken van een cluster.

options

ClustersCreateOptionalParams

De optiesparameters.

Retouren

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

beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)

Hiermee maakt u een nieuw cluster met servers.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

clusterName

string

De naam van het cluster.

parameters

Cluster

De vereiste parameters voor het maken of bijwerken van een cluster.

options

ClustersCreateOptionalParams

De optiesparameters.

Retouren

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Hiermee verwijdert u een cluster samen met servers erin.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

clusterName

string

De naam van het cluster.

options

ClustersDeleteOptionalParams

De optiesparameters.

Retouren

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

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Hiermee verwijdert u een cluster samen met servers erin.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

clusterName

string

De naam van het cluster.

options

ClustersDeleteOptionalParams

De optiesparameters.

Retouren

Promise<void>

beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)

Bevordert het leesreplicacluster naar een onafhankelijk cluster voor lezen/schrijven.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

clusterName

string

De naam van het cluster.

options

ClustersPromoteReadReplicaOptionalParams

De optiesparameters.

Retouren

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

beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)

Bevordert het leesreplicacluster naar een onafhankelijk cluster voor lezen/schrijven.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

clusterName

string

De naam van het cluster.

options

ClustersPromoteReadReplicaOptionalParams

De optiesparameters.

Retouren

Promise<ClustersPromoteReadReplicaHeaders>

beginRestart(string, string, ClustersRestartOptionalParams)

Start alle knooppunten in het cluster opnieuw op.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

clusterName

string

De naam van het cluster.

options

ClustersRestartOptionalParams

De optiesparameters.

Retouren

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

beginRestartAndWait(string, string, ClustersRestartOptionalParams)

Start alle knooppunten in het cluster opnieuw op.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

clusterName

string

De naam van het cluster.

options

ClustersRestartOptionalParams

De optiesparameters.

Retouren

Promise<ClustersRestartHeaders>

beginStart(string, string, ClustersStartOptionalParams)

Start gestopte berekening op alle clusterknooppunten.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

clusterName

string

De naam van het cluster.

options

ClustersStartOptionalParams

De optiesparameters.

Retouren

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

beginStartAndWait(string, string, ClustersStartOptionalParams)

Start gestopte berekening op alle clusterknooppunten.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

clusterName

string

De naam van het cluster.

options

ClustersStartOptionalParams

De optiesparameters.

Retouren

Promise<void>

beginStop(string, string, ClustersStopOptionalParams)

Hiermee stopt u de berekening op alle clusterknooppunten.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

clusterName

string

De naam van het cluster.

options

ClustersStopOptionalParams

De optiesparameters.

Retouren

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

beginStopAndWait(string, string, ClustersStopOptionalParams)

Hiermee stopt u de berekening op alle clusterknooppunten.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

clusterName

string

De naam van het cluster.

options

ClustersStopOptionalParams

De optiesparameters.

Retouren

Promise<void>

beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Hiermee wordt een bestaand cluster bijgewerkt. De hoofdtekst van de aanvraag kan een of meer eigenschappen uit de clusterdefinitie bevatten.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

clusterName

string

De naam van het cluster.

parameters

ClusterForUpdate

De parameters voor het bijwerken van een cluster.

options

ClustersUpdateOptionalParams

De optiesparameters.

Retouren

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

beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Hiermee wordt een bestaand cluster bijgewerkt. De hoofdtekst van de aanvraag kan een of meer eigenschappen uit de clusterdefinitie bevatten.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

clusterName

string

De naam van het cluster.

parameters

ClusterForUpdate

De parameters voor het bijwerken van een cluster.

options

ClustersUpdateOptionalParams

De optiesparameters.

Retouren

Promise<Cluster>

checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)

Controleert de beschikbaarheid van een clusternaam. Clusternamen moeten wereldwijd uniek zijn; ten minste 3 tekens en maximaal 40 tekens lang; ze mogen alleen kleine letters, cijfers en afbreekstreepjes bevatten; en mag niet beginnen of eindigen met een afbreekstreepje.

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

Parameters

nameAvailabilityRequest

NameAvailabilityRequest

De vereiste parameters voor het controleren of de clusternaam beschikbaar is.

options

ClustersCheckNameAvailabilityOptionalParams

De optiesparameters.

Retouren

Promise<NameAvailability>

get(string, string, ClustersGetOptionalParams)

Hiermee wordt informatie opgehaald over een cluster, zoals reken- en opslagconfiguratie en metagegevens van de levenscyclus van clusters, zoals de aanmaakdatum en -tijd van het cluster.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

clusterName

string

De naam van het cluster.

options

ClustersGetOptionalParams

De optiesparameters.

Retouren

Promise<Cluster>

list(ClustersListOptionalParams)

Geeft een lijst weer van alle clusters in een abonnement.

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

Parameters

options

ClustersListOptionalParams

De optiesparameters.

Retouren

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Een lijst met alle clusters in een resourcegroep.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

options

ClustersListByResourceGroupOptionalParams

De optiesparameters.

Retouren

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>