az documentdb mongocluster

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 . Obtenga más información sobre las extensiones.

Administre Azure clústeres de Mongo de DocumentDB.

Comandos

Nombre	Description	Tipo	Estado
az documentdb mongocluster check-name-availability	Compruebe si el nombre del clúster de Mongo está disponible para su uso.	Extension	GA
az documentdb mongocluster create	Cree un clúster de Mongo. La actualización sobrescribe todas las propiedades del recurso. Para modificar solo algunas de las propiedades, use PATCH.	Extension	GA
az documentdb mongocluster delete	Elimine un clúster de Mongo.	Extension	GA
az documentdb mongocluster firewall-rule	Administrar regla de firewall.	Extension	GA
az documentdb mongocluster firewall-rule create	Cree una nueva regla de firewall o actualice una regla de firewall existente en un clúster de Mongo.	Extension	GA
az documentdb mongocluster firewall-rule delete	Elimine una regla de firewall de clúster de Mongo.	Extension	GA
az documentdb mongocluster firewall-rule list	Enumere todas las reglas de firewall de un clúster de Mongo determinado.	Extension	GA
az documentdb mongocluster firewall-rule show	Obtenga información sobre una regla de firewall de clúster de Mongo.	Extension	GA
az documentdb mongocluster firewall-rule update	Actualice una nueva regla de firewall o actualice una regla de firewall existente en un clúster de Mongo.	Extension	GA
az documentdb mongocluster firewall-rule wait	Coloque la CLI en un estado de espera hasta que se cumpla una condición.	Extension	GA
az documentdb mongocluster identity	Administrar identidad.	Extension	GA
az documentdb mongocluster identity assign	Asigne las identidades administradas por el usuario o el sistema.	Extension	GA
az documentdb mongocluster identity list	Enumere las identidades administradas asignadas a un clúster de Mongo.	Extension	GA
az documentdb mongocluster identity remove	Quite las identidades administradas por el usuario o el sistema.	Extension	GA
az documentdb mongocluster identity show	Muestra los detalles de las identidades administradas.	Extension	GA
az documentdb mongocluster identity wait	Coloque la CLI en un estado de espera hasta que se cumpla una condición.	Extension	GA
az documentdb mongocluster list	Enumere todos los clústeres de mongo en una suscripción determinada.	Extension	GA
az documentdb mongocluster list-connection-strings	Enumere las cadenas de conexión del clúster de mongo. Esto incluye la cadena de conexión predeterminada mediante SCRAM-SHA-256, así como otras cadenas de conexión admitidas por el clúster.	Extension	GA
az documentdb mongocluster microsoft-entra-user	Administrar Microsoft Entra ID usuarios en un clúster de Mongo.	Extension	GA
az documentdb mongocluster microsoft-entra-user assign	Conceda a una entidad de seguridad Microsoft Entra ID acceso a un clúster de Mongo mediante la asignación de roles de base de datos.	Extension	GA
az documentdb mongocluster microsoft-entra-user list	Enumere los usuarios Microsoft Entra ID en un clúster de Mongo.	Extension	GA
az documentdb mongocluster microsoft-entra-user remove	Quite un Microsoft Entra ID acceso de la entidad de seguridad de un clúster de Mongo.	Extension	GA
az documentdb mongocluster microsoft-entra-user show	Obtenga la definición de un usuario de Microsoft Entra ID en un clúster de Mongo.	Extension	GA
az documentdb mongocluster microsoft-entra-user wait	Coloque la CLI en un estado de espera hasta que se cumpla una condición.	Extension	GA
az documentdb mongocluster replica	Administrar réplica.	Extension	GA
az documentdb mongocluster replica create	Cree una réplica de lectura de un clúster de Mongo existente.	Extension	GA
az documentdb mongocluster replica list	Enumere todas las réplicas del clúster de mongo.	Extension	GA
az documentdb mongocluster replica promote	Promueve un clúster de mongo de réplica a un rol principal.	Extension	GA
az documentdb mongocluster reset-password	Restablezca la contraseña de administrador de un clúster de Mongo.	Extension	GA
az documentdb mongocluster restore	Restaure un clúster de Mongo en un nuevo clúster desde un momento dado.	Extension	GA
az documentdb mongocluster show	Obtenga información sobre un clúster de Mongo.	Extension	GA
az documentdb mongocluster update	Actualice un clúster de Mongo. Solo se modifican las propiedades especificadas en la solicitud; todas las demás propiedades se dejan sin cambios (HTTP PATCH). Se admiten argumentos de actualización genéricos (--set, --add, --remove).	Extension	GA
az documentdb mongocluster wait	Coloque la CLI en un estado de espera hasta que se cumpla una condición.	Extension	GA

