az documentdb mongocluster

  • Versão Prévia

Note

Essa referência faz parte da extensão do documentdb para o CLI do Azure (versão 2.75.0 ou superior). A extensão instalará automaticamente na primeira vez que você executar um comando az documentdb mongocluster . Saiba mais sobre extensões.

O grupo de comandos 'az documentdb' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Gerencie Azure clusters mongo do DocumentDB.

Comandos

Nome Description Tipo Status
az documentdb mongocluster check-name-availability

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

 Extension Preview
az documentdb mongocluster create

Crie um cluster mongo. A atualização substitui todas as propriedades do recurso. Para modificar apenas algumas das propriedades, use PATCH.

 Extension Preview
az documentdb mongocluster delete

Exclua um cluster mongo.

 Extension Preview
az documentdb mongocluster firewall-rule

Gerenciar regra de firewall.

 Extension Preview
az documentdb mongocluster firewall-rule create

Crie uma nova regra de firewall ou atualize uma regra de firewall existente em um cluster mongo.

 Extension Preview
az documentdb mongocluster firewall-rule delete

Exclua 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 em um 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

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

Listar cadeias de conexão do cluster mongo. Isso inclui a cadeia de conexão padrão usando SCRAM-SHA-256, bem como outras cadeias de conexão compatíveis com o cluster.

 Extension Preview
az documentdb mongocluster microsoft-entra-user

Gerencie Microsoft Entra ID usuários em um cluster mongo.

 Extension Preview
az documentdb mongocluster microsoft-entra-user assign

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

 Extension Preview
az documentdb mongocluster microsoft-entra-user list

Liste os usuários Microsoft Entra ID em um cluster mongo.

 Extension Preview
az documentdb mongocluster microsoft-entra-user remove

Remova o acesso de uma entidade de Microsoft Entra ID de um cluster mongo.

 Extension Preview
az documentdb mongocluster microsoft-entra-user show

Obtenha a definição de um usuário Microsoft Entra ID em um 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

Gerenciar 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

Liste todas as réplicas para o cluster mongo.

 Extension Preview
az documentdb mongocluster replica promote

Promove um cluster mongo de réplica para uma função primária.

 Extension Preview
az documentdb mongocluster reset-password

Redefina a senha de administrador de um cluster mongo.

 Extension Preview
az documentdb mongocluster restore

Restaure um cluster mongo para um novo cluster de um ponto no tempo.

 Extension Preview
az documentdb mongocluster show

Obtenha informações sobre um cluster mongo.

 Extension Preview
az documentdb mongocluster update

Atualize um cluster mongo. Somente as propriedades especificadas na solicitação são modificadas; todas as outras propriedades são deixadas inalteradas (PATCH HTTP). Há suporte para argumentos de atualização genéricos (--set, --add, --remove).

 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

Versão Prévia

O grupo de comandos 'az documentdb mongocluster' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: 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

Verifique se um nome de cluster mongo está 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

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

A ID de referência de alteração relacionada para esta operação de recurso.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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 para o qual a disponibilidade precisa ser verificada.

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

Nome ou ID da 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 de recurso.

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

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False

az documentdb mongocluster create

Versão Prévia

O grupo de comandos 'az documentdb mongocluster' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Crie um cluster mongo. A atualização 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 Exigidos

--admin-password --password -p

A senha do administrador. Se o valor estiver em branco, ele será solicitado no 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 cluster mongo.

--high-availability

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

Propriedade Valor
Grupo de parâmetros: HighAvailability Arguments
Valores aceitos: 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 provisionadas 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, em que 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

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

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

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

A ID de referência de alteração relacionada para esta operação de recurso.

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

Habilite ou desabilite a API de Dados do Mongo no cluster. Valores permitidos: Habilitado, Desabilitado. Exemplo: --data-api-mode Enabled.

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

A configuração de criptografia do cluster. Depende da identidade que está sendo configurada. Suporte a sintaxe abreviada, arquivo json 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 especificado, o local do grupo de recursos será usado.

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

Defina as identidades gerenciadas pelo usuário. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

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

O modo de desvio de rede para o cluster. Configurar para 'AzureCosmosDB' permite que o serviço do Azure Cosmos DB contorne as restrições da rede.

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

Não aguarde a conclusão da operação de execução prolongada.

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

Lista separada por espaço de recursos de visualização para habilitar no cluster. Os nomes de recursos de visualização são cadeias de caracteres de forma livre; consulte a documentação do recurso do cluster mongo para obter os valores disponíveis no momento. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

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

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

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

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

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 aceitos: PremiumSSD, PremiumSSDv2
--tags

Tags de recursos. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

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

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az documentdb mongocluster delete

Versão Prévia

O grupo de comandos 'az documentdb mongocluster' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Exclua um cluster 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]

Exemplos

Exclua um cluster mongo.

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 se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

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

