KeyVault-Secrets-Rotation-CosmosDB-PowerShell

Functions regenerate individual key (alternating between two keys) in CosmosDB and add regenerated key to Key Vault as new version of the same secret.

Features

This project framework provides the following features:

• Rotation function for CosmosDB key triggered by Event Grid (AKVCosmosDBRotation)

• Rotation function for CosmosDB key triggered by HTTP call (AKVCosmosDBRotationHttp)

• ARM template for function deployment with secret deployment (optional)

• ARM template for adding CosmosDB key to existing function with secret deployment (optional)

Getting Started

Functions require following information stored in secret as tags:

• $secret.Tags["ValidityPeriodDays"] - number of days, it defines expiration date for new secret
• $secret.Tags["CredentialId"] - CosmosDB credential id (Primary, Secondary)
• $secret.Tags["ProviderAddress"] - CosmosDB Resource Id

You can create new secret with above tags and CosmosDB key as value or add those tags to existing secret with CosmosDB key. For automated rotation expiry date will also be required - key vault triggers 'SecretNearExpiry' event 30 days before expiry.

There are two available functions performing same rotation:

• AKVCosmosDBRotation - event triggered function, performs CosmosDB key rotation triggered by Key Vault events. In this setup Near Expiry event is used which is published 30 days before expiration
• AKVCosmosDBRotationHttp - on-demand function with KeyVaultName and Secret name as parameters

Functions are using Function App identity to access Key Vault and existing secret "CredentialId" tag with CosmosDB key id (key1/key2) and "ProviderAddress" with CosmosDB Resource Id.

Installation

ARM templates available:

• Secrets rotation Azure Function and configuration deployment template - it creates and deploys function app and function code, creates necessary permissions, Key Vault event subscription for Near Expiry Event for individual secret (secret name can be provided as parameter), and deploys secret with CosmosDB key (optional)
• Add event subscription to existing Azure Function deployment template - function can be used for multiple services for rotation. This template creates new event subscription for secret, necessary permissions to existing function, and deploys secret with CosmosDB key (optional)

Demo

You can find example for Storage Account rotation in tutorial below: Automate the rotation of a secret for resources that have two sets of authentication credentials

Youtube: https://youtu.be/qcdVbXJ7e-4

Project template information:

This project was generated using this template. You can find instructions here