az cosmosdb gremlin graph

Manage Azure Cosmos DB Gremlin graphs.

Commands

az cosmosdb gremlin graph create

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

az cosmosdb gremlin graph delete

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

az cosmosdb gremlin graph exists

Checks if an Azure Cosmos DB Gremlin graph exists.

az cosmosdb gremlin graph list

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

az cosmosdb gremlin graph show

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

az cosmosdb gremlin graph throughput

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

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 update

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

az cosmosdb gremlin graph create

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

az cosmosdb gremlin graph create --account-name
                                 --database-name
                                 --name
                                 --partition-key-path
                                 --resource-group
                                 [--conflict-resolution-policy]
                                 [--idx]
                                 [--max-throughput]
                                 [--subscription]
                                 [--throughput]
                                 [--ttl]

Examples

Create an Azure Cosmos DB Gremlin graph.

az cosmosdb gremlin graph create -g MyResourceGroup -a MyAccount -d MyDatabase -n MyGraph --partition-key-path "/my/path" --idx @policy-file.json --ttl 1000 --throughput "700"

Required Parameters

--account-name -a

Cosmosdb account name.

--database-name -d

Database name.

--name -n

Graph name.

--partition-key-path -p

Partition Key Path, e.g., '/address/zipcode'.

--resource-group -g

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

Optional Parameters

--conflict-resolution-policy -c

Conflict Resolution Policy, you can enter it as a string or as a file, e.g., --conflict-resolution-policy @policy-file.json or --conflict-resolution-policy "{"mode": "lastWriterWins", "conflictResolutionPath": "/path"}".

--idx

Indexing Policy, you can enter it as a string or as a file, e.g., --idx @policy-file.json or --idx "{"indexingMode": "consistent", "automatic": true, "includedPaths": [{"path": "/*"}], "excludedPaths": [{ "path": "/headquarters/employees/?"}, { "path": "/"_etag"/?"}]}".

default value: { "indexingMode": "consistent", "automatic": true, "includedPaths": [ { "path": "/*" } ], "excludedPaths": [ { "path": "/\"_etag\"/?" } ] }
--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 of Gremlin graph (RU/s). Default value is 400. Omit this parameter if the database has shared throughput unless the graph should have dedicated throughput.

--ttl

Default TTL. If the value is missing or set to "-1", items don’t expire. If the value is set to "n", items will expire "n" seconds after last modified time.

az cosmosdb gremlin graph delete

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

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

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

--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 graph exists

Checks if an Azure Cosmos DB Gremlin graph exists.

az cosmosdb gremlin graph exists --account-name
                                 --database-name
                                 --name
                                 --resource-group
                                 [--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

--subscription

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

az cosmosdb gremlin graph list

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

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

Required Parameters

--account-name -a

Cosmosdb account name.

--database-name -d

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.

az cosmosdb gremlin graph show

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

az cosmosdb gremlin graph 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 update

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

az cosmosdb gremlin graph update --account-name
                                 --database-name
                                 --name
                                 --resource-group
                                 [--idx]
                                 [--subscription]
                                 [--ttl]

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

--idx

Indexing Policy, you can enter it as a string or as a file, e.g., --idx @policy-file.json or --idx "{"indexingMode": "consistent", "automatic": true, "includedPaths": [{"path": "/*"}], "excludedPaths": [{ "path": "/headquarters/employees/?"}, { "path": "/"_etag"/?"}]}".

--subscription

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

--ttl

Default TTL. If the value is missing or set to "-1", items don’t expire. If the value is set to "n", items will expire "n" seconds after last modified time.