az cosmosdb gremlin graph throughput

  • Reference

Manage throughput of Gremlin graph under an Azure Cosmos DB account.

Commands

az cosmosdb gremlin graph throughput migrate

Migrate the throughput of the Gremlin Graph between autoscale and manually provisioned.
az cosmosdb gremlin graph throughput show

Get the throughput of the Gremlin graph under an Azure Cosmos DB Gremlin database.
az cosmosdb gremlin graph throughput update

Update the throughput of the Gremlin graph under an Azure Cosmos DB Gremlin database.

az cosmosdb gremlin graph throughput migrate

Edit

Migrate the throughput of the Gremlin Graph between autoscale and manually provisioned.

az cosmosdb gremlin graph throughput migrate --account-name
                                             --database-name
                                             --name
                                             --resource-group
                                             --throughput-type {autoscale, manual}
                                             [--subscription]

Required Parameters

--account-name -a

Cosmosdb account name.

--database-name -d

Database name.

--name -n

Graph name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--throughput-type -t

The type of throughput to migrate to.

accepted values: autoscale, manual

Optional Parameters

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az cosmosdb gremlin graph throughput show

Edit

Get the throughput of the Gremlin graph under an Azure Cosmos DB Gremlin database.

az cosmosdb gremlin graph throughput show --account-name
                                          --database-name
                                          --name
                                          --resource-group
                                          [--query-examples]
                                          [--subscription]

Required Parameters

--account-name -a

Cosmosdb account name.

--database-name -d

Database name.

--name -n

Graph name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az cosmosdb gremlin graph throughput update

Edit

Update the throughput of the Gremlin graph under an Azure Cosmos DB Gremlin database.

az cosmosdb gremlin graph throughput update --account-name
                                            --database-name
                                            --name
                                            --resource-group
                                            [--max-throughput]
                                            [--subscription]
                                            [--throughput]

Required Parameters

--account-name -a

Cosmosdb account name.

--database-name -d

Database name.

--name -n

Graph name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--max-throughput

The maximum throughput resource can scale to (RU/s). Provided when the resource is autoscale enabled. The minimum value can be 4000 (RU/s).

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--throughput

The throughput Gremlin graph (RU/s).