az documentdb mongocluster check-name-availability

Compruebe si el nombre del clúster de Mongo está disponible para su uso.

az documentdb mongocluster check-name-availability [--acquire-policy-token]
                                                   [--change-reference]
                                                   [--ids]
                                                   [--location]
                                                   [--name]
                                                   [--subscription]
                                                   [--type]

Ejemplos

Compruebe si hay disponible un nombre de clúster de Mongo.

az documentdb mongocluster check-name-availability --location eastus --name MyCluster

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

--location -l

Location. Los valores de: az account list-locations. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--name

Nombre del recurso para el que se debe comprobar la disponibilidad.

Propiedad	Valor
Grupo de parámetros:	Body 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

--type

Tipo de recurso.

Propiedad	Valor
Grupo de parámetros:	Body Arguments
Valor predeterminado:	Microsoft.DocumentDB/mongoClusters

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

az documentdb mongocluster create

Cree un clúster de Mongo. La actualización sobrescribe todas las propiedades del recurso. Para modificar solo algunas de las propiedades, use PATCH.

az documentdb mongocluster create --admin-password --password
                                  --admin-user
                                  --cluster-name --name
                                  --high-availability {Disabled, SameZone, ZoneRedundantPreferred}
                                  --resource-group
                                  --shard-count
                                  --storage-size
                                  --tier
                                  [--acquire-policy-token]
                                  [--auth-allowed-modes]
                                  [--change-reference]
                                  [--data-api-mode {Disabled, Enabled}]
                                  [--encryption]
                                  [--location]
                                  [--mi-user-assigned --user-assigned]
                                  [--network-bypass-mode {AzureCosmosDB, None}]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--preview-features]
                                  [--public-network-access {Disabled, Enabled}]
                                  [--server-version]
                                  [--storage-type {PremiumSSD, PremiumSSDv2}]
                                  [--tags]

Ejemplos

Cree un clúster de Mongo con almacenamiento ssd prémium v2.

az documentdb mongocluster create -n MyCluster -g MyResourceGroup --location eastus --admin-user dbadmin --admin-password MyP@ssw0rd123! --tier M30 --storage-size 128 --storage-type PremiumSSDv2 --shard-count 1 --high-availability Disabled

Parámetros requeridos

--admin-password --password -p

Contraseña de administrador. Si el valor está en blanco, se le pregunta desde tty.

Propiedad	Valor
Grupo de parámetros:	Administrator Arguments

--admin-user -u

Nombre de usuario del administrador.

Propiedad	Valor
Grupo de parámetros:	Administrator Arguments

--cluster-name --name -n

Nombre del clúster de mongo.

--high-availability

Modo de alta disponibilidad de destino solicitado para el clúster.

Propiedad	Valor
Grupo de parámetros:	HighAvailability Arguments
Valores aceptados:	Disabled, SameZone, ZoneRedundantPreferred

--resource-group -g

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

--shard-count

Número de particiones que se van a aprovisionar en el clúster.

Propiedad	Valor
Grupo de parámetros:	Sharding Arguments

--storage-size

Tamaño del disco de datos asignado a cada servidor.

