Use Azure CLI to create a Gremlin serverless account, database, and graph


The script in this article creates an Azure Cosmos DB for Gremlin serverless account, database, and graph.


  • If you don't have an Azure subscription, create an Azure free account before you begin.

  • This script requires Azure CLI version 2.30 or later.

    • You can run the script in the Bash environment in Azure Cloud Shell. When Cloud Shell opens, make sure to select Bash in the environment field at the upper left of the shell window. Cloud Shell has the latest version of Azure CLI.

      Launch Cloud Shell in a new window

    • If you prefer, you can install Azure CLI to run the script locally. Run az version to find your Azure CLI version, and run az upgrade if you need to upgrade. Sign in to Azure by running az login.

Sample script

This script uses the following commands:

# Create a Gremlin serverless account, database and graph

# Variable block
let "randomIdentifier=$RANDOM*$RANDOM"
location="East US"
failoverLocation="Central US"
account="msdocs-account-cosmos-$randomIdentifier" #needs to be lower case

# Create a resource group
echo "Creating $resourceGroup in $location..."
az group create --name $resourceGroup --location "$location" --tags $tag

# Create a Cosmos account for Gremlin API
echo "Creating $account"
az cosmosdb create --name $account --resource-group $resourceGroup --capabilities EnableGremlin EnableServerless --default-consistency-level Eventual --locations regionName="$failoverLocation" failoverPriority=0 isZoneRedundant=False

# Create a Gremlin database
echo "Creating $database with $account"
az cosmosdb gremlin database create --account-name $account --resource-group $resourceGroup --name $database

# Create a Gremlin graph
echo "Creating $graph"
az cosmosdb gremlin graph create --account-name $account --resource-group $resourceGroup --database-name $database --name $graph --partition-key-path $partitionKey

Delete resources

If you don't need the resources the script created, use the az group delete command to delete the resource group and all resources it contains, including the Azure Cosmos DB account and database.

az group delete --name $resourceGroup

Next steps

Azure Cosmos DB CLI documentation