Create an Azure Cosmos Gremlin API serverless account, database and graph using Azure CLI
APPLIES TO:
Gremlin API
Prerequisites
Use the Bash environment in Azure Cloud Shell. For more information, see Azure Cloud Shell Quickstart - Bash.
If you prefer to run CLI reference commands locally, install the Azure CLI. If you are running on Windows or macOS, consider running Azure CLI in a Docker container. For more information, see How to run the Azure CLI in a Docker container.
If you're using a local installation, sign in to the Azure CLI by using the az login command. To finish the authentication process, follow the steps displayed in your terminal. For additional sign-in options, see Sign in with the Azure CLI.
When you're prompted, install Azure CLI extensions on first use. For more information about extensions, see Use extensions with the Azure CLI.
Run az version to find the version and dependent libraries that are installed. To upgrade to the latest version, run az upgrade.
Sample script
#!/bin/bash
# Reference: az cosmosdb | https://docs.microsoft.com/cli/azure/cosmosdb
# --------------------------------------------------
#
# Create a Gremlin serverless account, database and graph
#
#
# Variables for Gremlin API resources
uniqueId=$RANDOM
resourceGroupName="Group-$uniqueId"
location='westus2'
accountName="cosmos-$uniqueId" #needs to be lower case
databaseName='database1'
graphName='graph1'
partitionKey='/pk'
# Create a resource group
az group create -n $resourceGroupName -l $location
# Create a Cosmos account for Gremlin API
az cosmosdb create \
-n $accountName \
-g $resourceGroupName \
--capabilities EnableGremlin EnableServerless \
--default-consistency-level Eventual \
--locations regionName='West US 2' failoverPriority=0 isZoneRedundant=False \
# Create a Gremlin database
az cosmosdb gremlin database create \
-a $accountName \
-g $resourceGroupName \
-n $databaseName
# Create a Gremlin graph
az cosmosdb gremlin graph create \
-a $accountName \
-g $resourceGroupName \
-d $databaseName \
-n $graphName \
-p $partitionKey
Clean up deployment
After the script sample has been run, the following command can be used to remove the resource group and all resources associated with it.
az group delete --name $resourceGroupName
Script explanation
This script uses the following commands. Each command in the table links to command specific documentation.
| Command | Notes |
|---|---|
| az group create | Creates a resource group in which all resources are stored. |
| az cosmosdb create | Creates an Azure Cosmos DB account. |
| az cosmosdb gremlin database create | Creates an Azure Cosmos Gremlin database. |
| az cosmosdb gremlin graph create | Creates an Azure Cosmos Gremlin graph. |
| az group delete | Deletes a resource group including all nested resources. |
Next steps
For more information on the Azure Cosmos DB CLI, see Azure Cosmos DB CLI documentation.
All Azure Cosmos DB CLI script samples can be found in the Azure Cosmos DB CLI GitHub Repository.