A ID de referência de alteração relacionada para esta operação de recurso.

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

O nome do cluster mongo.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 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 da 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 padrão: False
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False

az documentdb mongocluster list

Versão Prévia

O grupo de comandos 'az documentdb mongocluster' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: 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

Liste todos os clusters mongo em um 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--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 onde iniciar a paginação. Esse é o valor do 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 Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az documentdb mongocluster list-connection-strings

Versão Prévia

O grupo de comandos 'az documentdb mongocluster' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Listar cadeias de conexão do cluster mongo. Isso inclui a cadeia de conexão padrão usando SCRAM-SHA-256, bem como outras cadeias de conexão compatíveis com o cluster.

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

Exemplos

Liste as cadeias de conexã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 se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

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

A ID de referência de alteração relacionada para esta operação de recurso.

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

O nome do cluster mongo.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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 da 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 Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False

az documentdb mongocluster reset-password

Versão Prévia

O grupo de comandos 'az documentdb mongocluster' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Redefina a senha 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 senha do administrador.

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

Parâmetros Exigidos

--admin-password --password -p

A nova senha de administrador. Se o valor estiver em branco, ele será solicitado no 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

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

A ID de referência de alteração relacionada para esta operação de recurso.

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

O nome do cluster mongo.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 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 da 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 Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False

az documentdb mongocluster restore

Versão Prévia

O grupo de comandos 'az documentdb mongocluster' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Restaure um cluster mongo para um novo cluster de um ponto no tempo.

Cria um novo cluster mongo a partir do backup de um cluster de origem existente (ou excluído) no ponto solicitado no tempo.

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

--admin-password --password -p

A senha do administrador. Se o valor estiver em branco, ele será solicitado no 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 cluster mongo.

--resource-group -g

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

--restore-time

Ponto UTC no tempo para restauração 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 do qual restaurar. Se um nome for fornecido, a assinatura atual e o grupo de recursos serão assumidos.

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 se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

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

A ID de referência de alteração relacionada 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 especificado, o local do grupo de recursos será usado.

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

Não aguarde a conclusão da operação de execução prolongada.

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

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az documentdb mongocluster show

Versão Prévia

O grupo de comandos 'az documentdb mongocluster' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Obtenha informações sobre um cluster mongo.

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

Exemplos

Obtenha informações sobre um cluster mongo.

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 se tornar obrigatórios para que o comando seja executado com sucesso.

--cluster-name --name -n

O nome do cluster mongo.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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 da 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 Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False

az documentdb mongocluster update

Versão Prévia

O grupo de comandos 'az documentdb mongocluster' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Atualize um cluster mongo. Somente as propriedades especificadas na solicitação são modificadas; todas as outras propriedades são deixadas inalteradas (PATCH HTTP). Há suporte para argumentos de atualização 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]

Exemplos

Atualize a camada 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa 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 do administrador. Se o valor estiver em branco, ele será solicitado no 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 de modos de autenticação permitidos para acesso a dados. Valores permitidos: NativeAuth, MicrosoftEntraID. Exemplo: --auth-allowed-modes NativeAuth MicrosoftEntraID Support shorthand-syntax, json-file e yaml-file. Tente "??" para mostrar mais.

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

A ID de referência de alteração relacionada para esta operação de recurso.

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

O nome do cluster mongo.

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

Habilite ou desabilite a API de Dados do Mongo no cluster. Valores permitidos: Habilitado, Desabilitado. Exemplo: --data-api-mode Enabled.

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

A configuração de criptografia do cluster. Depende da identidade que está sendo configurada. Suporte a sintaxe abreviada, arquivo json 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 cadeia de caracteres em vez de tentar converter em JSON.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valores aceitos: 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 aceitos: Disabled, SameZone, ZoneRedundantPreferred
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

O modo de desvio de rede para o cluster. Configurar para 'AzureCosmosDB' permite que o serviço do Azure Cosmos DB contorne as restrições da rede.

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

Não aguarde a conclusão da operação de execução prolongada.

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

Lista separada por espaço de recursos de visualização para habilitar no cluster. Os nomes de recursos de visualização são cadeias de caracteres de forma livre; consulte a documentação do recurso do cluster mongo para obter os valores disponíveis no momento. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

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

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

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

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --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 do Mongo DB. O padrão é a versão mais recente disponível, se não for especificada.

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 provisionadas 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 aceitos: PremiumSSD, PremiumSSDv2
--subscription

Nome ou ID da 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. Suporte a sintaxe abreviada, arquivo json 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, em que 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 Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False

az documentdb mongocluster wait

Versão Prévia

O grupo de comandos 'az documentdb mongocluster' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

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

A ID de referência de alteração relacionada para esta operação de recurso.

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

O nome do cluster mongo.

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 padrão: False
--custom

Aguarde até que a condição atenda 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 padrão: False
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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 padrão: 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 da 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 padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

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

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False