Share via


az cosmosdb gremlin

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 Gremlin resources of Azure Cosmos DB account.

Commands

Name Description Type Status
az cosmosdb gremlin database

Manage Azure Cosmos DB Gremlin databases.

Core and Extension GA
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 graph

Manage Azure Cosmos DB Gremlin graphs.

Core and Extension GA
az cosmosdb gremlin graph create

Create an Gremlin graph under an Azure Cosmos DB Gremlin database.

Core GA
az cosmosdb gremlin graph delete

Delete the Gremlin graph under an Azure Cosmos DB Gremlin database.

Core GA
az cosmosdb gremlin graph exists

Checks if an Azure Cosmos DB Gremlin graph exists.

Core GA
az cosmosdb gremlin graph list

List the Gremlin graphs under an Azure Cosmos DB Gremlin database.

Core GA
az cosmosdb gremlin graph restore

Restore a deleted gremlin graph within the same account.

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

Restore a deleted gremlin graph within the same account.

Extension Preview
az cosmosdb gremlin graph show

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

Core GA
az cosmosdb gremlin graph throughput

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

Core GA
az cosmosdb gremlin graph throughput migrate

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

Core GA
az cosmosdb gremlin graph throughput show

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

Core GA
az cosmosdb gremlin graph throughput update

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

Core GA
az cosmosdb gremlin graph update

Update an Gremlin graph under an Azure Cosmos DB Gremlin database.

Core GA
az cosmosdb gremlin restorable-database

Manage different versions of gremlin databases that are restorable in a Azure Cosmos DB account.

Core and Extension GA
az cosmosdb gremlin restorable-database list

List all the versions of all the gremlin databases that were created / modified / deleted in the given restorable account.

Core GA
az cosmosdb gremlin restorable-database list (cosmosdb-preview extension)

List all the versions of all the gremlin databases that were created / modified / deleted in the given restorable account.

Extension Preview
az cosmosdb gremlin restorable-graph

Manage different versions of gremlin graphs that are restorable in a database of a Azure Cosmos DB account.

Core and Extension GA
az cosmosdb gremlin restorable-graph list

List all the versions of all the gremlin graphs that were created / modified / deleted in the given database and restorable account.

Core GA
az cosmosdb gremlin restorable-graph list (cosmosdb-preview extension)

List all the versions of all the gremlin graphs that were created / modified / deleted in the given database and restorable account.

Extension Preview
az cosmosdb gremlin restorable-resource

Manage the databases and its graphs that can be restored in the given account at the given timestamp and region.

Core and Extension GA
az cosmosdb gremlin restorable-resource list

List all the databases and its graphs that can be restored in the given account at the given timestamp and region.

Core GA
az cosmosdb gremlin restorable-resource list (cosmosdb-preview extension)

List all the databases and its graphs that can be restored in the given account at the given timestamp and region.

Extension Preview
az cosmosdb gremlin retrieve-latest-backup-time

Retrieves latest restorable timestamp for the given gremlin graph in given region.

Core GA
az cosmosdb gremlin retrieve-latest-backup-time (cosmosdb-preview extension)

Retrieves latest restorable timestamp for the given gremlin graph in given region.

Extension Preview

az cosmosdb gremlin retrieve-latest-backup-time

Retrieves latest restorable timestamp for the given gremlin graph in given region.

az cosmosdb gremlin retrieve-latest-backup-time --account-name
                                                --database-name
                                                --graph-name
                                                --location
                                                --resource-group

Required Parameters

--account-name -a

Name of the CosmosDB database account.

--database-name -d

Name of the CosmosDB Gremlin database name.

--graph-name -n

Name of the CosmosDB Gremlin graph name.

--location -l

Location of the account.

--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 retrieve-latest-backup-time (cosmosdb-preview extension)

Preview

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

Retrieves latest restorable timestamp for the given gremlin graph in given region.

az cosmosdb gremlin retrieve-latest-backup-time --account-name
                                                --database-name
                                                --graph-name
                                                --location
                                                --resource-group

Required Parameters

--account-name -a

Name of the CosmosDB database account.

--database-name -d

Name of the CosmosDB Gremlin database name.

--graph-name -n

Name of the CosmosDB Gremlin graph name.

--location -l

Location of the account.

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