Back to Azure Bicep templates index <–
A Cosmos DB NoSql database engine.
Template Locations
Online documentation
Template reference
Service description
Related Azure Resources
| Resource | Description | Automation |
|---|
Requirements
- Resource group must been created with a valid name and location.
Input values
- tagBillingIdentifier : BillingIdentifier tag.
- CosmosDBCustomName : The name to use for the Cosmos DB Engine.
- rgLocation : The Azure Region that the resource should be created. Defaults to the current resource groups location. Will be used as the primary location for the Cosmos DB engine if system managed failover is activated.
- systemManagedFailover : Boolean indicating with the Cosmos DB should have a failover instance created in another region.
- secondaryRegion : The Azure region in which the failover instance should be created. This cannot be the same as the primary region.
- defaultConsistencyLevel : The consistency level to be used.
- maxStalenessPrefix : If the defaultConsistencyLevel is defined as BoundedStaleness, this defines the maximum number of stale requests permitted.
- maxIntervalInSeconds: If the defaultConsistencyLevel is defined as BoundedStaleness, this defines the maximum lag time in minutes permitted.
- EnablePrivateEndpoint : Indicates whether the SQL Server should be created with a private endpoint in a virtual network.
- PrivateEndpointVirtualNetworkName : The name of the virtual network to be used for creating the private endpoint.
- PrivateEndpointSubNetName : The name of the subnet to which the private endpoint should be attached.
Output values
- cosmosDbResourceId : The resource Id of the SQL Server
- cosmosDbName : The name of the SQL Server