az cosmosdb gremlin database

Manage Azure Cosmos DB Gremlin databases.

Commands

az cosmosdb gremlin database create

Create an Gremlin database under an Azure Cosmos DB account.

az cosmosdb gremlin database delete

Delete the Gremlin database under an Azure Cosmos DB account.

az cosmosdb gremlin database exists

Checks if an Azure Cosmos DB Gremlin database exists.

az cosmosdb gremlin database list

List the Gremlin databases under an Azure Cosmos DB account.

az cosmosdb gremlin database show

Show the details of a Gremlin database under an Azure Cosmos DB account.

az cosmosdb gremlin database throughput

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

az cosmosdb gremlin database throughput migrate

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

az cosmosdb gremlin database throughput show

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

az cosmosdb gremlin database throughput update

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

az cosmosdb gremlin database create

Create an Gremlin database under an Azure Cosmos DB account.

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

Required Parameters

--account-name -a

Cosmosdb account name.

--name -n

Database 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 database (RU/s). Default value is 400.

az cosmosdb gremlin database delete

Delete the Gremlin database under an Azure Cosmos DB account.

az cosmosdb gremlin database delete --account-name
                                    --name
                                    --resource-group
                                    [--subscription]
                                    [--yes]

Required Parameters

--account-name -a

Cosmosdb account name.

--name -n

Database name.

--resource-group -g

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

Optional Parameters

--subscription

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

--yes -y

Do not prompt for confirmation.

az cosmosdb gremlin database exists

Checks if an Azure Cosmos DB Gremlin database exists.

az cosmosdb gremlin database exists --account-name
                                    --name
                                    --resource-group
                                    [--subscription]

Required Parameters

--account-name -a

Cosmosdb account name.

--name -n

Database name.

--resource-group -g

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

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 database list

List the Gremlin databases under an Azure Cosmos DB account.

az cosmosdb gremlin database list --account-name
                                  --resource-group
                                  [--query-examples]
                                  [--subscription]

Required Parameters

--account-name -a

Cosmosdb account 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 database show

Show the details of a Gremlin database under an Azure Cosmos DB account.

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

Required Parameters

--account-name -a

Cosmosdb account name.

--name -n

Database 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.