Propiedad	Valor
Grupo de parámetros:	Storage Arguments

--tier

Nivel de proceso que se va a asignar al clúster, donde cada nivel se asigna a un tamaño de núcleo virtual y memoria. Valores de ejemplo: "M30", "M40".

Propiedad	Valor
Grupo de parámetros:	Compute 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

--auth-allowed-modes

Lista separada por espacios de los modos de autenticación permitidos para el acceso a datos. Valores permitidos: NativeAuth, MicrosoftEntraID. Ejemplo: --auth-allowed-modes NativeAuth MicrosoftEntraID Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad	Valor
Grupo de parámetros:	AuthConfig Arguments

--change-reference

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

Propiedad	Valor
Grupo de parámetros:	Global Policy Arguments

--data-api-mode

Habilite o deshabilite mongo Data API en el clúster. Valores permitidos: Enabled (Habilitada), Disabled (Deshabilitada). Ejemplo: --data-api-mode Habilitado.

Propiedad	Valor
Grupo de parámetros:	DataApi Arguments
Valores aceptados:	Disabled, Enabled

--encryption

La configuración de cifrado del clúster. Depende de la identidad que se esté configurando. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad	Valor
Grupo de parámetros:	Properties 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

--mi-user-assigned --user-assigned

Establezca las identidades administradas por el usuario. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad	Valor
Grupo de parámetros:	Identity Arguments

--network-bypass-mode

El modo de bypass de red para el clúster. Configurar en 'AzureCosmosDB' permite que el servicio de Azure Cosmos DB evite las restricciones de red.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments
Valores aceptados:	AzureCosmosDB, None

--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

--preview-features

Lista separada por espacios de características en versión preliminar para habilitar en el clúster. Los nombres de características en versión preliminar son cadenas de forma libre; Consulte la documentación de la característica de clúster de mongo para conocer los valores disponibles actualmente. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--public-network-access

Indica si se permite o no el acceso al punto de conexión público para este clúster de Mongo.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments
Valores aceptados:	Disabled, Enabled

--server-version

Versión del servidor de Mongo DB. El valor predeterminado es la versión más reciente disponible si no se especifica.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--storage-type

El tipo de almacenamiento con el que se van a aprovisionar los servidores de clúster.

Propiedad	Valor
Grupo de parámetros:	Storage Arguments
Valores aceptados:	PremiumSSD, PremiumSSDv2

--tags

Etiquetas de recursos. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad	Valor
Grupo de parámetros:	Resource 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 delete

Elimine un clúster de Mongo.

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

Ejemplos

Elimine un clúster de Mongo.

az documentdb mongocluster delete -n MyCluster -g MyResourceGroup

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

--cluster-name --name -n

Nombre del clúster de mongo.

Propiedad	Valor
Grupo de parámetros:	Resource Id 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

--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

az documentdb mongocluster list

Enumere todos los clústeres de mongo en una suscripción determinada.

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

Ejemplos

Enumere todos los clústeres de mongo de un grupo de recursos.

az documentdb mongocluster list -g MyResourceGroup

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

--resource-group -g

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

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 list-connection-strings

Enumere las cadenas de conexión del clúster de mongo. Esto incluye la cadena de conexión predeterminada mediante SCRAM-SHA-256, así como otras cadenas de conexión admitidas por el clúster.

az documentdb mongocluster list-connection-strings [--acquire-policy-token]
                                                   [--change-reference]
                                                   [--cluster-name]
                                                   [--ids]
                                                   [--resource-group]
                                                   [--subscription]

Ejemplos

Enumere las cadenas de conexión de un clúster de Mongo.

az documentdb mongocluster list-connection-strings --cluster-name MyCluster -g MyResourceGroup

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

--cluster-name

Nombre del clúster de mongo.

Propiedad	Valor
Grupo de parámetros:	Resource Id 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

--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

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

az documentdb mongocluster reset-password

Restablezca la contraseña de administrador de un clúster de Mongo.

