az documentdb mongocluster

  • Pré-visualizar

Note

Esta referência faz parte da extensão documentdb para a CLI do Azure (versão 2.75.0 ou superior). A extensão vai instalar-se automaticamente na primeira vez que executares um comando az documentdb mongocluster . Saiba mais sobre extensões.

O grupo de comando 'az documentdb' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Manage clusters mongo do Azure DocumentDB.

Comandos

Nome Descrição Tipo Estado
az documentdb mongocluster check-name-availability

Verifique se o nome do cluster mongo está disponível para uso.

 Extension Preview
az documentdb mongocluster create

Cria um aglomerado de mongos. Update substitui todas as propriedades do recurso. Para modificar apenas algumas das propriedades, use PATCH.

 Extension Preview
az documentdb mongocluster delete

Apaga um cluster de mongos.

 Extension Preview
az documentdb mongocluster firewall-rule

Regra de Gerir o Firewall.

 Extension Preview
az documentdb mongocluster firewall-rule create

Cria uma nova regra de firewall ou atualiza uma regra de firewall existente num cluster Mongo.

 Extension Preview
az documentdb mongocluster firewall-rule delete

Apaga uma regra de firewall do cluster Mongo.

 Extension Preview
az documentdb mongocluster firewall-rule list

Liste todas as regras de firewall em um determinado cluster mongo.

 Extension Preview
az documentdb mongocluster firewall-rule show

Obtenha informações sobre uma regra de firewall do cluster Mongo.

 Extension Preview
az documentdb mongocluster firewall-rule update

Atualize uma nova regra de firewall ou atualize uma regra de firewall existente num cluster Mongo.

 Extension Preview
az documentdb mongocluster firewall-rule wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

 Extension Preview
az documentdb mongocluster identity

Gerencie a identidade.

 Extension Preview
az documentdb mongocluster identity assign

Atribua as identidades gerenciadas pelo usuário ou pelo sistema.

 Extension Preview
az documentdb mongocluster identity list

Liste as identidades geridas atribuídas a um cluster mongo.

 Extension Preview
az documentdb mongocluster identity remove

Remova as identidades gerenciadas pelo usuário ou pelo sistema.

 Extension Preview
az documentdb mongocluster identity show

Mostrar os detalhes das identidades gerenciadas.

 Extension Preview
az documentdb mongocluster identity wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

 Extension Preview
az documentdb mongocluster list

Liste todos os clusters mongo em uma determinada assinatura.

 Extension Preview
az documentdb mongocluster list-connection-strings

Liste cadeias de conexão de cluster mongo. Isso inclui a cadeia de conexão padrão usando SCRAM-SHA-256, bem como outras cadeias de conexão suportadas pelo cluster.

 Extension Preview
az documentdb mongocluster microsoft-entra-user

Gerir utilizadores do Microsoft Entra ID num cluster Mongo.

 Extension Preview
az documentdb mongocluster microsoft-entra-user assign

Conceda a um Microsoft Entra ID o acesso principal a um cluster mongo atribuindo-lhe funções de base de dados.

 Extension Preview
az documentdb mongocluster microsoft-entra-user list

Liste os utilizadores do Microsoft Entra ID num cluster Mongo.

 Extension Preview
az documentdb mongocluster microsoft-entra-user remove

Remover o acesso de um principal do Microsoft Entra ID de um cluster Mongo.

 Extension Preview
az documentdb mongocluster microsoft-entra-user show

Obtenha a definição de um utilizador do Microsoft Entra ID num cluster Mongo.

 Extension Preview
az documentdb mongocluster microsoft-entra-user wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

 Extension Preview
az documentdb mongocluster replica

Gerir a Réplica.

 Extension Preview
az documentdb mongocluster replica create

Crie uma réplica de leitura de um cluster mongo existente.

 Extension Preview
az documentdb mongocluster replica list

Lista todas as réplicas do cluster Mongo.

 Extension Preview
az documentdb mongocluster replica promote

Promove uma réplica do cluster mongo para uma função principal.

 Extension Preview
az documentdb mongocluster reset-password

Redefinir a palavra-passe de administrador de um cluster Mongo.

 Extension Preview
