Clusters interface

Paquete:

@azure/arm-cosmosdbforpostgresql

Interfaz que representa un clúster.

Métodos

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)	Crea un nuevo clúster con servidores.
beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)	Crea un nuevo clúster con servidores.
beginDelete(string, string, ClustersDeleteOptionalParams)	Elimina un clúster junto con servidores en él.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	Elimina un clúster junto con servidores en él.
beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)	Promueve el clúster de réplica de lectura a un clúster de lectura y escritura independiente.
beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)	Promueve el clúster de réplica de lectura a un clúster de lectura y escritura independiente.
beginRestart(string, string, ClustersRestartOptionalParams)	Reinicia todos los nodos del clúster.
beginRestartAndWait(string, string, ClustersRestartOptionalParams)	Reinicia todos los nodos del clúster.
beginStart(string, string, ClustersStartOptionalParams)	Inicia el proceso detenido en todos los nodos del clúster.
beginStartAndWait(string, string, ClustersStartOptionalParams)	Inicia el proceso detenido en todos los nodos del clúster.
beginStop(string, string, ClustersStopOptionalParams)	Detiene el proceso en todos los nodos del clúster.
beginStopAndWait(string, string, ClustersStopOptionalParams)	Detiene el proceso en todos los nodos del clúster.
beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Novedades un clúster existente. El cuerpo de la solicitud puede contener una o varias propiedades de la definición del clúster.
beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Novedades un clúster existente. El cuerpo de la solicitud puede contener una o varias propiedades de la definición del clúster.
checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)	Comprueba la disponibilidad de un nombre de clúster. Los nombres de clúster deben ser únicos globalmente; al menos 3 caracteres y un máximo de 40 caracteres; solo deben contener letras minúsculas, números y guiones; y no deben comenzar ni terminar con un guión.
get(string, string, ClustersGetOptionalParams)	Obtiene información sobre un clúster, como la configuración de proceso y almacenamiento y los metadatos del ciclo de vida del clúster, como la fecha y hora de creación del clúster.
list(ClustersListOptionalParams)	Enumera todos los clústeres de una suscripción.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	Enumera todos los clústeres de un grupo de recursos.

Detalles del método

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)

Crea un nuevo clúster con servidores.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

clusterName

string

Nombre del clúster.

parameters

Cluster

Parámetros necesarios para crear o actualizar un clúster.

options

ClustersCreateOptionalParams

Parámetros de opciones.

Devoluciones

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

beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)

Crea un nuevo clúster con servidores.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

clusterName

string

Nombre del clúster.

parameters

Cluster

Parámetros necesarios para crear o actualizar un clúster.

options

ClustersCreateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Elimina un clúster junto con servidores en él.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

clusterName

string

Nombre del clúster.

options

ClustersDeleteOptionalParams

Parámetros de opciones.

Devoluciones

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

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Elimina un clúster junto con servidores en él.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

clusterName

string

Nombre del clúster.

options

ClustersDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)

Promueve el clúster de réplica de lectura a un clúster de lectura y escritura independiente.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

clusterName

string

Nombre del clúster.

options

ClustersPromoteReadReplicaOptionalParams

Parámetros de opciones.

Devoluciones

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

beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)

Promueve el clúster de réplica de lectura a un clúster de lectura y escritura independiente.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

clusterName

string

Nombre del clúster.

options

ClustersPromoteReadReplicaOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ClustersPromoteReadReplicaHeaders>

beginRestart(string, string, ClustersRestartOptionalParams)

Reinicia todos los nodos del clúster.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

clusterName

string

Nombre del clúster.

options

ClustersRestartOptionalParams

Parámetros de opciones.

Devoluciones

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

beginRestartAndWait(string, string, ClustersRestartOptionalParams)

Reinicia todos los nodos del clúster.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

clusterName

string

Nombre del clúster.

options

ClustersRestartOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ClustersRestartHeaders>

beginStart(string, string, ClustersStartOptionalParams)

Inicia el proceso detenido en todos los nodos del clúster.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

clusterName

string

Nombre del clúster.

options

ClustersStartOptionalParams

Parámetros de opciones.

Devoluciones

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

beginStartAndWait(string, string, ClustersStartOptionalParams)

Inicia el proceso detenido en todos los nodos del clúster.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

clusterName

string

Nombre del clúster.

options

ClustersStartOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

beginStop(string, string, ClustersStopOptionalParams)

Detiene el proceso en todos los nodos del clúster.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

clusterName

string

Nombre del clúster.

options

ClustersStopOptionalParams

Parámetros de opciones.

Devoluciones

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

beginStopAndWait(string, string, ClustersStopOptionalParams)

Detiene el proceso en todos los nodos del clúster.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

clusterName

string

Nombre del clúster.

options

ClustersStopOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Novedades un clúster existente. El cuerpo de la solicitud puede contener una o varias propiedades de la definición del clúster.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

clusterName

string

Nombre del clúster.

parameters

ClusterForUpdate

Parámetros para actualizar un clúster.

options

ClustersUpdateOptionalParams

Parámetros de opciones.

Devoluciones

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

beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Novedades un clúster existente. El cuerpo de la solicitud puede contener una o varias propiedades de la definición del clúster.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

clusterName

string

Nombre del clúster.

parameters

ClusterForUpdate

Parámetros para actualizar un clúster.

options

ClustersUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<Cluster>

checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)

Comprueba la disponibilidad de un nombre de clúster. Los nombres de clúster deben ser únicos globalmente; al menos 3 caracteres y un máximo de 40 caracteres; solo deben contener letras minúsculas, números y guiones; y no deben comenzar ni terminar con un guión.

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

Parámetros

nameAvailabilityRequest

NameAvailabilityRequest

Parámetros necesarios para comprobar si el nombre del clúster está disponible.

options

ClustersCheckNameAvailabilityOptionalParams

Parámetros de opciones.

Devoluciones

Promise<NameAvailability>

get(string, string, ClustersGetOptionalParams)

Obtiene información sobre un clúster, como la configuración de proceso y almacenamiento y los metadatos del ciclo de vida del clúster, como la fecha y hora de creación del clúster.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

clusterName

string

Nombre del clúster.

options

ClustersGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<Cluster>

list(ClustersListOptionalParams)

Enumera todos los clústeres de una suscripción.

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

Parámetros

options

ClustersListOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Enumera todos los clústeres de un grupo de recursos.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

options

ClustersListByResourceGroupOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>