Compartilhar via


az cosmosdb mongodb collection

Note

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 do MongoDB em um banco de dados MongoDB do Azure Cosmos DB.

Core GA
az cosmosdb mongodb collection delete

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

Core GA
az cosmosdb mongodb collection exists

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

Core GA
az cosmosdb mongodb collection list

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

Core GA
az cosmosdb mongodb collection merge

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

Extension Preview
az cosmosdb mongodb collection redistribute-partition-throughput

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

Extension Preview
az cosmosdb mongodb collection restore

Restaure uma coleção excluída do mongoDB na mesma conta.

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

Restaure uma coleção excluída do mongoDB na mesma conta.

Extension Preview
az cosmosdb mongodb collection retrieve-partition-throughput

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

Extension Preview
az cosmosdb mongodb collection show

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

Core GA
az cosmosdb mongodb collection throughput

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

Core GA
az cosmosdb mongodb collection throughput migrate

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

Core GA
az cosmosdb mongodb collection throughput show

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

Core GA
az cosmosdb mongodb collection throughput update

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

Core GA
az cosmosdb mongodb collection update

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

Core GA

az cosmosdb mongodb collection create

Crie uma coleção do 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 MongoDB do Azure Cosmos DB.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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 está habilitado para dimensionamento automático. O valor mínimo pode ser 4000 (RU/s).

--shard

Caminho da chave de fragmentação.

--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 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 cosmosdb mongodb collection delete

Exclua a coleção do 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

--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 cosmosdb mongodb collection exists

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

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 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 cosmosdb mongodb collection list

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

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 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 cosmosdb mongodb collection merge

Versão Prévia

Esse comando está em versão prévia 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 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 cosmosdb mongodb collection redistribute-partition-throughput

Versão Prévia

Esse comando está em versão prévia 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 de 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 de 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 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--evenly-distribute

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

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--source-partition-info

IDs de partição física de origem separadas por espaço, por exemplo: 1 2.

Propriedade Valor
Valor padrão: []
--target-partition-info

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

Propriedade Valor
Valor padrão: []
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 cosmosdb mongodb collection restore

Restaure uma coleção excluída do mongoDB na mesma conta.

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

Exemplos

Restaure uma coleção excluída do mongoDB na 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--disable-ttl

Sinalizador para restauração com TTL desabilitado.

Uso: --disable-ttl True Default: false.

--restore-timestamp -t

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

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 cosmosdb mongodb collection restore (cosmosdb-preview extensão)

Versão Prévia

Esse comando está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Restaure uma coleção excluída do mongoDB na 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 excluída do mongoDB na 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--disable-ttl
Versão Prévia

Ative ou desative a restauração com o ttl desabilitado.

Propriedade Valor
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 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 cosmosdb mongodb collection retrieve-partition-throughput

Versão Prévia

Esse comando está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Recupere a taxa de transferência da 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 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--all-partitions

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

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--physical-partition-ids -p

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

Propriedade Valor
Valor padrão: []
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 cosmosdb mongodb collection show

Mostre os detalhes de uma coleção do 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 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 cosmosdb mongodb collection update

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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