Clusters interface

Paquet:

@azure/arm-cosmosdbforpostgresql

Interface représentant un cluster.

Méthodes

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)	Crée un cluster avec des serveurs.
beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)	Crée un cluster avec des serveurs.
beginDelete(string, string, ClustersDeleteOptionalParams)	Supprime un cluster avec des serveurs.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	Supprime un cluster avec des serveurs.
beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)	Promeut la lecture réplica cluster en un cluster en lecture-écriture indépendant.
beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)	Promeut la lecture réplica cluster en un cluster en lecture-écriture indépendant.
beginRestart(string, string, ClustersRestartOptionalParams)	Redémarre tous les nœuds du cluster.
beginRestartAndWait(string, string, ClustersRestartOptionalParams)	Redémarre tous les nœuds du cluster.
beginStart(string, string, ClustersStartOptionalParams)	Démarre le calcul arrêté sur tous les nœuds de cluster.
beginStartAndWait(string, string, ClustersStartOptionalParams)	Démarre le calcul arrêté sur tous les nœuds de cluster.
beginStop(string, string, ClustersStopOptionalParams)	Arrête le calcul sur tous les nœuds de cluster.
beginStopAndWait(string, string, ClustersStopOptionalParams)	Arrête le calcul sur tous les nœuds de cluster.
beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Mises à jour un cluster existant. Le corps de la requête peut contenir une ou plusieurs propriétés de la définition du cluster.
beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Mises à jour un cluster existant. Le corps de la requête peut contenir une ou plusieurs propriétés de la définition du cluster.
checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)	Vérifie la disponibilité d’un nom de cluster. Les noms de cluster doivent être globalement uniques ; au moins 3 caractères et au plus 40 caractères ; ils ne doivent contenir que des lettres minuscules, des chiffres et des traits d’union; et ne doit pas commencer ou se terminer par un trait d’union.
get(string, string, ClustersGetOptionalParams)	Obtient des informations sur un cluster, telles que la configuration de calcul et de stockage et les métadonnées de cycle de vie du cluster, telles que la date et l’heure de création du cluster.
list(ClustersListOptionalParams)	Répertorie tous les clusters d’un abonnement.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	Répertorie tous les clusters d’un groupe de ressources.

Détails de la méthode

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)

Crée un cluster avec des serveurs.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

clusterName

string

Nom du cluster.

parameters

Cluster

Paramètres requis pour la création ou la mise à jour d’un cluster.

options

ClustersCreateOptionalParams

Paramètres d’options.

Retours

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

beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)

Crée un cluster avec des serveurs.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

clusterName

string

Nom du cluster.

parameters

Cluster

Paramètres requis pour la création ou la mise à jour d’un cluster.

options

ClustersCreateOptionalParams

Paramètres d’options.

Retours

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Supprime un cluster avec des serveurs.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

clusterName

string

Nom du cluster.

options

ClustersDeleteOptionalParams

Paramètres d’options.

Retours

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

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Supprime un cluster avec des serveurs.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

clusterName

string

Nom du cluster.

options

ClustersDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)

Promeut la lecture réplica cluster en un cluster en lecture-écriture indépendant.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

clusterName

string

Nom du cluster.

options

ClustersPromoteReadReplicaOptionalParams

Paramètres d’options.

Retours

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

beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)

Promeut la lecture réplica cluster en un cluster en lecture-écriture indépendant.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

clusterName

string

Nom du cluster.

options

ClustersPromoteReadReplicaOptionalParams

Paramètres d’options.

Retours

Promise<ClustersPromoteReadReplicaHeaders>

beginRestart(string, string, ClustersRestartOptionalParams)

Redémarre tous les nœuds du cluster.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

clusterName

string

Nom du cluster.

options

ClustersRestartOptionalParams

Paramètres d’options.

Retours

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

beginRestartAndWait(string, string, ClustersRestartOptionalParams)

Redémarre tous les nœuds du cluster.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

clusterName

string

Nom du cluster.

options

ClustersRestartOptionalParams

Paramètres d’options.

Retours

Promise<ClustersRestartHeaders>

beginStart(string, string, ClustersStartOptionalParams)

Démarre le calcul arrêté sur tous les nœuds de cluster.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

clusterName

string

Nom du cluster.

options

ClustersStartOptionalParams

Paramètres d’options.

Retours

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

beginStartAndWait(string, string, ClustersStartOptionalParams)

Démarre le calcul arrêté sur tous les nœuds de cluster.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

clusterName

string

Nom du cluster.

options

ClustersStartOptionalParams

Paramètres d’options.

Retours

Promise<void>

beginStop(string, string, ClustersStopOptionalParams)

Arrête le calcul sur tous les nœuds de cluster.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

clusterName

string

Nom du cluster.

options

ClustersStopOptionalParams

Paramètres d’options.

Retours

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

beginStopAndWait(string, string, ClustersStopOptionalParams)

Arrête le calcul sur tous les nœuds de cluster.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

clusterName

string

Nom du cluster.

options

ClustersStopOptionalParams

Paramètres d’options.

Retours

Promise<void>

beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Mises à jour un cluster existant. Le corps de la requête peut contenir une ou plusieurs propriétés de la définition du cluster.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

clusterName

string

Nom du cluster.

parameters

ClusterForUpdate

Paramètres de mise à jour d’un cluster.

options

ClustersUpdateOptionalParams

Paramètres d’options.

Retours

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

beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Mises à jour un cluster existant. Le corps de la requête peut contenir une ou plusieurs propriétés de la définition du cluster.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

clusterName

string

Nom du cluster.

parameters

ClusterForUpdate

Paramètres de mise à jour d’un cluster.

options

ClustersUpdateOptionalParams

Paramètres d’options.

Retours

Promise<Cluster>

checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)

Vérifie la disponibilité d’un nom de cluster. Les noms de cluster doivent être globalement uniques ; au moins 3 caractères et au plus 40 caractères ; ils ne doivent contenir que des lettres minuscules, des chiffres et des traits d’union; et ne doit pas commencer ou se terminer par un trait d’union.

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

Paramètres

nameAvailabilityRequest

NameAvailabilityRequest

Paramètres requis pour vérifier si le nom du cluster est disponible.

options

ClustersCheckNameAvailabilityOptionalParams

Paramètres d’options.

Retours

Promise<NameAvailability>

get(string, string, ClustersGetOptionalParams)

Obtient des informations sur un cluster, telles que la configuration de calcul et de stockage et les métadonnées de cycle de vie du cluster, telles que la date et l’heure de création du cluster.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

clusterName

string

Nom du cluster.

options

ClustersGetOptionalParams

Paramètres d’options.

Retours

Promise<Cluster>

list(ClustersListOptionalParams)

Répertorie tous les clusters d’un abonnement.

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

Paramètres

options

ClustersListOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Répertorie tous les clusters d’un groupe de ressources.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

options

ClustersListByResourceGroupOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>