Compartilhar via

az cosmosdb collection

  • Preterido
  • Referência

Esse comando foi preterido e será removido em uma versão futura. Use 'cosmosdb sql container, cosmosdb mongodb collection, cosmosdb cassandra table, cosmosdb gremlin graph ou cosmosdb table' em vez disso.

Gerenciar coleções do Azure Cosmos DB.

Comandos

Nome Description Tipo Status
az cosmosdb collection create

Cria uma coleção do Azure Cosmos DB.

 Núcleo Preterido
az cosmosdb collection delete

Exclui uma coleção do Azure Cosmos DB.

 Núcleo Preterido
az cosmosdb collection exists

Retorna um booleano indicando se a coleção existe.

 Núcleo Preterido
az cosmosdb collection list

Lista todas as coleções do Azure Cosmos DB.

 Núcleo Preterido
az cosmosdb collection show

Mostra uma coleção do Azure Cosmos DB e sua oferta.

 Núcleo Preterido
az cosmosdb collection update

Atualiza uma coleção do Azure Cosmos DB.

 Núcleo Preterido

az cosmosdb collection create

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'coleção cosmosdb' foi preterido e será removido em uma versão futura. Use 'cosmosdb sql container, cosmosdb mongodb collection, cosmosdb cassandra table, cosmosdb gremlin graph ou cosmosdb table' em vez disso.

Cria uma coleção do Azure Cosmos DB.

az cosmosdb collection create --collection-name
                              --db-name
                              [--cep]
                              [--default-ttl]
                              [--indexing-policy]
                              [--key]
                              [--name]
                              [--partition-key-path]
                              [--resource-group-name]
                              [--throughput]
                              [--url-connection]

Parâmetros Exigidos

--collection-name -c

Nome da Coleção.

--db-name -d

Nome do Banco de Dados.

Parâmetros Opcionais

--cep

Política de criptografia de cliente, você pode inseri-lo como uma cadeia de caracteres ou como um arquivo, por exemplo, --cep ou --cep @policy-file.json "{"includedPaths": [{"path": "/path1","clientEncryptionKeyId": "key1","encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256","encryptionType": "Deterministic"}],"policyFormatVersion": 2}".

--default-ttl

TTL padrão. Forneça 0 para desabilitar.

--indexing-policy

Política de indexação, você pode inseri-la como uma cadeia de caracteres ou como um arquivo, por exemplo, --indexing-policy @policy-file.json).

Valor padrão: { "indexingMode": "consistent", "automatic": true, "includedPaths": [ { "path": "/*" } ], "excludedPaths": [ { "path": "/\"_etag\"/?" } ] }
--key

Chave de conta do Cosmos DB. Deve ser usado em conjunto com o nome da conta do cosmosdb ou a conexão url.

--name -n

Nome da conta do Cosmos DB. Deve ser usado em conjunto com o nome do grupo de recursos ou a chave de conta do cosmosdb.

--partition-key-path

Caminho da chave de partição, por exemplo, '/properties/name'.

--resource-group-name -g

Nome do grupo de recursos. Deve ser usado em conjunto com o nome da conta do cosmosdb.

--throughput

Taxa de transferência da oferta (RU/s).

--url-connection

Conexão de URL da conta do Cosmos DB. Deve ser usado em conjunto com a chave de conta do cosmosdb.

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

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'coleção cosmosdb' foi preterido e será removido em uma versão futura. Use 'cosmosdb sql container, cosmosdb mongodb collection, cosmosdb cassandra table, cosmosdb gremlin graph ou cosmosdb table' em vez disso.

Exclui uma coleção do Azure Cosmos DB.

az cosmosdb collection delete --collection-name
                              --db-name
                              [--key]
                              [--name]
                              [--resource-group-name]
                              [--url-connection]
                              [--yes]

Parâmetros Exigidos

--collection-name -c

Nome da Coleção.

--db-name -d

Nome do Banco de Dados.

Parâmetros Opcionais

--key

Chave de conta do Cosmos DB. Deve ser usado em conjunto com o nome da conta do cosmosdb ou a conexão url.

--name -n

Nome da conta do Cosmos DB. Deve ser usado em conjunto com o nome do grupo de recursos ou a chave de conta do cosmosdb.

--resource-group-name -g

Nome do grupo de recursos. Deve ser usado em conjunto com o nome da conta do cosmosdb.

--url-connection

Conexão de URL da conta do Cosmos DB. Deve ser usado em conjunto com a chave de conta do cosmosdb.

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

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'coleção cosmosdb' foi preterido e será removido em uma versão futura. Use 'cosmosdb sql container, cosmosdb mongodb collection, cosmosdb cassandra table, cosmosdb gremlin graph ou cosmosdb table' em vez disso.