az documentdb mongocluster reset-password --admin-password --password
                                          [--acquire-policy-token]
                                          [--change-reference]
                                          [--cluster-name --name]
                                          [--ids]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--resource-group]
                                          [--subscription]

Ejemplos

Restablezca la contraseña del administrador.

az documentdb mongocluster reset-password -n MyCluster -g MyResourceGroup --admin-password NewP@ssw0rd123!

Parámetros requeridos

--admin-password --password -p

Nueva contraseña de administrador. Si el valor está en blanco, se le pregunta desde tty.

Propiedad	Valor
Grupo de parámetros:	Administrator 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

--cluster-name --name -n

Nombre del clúster de mongo.

Propiedad	Valor
Grupo de parámetros:	Resource Id 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

--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

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

az documentdb mongocluster restore

Restaure un clúster de Mongo en un nuevo clúster desde un momento dado.

Crea un nuevo clúster de mongo a partir de la copia de seguridad de un clúster de origen existente (o eliminado) en el momento solicitado.

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

Ejemplos

Restaure un clúster a un momento dado.

az documentdb mongocluster restore -n RestoredCluster -g MyResourceGroup --location eastus2 --source-cluster MySourceCluster --restore-time "2026-06-30T10:00:00Z" --admin-user dbadmin --admin-password MyP@ssw0rd123!

Parámetros requeridos

--admin-password --password -p

Contraseña de administrador. Si el valor está en blanco, se le pregunta desde tty.

Propiedad	Valor
Grupo de parámetros:	Administrator Arguments

--admin-user -u

Nombre de usuario del administrador.

Propiedad	Valor
Grupo de parámetros:	Administrator Arguments

--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>.

--restore-time

Hora UTC a la que restaurar, en formato ISO-8601 (por ejemplo: 2026-06-30T10:00:00Z).

Propiedad	Valor
Grupo de parámetros:	Restore Arguments

--source-cluster

Nombre o identificador de recurso del clúster de mongo de origen desde el que se va a restaurar. Si se da un nombre, se asume la suscripción actual y el grupo de recursos.

Propiedad	Valor
Grupo de parámetros:	Restore 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 show

Obtenga información sobre un clúster de Mongo.

az documentdb mongocluster show [--cluster-name --name]
                                [--ids]
                                [--resource-group]
                                [--subscription]

Ejemplos

Obtenga información sobre un clúster de Mongo.

az documentdb mongocluster show -n MyCluster -g MyResourceGroup

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.

--cluster-name --name -n

Nombre del clúster de mongo.

Propiedad	Valor
Grupo de parámetros:	Resource Id 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

--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

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

az documentdb mongocluster update

Actualice un clúster de Mongo. Solo se modifican las propiedades especificadas en la solicitud; todas las demás propiedades se dejan sin cambios (HTTP PATCH). Se admiten argumentos de actualización genéricos (--set, --add, --remove).

az documentdb mongocluster update [--acquire-policy-token]
                                  [--add]
                                  [--admin-password --password]
                                  [--admin-user]
                                  [--auth-allowed-modes]
                                  [--change-reference]
                                  [--cluster-name --name]
                                  [--data-api-mode {Disabled, Enabled}]
                                  [--encryption]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--high-availability {Disabled, SameZone, ZoneRedundantPreferred}]
                                  [--ids]
                                  [--network-bypass-mode {AzureCosmosDB, None}]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--preview-features]
                                  [--public-network-access {Disabled, Enabled}]
                                  [--remove]
                                  [--resource-group]
                                  [--server-version]
                                  [--set]
                                  [--shard-count]
                                  [--storage-size]
                                  [--storage-type {PremiumSSD, PremiumSSDv2}]
                                  [--subscription]
                                  [--tags]
                                  [--tier]

Ejemplos

Actualice el nivel de proceso de un clúster de Mongo.

az documentdb mongocluster update -n MyCluster -g MyResourceGroup --tier M40

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

