az documentdb mongocluster replica

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 de réplica do mongocluster do az documentdb . Saiba mais sobre extensões.

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

Gerir a Réplica.

Comandos

Nome Descrição Tipo Estado
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 replica create

Pré-visualizar

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

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

O cluster de origem deve ter ativada a funcionalidade de pré-visualização "GeoReplicas". A réplica é provisionada como um novo cluster mongo e herda a sua configuração (computação, armazenamento, fragmentação) do cluster de origem. Uma réplica na mesma região da fonte é criada como uma região dentro AsyncReplicada região ; uma réplica numa região diferente é criada como uma região transversal GeoAsyncReplica.

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

Exemplos

Criar uma réplica de um cluster.

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

Parâmetros Obrigatórios

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

--source-cluster

Nome ou ID de recurso do cluster mongo de origem (primário) para replicar. Se for dado um nome, assumem-se a subscrição atual e o grupo de recursos. Forneça um ID ARM completo para uma fonte noutro grupo de recursos ou subscrição.

Propriedade Valor
Grupo de parâmetros: Replica 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 replica list

Pré-visualizar

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

Lista todas as réplicas do cluster Mongo.

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

Exemplos

Liste réplicas de um cluster.

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

Parâmetros Obrigatórios

--resource-group -g

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

--source-cluster

O nome do cluster de Mongo de origem.

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

Pré-visualizar

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

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

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

Exemplos

Promova uma réplica a primária.

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

Parâmetros Obrigatórios

--promote-option

A opção de promoção para candidatar-se à operação.

Propriedade Valor
Grupo de parâmetros: Body Arguments
Valores aceites: Forced, Planned
--source-cluster

Nome ou ID de recurso do cluster fonte (primário) esperado desta réplica. A promoção só prossegue se corresponder ao cluster de origem real da réplica; caso contrário, a operação falha.

Propriedade Valor
Grupo de parâmetros: Replica 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
--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
--mode

O modo de aplicar à operação de promoção. O valor é opcional e o valor padrão é 'Switchover'.

Propriedade Valor
Grupo de parâmetros: Body Arguments
Valores aceites: Switchover
--name -n

O nome da réplica a promover.

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