Create an Azure Cosmos account with IP firewall using Azure CLI
APPLIES TO: SQL API Cassandra API Gremlin API Table API Azure Cosmos DB API for MongoDB
Use Azure Cloud Shell using the Bash environment.
If you prefer, install the Azure CLI to run CLI reference commands.
- 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.
- This article requires version 2.9.1 or later of the Azure CLI. If using Azure Cloud Shell, the latest version is already installed.
This sample demonstrates using a SQL (Core) API account. To use this sample for other APIs, apply the
ip-range-filter parameter in the script below to
az cosmosdb account create command for your API specific script.
#!/bin/bash # Reference: az cosmosdb | https://docs.microsoft.com/cli/azure/cosmosdb # -------------------------------------------------- # # Create an Azure Cosmos Account with IP Firewall # # # Resource group and Cosmos account variables uniqueId=$RANDOM resourceGroupName="Group-$uniqueId" location='westus2' accountName="cosmos-$uniqueId" #needs to be lower case # Create a resource group az group create -n $resourceGroupName -l $location # Create a Cosmos DB account with default values and IP Firewall enabled # Use appropriate values for --kind or --capabilities for other APIs az cosmosdb create \ -n $accountName \ -g $resourceGroupName \ --ip-range-filter '192.168.221.17'
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
This script uses the following commands. Each command in the table links to command specific documentation.
|az group create||Creates a resource group in which all resources are stored.|
|az cosmosdb create||Creates an Azure Cosmos DB account.|
|az group delete||Deletes a resource group including all nested resources.|
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.