Migrate between standard and autoscale throughput by using PowerShell or Azure CLI

To migrate between standard and autoscale throughput in Azure Cosmos DB using PowerShell or Azure CLI, you can leverage the Azure Cosmos DB management capabilities provided by these tools. This article will guide you through the process, demonstrating how to switch between standard and autoscale throughput modes programmatically.

Azure Cosmos DB Overview

Azure Cosmos DB is a globally distributed, multi-model database service offered by Microsoft Azure. It provides scalable throughput and global distribution, making it an excellent choice for building highly available and performant native applications.

Migrating between standard and autoscale throughput involves modifying the throughput policy of your Azure Cosmos DB account. The process can be automated and simplified using PowerShell or Azure CLI scripts. Let’s explore how to perform this migration using both approaches.

Migrating using PowerShell

PowerShell provides a rich set of cmdlets for managing Azure resources, including Azure Cosmos DB. To migrate between standard and autoscale throughput using PowerShell, follow these steps:

Step 1: Install the Azure PowerShell module

If you haven’t already installed the Azure PowerShell module, you can install it by running the following command:

Install-Module -Name Az

Step 2: Connect to your Azure account

Connect to your Azure account by running the following command and following the authentication instructions:

Connect-AzAccount

Step 3: Select the Azure Cosmos DB account to migrate

Select the Azure Cosmos DB account you want to migrate by running the following command:

$cosmosDbAccount = Get-AzCosmosDBAccount -ResourceGroupName '' -Name ''

Replace ‘<resource-group-name>’ with the name of the resource group where your Azure Cosmos DB account resides, and ‘<cosmos-db-account-name>’ with the name of your Azure Cosmos DB account.

Step 4: Switch to autoscale throughput

To switch your Azure Cosmos DB account to autoscale throughput, run the following command:

$autoscaleSettings = @{
'maxThroughput' = 4000 # The maximum autoscale throughput in Request Units (RUs)
}

Set-AzCosmosDBAccount -ResourceGroupName $cosmosDbAccount.ResourceGroupName -Name $cosmosDbAccount.Name -Kind $cosmosDbAccount.Kind -Location $cosmosDbAccount.Location -DefaultConsistencyLevel $cosmosDbAccount.DefaultConsistencyLevel -LocationObject $cosmosDbAccount.LocationObject -Throughput $autoscaleSettings

Replace ‘4000’ with your desired maximum autoscale throughput value.

Step 5: Switch to standard throughput

To switch your Azure Cosmos DB account to standard throughput, run the following command:

Set-AzCosmosDBThroughput -ResourceGroupName $cosmosDbAccount.ResourceGroupName -Name $cosmosDbAccount.Name -Throughput 400

Replace ‘400’ with your desired standard throughput value.

Migrating using Azure CLI

Azure CLI is a cross-platform command-line interface provided by Microsoft to interact with Azure resources. To migrate between standard and autoscale throughput using Azure CLI, follow these steps:

Step 1: Install Azure CLI

If you haven’t already installed Azure CLI, you can follow the installation instructions provided at https://docs.microsoft.com/cli/azure/install-azure-cli.

Step 2: Log in to your Azure account

Log in to your Azure account by running the following command and following the authentication instructions:

az login

Step 3: Select the Azure Cosmos DB account to migrate

Select the Azure Cosmos DB account you want to migrate by running the following command:

cosmosDbAccount=$(az cosmosdb show --resource-group --name --query "{id:id,kind:kind,location:location}" --output json)

Replace ‘<resource-group-name>’ with the name of the resource group where your Azure Cosmos DB account resides, and ‘<cosmos-db-account-name>’ with the name of your Azure Cosmos DB account.

Step 4: Switch to autoscale throughput

To switch your Azure Cosmos DB account to autoscale throughput, run the following command:

az cosmosdb update --resource-group $(echo $cosmosDbAccount | jq -r .id | awk -F'/' '{print $5}') --name $(echo $cosmosDbAccount | jq -r .id | awk -F'/' '{print $9}') --locations "$(echo $cosmosDbAccount | jq -r .location)" --default-consistency-level $(echo $cosmosDbAccount | jq -r .kind) --max-throughput 4000

Replace ‘4000’ with your desired maximum autoscale throughput value.

Step 5: Switch to standard throughput

To switch your Azure Cosmos DB account to standard throughput, run the following command:

az cosmosdb update --resource-group $(echo $cosmosDbAccount | jq -r .id | awk -F'/' '{print $5}') --name $(echo $cosmosDbAccount | jq -r .id | awk -F'/' '{print $9}') --throughput 400

Replace ‘400’ with your desired standard throughput value.

Conclusion

Migrating between standard and autoscale throughput in Azure Cosmos DB can be accomplished programmatically using PowerShell or Azure CLI. Both approaches offer the flexibility to switch between throughput modes based on your application requirements. By leveraging the Azure Cosmos DB management capabilities provided by these tools, you can seamlessly adapt your throughput configuration to meet the changing needs of your native applications.