az documentdb mongocluster restore

Restaurar um cluster mongo para um novo cluster a partir de um determinado momento.

 Extension Preview
az documentdb mongocluster show

Obtenha informações sobre um aglomerado de mongos.

 Extension Preview
az documentdb mongocluster update

Atualizar um cluster de mongos. Apenas as propriedades especificadas no pedido são modificadas; todas as outras propriedades permanecem inalteradas (HTTP PATCH). Argumentos genéricos de atualização (--set, --add, --remove) são suportados.

 Extension Preview
az documentdb mongocluster wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

 Extension Preview

az documentdb mongocluster check-name-availability

Pré-visualizar

O grupo de comando 'az documentdb mongocluster' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Verifique se o nome do cluster mongo está disponível para uso.

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

Exemplos

Verifica se existe um nome de cluster mongo disponível.

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--location -l

Location. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name

O nome do recurso cuja disponibilidade precisa ser verificada.

Propriedade Valor
Grupo de parâmetros: Body Arguments
--subscription

Nome ou ID de assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--type

O tipo do recurso.

Propriedade Valor
Grupo de parâmetros: Body Arguments
Valor predefinido: Microsoft.DocumentDB/mongoClusters
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Valor predefinido: False

az documentdb mongocluster create

Pré-visualizar

O grupo de comando 'az documentdb mongocluster' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Cria um aglomerado de mongos. Update substitui todas as propriedades do recurso. Para modificar apenas algumas das propriedades, 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]

Exemplos

Crie um cluster Mongo com armazenamento SSD Premium 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 Obrigatórios

--admin-password --password -p

A senha de administrador. Se o valor estiver em branco, é solicitado ao tty.

Propriedade Valor
Grupo de parâmetros: Administrator Arguments
--admin-user -u

O nome de usuário do administrador.

Propriedade Valor
Grupo de parâmetros: Administrator Arguments
--cluster-name --name -n

O nome do aglomerado de mongos.

--high-availability

O modo de alta disponibilidade de destino solicitado para o cluster.

Propriedade Valor
Grupo de parâmetros: HighAvailability Arguments
Valores aceites: Disabled, SameZone, ZoneRedundantPreferred
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--shard-count

Número de fragmentos a serem provisionados no cluster.

Propriedade Valor
Grupo de parâmetros: Sharding Arguments
--storage-size

O tamanho do disco de dados atribuído a cada servidor.

Propriedade Valor
Grupo de parâmetros: Storage Arguments
--tier

A camada de computação a ser atribuída ao cluster, onde cada camada é mapeada para um núcleo virtual e tamanho de memória. Valores de exemplo: 'M30', 'M40'.

Propriedade Valor
Grupo de parâmetros: Compute Arguments

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--auth-allowed-modes

Lista separada por espaço dos modos de autenticação permitidos para acesso a dados. Valores permitidos: NativeAuth, MicrosoftEntraID. Exemplo: --auth-allowed-modes NativeAuth MicrosoftEntraID Suporte à sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: AuthConfig Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--data-api-mode

Ative ou desative a API de Dados Mongo no cluster. Valores permitidos: Ativado, Desativado. Exemplo: --data-api-mode Ativado.

Propriedade Valor
Grupo de parâmetros: DataApi Arguments
Valores aceites: Disabled, Enabled
--encryption

A configuração de criptografia para o cluster. Depende da identidade que está sendo configurada. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--location -l

A localização geográfica onde o recurso reside Quando não especificada, a localização do grupo de recursos será usada.

Propriedade Valor
Grupo de parâmetros: Resource Arguments
--mi-user-assigned --user-assigned

Defina as identidades gerenciadas pelo usuário. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Identity Arguments
--network-bypass-mode

O modo de bypass de rede para o cluster. Definir para 'AzureCosmosDB' permite que o serviço Azure Cosmos DB contorne restrições de rede.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceites: AzureCosmosDB, None
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--preview-features

Lista separada por espaço de funcionalidades de pré-visualização para ativar no cluster. Os nomes das funcionalidades de pré-visualização são cadeias de formato livre; consulte a documentação de funcionalidades do Mongo Cluster para os valores atualmente disponíveis. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--public-network-access