Retorna um booleano indicando se a coleção existe.

az cosmosdb collection exists --collection-name
                              --db-name
                              [--key]
                              [--name]
                              [--resource-group-name]
                              [--url-connection]

Parâmetros Exigidos

--collection-name -c

Nome da Coleção.

--db-name -d

Nome do Banco de Dados.

Parâmetros Opcionais

--key

Chave de conta do Cosmos DB. Deve ser usado em conjunto com o nome da conta do cosmosdb ou a conexão url.

--name -n

Nome da conta do Cosmos DB. Deve ser usado em conjunto com o nome do grupo de recursos ou a chave de conta do cosmosdb.

--resource-group-name -g

Nome do grupo de recursos. Deve ser usado em conjunto com o nome da conta do cosmosdb.

--url-connection

Conexão de URL da conta do Cosmos DB. Deve ser usado em conjunto com a chave de conta do cosmosdb.

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

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'coleção cosmosdb' foi preterido e será removido em uma versão futura. Use 'cosmosdb sql container, cosmosdb mongodb collection, cosmosdb cassandra table, cosmosdb gremlin graph ou cosmosdb table' em vez disso.

Lista todas as coleções do Azure Cosmos DB.

az cosmosdb collection list --db-name
                            [--key]
                            [--name]
                            [--resource-group-name]
                            [--url-connection]

Parâmetros Exigidos

--db-name -d

Nome do Banco de Dados.

Parâmetros Opcionais

--key

Chave de conta do Cosmos DB. Deve ser usado em conjunto com o nome da conta do cosmosdb ou a conexão url.

--name -n

Nome da conta do Cosmos DB. Deve ser usado em conjunto com o nome do grupo de recursos ou a chave de conta do cosmosdb.

--resource-group-name -g

Nome do grupo de recursos. Deve ser usado em conjunto com o nome da conta do cosmosdb.

--url-connection

Conexão de URL da conta do Cosmos DB. Deve ser usado em conjunto com a chave de conta do cosmosdb.

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

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'coleção cosmosdb' foi preterido e será removido em uma versão futura. Use 'cosmosdb sql container, cosmosdb mongodb collection, cosmosdb cassandra table, cosmosdb gremlin graph ou cosmosdb table' em vez disso.

Mostra uma coleção do Azure Cosmos DB e sua oferta.

az cosmosdb collection show --collection-name
                            --db-name
                            [--key]
                            [--name]
                            [--resource-group-name]
                            [--url-connection]

Parâmetros Exigidos

--collection-name -c

Nome da Coleção.

--db-name -d

Nome do Banco de Dados.

Parâmetros Opcionais

--key

Chave de conta do Cosmos DB. Deve ser usado em conjunto com o nome da conta do cosmosdb ou a conexão url.

--name -n

Nome da conta do Cosmos DB. Deve ser usado em conjunto com o nome do grupo de recursos ou a chave de conta do cosmosdb.

--resource-group-name -g

Nome do grupo de recursos. Deve ser usado em conjunto com o nome da conta do cosmosdb.

--url-connection

Conexão de URL da conta do Cosmos DB. Deve ser usado em conjunto com a chave de conta do cosmosdb.

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

Editar
Preterido

Esse comando foi preterido implicitamente porque o grupo de comandos 'coleção cosmosdb' foi preterido e será removido em uma versão futura. Use 'cosmosdb sql container, cosmosdb mongodb collection, cosmosdb cassandra table, cosmosdb gremlin graph ou cosmosdb table' em vez disso.

Atualiza uma coleção do Azure Cosmos DB.

az cosmosdb collection update --collection-name
                              --db-name
                              [--default-ttl]
                              [--indexing-policy]
                              [--key]
                              [--name]
                              [--resource-group-name]
                              [--throughput]
                              [--url-connection]

Parâmetros Exigidos

--collection-name -c

Nome da Coleção.

--db-name -d

Nome do Banco de Dados.

Parâmetros Opcionais

--default-ttl

TTL padrão. Forneça 0 para desabilitar.

--indexing-policy

Política de indexação, você pode inseri-la como uma cadeia de caracteres ou como um arquivo, por exemplo, --indexing-policy @policy-file.json).

--key

Chave de conta do Cosmos DB. Deve ser usado em conjunto com o nome da conta do cosmosdb ou a conexão url.

--name -n

Nome da conta do Cosmos DB. Deve ser usado em conjunto com o nome do grupo de recursos ou a chave de conta do cosmosdb.

--resource-group-name -g

Nome do grupo de recursos. Deve ser usado em conjunto com o nome da conta do cosmosdb.

--throughput

Taxa de transferência da oferta (RU/s).

--url-connection

Conexão de URL da conta do Cosmos DB. Deve ser usado em conjunto com a chave de conta do cosmosdb.

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.