针对用于 Azure Cosmos DB Gremlin API 的数据库或图形,使用 Azure CLI 实现的吞吐量 (RU/s) 操作

适用于: Gremlin API

先决条件

  • 如果需要,请安装 Azure CLI 来运行 CLI 参考命令。

    • 如果使用的是本地安装,请使用 az login 命令登录到 Azure CLI。 若要完成身份验证过程,请遵循终端中显示的步骤。 有关其他登录选项,请参阅登录 Azure CLI

    • 出现提示时,请在首次使用时安装 Azure CLI 扩展。 有关扩展详细信息,请参阅使用 Azure CLI 的扩展

    • 运行 az version 以查找安装的版本和依赖库。 若要升级到最新版本,请运行 az upgrade

  • 本文需要 Azure CLI 版本 2.12.1 或更高版本。

备注

请先运行 az cloud set -n AzureChinaCloud 更改云环境,然后才能在 Azure 中国世纪互联中使用 Azure CLI。 若要切换回 Azure 公有云,请再次运行 az cloud set -n AzureCloud

示例脚本

此脚本创建一个具有共享吞吐量的 Gremlin 数据库和一个具有专用吞吐量的 Gremlin 图,然后更新该数据库和该图的吞吐量。 脚本随后从标准吞吐量迁移到自动缩放吞吐量,然后在迁移后读取自动缩放吞吐量的值。

#!/bin/bash
# Reference: az cosmosdb | https://docs.azure.cn/cli/cosmosdb
# --------------------------------------------------
#
# Throughput operations for a Gremlin API database and graph
#
#

# Sign in the Azure China Cloud
az cloud set -n AzureChinaCloud
az login

# Variables for Gremlin API resources
uniqueId=$RANDOM
resourceGroupName="Group-$uniqueId"
location='chinanorth2'
accountName="cosmos-$uniqueId" #needs to be lower case
databaseName='database1'
graphName='graph1'
originalThroughput=400
updateThroughput=500

# Create a resource group, Cosmos account, database with throughput and graph with throughput
az group create -n $resourceGroupName -l $location
az cosmosdb create -n $accountName -g $resourceGroupName --capabilities EnableGremlin
az cosmosdb gremlin database create -a $accountName -g $resourceGroupName -n $databaseName --throughput $originalThroughput
az cosmosdb gremlin graph create -a $accountName -g $resourceGroupName -d $databaseName -n $graphName -p '/zipcode' --throughput $originalThroughput

# Throughput operations for Gremlin API database
# 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

read -p 'Press any key to read current provisioned throughput on database'

az cosmosdb gremlin database throughput show \
    -g $resourceGroupName \
    -a $accountName \
    -n $databaseName \
    --query resource.throughput \
    -o tsv

read -p 'Press any key to read minimum throughput on database'

minimumThroughput=$(az cosmosdb gremlin database throughput show \
    -g $resourceGroupName \
    -a $accountName \
    -n $databaseName \
    --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

read -p 'Press any key to update database throughput'

az cosmosdb gremlin database throughput update \
    -a $accountName \
    -g $resourceGroupName \
    -n $databaseName \
    --throughput $updateThroughput

read -p 'Press any key to migrate the database from standard (manual) throughput to autoscale throughput'

az cosmosdb gremlin database throughput migrate \
    -a $accountName \
    -g $resourceGroupName \
    -n $databaseName \
    -t 'autoscale'

read -p 'Press any key to read current autoscale provisioned max throughput on the database'

az cosmosdb gremlin database throughput show \
    -g $resourceGroupName \
    -a $accountName \
    -n $databaseName \
    --query resource.autoscaleSettings.maxThroughput \
    -o tsv

# Throughput operations for Gremlin API graph
# 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

read -p 'Press any key to read current provisioned throughput on a graph'

az cosmosdb gremlin graph throughput show \
    -g $resourceGroupName \
    -a $accountName \
    -d $databaseName \
    -n $graphName \
    --query resource.throughput \
    -o tsv

read -p 'Press any key to read minimum throughput on graph'

minimumThroughput=$(az cosmosdb gremlin graph throughput show \
    -g $resourceGroupName \
    -a $accountName \
    -d $databaseName \
    -n $graphName \
    --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

read -p 'Press any key to update graph throughput'

az cosmosdb gremlin graph throughput update \
    -g $resourceGroupName \
    -a $accountName \
    -d $databaseName \
    -n $graphName \
    --throughput $updateThroughput

read -p 'Press any key to migrate the graph from standard (manual) throughput to autoscale throughput'

az cosmosdb gremlin container throughput migrate \
    -a $accountName \
    -g $resourceGroupName \
    -d $databaseName \
    -n $graphName \
    -t 'autoscale'

read -p 'Press any key to read current autoscale provisioned max throughput on the graph'

az cosmosdb gremlin container throughput show \
    -g $resourceGroupName \
    -a $accountName \
    -d $databaseName \
    -n $graphName \
    --query resource.autoscaleSettings.maxThroughput \
    -o tsv

清理部署

运行脚本示例后,可以使用以下命令删除资源组以及与其关联的所有资源。

az group delete --name $resourceGroupName

脚本说明

此脚本使用以下命令。 表中的每条命令均链接到特定于命令的文档。

命令 说明
az group create 创建用于存储所有资源的资源组。
az cosmosdb create 创建 Azure Cosmos DB 帐户。
az cosmosdb gremlin database create 创建 Azure Cosmos Gremlin 数据库。
az cosmosdb gremlin graph create 创建 Azure Cosmos Gremlin 图。
az cosmosdb gremlin database throughput update 更新 Azure Cosmos Gremlin 数据库的 RU/秒。
az cosmosdb gremlin graph throughput update 更新 Azure Cosmos Gremlin 图的 RU/秒。
az cosmosdb gremlin database throughput migrate 迁移 Azure Cosmos Gremlin 数据库的吞吐量。
az cosmosdb gremlin graph throughput migrate 迁移 Azure Cosmos Gremlin 图形的吞吐量。
az group delete 删除资源组,包括所有嵌套的资源。

后续步骤

有关 Azure Cosmos DB CLI 的详细信息,请参阅 Azure Cosmos DB CLI 文档

可以在 Azure Cosmos DB CLI GitHub 存储库中找到所有 Azure Cosmos DB CLI 脚本示例。