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 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 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
--resource-group
[--idx]
[--partition-key-path]
[--subscription]
[--throughput]
[--ttl]

Examples

Create an Azure Cosmos DB Gremlin graph.

az cosmosdb gremlin graph create -g MyResourceGroup -a MyAccount -d MyDatabase -n MyGraph --part "/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.

--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", "includedPaths": [{"path": "/*", "indexes": [{"dataType": "String", "kind": "Range"}]}], "excludedPaths": [{ "path": "/headquarters/employees/?"}]}".

default value: { "indexingMode": "consistent", "automatic": true, "includedPaths": [ { "path": "/*", "indexes": [ { "kind": "Range", "dataType": "String", "precision": -1 }, { "kind": "Range", "dataType": "Number", "precision": -1 } ] } ] }
--partition-key-path -p

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

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

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

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

--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
[--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 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", "includedPaths": [{"path": "/*", "indexes": [{"dataType": "String", "kind": "Range"}]}], "excludedPaths": [{ "path": "/headquarters/employees/?"}]}".

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