Clusters interface

Pacote:

@azure/arm-cosmosdbforpostgresql

Interface que representa um Clusters.

Métodos

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)	Cria um novo cluster com servidores.
beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)	Cria um novo cluster com servidores.
beginDelete(string, string, ClustersDeleteOptionalParams)	Exclui um cluster juntamente com os servidores nele.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	Exclui um cluster juntamente com os servidores nele.
beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)	Promove o cluster de réplica de leitura para um cluster de leitura-gravação independente.
beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)	Promove o cluster de réplica de leitura para um cluster de leitura-gravação independente.
beginRestart(string, string, ClustersRestartOptionalParams)	Reinicia todos os nós no cluster.
beginRestartAndWait(string, string, ClustersRestartOptionalParams)	Reinicia todos os nós no cluster.
beginStart(string, string, ClustersStartOptionalParams)	Inicia a computação interrompida em todos os nós do cluster.
beginStartAndWait(string, string, ClustersStartOptionalParams)	Inicia a computação interrompida em todos os nós do cluster.
beginStop(string, string, ClustersStopOptionalParams)	Interrompe a computação em todos os nós do cluster.
beginStopAndWait(string, string, ClustersStopOptionalParams)	Interrompe a computação em todos os nós do cluster.
beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Atualiza um cluster existente. O corpo da solicitação pode conter uma ou várias propriedades da definição de cluster.
beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Atualiza um cluster existente. O corpo da solicitação pode conter uma ou várias propriedades da definição de cluster.
checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)	Verifica a disponibilidade de um nome de cluster. Os nomes de cluster devem ser globalmente exclusivos; pelo menos 3 caracteres e no máximo 40 caracteres; devem conter apenas letras minúsculas, números e hífenes; e não deve começar ou terminar com hífen.
get(string, string, ClustersGetOptionalParams)	Obtém informações sobre um cluster, como configuração de computação e armazenamento, e metadados do ciclo de vida do cluster, como data e hora de criação do cluster.
list(ClustersListOptionalParams)	Lista todos os clusters em uma assinatura.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	Lista todos os clusters em um grupo de recursos.

Detalhes de Método

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)

Cria um novo cluster com servidores.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

clusterName

string

O nome do cluster.

parameters

Cluster

Os parâmetros necessários para criar ou atualizar um cluster.

options

ClustersCreateOptionalParams

Os parâmetros de opções.

Devoluções

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

beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)

Cria um novo cluster com servidores.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

clusterName

string

O nome do cluster.

parameters

Cluster

Os parâmetros necessários para criar ou atualizar um cluster.

options

ClustersCreateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Exclui um cluster juntamente com os servidores nele.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

clusterName

string

O nome do cluster.

options

ClustersDeleteOptionalParams

Os parâmetros de opções.

Devoluções

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

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Exclui um cluster juntamente com os servidores nele.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

clusterName

string

O nome do cluster.

options

ClustersDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)

Promove o cluster de réplica de leitura para um cluster de leitura-gravação independente.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

clusterName

string

O nome do cluster.

options

ClustersPromoteReadReplicaOptionalParams

Os parâmetros de opções.

Devoluções

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

beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)

Promove o cluster de réplica de leitura para um cluster de leitura-gravação independente.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

clusterName

string

O nome do cluster.

options

ClustersPromoteReadReplicaOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ClustersPromoteReadReplicaHeaders>

beginRestart(string, string, ClustersRestartOptionalParams)

Reinicia todos os nós no cluster.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

clusterName

string

O nome do cluster.

options

ClustersRestartOptionalParams

Os parâmetros de opções.

Devoluções

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

beginRestartAndWait(string, string, ClustersRestartOptionalParams)

Reinicia todos os nós no cluster.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

clusterName

string

O nome do cluster.

options

ClustersRestartOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ClustersRestartHeaders>

beginStart(string, string, ClustersStartOptionalParams)

Inicia a computação interrompida em todos os nós do cluster.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

clusterName

string

O nome do cluster.

options

ClustersStartOptionalParams

Os parâmetros de opções.

Devoluções

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

beginStartAndWait(string, string, ClustersStartOptionalParams)

Inicia a computação interrompida em todos os nós do cluster.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

clusterName

string

O nome do cluster.

options

ClustersStartOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

beginStop(string, string, ClustersStopOptionalParams)

Interrompe a computação em todos os nós do cluster.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

clusterName

string

O nome do cluster.

options

ClustersStopOptionalParams

Os parâmetros de opções.

Devoluções

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

beginStopAndWait(string, string, ClustersStopOptionalParams)

Interrompe a computação em todos os nós do cluster.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

clusterName

string

O nome do cluster.

options

ClustersStopOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Atualiza um cluster existente. O corpo da solicitação pode conter uma ou várias propriedades da definição de cluster.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

clusterName

string

O nome do cluster.

parameters

ClusterForUpdate

Os parâmetros para atualizar um cluster.

options

ClustersUpdateOptionalParams

Os parâmetros de opções.

Devoluções

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

beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Atualiza um cluster existente. O corpo da solicitação pode conter uma ou várias propriedades da definição de cluster.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

clusterName

string

O nome do cluster.

parameters

ClusterForUpdate

Os parâmetros para atualizar um cluster.

options

ClustersUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<Cluster>

checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)

Verifica a disponibilidade de um nome de cluster. Os nomes de cluster devem ser globalmente exclusivos; pelo menos 3 caracteres e no máximo 40 caracteres; devem conter apenas letras minúsculas, números e hífenes; e não deve começar ou terminar com hífen.

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

Parâmetros

nameAvailabilityRequest

NameAvailabilityRequest

Os parâmetros necessários para verificar se o nome do cluster está disponível.

options

ClustersCheckNameAvailabilityOptionalParams

Os parâmetros de opções.

Devoluções

Promise<NameAvailability>

get(string, string, ClustersGetOptionalParams)

Obtém informações sobre um cluster, como configuração de computação e armazenamento, e metadados do ciclo de vida do cluster, como data e hora de criação do cluster.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

clusterName

string

O nome do cluster.

options

ClustersGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<Cluster>

list(ClustersListOptionalParams)

Lista todos os clusters em uma assinatura.

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

Parâmetros

options

ClustersListOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Lista todos os clusters em um grupo de recursos.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

options

ClustersListByResourceGroupOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>