CmdID

CmdID / az / az cosmosdb / az cosmosdb sql

az cosmosdb sql container

Manage Azure Cosmos DB SQL containers. Azure CLI reference

11 commands 15 options Its page in the Azure CLI reference

Opens CmdID with your command. It is read in your browser and sent nowhere.

Commands

11, each with its page
createCreate an SQL container under an Azure Cosmos DB SQL database.deleteDelete the SQL container under an Azure Cosmos DB SQL database.existsChecks if an Azure Cosmos DB SQL container existslistList the SQL containers under an Azure Cosmos DB SQL database.mergeMerges the partitions of a sql container.redistribute-partition-throughputRedistributes the partition throughput of a sql container.restoreRestore a deleted sql container within the same account.retrieve-partition-throughputRetrieve the partition throughput of a sql container.showShow the details of a SQL container under an Azure Cosmos DB SQL database.throughputManage throughput of SQL container under an Azure Cosmos DB account.updateUpdate an SQL container under an Azure Cosmos DB SQL database.

Options

15 in the Azure CLI reference
--account-name, -aCosmosdb account name.
--analytical-storage-ttl, -tAnalytical TTL, when analytical storage is enabled.
--cepClient Encryption Policy, you can enter it as a string or as a file, e.g., --cep @policy-file.json or --cep "{\"includedPaths\": [{\"path\": \"/path1\",\"clientEncryptionKeyId\": \"key1\",\"encryptionAlgorithm\": \"AEAD_AES_256_CBC_HMAC_SHA256\",\"encryptionType\": \"Deterministic\"}],\"policyFormatVersion\": 2}"
--conflict-resolution-policy, -cConflict Resolution Policy, you can enter it as a string or as a file, e.g., --conflict-resolution-policy @policy-file.json or --conflict-resolution-policy "{\"mode\": \"lastWriterWins\", \"conflictResolutionPath\": \"/path\"}"
--database-name, -dDatabase name.
--full-text-policyFull Text Policy, you can enter it as a string or as a file, e.g., --full-text-policy @policy-file.json or --full-text-policy "{\"fullTextPaths\": [{\"path\": \"/ftPath1\", \"language\": \"en-US\" }]}"
--idxIndexing Policy, you can enter it as a string or as a file, e.g., --idx @policy-file.json or --idx "{\"indexingMode\": \"consistent\", \"automatic\": true, \"includedPaths\": [{\"path\": \"/*\"}], \"excludedPaths\": [{ \"path\": \"/headquarters/employees/?\"}, { \"path\": \"/\\"_etag\\"/?\"}],\"vectorIndexes\": [{\"path\": \"/vector1\",\"type\": \"flat\"}]}"
--max-throughputThe maximum throughput resource can scale to (RU/s).
--name, -nContainer name
--partition-key-path, -pPartition Key Path, e.g., '/address/zipcode'
--partition-key-versionThe version of partition key.
--throughputThe throughput of SQL container (RU/s).
--ttlDefault TTL.
--unique-key-policy, -uUnique Key Policy, you can enter it as a string or as a file, e.g., --unique-key-policy @policy-file.json or --unique-key-policy "{\"uniqueKeys\": [{\"paths\": [\"/path/to/key1\"]}, {\"paths\": [\"/path/to/key2\"]}]}"
--vector-embeddingsVector Embedding Policy, you can enter it as a string or as a file, e.g., --vector-embeddings @policy-file.json or --vector-embeddings "{\"vectorEmbeddings\": [{\"path\": \"/vector1\", \"dataType\": \"float32\", \"dimensions\": 2, \"distanceFunction\": \"dotproduct\" }]}"