az documentdb mongocluster replica

Note

Esta referencia forma parte de la extensión documentdb para el CLI de Azure (versión 2.75.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az documentdb mongocluster replica . Obtenga más información sobre las extensiones.

El grupo de comandos "az documentdb mongocluster" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Administrar réplica.

Comandos

Nombre Description Tipo Estado
az documentdb mongocluster replica create

Cree una réplica de lectura de un clúster de Mongo existente.

Extension Preview
az documentdb mongocluster replica list

Enumere todas las réplicas del clúster de mongo.

Extension Preview
az documentdb mongocluster replica promote

Promueve un clúster de mongo de réplica a un rol principal.

Extension Preview

az documentdb mongocluster replica create

Vista previa

El grupo de comandos "az documentdb mongocluster replica" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Cree una réplica de lectura de un clúster de Mongo existente.

El clúster de origen debe tener habilitada la característica de vista previa "GeoReplicas". La réplica se aprovisiona como un nuevo clúster de mongo y hereda su configuración (proceso, almacenamiento, particionamiento) del clúster de origen. Se crea una réplica en la misma región que el origen como una en la región AsyncReplica; se crea una réplica en otra región como una región entre regiones GeoAsyncReplica.

az documentdb mongocluster replica create --cluster-name --name
                                          --resource-group
                                          --source-cluster
                                          [--acquire-policy-token]
                                          [--change-reference]
                                          [--location]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Ejemplos

Cree una réplica de un clúster.

az documentdb mongocluster replica create -n MyReplica -g MyResourceGroup --location centralus --source-cluster MySourceCluster

Parámetros requeridos

--cluster-name --name -n

Nombre del clúster de mongo.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--source-cluster

Nombre o identificador de recurso del clúster de mongo de origen (principal) desde el que se va a replicar. Si se da un nombre, se asume la suscripción actual y el grupo de recursos. Proporcione un identificador de ARM completo para un origen en otro grupo de recursos o suscripción.

Propiedad Valor
Grupo de parámetros: Replica Arguments

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--acquire-policy-token

Adquirir un token de Azure Policy automáticamente para esta operación de recursos.

Propiedad Valor
Grupo de parámetros: Global Policy Arguments
--change-reference

Identificador de referencia de cambio relacionado para esta operación de recurso.

Propiedad Valor
Grupo de parámetros: Global Policy Arguments
--location -l

Ubicación geográfica donde reside el recurso Cuando no se especifica, se usará la ubicación del grupo de recursos.

Propiedad Valor
Grupo de parámetros: Resource Arguments
--no-wait

No espere a que finalice la operación de ejecución prolongada.

Propiedad Valor
Valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az documentdb mongocluster replica list

Vista previa

El grupo de comandos "az documentdb mongocluster replica" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Enumere todas las réplicas del clúster de mongo.

az documentdb mongocluster replica list --resource-group
                                        --source-cluster
                                        [--max-items]
                                        [--next-token]

Ejemplos

Enumerar réplicas de un clúster.

az documentdb mongocluster replica list --source-cluster MyCluster -g MyResourceGroup

Parámetros requeridos

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--source-cluster

Nombre del clúster de mongo de origen.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--max-items

Número total de elementos que se van a devolver en la salida del comando. Si el número total de elementos disponibles es mayor que el valor especificado, se proporciona un token en la salida del comando. Para reanudar la paginación, proporcione el valor del token en --next-token argumento de un comando posterior.

Propiedad Valor
Grupo de parámetros: Pagination Arguments
--next-token

Token para especificar dónde iniciar la paginación. Este es el valor del token de una respuesta truncada anteriormente.

Propiedad Valor
Grupo de parámetros: Pagination Arguments
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az documentdb mongocluster replica promote

Vista previa

El grupo de comandos "az documentdb mongocluster replica" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Promueve un clúster de mongo de réplica a un rol principal.

az documentdb mongocluster replica promote --promote-option {Forced, Planned}
                                           --source-cluster
                                           [--acquire-policy-token]
                                           [--change-reference]
                                           [--ids]
                                           [--mode {Switchover}]
                                           [--name]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--resource-group]
                                           [--subscription]
                                           [--yes]

Ejemplos

Promover una réplica a principal.

az documentdb mongocluster replica promote -n MyReplica -g MyResourceGroup --mode Switchover --promote-option Forced

Parámetros requeridos

--promote-option

Opción de promoción que se va a aplicar a la operación.

Propiedad Valor
Grupo de parámetros: Body Arguments
Valores aceptados: Forced, Planned
--source-cluster

Nombre o identificador de recurso del clúster de origen esperado (principal) de esta réplica. La promoción solo continúa si coincide con el clúster de origen real de la réplica; de lo contrario, se produce un error en la operación.

Propiedad Valor
Grupo de parámetros: Replica Arguments

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--acquire-policy-token

Adquirir un token de Azure Policy automáticamente para esta operación de recursos.

Propiedad Valor
Grupo de parámetros: Global Policy Arguments
--change-reference

Identificador de referencia de cambio relacionado para esta operación de recurso.

Propiedad Valor
Grupo de parámetros: Global Policy Arguments
--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--mode

Modo que se va a aplicar a la operación de promoción. El valor es opcional y el valor predeterminado es "Switchover".

Propiedad Valor
Grupo de parámetros: Body Arguments
Valores aceptados: Switchover
--name -n

Nombre de la réplica que se va a promover.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--no-wait

No espere a que finalice la operación de ejecución prolongada.

Propiedad Valor
Valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--yes -y

No solicitar confirmación.

Propiedad Valor
Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False