az cosmosdb mongodb collection

  • Referência

Observação

Esse grupo de comandos tem comandos definidos na CLI do Azure e em pelo menos uma extensão. Instale cada extensão para se beneficiar de seus recursos estendidos. Saiba mais sobre extensões.

Gerencie coleções do MongoDB do Azure Cosmos DB.

Comandos

Nome Description Tipo Status
az cosmosdb mongodb collection create

Crie uma coleção MongoDB em um banco de dados MongoDB do Azure Cosmos DB.

 Núcleo GA
az cosmosdb mongodb collection delete

Exclua a coleção MongoDB em um banco de dados MongoDB do Azure Cosmos DB.

 Núcleo GA
az cosmosdb mongodb collection exists

Verifica se existe uma coleção do Azure Cosmos DB MongoDB.

 Núcleo GA
az cosmosdb mongodb collection list

Liste as coleções do MongoDB em um banco de dados do Azure Cosmos DB MongoDB.

 Núcleo GA
az cosmosdb mongodb collection merge

Mescla as partições de uma coleção mongodb.

 Extensão Visualizar
az cosmosdb mongodb collection redistribute-partition-throughput

Redistribui a taxa de transferência de partição de uma coleção mongodb.

 Extensão Visualizar
az cosmosdb mongodb collection restore

Restaure uma coleção mongodb excluída dentro da mesma conta.

 Núcleo GA
az cosmosdb mongodb collection restore (cosmosdb-preview extensão)

Restaure uma coleção mongodb excluída dentro da mesma conta.

 Extensão Visualizar
az cosmosdb mongodb collection retrieve-partition-throughput

Recupere a taxa de transferência de partição de uma coleção mongodb.

 Extensão Visualizar
az cosmosdb mongodb collection show

Mostrar os detalhes de uma coleção MongoDB em um banco de dados MongoDB do Azure Cosmos DB.

 Núcleo GA
az cosmosdb mongodb collection throughput

Gerencie a taxa de transferência da coleção do MongoDB em uma conta do Azure Cosmos DB.

 Núcleo GA
az cosmosdb mongodb collection throughput migrate

Migre a taxa de transferência da coleção do MongoDB entre dimensionamento automático e provisionado manualmente.

 Núcleo GA
az cosmosdb mongodb collection throughput show

Obtenha a taxa de transferência da coleção MongoDB em um banco de dados MongoDB do Azure Cosmos DB.

 Núcleo GA
az cosmosdb mongodb collection throughput update

Atualize a taxa de transferência da coleção MongoDB em um banco de dados MongoDB do Azure Cosmos DB.

 Núcleo GA
az cosmosdb mongodb collection update

Atualize uma coleção do MongoDB em um banco de dados do Azure Cosmos DB MongoDB.

 Núcleo GA

az cosmosdb mongodb collection create

Editar

Crie uma coleção MongoDB em um banco de dados MongoDB do Azure Cosmos DB.

az cosmosdb mongodb collection create --account-name
                                      --database-name
                                      --name
                                      --resource-group
                                      [--analytical-storage-ttl]
                                      [--idx]
                                      [--max-throughput]
                                      [--shard]
                                      [--throughput]

Exemplos

Crie uma coleção do Azure Cosmos DB MongoDB.

az cosmosdb mongodb collection create -g MyResourceGroup -a MyAccount -d MyDatabase -n MyCollection --shard "ShardingKey" --idx @indexes-file.json --throughput "500"

Parâmetros Exigidos

--account-name -a

Nome da conta do Cosmosdb.

--database-name -d

nome do banco de dados.

--name -n

Nome da coleção.

--resource-group -g

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

Parâmetros Opcionais

--analytical-storage-ttl

TTL analítico, quando o armazenamento analítico está habilitado.

--idx

Índices, você pode inseri-lo como uma cadeia de caracteres ou como um arquivo, por exemplo, --idx @indexes-file.json ou --idx "[{"key": {"keys": ["_ts"]},"options": {"expireAfterSeconds": 1000}}, {"key": {"keys": ["user_id", "user_address"]}, "options": {"unique": "true"}}]".

