Share via

az cosmosdb collection

  • Preterido
  • Referência

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

Gerencie coleções do Azure Cosmos DB.

Comandos

Name Description Tipo Estado
az cosmosdb collection create

Cria uma coleção do Azure Cosmos DB.

 Principal Preterido
az cosmosdb collection delete

Exclui uma coleção do Azure Cosmos DB.

 Principal Preterido
az cosmosdb collection exists

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

 Principal Preterido
az cosmosdb collection list

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

 Principal Preterido
az cosmosdb collection show

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

 Principal Preterido
az cosmosdb collection update

Atualiza uma coleção do Azure Cosmos DB.

 Principal Preterido

az cosmosdb collection create

Editar
Preterido

Este comando foi implicitamente preterido 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 or 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 Obrigatórios

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

--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 predefinido: { "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 cosmosdb ou 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 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 cosmosdb.

--throughput

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

--url-connection

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az cosmosdb collection delete

Editar
Preterido

Este comando foi implicitamente preterido 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 or 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 Obrigatórios

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

--resource-group-name -g

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

--url-connection

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

--yes -y

Não solicite confirmação.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az cosmosdb collection exists

Editar
Preterido

Este comando foi implicitamente preterido 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 or 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 Obrigatórios

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

--resource-group-name -g

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

--url-connection

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az cosmosdb collection list

Editar
Preterido

Este comando foi implicitamente preterido 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 or 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 Obrigatórios

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

--resource-group-name -g

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

--url-connection

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az cosmosdb collection show

Editar
Preterido

Este comando foi implicitamente preterido 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 or 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 Obrigatórios

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

--resource-group-name -g

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

--url-connection

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az cosmosdb collection update

Editar
Preterido

Este comando foi implicitamente preterido 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 or 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 Obrigatórios

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

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

--resource-group-name -g

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

--throughput

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

--url-connection

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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