Se o acesso público ao endpoint é permitido ou não para este cluster mongo.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceites: Disabled, Enabled
--server-version

A versão do servidor Mongo DB. O padrão é a versão mais recente disponível, se não for especificado.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--storage-type

O tipo de armazenamento com o qual provisionar os servidores de cluster.

Propriedade Valor
Grupo de parâmetros: Storage Arguments
Valores aceites: PremiumSSD, PremiumSSDv2
--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Resource Arguments
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID de assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Valor predefinido: False

az documentdb mongocluster delete

Pré-visualizar

O grupo de comando 'az documentdb mongocluster' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Apaga um cluster de mongos.

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]

Exemplos

Apaga um cluster de mongos.

az documentdb mongocluster delete -n MyCluster -g MyResourceGroup

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--cluster-name --name -n

O nome do aglomerado de mongos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não espere que a operação de longa duração termine.

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

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID de assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--yes -y

Não solicite confirmação.

Propriedade Valor
Valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Valor predefinido: False

az documentdb mongocluster list

Pré-visualizar

O grupo de comando 'az documentdb mongocluster' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Liste todos os clusters mongo em uma determinada assinatura.

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

Exemplos

Lista todos os clusters de mongos num grupo de recursos.

az documentdb mongocluster list -g MyResourceGroup

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token em --next-token argumento de um comando subsequente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--next-token

Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID de assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Valor predefinido: False

az documentdb mongocluster list-connection-strings

Pré-visualizar

O grupo de comando 'az documentdb mongocluster' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Liste cadeias de conexão de cluster mongo. Isso inclui a cadeia de conexão padrão usando SCRAM-SHA-256, bem como outras cadeias de conexão suportadas pelo cluster.

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

Exemplos

Liste as cadeias de ligação para um cluster Mongo.

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--cluster-name

O nome do aglomerado de mongos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID de assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Valor predefinido: False

az documentdb mongocluster reset-password

Pré-visualizar

O grupo de comando 'az documentdb mongocluster' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Redefinir a palavra-passe de administrador de um cluster 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]

Exemplos

Redefina a palavra-passe do administrador.

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

Parâmetros Obrigatórios

--admin-password --password -p

A nova palavra-passe de administrador. Se o valor estiver em branco, é solicitado ao tty.

Propriedade Valor
Grupo de parâmetros: Administrator Arguments

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--cluster-name --name -n

O nome do aglomerado de mongos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não espere que a operação de longa duração termine.

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

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID de assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Valor predefinido: False

az documentdb mongocluster restore

Pré-visualizar

O grupo de comando 'az documentdb mongocluster' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Restaurar um cluster mongo para um novo cluster a partir de um determinado momento.

Cria um novo cluster Mongo a partir do backup de um cluster de origem existente (ou eliminado) no 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}]

Exemplos

Restaure um cluster para um determinado ponto no tempo.

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 Obrigatórios

--admin-password --password -p

A senha de administrador. Se o valor estiver em branco, é solicitado ao tty.

Propriedade Valor
Grupo de parâmetros: Administrator Arguments
--admin-user -u

O nome de usuário do administrador.

Propriedade Valor
Grupo de parâmetros: Administrator Arguments
--cluster-name --name -n

O nome do aglomerado de mongos.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--restore-time

Ponto no tempo UTC para restaurar, no formato ISO-8601 (por exemplo: 2026-06-30T10:00:00Z).

Propriedade Valor
Grupo de parâmetros: Restore Arguments
--source-cluster

Nome ou ID de recurso do cluster Mongo de origem para restaurar. Se for dado um nome, assumem-se a subscrição atual e o grupo de recursos.

Propriedade Valor
Grupo de parâmetros: Restore Arguments

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--location -l

A localização geográfica onde o recurso reside Quando não especificada, a localização do grupo de recursos será usada.

Propriedade Valor
Grupo de parâmetros: Resource Arguments
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID de assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Valor predefinido: False

az documentdb mongocluster show

Pré-visualizar

