Clusters interface

Balíček:

@azure/arm-cosmosdbforpostgresql

Rozhraní představující clustery.

Metody

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)	Vytvoří nový cluster se servery.
beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)	Vytvoří nový cluster se servery.
beginDelete(string, string, ClustersDeleteOptionalParams)	Odstraní cluster společně se servery v něm.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	Odstraní cluster společně se servery v něm.
beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)	Podporuje cluster replik pro čtení na nezávislý cluster pro čtení i zápis.
beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)	Podporuje cluster replik pro čtení na nezávislý cluster pro čtení i zápis.
beginRestart(string, string, ClustersRestartOptionalParams)	Restartuje všechny uzly v clusteru.
beginRestartAndWait(string, string, ClustersRestartOptionalParams)	Restartuje všechny uzly v clusteru.
beginStart(string, string, ClustersStartOptionalParams)	Spustí zastavené výpočetní prostředky na všech uzlech clusteru.
beginStartAndWait(string, string, ClustersStartOptionalParams)	Spustí zastavené výpočetní prostředky na všech uzlech clusteru.
beginStop(string, string, ClustersStopOptionalParams)	Zastaví výpočetní prostředky na všech uzlech clusteru.
beginStopAndWait(string, string, ClustersStopOptionalParams)	Zastaví výpočetní prostředky na všech uzlech clusteru.
beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Aktualizace existující cluster. Text požadavku může obsahovat jednu nebo několik vlastností z definice clusteru.
beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Aktualizace existující cluster. Text požadavku může obsahovat jednu nebo několik vlastností z definice clusteru.
checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)	Zkontroluje dostupnost názvu clusteru. Názvy clusterů by měly být globálně jedinečné. alespoň 3 znaky a maximálně 40 znaků dlouhé; smí obsahovat pouze malá písmena, číslice a spojovníky; a nesmí začínat ani končit spojovníkem.
get(string, string, ClustersGetOptionalParams)	Získá informace o clusteru, jako je konfigurace výpočetních prostředků a úložiště a metadata životního cyklu clusteru, jako je datum a čas vytvoření clusteru.
list(ClustersListOptionalParams)	Zobrazí seznam všech clusterů v předplatném.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	Zobrazí seznam všech clusterů ve skupině prostředků.

Podrobnosti metody

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)

Vytvoří nový cluster se servery.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

clusterName

string

Název clusteru.

parameters

Cluster

Požadované parametry pro vytvoření nebo aktualizaci clusteru.

options

ClustersCreateOptionalParams

Parametry možností

Návraty

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

beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)

Vytvoří nový cluster se servery.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

clusterName

string

Název clusteru.

parameters

Cluster

Požadované parametry pro vytvoření nebo aktualizaci clusteru.

options

ClustersCreateOptionalParams

Parametry možností

Návraty

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Odstraní cluster společně se servery v něm.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

clusterName

string

Název clusteru.

options

ClustersDeleteOptionalParams

Parametry možností

Návraty

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

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Odstraní cluster společně se servery v něm.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

clusterName

string

Název clusteru.

options

ClustersDeleteOptionalParams

Parametry možností

Návraty

Promise<void>

beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)

Podporuje cluster replik pro čtení na nezávislý cluster pro čtení i zápis.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

clusterName

string

Název clusteru.

options

ClustersPromoteReadReplicaOptionalParams

Parametry možností

Návraty

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

beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)

Podporuje cluster replik pro čtení na nezávislý cluster pro čtení i zápis.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

clusterName

string

Název clusteru.

options

ClustersPromoteReadReplicaOptionalParams

Parametry možností

Návraty

Promise<ClustersPromoteReadReplicaHeaders>

beginRestart(string, string, ClustersRestartOptionalParams)

Restartuje všechny uzly v clusteru.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

clusterName

string

Název clusteru.

options

ClustersRestartOptionalParams

Parametry možností

Návraty

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

beginRestartAndWait(string, string, ClustersRestartOptionalParams)

Restartuje všechny uzly v clusteru.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

clusterName

string

Název clusteru.

options

ClustersRestartOptionalParams

Parametry možností

Návraty

Promise<ClustersRestartHeaders>

beginStart(string, string, ClustersStartOptionalParams)

Spustí zastavené výpočetní prostředky na všech uzlech clusteru.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

clusterName

string

Název clusteru.

options

ClustersStartOptionalParams

Parametry možností

Návraty

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

beginStartAndWait(string, string, ClustersStartOptionalParams)

Spustí zastavené výpočetní prostředky na všech uzlech clusteru.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

clusterName

string

Název clusteru.

options

ClustersStartOptionalParams

Parametry možností

Návraty

Promise<void>

beginStop(string, string, ClustersStopOptionalParams)

Zastaví výpočetní prostředky na všech uzlech clusteru.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

clusterName

string

Název clusteru.

options

ClustersStopOptionalParams

Parametry možností.

Návraty

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

beginStopAndWait(string, string, ClustersStopOptionalParams)

Zastaví výpočetní prostředky na všech uzlech clusteru.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

clusterName

string

Název clusteru.

options

ClustersStopOptionalParams

Parametry možností.

Návraty

Promise<void>

beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Aktualizace existující cluster. Text požadavku může obsahovat jednu nebo několik vlastností z definice clusteru.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

clusterName

string

Název clusteru.

parameters

ClusterForUpdate

Parametry pro aktualizaci clusteru.

options

ClustersUpdateOptionalParams

Parametry možností.

Návraty

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

beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Aktualizace existující cluster. Text požadavku může obsahovat jednu nebo několik vlastností z definice clusteru.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

clusterName

string

Název clusteru.

parameters

ClusterForUpdate

Parametry pro aktualizaci clusteru.

options

ClustersUpdateOptionalParams

Parametry možností.

Návraty

Promise<Cluster>

checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)

Zkontroluje dostupnost názvu clusteru. Názvy clusterů by měly být globálně jedinečné. alespoň 3 znaky a maximálně 40 znaků dlouhé; smí obsahovat pouze malá písmena, číslice a spojovníky; a nesmí začínat ani končit spojovníkem.

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

Parametry

nameAvailabilityRequest

NameAvailabilityRequest

Požadované parametry pro kontrolu, jestli je název clusteru dostupný.

options

ClustersCheckNameAvailabilityOptionalParams

Parametry možností.

Návraty

Promise<NameAvailability>

get(string, string, ClustersGetOptionalParams)

Získá informace o clusteru, jako je konfigurace výpočetních prostředků a úložiště a metadata životního cyklu clusteru, jako je datum a čas vytvoření clusteru.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

clusterName

string

Název clusteru.

options

ClustersGetOptionalParams

Parametry možností.

Návraty

Promise<Cluster>

list(ClustersListOptionalParams)

Zobrazí seznam všech clusterů v předplatném.

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

Parametry

options

ClustersListOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Zobrazí seznam všech clusterů ve skupině prostředků.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

options

ClustersListByResourceGroupOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>