Clusters interface

Pakiet:

@azure/arm-cosmosdbforpostgresql

Interfejs reprezentujący klastry.

Metody

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)	Tworzy nowy klaster z serwerami.
beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)	Tworzy nowy klaster z serwerami.
beginDelete(string, string, ClustersDeleteOptionalParams)	Usuwa klaster wraz z serwerami w nim.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	Usuwa klaster wraz z serwerami w nim.
beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)	Promuje klaster replik do odczytu do niezależnego klastra odczytu i zapisu.
beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)	Promuje klaster replik do odczytu do niezależnego klastra odczytu i zapisu.
beginRestart(string, string, ClustersRestartOptionalParams)	Uruchamia ponownie wszystkie węzły w klastrze.
beginRestartAndWait(string, string, ClustersRestartOptionalParams)	Uruchamia ponownie wszystkie węzły w klastrze.
beginStart(string, string, ClustersStartOptionalParams)	Uruchamia zatrzymane obliczenia na wszystkich węzłach klastra.
beginStartAndWait(string, string, ClustersStartOptionalParams)	Uruchamia zatrzymane obliczenia na wszystkich węzłach klastra.
beginStop(string, string, ClustersStopOptionalParams)	Zatrzymuje obliczenia na wszystkich węzłach klastra.
beginStopAndWait(string, string, ClustersStopOptionalParams)	Zatrzymuje obliczenia na wszystkich węzłach klastra.
beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Aktualizacje istniejącego klastra. Treść żądania może zawierać jedną lub kilka właściwości z definicji klastra.
beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Aktualizacje istniejącego klastra. Treść żądania może zawierać jedną lub kilka właściwości z definicji klastra.
checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)	Sprawdza dostępność nazwy klastra. Nazwy klastrów powinny być globalnie unikatowe; co najmniej 3 znaki i co najmniej 40 znaków; muszą zawierać tylko małe litery, cyfry i łączniki; i nie może zaczynać się ani kończyć łącznikiem.
get(string, string, ClustersGetOptionalParams)	Pobiera informacje o klastrze, takim jak konfiguracja obliczeniowa i magazyn oraz metadane cyklu życia klastra, takie jak data i godzina tworzenia klastra.
list(ClustersListOptionalParams)	Wyświetla listę wszystkich klastrów w subskrypcji.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	Wyświetla listę wszystkich klastrów w grupie zasobów.

Szczegóły metody

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)

Tworzy nowy klaster z serwerami.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

clusterName

string

Nazwa klastra.

parameters

Cluster

Wymagane parametry do tworzenia lub aktualizowania klastra.

options

ClustersCreateOptionalParams

Parametry opcji.

Zwraca

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

beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)

Tworzy nowy klaster z serwerami.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

clusterName

string

Nazwa klastra.

parameters

Cluster

Wymagane parametry do tworzenia lub aktualizowania klastra.

options

ClustersCreateOptionalParams

Parametry opcji.

Zwraca

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Usuwa klaster wraz z serwerami w nim.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

clusterName

string

Nazwa klastra.

options

ClustersDeleteOptionalParams

Parametry opcji.

Zwraca

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

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Usuwa klaster wraz z serwerami w nim.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

clusterName

string

Nazwa klastra.

options

ClustersDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)

Promuje klaster replik do odczytu do niezależnego klastra odczytu i zapisu.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

clusterName

string

Nazwa klastra.

options

ClustersPromoteReadReplicaOptionalParams

Parametry opcji.

Zwraca

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

beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)

Promuje klaster replik do odczytu do niezależnego klastra odczytu i zapisu.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

clusterName

string

Nazwa klastra.

options

ClustersPromoteReadReplicaOptionalParams

Parametry opcji.

Zwraca

Promise<ClustersPromoteReadReplicaHeaders>

beginRestart(string, string, ClustersRestartOptionalParams)

Uruchamia ponownie wszystkie węzły w klastrze.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

clusterName

string

Nazwa klastra.

options

ClustersRestartOptionalParams

Parametry opcji.

Zwraca

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

beginRestartAndWait(string, string, ClustersRestartOptionalParams)

Uruchamia ponownie wszystkie węzły w klastrze.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

clusterName

string

Nazwa klastra.

options

ClustersRestartOptionalParams

Parametry opcji.

Zwraca

Promise<ClustersRestartHeaders>

beginStart(string, string, ClustersStartOptionalParams)

Uruchamia zatrzymane obliczenia na wszystkich węzłach klastra.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

clusterName

string

Nazwa klastra.

options

ClustersStartOptionalParams

Parametry opcji.

Zwraca

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

beginStartAndWait(string, string, ClustersStartOptionalParams)

Uruchamia zatrzymane obliczenia na wszystkich węzłach klastra.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

clusterName

string

Nazwa klastra.

options

ClustersStartOptionalParams

Parametry opcji.

Zwraca

Promise<void>

beginStop(string, string, ClustersStopOptionalParams)

Zatrzymuje obliczenia na wszystkich węzłach klastra.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

clusterName

string

Nazwa klastra.

options

ClustersStopOptionalParams

Parametry opcji.

Zwraca

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

beginStopAndWait(string, string, ClustersStopOptionalParams)

Zatrzymuje obliczenia na wszystkich węzłach klastra.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

clusterName

string

Nazwa klastra.

options

ClustersStopOptionalParams

Parametry opcji.

Zwraca

Promise<void>

beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Aktualizacje istniejącego klastra. Treść żądania może zawierać jedną lub kilka właściwości z definicji klastra.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

clusterName

string

Nazwa klastra.

parameters

ClusterForUpdate

Parametry aktualizacji klastra.

options

ClustersUpdateOptionalParams

Parametry opcji.

Zwraca

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

beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Aktualizacje istniejącego klastra. Treść żądania może zawierać jedną lub kilka właściwości z definicji klastra.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

clusterName

string

Nazwa klastra.

parameters

ClusterForUpdate

Parametry aktualizacji klastra.

options

ClustersUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<Cluster>

checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)

Sprawdza dostępność nazwy klastra. Nazwy klastrów powinny być globalnie unikatowe; co najmniej 3 znaki i co najmniej 40 znaków; muszą zawierać tylko małe litery, cyfry i łączniki; i nie może zaczynać się ani kończyć łącznikiem.

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

Parametry

nameAvailabilityRequest

NameAvailabilityRequest

Wymagane parametry sprawdzania, czy nazwa klastra jest dostępna.

options

ClustersCheckNameAvailabilityOptionalParams

Parametry opcji.

Zwraca

Promise<NameAvailability>

get(string, string, ClustersGetOptionalParams)

Pobiera informacje o klastrze, takim jak konfiguracja obliczeniowa i magazyn oraz metadane cyklu życia klastra, takie jak data i godzina tworzenia klastra.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

clusterName

string

Nazwa klastra.

options

ClustersGetOptionalParams

Parametry opcji.

Zwraca

Promise<Cluster>

list(ClustersListOptionalParams)

Wyświetla listę wszystkich klastrów w subskrypcji.

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

Parametry

options

ClustersListOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Wyświetla listę wszystkich klastrów w grupie zasobów.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

options

ClustersListByResourceGroupOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>