Throughput (RU/s) operations with Azure CLI for a table for Azure Cosmos DB for Table
APPLIES TO: Table
The script in this article creates a API for Table table then updates the throughput the table. The script then migrates from standard to autoscale throughput then reads the value of the autoscale throughput after it has been migrated.
If you prefer to run CLI reference commands locally, install the Azure CLI. If you're running on Windows or macOS, consider running Azure CLI in a Docker container. For more information, see How to run the Azure CLI in a Docker container.
If you're using a local installation, sign in to the Azure CLI by using the az login command. To finish the authentication process, follow the steps displayed in your terminal. For other sign-in options, see Sign in with the Azure CLI.
When you're prompted, install the Azure CLI extension on first use. For more information about extensions, see Use extensions with the Azure CLI.
- This article requires version 2.12.1 or later. Run
az --versionto find the version. If you need to install or upgrade, see Install Azure CLI. If using Azure Cloud Shell, the latest version is already installed.
Launch Azure Cloud Shell
The Azure Cloud Shell is a free interactive shell that you can use to run the steps in this article. It has common Azure tools preinstalled and configured to use with your account.
To open the Cloud Shell, just select Try it from the upper right corner of a code block. You can also launch Cloud Shell in a separate browser tab by going to https://shell.azure.com.
When Cloud Shell opens, verify that Bash is selected for your environment. Subsequent sessions will use Azure CLI in a Bash environment, Select Copy to copy the blocks of code, paste it into the Cloud Shell, and press Enter to run it.
Sign in to Azure
Cloud Shell is automatically authenticated under the initial account signed-in with. Use the following script to sign in using a different subscription, replacing
<Subscription ID> with your Azure Subscription ID. If you don't have an Azure subscription, create an Azure free account before you begin.
subscription="<subscriptionId>" # add subscription here az account set -s $subscription # ...or use 'az login'
Run the script
# Throughput operations for a Table API table # Variable block let "randomIdentifier=$RANDOM*$RANDOM" location="East US" resourceGroup="msdocs-cosmosdb-rg-$randomIdentifier" tag="throughput-table-cosmosdb" account="msdocs-account-cosmos-$randomIdentifier" #needs to be lower case table="msdocs-table-cosmos-$randomIdentifier" originalThroughput=400 updateThroughput=500 # Create a resource group echo "Creating $resourceGroup in $location..." az group create --name $resourceGroup --location "$location" --tags $tag # Create a Cosmos account for Table API echo "Creating $account" az cosmosdb create --name $account --resource-group $resourceGroup --capabilities EnableTable # Create a Table API Table with autoscale echo "Create $table with $maxThroughput" az cosmosdb table create --account-name $account --resource-group $resourceGroup --name $table --throughput $originalThroughput # Throughput operations for Table API table # Read the current throughput # Read the minimum throughput # Make sure the updated throughput is not less than the minimum # Update the throughput # Migrate between standard (manual) and autoscale throughput # Read the autoscale max throughput # Retrieve the current provisioned table throughput az cosmosdb table throughput show --name $table --resource-group $resourceGroup --account-name $account --query resource.throughput -o tsv # Retrieve the minimum allowable table throughput minimumThroughput=$(az cosmosdb table throughput show --resource-group $resourceGroup --account-name $account --name $table --query resource.minimumThroughput -o tsv) echo $minimumThroughput # Make sure the updated throughput is not less than the minimum allowed throughput if [ $updateThroughput -lt $minimumThroughput ]; then updateThroughput=$minimumThroughput fi # Update table throughput echo "Updating $table throughput to $updateThroughput" az cosmosdb table throughput update --account-name $account --resource-group $resourceGroup --name $table --throughput $updateThroughput # Migrate the table from standard (manual) throughput to autoscale throughput az cosmosdb table throughput migrate --account-name $account --resource-group $resourceGroup --name $table --throughput-type 'autoscale' # Retrieve current autoscale provisioned max table throughput az cosmosdb table throughput show --account-name $account --resource-group $resourceGroup --name $table --query resource.autoscaleSettings.maxThroughput -o tsv
Clean up resources
Use the following command to remove the resource group and all resources associated with it using the az group delete command - unless you have an ongoing need for these resources. Some of these resources may take a while to create, as well as to delete.
az group delete --name $resourceGroup
This script uses the following commands. Each command in the table links to command specific documentation.
|az group create||Creates a resource group in which all resources are stored.|
|az cosmosdb create||Creates an Azure Cosmos DB account.|
|az cosmosdb table create||Creates an Azure Cosmos DB Table API table.|
|az cosmosdb table throughput update||Update throughput for an Azure Cosmos DB Table API table.|
|az cosmosdb table throughput migrate||Migrate throughput for an Azure Cosmos DB Table API table.|
|az group delete||Deletes a resource group including all nested resources.|
For more information on the Azure Cosmos DB CLI, see Azure Cosmos DB CLI documentation.