Create an Azure Cosmos DB Account with a private endpoint

Last updated: 10/04/2020

This template will create a Cosmos account, a virtual network and a private endpoint exposing the Cosmos account to the virtual network.

This Azure Resource Manager (ARM) template was created by a member of the community and not by Microsoft. Each ARM template is licensed to you under a licence agreement by its owner, not Microsoft. Microsoft is not responsible for ARM templates provided and licensed by community members and does not screen for security, compatibility or performance. Community ARM templates are not supported under any Microsoft support programme or service, and are made available AS IS without warranty of any kind.

Parameters

Parameter Name Description
location Location for all resources.
virtualNetworkName Virtual network name
accountName Cosmos DB account name, max length 44 characters
publicNetworkAccess Enable public network traffic to access the account; if set to Disabled, public network traffic will be blocked even before the private endpoint is created
privateEndpointName Private endpoint name

Use the template

PowerShell

New-AzResourceGroup -Name <resource-group-name> -Location <resource-group-location> #use this command when you need to create a new resource group for your deployment
New-AzResourceGroupDeployment -ResourceGroupName <resource-group-name> -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-cosmosdb-private-endpoint/azuredeploy.json
Installing and configuring Azure PowerShell

Command line

az group create --name <resource-group-name> --location <resource-group-location> #use this command when you need to create a new resource group for your deployment
az group deployment create --resource-group <my-resource-group> --template-uri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-cosmosdb-private-endpoint/azuredeploy.json
Installing and configuring the Azure cross-platform command-line interface