Share via

az cosmosdb gremlin database

  • Reference

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage Azure Cosmos DB Gremlin databases.

Commands

Name Description Type Status
az cosmosdb gremlin database create

Create an Gremlin database under an Azure Cosmos DB account.

 Core GA
az cosmosdb gremlin database delete

Delete the Gremlin database under an Azure Cosmos DB account.

 Core GA
az cosmosdb gremlin database exists

Checks if an Azure Cosmos DB Gremlin database exists.

 Core GA
az cosmosdb gremlin database list

List the Gremlin databases under an Azure Cosmos DB account.

 Core GA
az cosmosdb gremlin database restore

Restore a deleted gremlin database within the same account.

 Core GA
az cosmosdb gremlin database restore (cosmosdb-preview extension)

Restore a deleted gremlin database within the same account.

 Extension Preview
az cosmosdb gremlin database show

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

 Core GA
az cosmosdb gremlin database throughput

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

 Core GA
az cosmosdb gremlin database throughput migrate

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

 Core GA
az cosmosdb gremlin database throughput show

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

 Core GA
az cosmosdb gremlin database throughput update

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

 Core GA

az cosmosdb gremlin database create

Edit

Create an Gremlin database under an Azure Cosmos DB account.

Azure CLI 
az cosmosdb gremlin database create --account-name
                                    --name
                                    --resource-group
                                    [--max-throughput]
                                    [--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).

--throughput

The throughput Gremlin database (RU/s). Default value is 400.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb gremlin database delete

Edit

Delete the Gremlin database under an Azure Cosmos DB account.

Azure CLI 
az cosmosdb gremlin database delete --account-name
                                    --name
                                    --resource-group
                                    [--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

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb gremlin database exists

Edit

Checks if an Azure Cosmos DB Gremlin database exists.

Azure CLI 
az cosmosdb gremlin database exists --account-name
                                    --name
                                    --resource-group

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb gremlin database list

Edit

List the Gremlin databases under an Azure Cosmos DB account.

Azure CLI 
az cosmosdb gremlin database list --account-name
                                  --resource-group

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb gremlin database restore

Edit

Restore a deleted gremlin database within the same account.

Azure CLI 
az cosmosdb gremlin database restore --account-name
                                     --name
                                     --resource-group
                                     [--disable-ttl]
                                     [--restore-timestamp]

Examples

Restore a deleted gremlin database within the same account.

Azure CLI 
az cosmosdb gremlin database restore --resource-group resource_group --account-name database_account_name --name name_of_database_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

Required Parameters

--account-name -a

Cosmosdb account name.

--name -n

Name of the CosmosDB Gremlin database name.

--resource-group -g

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

Optional Parameters

--disable-ttl

Flag to restore with TTL disabled.

Usage: --disable-ttl True Default: false.

--restore-timestamp -t

The timestamp to which the database needs to be restored to.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb gremlin database restore (cosmosdb-preview extension)

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Restore a deleted gremlin database within the same account.

Azure CLI 
az cosmosdb gremlin database restore --account-name
                                     --name
                                     --resource-group
                                     [--disable-ttl {false, true}]
                                     [--restore-timestamp]

Examples

Restore a deleted gremlin database within the same account.

Azure CLI 
az cosmosdb gremlin database restore --resource-group resource_group --account-name database_account_name --name name_of_database_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

Required Parameters

--account-name -a

Cosmosdb account name.

--name -n

Name of the CosmosDB Gremlin database name.

--resource-group -g

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

Optional Parameters

--disable-ttl
Preview

Enable or disable restoring with ttl disabled.

Accepted values: false, true
--restore-timestamp -t

The timestamp to which the database needs to be restored to.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb gremlin database show

Edit

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

Azure CLI 
az cosmosdb gremlin database show --account-name
                                  --name
                                  --resource-group

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.