Deploy Azure Cosmos DB from the service catalog into a workload

Azure Enclave is a cloud networking service that provides organizations with highly sensitive data the ability to quickly deploy and manage workloads across Commercial and air-gapped Azure clouds at scale. In this quickstart, you:

• Deploy a service catalog template for an Azure Cosmos DB account into an existing workload from the Portal.

Before you begin

• This quickstart assumes a basic understanding of networking and Azure Enclave concepts. For more information, see Best practices of Azure Enclave.

• You need an Azure account with an active subscription. If you don't have one, create an account for free.

• You need a community, enclave, workload, and at least one workload resource group and permissions to create resources inside the workload resource group.

• Enable Advanced maintenance mode for your enclave so you can add the Private Link resources to your enclave managed resource group.

Prerequisites

There are guardrail requirements on the enclaves to ensure enclave resources are using Customer-Managed Keys (CMK) encryption. This requires a key and identity to access the key to be accessible in the enclave. Create the CMK (optional Key Vault) and Managed Identity in the Common Dependencies service catalog template

1. Subnet for Private Endpoints: You had the option to create subnets during enclave creation or you can create new subnets after enclave creation. The private endpoint subnet should have no subnet delegation for the private endpoints to work properly.

1. Quickly create these Private DNS Zones based on what you create next:
   • Key Vault required when creating a Key Vault from this template or the more customizable Key Vault template.
   • Storage File, Storage Queue, Storage Blob, and Storage Table are required when making a Storage Account from this template or the more customizable Storage Account template.
   • privatelink.cosmos.azure.com under Additional Private DNS Zone names which is required to access Cosmos DB privately.
2. A Key Vault, Customer Managed Key (CMK), and Managed Identity are required for this template. Create a Key Vault, CMK, and Managed Identity in the Common Dependencies service catalog quickstart or create your own.
   • These resources should be created inside a workload resource group.
   • After creating the User Managed Identity, ensure it has access to the CMK key
     • Assign the Key Vault Crypto Service Encryption User RBAC role to the managed identity scoped to the key vault with these instructions. This allows you to then assign the managed identity to another resource, like a Virtual Machine, and that Virtual Machine can encrypt the operating system disk with the CMK in the key vault without having permissions to do other operations on the key vault following least privilege.
3. (optional) An existing domain to join if the Admin VM will be domain joined.

Deploy the template

1. Navigate to the workload for the intended deployment.
2. Select +Add an Azure Service button.
3. Select the Azure Cosmos DB service template from the service catalog list dropdown, confirm the version you need (default: latest), and select Next.

1. Go through each tab and enter all the required parameters.
2. Adjust any of the prepopulated parameters as needed.
3. Select Review + Create then Create.

It can take up to 30 minutes to finish all resource creation. Wait for the deployment to be successfully completed before you take any actions within your deployed resources.

Validate the deployment

1. Go to the specified resource group to confirm the resources were created: an Azure Cosmos DB account and a private endpoint.
2. Verify that the Azure Cosmos DB account was created and it its status is Online.
3. Check that the Azure Cosmos DB account identity is using the user assigned Managed Identity mentioned in prerequisites section.
4. Check that Azure Cosmos DB account encryption is using the key mentioned in prerequisites section.

Delete the deployment

If you don't plan on keeping these resources, clean up unnecessary resources to avoid Azure charges. If no other deployments exist in the resource group, the whole resource group can be deleted.

Recommendations

• Add tags to service catalog deployments to track important information for that resource such as:
  • Owner: <main POC>
  • Deployer: <yourName>
  • Purpose: <cosmos db account purpose>
  • Service Catalog Name: <Cosmos DB>
  • Service Catalog Version: <version you deployed>
• Consider adding an Azure Policy to enforce and inherit tags