--max-throughput

O recurso de taxa de transferência máxima pode ser dimensionado para (RU/s). Fornecido quando o recurso é habilitado para dimensionamento automático. O valor mínimo pode ser 4000 (RU/s).

--shard

Compartilhando o caminho da chave.

--throughput

A taxa de transferência da coleção MongoDB (RU/s). O valor padrão é 400. Omita esse parâmetro se o banco de dados tiver taxa de transferência compartilhada, a menos que a coleção deva ter taxa de transferência dedicada.

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb mongodb collection delete

Editar

Exclua a coleção MongoDB em um banco de dados MongoDB do Azure Cosmos DB.

az cosmosdb mongodb collection delete --account-name
                                      --database-name
                                      --name
                                      --resource-group
                                      [--yes]

Parâmetros Exigidos

--account-name -a

Nome da conta do Cosmosdb.

--database-name -d

nome do banco de dados.

--name -n

Nome da coleção.

--resource-group -g

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

Parâmetros Opcionais

--yes -y

Não solicite confirmação.

valor padrão: False
Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb mongodb collection exists

Editar

Verifica se existe uma coleção do Azure Cosmos DB MongoDB.

az cosmosdb mongodb collection exists --account-name
                                      --database-name
                                      --name
                                      --resource-group

Parâmetros Exigidos

--account-name -a

Nome da conta do Cosmosdb.

--database-name -d

nome do banco de dados.

--name -n

Nome da coleção.

--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 o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb mongodb collection list

Editar

Liste as coleções do MongoDB em um banco de dados do Azure Cosmos DB MongoDB.

az cosmosdb mongodb collection list --account-name
                                    --database-name
                                    --resource-group

Parâmetros Exigidos

--account-name -a

Nome da conta do Cosmosdb.

--database-name -d

nome do banco de dados.

--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 o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb mongodb collection merge

Versão Prévia

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Mescla as partições de uma coleção mongodb.

az cosmosdb mongodb collection merge --account-name
                                     --database-name
                                     --name
                                     --resource-group

Exemplos

mesclar partições da coleção my-mongoDB-collection

az cosmosdb mongodb collection merge -g my-resource-group -a my-account -d my-db --name my-mongodb-collection

Parâmetros Exigidos

--account-name -a

Nome da conta de banco de dados do CosmosDB.

--database-name -d

Nome do banco de dados mongoDB.

--name -n

Nome da coleção mongoDB.

--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 o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb mongodb collection redistribute-partition-throughput

Versão Prévia

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Redistribui a taxa de transferência de partição de uma coleção mongodb.

az cosmosdb mongodb collection redistribute-partition-throughput --account-name
                                                                 --database-name
                                                                 --name
                                                                 --resource-group
                                                                 [--evenly-distribute {false, true}]
                                                                 [--source-partition-info]
                                                                 [--target-partition-info]

Exemplos

Distribui uniformemente a taxa de transferência de partição para uma coleção mongodb entre todas as partições físicas

az cosmosdb mongodb collection redistribute-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --evenly-distribute

Redistribui a taxa de transferência de partição para uma coleção mongodb de partições de origem para partições de destino

az cosmosdb mongodb collection redistribute-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --target-partition-info 8=1200 6=1200' --source-partition-info 9'

Parâmetros Exigidos

--account-name -a

Nome da conta de banco de dados do CosmosDB.

--database-name -d

Nome do banco de dados do CosmosDB.

--name -n

Nome da coleção do CosmosDB.

--resource-group -g

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

Parâmetros Opcionais

--evenly-distribute

Alterne para distribuir a taxa de transferência igualmente entre todas as partições físicas.

valores aceitos: false, true
valor padrão: False
--source-partition-info

Partição física de origem separada por espaço ids por exemplo: 1 2.

valor padrão: []
--target-partition-info

Informações sobre a taxa de transferência da partição física de destino desejada, por exemplo: '0=1200 1=1200'.

valor padrão: []
Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb mongodb collection restore

Editar

Restaure uma coleção mongodb excluída dentro da mesma conta.

