Clusters interface

Paket:

@azure/arm-cosmosdbforpostgresql

Schnittstelle, die einen Cluster darstellt.

Methoden

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)	Erstellt einen neuen Cluster mit Servern.
beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)	Erstellt einen neuen Cluster mit Servern.
beginDelete(string, string, ClustersDeleteOptionalParams)	Löscht einen Cluster zusammen mit Servern darin.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	Löscht einen Cluster zusammen mit Servern darin.
beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)	Höherer Lesereplikatcluster zu einem unabhängigen Lese-/Schreibcluster.
beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)	Höherer Lesereplikatcluster zu einem unabhängigen Lese-/Schreibcluster.
beginRestart(string, string, ClustersRestartOptionalParams)	Startet alle Knoten im Cluster neu.
beginRestartAndWait(string, string, ClustersRestartOptionalParams)	Startet alle Knoten im Cluster neu.
beginStart(string, string, ClustersStartOptionalParams)	Startet beendetes Compute auf allen Clusterknoten.
beginStartAndWait(string, string, ClustersStartOptionalParams)	Startet beendetes Compute auf allen Clusterknoten.
beginStop(string, string, ClustersStopOptionalParams)	Beendet compute auf allen Clusterknoten.
beginStopAndWait(string, string, ClustersStopOptionalParams)	Beendet compute auf allen Clusterknoten.
beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Updates einen vorhandenen Cluster. Der Anforderungstext kann eine oder mehrere Eigenschaften aus der Clusterdefinition enthalten.
beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Updates einen vorhandenen Cluster. Der Anforderungstext kann eine oder mehrere Eigenschaften aus der Clusterdefinition enthalten.
checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)	Überprüft die Verfügbarkeit eines Clusternamens. Clusternamen sollten global eindeutig sein. mindestens 3 Zeichen und höchstens 40 Zeichen lang; sie dürfen nur Kleinbuchstaben, Zahlen und Bindestriche enthalten; und darf nicht mit einem Bindestrich beginnen oder enden.
get(string, string, ClustersGetOptionalParams)	Ruft Informationen zu einem Cluster ab, z. B. Compute- und Speicherkonfiguration und Metadaten des Clusterlebenszyklus, z. B. Datum und Uhrzeit der Clustererstellung.
list(ClustersListOptionalParams)	Listet alle Cluster in einem Abonnement auf.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	Listet alle Cluster in einer Ressourcengruppe auf.

Details zur Methode

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)

Erstellt einen neuen Cluster mit Servern.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

clusterName

string

Der Name des Clusters.

parameters

Cluster

Die erforderlichen Parameter zum Erstellen oder Aktualisieren eines Clusters.

options

ClustersCreateOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)

Erstellt einen neuen Cluster mit Servern.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

clusterName

string

Der Name des Clusters.

parameters

Cluster

Die erforderlichen Parameter zum Erstellen oder Aktualisieren eines Clusters.

options

ClustersCreateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Löscht einen Cluster zusammen mit Servern darin.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

clusterName

string

Der Name des Clusters.

options

ClustersDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Löscht einen Cluster zusammen mit Servern darin.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

clusterName

string

Der Name des Clusters.

options

ClustersDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)

Höherer Lesereplikatcluster zu einem unabhängigen Lese-/Schreibcluster.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

clusterName

string

Der Name des Clusters.

options

ClustersPromoteReadReplicaOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)

Höherer Lesereplikatcluster zu einem unabhängigen Lese-/Schreibcluster.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

clusterName

string

Der Name des Clusters.

options

ClustersPromoteReadReplicaOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ClustersPromoteReadReplicaHeaders>

beginRestart(string, string, ClustersRestartOptionalParams)

Startet alle Knoten im Cluster neu.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

clusterName

string

Der Name des Clusters.

options

ClustersRestartOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginRestartAndWait(string, string, ClustersRestartOptionalParams)

Startet alle Knoten im Cluster neu.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

clusterName

string

Der Name des Clusters.

options

ClustersRestartOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ClustersRestartHeaders>

beginStart(string, string, ClustersStartOptionalParams)

Startet beendetes Compute auf allen Clusterknoten.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

clusterName

string

Der Name des Clusters.

options

ClustersStartOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginStartAndWait(string, string, ClustersStartOptionalParams)

Startet beendetes Compute auf allen Clusterknoten.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

clusterName

string

Der Name des Clusters.

options

ClustersStartOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

beginStop(string, string, ClustersStopOptionalParams)

Beendet compute auf allen Clusterknoten.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

clusterName

string

Der Name des Clusters.

options

ClustersStopOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginStopAndWait(string, string, ClustersStopOptionalParams)

Beendet compute auf allen Clusterknoten.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

clusterName

string

Der Name des Clusters.

options

ClustersStopOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Updates einen vorhandenen Cluster. Der Anforderungstext kann eine oder mehrere Eigenschaften aus der Clusterdefinition enthalten.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

clusterName

string

Der Name des Clusters.

parameters

ClusterForUpdate

Die Parameter zum Aktualisieren eines Clusters.

options

ClustersUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Updates einen vorhandenen Cluster. Der Anforderungstext kann eine oder mehrere Eigenschaften aus der Clusterdefinition enthalten.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

clusterName

string

Der Name des Clusters.

parameters

ClusterForUpdate

Die Parameter zum Aktualisieren eines Clusters.

options

ClustersUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Cluster>

checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)

Überprüft die Verfügbarkeit eines Clusternamens. Clusternamen sollten global eindeutig sein. mindestens 3 Zeichen und höchstens 40 Zeichen lang; sie dürfen nur Kleinbuchstaben, Zahlen und Bindestriche enthalten; und darf nicht mit einem Bindestrich beginnen oder enden.

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

Parameter

nameAvailabilityRequest

NameAvailabilityRequest

Die erforderlichen Parameter für die Überprüfung, ob der Clustername verfügbar ist.

options

ClustersCheckNameAvailabilityOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<NameAvailability>

get(string, string, ClustersGetOptionalParams)

Ruft Informationen zu einem Cluster ab, z. B. Compute- und Speicherkonfiguration und Metadaten des Clusterlebenszyklus, z. B. Datum und Uhrzeit der Clustererstellung.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

clusterName

string

Der Name des Clusters.

options

ClustersGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Cluster>

list(ClustersListOptionalParams)

Listet alle Cluster in einem Abonnement auf.

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

Parameter

options

ClustersListOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Listet alle Cluster in einer Ressourcengruppe auf.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

options

ClustersListByResourceGroupOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>