--add

Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string or JSON string>.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments

--admin-password --password -p

Contraseña de administrador. Si el valor está en blanco, se le pregunta desde tty.

Propiedad	Valor
Grupo de parámetros:	Administrator Arguments

--admin-user -u

Nombre de usuario del administrador.

Propiedad	Valor
Grupo de parámetros:	Administrator Arguments

--auth-allowed-modes

Lista separada por espacios de los modos de autenticación permitidos para el acceso a datos. Valores permitidos: NativeAuth, MicrosoftEntraID. Ejemplo: --auth-allowed-modes NativeAuth MicrosoftEntraID Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad	Valor
Grupo de parámetros:	AuthConfig Arguments

--change-reference

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

Propiedad	Valor
Grupo de parámetros:	Global Policy Arguments

--cluster-name --name -n

Nombre del clúster de mongo.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--data-api-mode

Habilite o deshabilite mongo Data API en el clúster. Valores permitidos: Enabled (Habilitada), Disabled (Deshabilitada). Ejemplo: --data-api-mode Habilitado.

Propiedad	Valor
Grupo de parámetros:	DataApi Arguments
Valores aceptados:	Disabled, Enabled

--encryption

La configuración de cifrado del clúster. Depende de la identidad que se esté configurando. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--force-string

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments
Valores aceptados:	0, 1, f, false, n, no, t, true, y, yes

--high-availability

Modo de alta disponibilidad de destino solicitado para el clúster.

Propiedad	Valor
Grupo de parámetros:	HighAvailability Arguments
Valores aceptados:	Disabled, SameZone, ZoneRedundantPreferred

--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

--network-bypass-mode

El modo de bypass de red para el clúster. Configurar en 'AzureCosmosDB' permite que el servicio de Azure Cosmos DB evite las restricciones de red.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments
Valores aceptados:	AzureCosmosDB, None

--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

--preview-features

Lista separada por espacios de características en versión preliminar para habilitar en el clúster. Los nombres de características en versión preliminar son cadenas de forma libre; Consulte la documentación de la característica de clúster de mongo para conocer los valores disponibles actualmente. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--public-network-access

Indica si se permite o no el acceso al punto de conexión público para este clúster de Mongo.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments
Valores aceptados:	Disabled, Enabled

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments

--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

--server-version

Versión del servidor de Mongo DB. El valor predeterminado es la versión más reciente disponible si no se especifica.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=<value>.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments

--shard-count

Número de particiones que se van a aprovisionar en el clúster.

Propiedad	Valor
Grupo de parámetros:	Sharding Arguments

--storage-size

Tamaño del disco de datos asignado a cada servidor.

Propiedad	Valor
Grupo de parámetros:	Storage Arguments

--storage-type

El tipo de almacenamiento con el que se van a aprovisionar los servidores de clúster.

Propiedad	Valor
Grupo de parámetros:	Storage Arguments
Valores aceptados:	PremiumSSD, PremiumSSDv2

--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

--tags

Etiquetas de recursos. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad	Valor
Grupo de parámetros:	Resource Arguments

--tier

Nivel de proceso que se va a asignar al clúster, donde cada nivel se asigna a un tamaño de núcleo virtual y memoria. Valores de ejemplo: "M30", "M40".

Propiedad	Valor
Grupo de parámetros:	Compute 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.

--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 wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición.

az documentdb mongocluster wait [--acquire-policy-token]
                                [--change-reference]
                                [--cluster-name --name]
                                [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--ids]
                                [--interval]
                                [--resource-group]
                                [--subscription]
                                [--timeout]
                                [--updated]

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

--cluster-name --name -n

Nombre del clúster de mongo.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	False

--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments

--deleted

Espere hasta que se elimine.

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	False

--exists

Espere hasta que exista el recurso.

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	False

--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

--interval

Intervalo de sondeo en segundos.

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	30

--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

--timeout

Espera máxima en segundos.

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	3600

--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
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