az cosmosdb mongodb collection restore --account-name
                                       --database-name
                                       --name
                                       --resource-group
                                       [--restore-timestamp]

Exemplos

Restaure uma coleção mongodb excluída dentro da mesma conta.

az cosmosdb mongodb collection restore --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_collection_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

Parâmetros Exigidos

--account-name -a

Nome da conta do Cosmosdb.

--database-name -d

nome do banco de dados.

--name -n

Nome da coleção.

--resource-group -g

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

Parâmetros Opcionais

--restore-timestamp -t

O carimbo de data/hora para o qual a coleção precisa ser restaurada.

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb mongodb collection restore (cosmosdb-preview extensão)

Versão Prévia

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Restaure uma coleção mongodb excluída dentro da mesma conta.

az cosmosdb mongodb collection restore --account-name
                                       --database-name
                                       --name
                                       --resource-group
                                       [--disable-ttl {false, true}]
                                       [--restore-timestamp]

Exemplos

Restaure uma coleção mongodb excluída dentro da mesma conta.

az cosmosdb mongodb collection restore --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_collection_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

Parâmetros Exigidos

--account-name -a

Nome da conta do Cosmosdb.

--database-name -d

nome do banco de dados.

--name -n

Nome da coleção.

--resource-group -g

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

Parâmetros Opcionais

--disable-ttl
Versão Prévia

Habilite ou desabilite a restauração com o ttl desabilitado.

valores aceitos: false, true
--restore-timestamp -t

O carimbo de data/hora para o qual a coleção precisa ser restaurada.

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb mongodb collection retrieve-partition-throughput

Versão Prévia

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Recupere a taxa de transferência de partição de uma coleção mongodb.

az cosmosdb mongodb collection retrieve-partition-throughput --account-name
                                                             --database-name
                                                             --name
                                                             --resource-group
                                                             [--all-partitions {false, true}]
                                                             [--physical-partition-ids]

Exemplos

Recuperar a taxa de transferência do container_name de contêiner para partições físicas específicas

az cosmosdb mongodb collection retrieve-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --physical-partition-ids 8 9

Recuperar a taxa de transferência do container_name de contêiner para todas as partições físicas

az cosmosdb mongodb collection retrieve-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --all-partitions

Parâmetros Exigidos

--account-name -a

Nome da conta de banco de dados do CosmosDB.

--database-name -d

Nome do banco de dados do CosmosDB.

--name -n

Nome do contêiner do CosmosDB.

--resource-group -g

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

Parâmetros Opcionais

--all-partitions

Alterne para recuperar a taxa de transferência de todas as partições físicas.

valores aceitos: false, true
valor padrão: False
--physical-partition-ids -p

Lista separada por espaço de ids de partição física.

valor padrão: []
Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb mongodb collection show

Editar

Mostrar os detalhes de uma coleção MongoDB em um banco de dados MongoDB do Azure Cosmos DB.

az cosmosdb mongodb collection show --account-name
                                    --database-name
                                    --name
                                    --resource-group

Parâmetros Exigidos

--account-name -a

Nome da conta do Cosmosdb.

--database-name -d

nome do banco de dados.

--name -n

Nome da coleção.

--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 o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb mongodb collection update

Editar

Atualize uma coleção do MongoDB em um banco de dados do Azure Cosmos DB MongoDB.

az cosmosdb mongodb collection update --account-name
                                      --database-name
                                      --name
                                      --resource-group
                                      [--analytical-storage-ttl]
                                      [--idx]

Parâmetros Exigidos

--account-name -a

Nome da conta do Cosmosdb.

--database-name -d

nome do banco de dados.

--name -n

Nome da coleção.

--resource-group -g

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

Parâmetros Opcionais

--analytical-storage-ttl

TTL analítico, quando o armazenamento analítico está habilitado.

--idx

Índices, você pode inseri-lo como uma cadeia de caracteres ou como um arquivo, por exemplo, --idx @indexes-file.json ou --idx "[{"key": {"keys": ["_ts"]},"options": {"expireAfterSeconds": 1000}}, {"key": {"keys": ["user_id", "user_address"]}, "options": {"unique": "true"}}]".

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.