O grupo de comando 'az documentdb mongocluster' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Obtenha informações sobre um aglomerado de mongos.

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

Exemplos

Obtenha informações sobre um aglomerado de mongos.

az documentdb mongocluster show -n MyCluster -g MyResourceGroup

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--cluster-name --name -n

O nome do aglomerado de mongos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID de assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Valor predefinido: False

az documentdb mongocluster update

Pré-visualizar

O grupo de comando 'az documentdb mongocluster' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Atualizar um cluster de mongos. Apenas as propriedades especificadas no pedido são modificadas; todas as outras propriedades permanecem inalteradas (HTTP PATCH). Argumentos genéricos de atualização (--set, --add, --remove) são suportados.

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]

Exemplos

Atualize o nível de computação de um cluster Mongo.

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--admin-password --password -p

A senha de administrador. Se o valor estiver em branco, é solicitado ao tty.

Propriedade Valor
Grupo de parâmetros: Administrator Arguments
--admin-user -u

O nome de usuário do administrador.

Propriedade Valor
Grupo de parâmetros: Administrator Arguments
--auth-allowed-modes

Lista separada por espaço dos modos de autenticação permitidos para acesso a dados. Valores permitidos: NativeAuth, MicrosoftEntraID. Exemplo: --auth-allowed-modes NativeAuth MicrosoftEntraID Suporte à sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: AuthConfig Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--cluster-name --name -n

O nome do aglomerado de mongos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--data-api-mode

Ative ou desative a API de Dados Mongo no cluster. Valores permitidos: Ativado, Desativado. Exemplo: --data-api-mode Ativado.

Propriedade Valor
Grupo de parâmetros: DataApi Arguments
Valores aceites: Disabled, Enabled
--encryption

A configuração de criptografia para o cluster. Depende da identidade que está sendo configurada. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--force-string

Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--high-availability

O modo de alta disponibilidade de destino solicitado para o cluster.

Propriedade Valor
Grupo de parâmetros: HighAvailability Arguments
Valores aceites: Disabled, SameZone, ZoneRedundantPreferred
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--network-bypass-mode

O modo de bypass de rede para o cluster. Definir para 'AzureCosmosDB' permite que o serviço Azure Cosmos DB contorne restrições de rede.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceites: AzureCosmosDB, None
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--preview-features

Lista separada por espaço de funcionalidades de pré-visualização para ativar no cluster. Os nomes das funcionalidades de pré-visualização são cadeias de formato livre; consulte a documentação de funcionalidades do Mongo Cluster para os valores atualmente disponíveis. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--public-network-access

Se o acesso público ao endpoint é permitido ou não para este cluster mongo.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceites: Disabled, Enabled
--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OU --remove propertyToRemove.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--server-version

A versão do servidor Mongo DB. O padrão é a versão mais recente disponível, se não for especificado.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--shard-count

Número de fragmentos a serem provisionados no cluster.

Propriedade Valor
Grupo de parâmetros: Sharding Arguments
--storage-size

O tamanho do disco de dados atribuído a cada servidor.

Propriedade Valor
Grupo de parâmetros: Storage Arguments
--storage-type

O tipo de armazenamento com o qual provisionar os servidores de cluster.

Propriedade Valor
Grupo de parâmetros: Storage Arguments
Valores aceites: PremiumSSD, PremiumSSDv2
--subscription

Nome ou ID de assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Resource Arguments
--tier

A camada de computação a ser atribuída ao cluster, onde cada camada é mapeada para um núcleo virtual e tamanho de memória. Valores de exemplo: 'M30', 'M40'.

Propriedade Valor
Grupo de parâmetros: Compute Arguments
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Valor predefinido: False

az documentdb mongocluster wait

Pré-visualizar

O grupo de comando 'az documentdb mongocluster' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Coloque a CLI em um estado de espera até que uma condição seja atendida.

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 Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--cluster-name --name -n

O nome do aglomerado de mongos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor predefinido: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
--deleted

Aguarde até ser excluído.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor predefinido: False
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor predefinido: False
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor predefinido: 30
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID de assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--timeout

Espera máxima em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor predefinido: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Valor predefinido: False