Key Vault

Overview

{
	"key_vault": {
		"name": "kv-vault-{env}",
		"sku_family": "A",
		"sku_name": "standard",

		"tenant_id": "string",
		"policies": [
			{
				"@function_app_name": "func-app-{env}",
				"type": "FunctionApp",
				"certificates": ["Get"],
				"keys": ["Get"],
				"secrets": ["Get"],
				"storage": ["Get"]
			},

			{
				"@web_app_name": "web-app-{env}",
				"type": "WebApp",
				"certificates": ["Get"],
				"keys": ["Get"],
				"secrets": ["Get"],
				"storage": ["Get"]
			}
		],
		"location": "northeurope",
		"external": false,
		"resource_group_name": "my-rg-name",
		"tags": { "example": "S0" }
	}
}

KeyVault Reference

KeyTypeDescription
name (required)stringThe name of the keyvault (see how to name)
sku_family (required)Keyvault sku familyThe sku family
sku_name (required)Keyvault Sku DefinitionThe sku name
tenant_idstringID of the Tenant (defaults to the tenant id of the subscription)
policiesPolicies[]The policies permissions for function apps or web apps (defaults to no permissions)
locationstringResource Location (defaults to the resource group location)
externalboolA reference to an existing Keyvault (defaults to false)
resource_group_namestringThe name of the resource group where the resource is located, only with external resources (defaults to the resource group of the deployment)
tagsobjectAdditional tags for the resource (defaults to no additional tags)

KeyvaultSku

ValueDescription
standardIs limited to secrets and software-protected keys
premiumSupports keys stored in Hardware Security Modules (HSMs) and are FIPS 140-2 Level 3 validated

Policies

ValueTypeDescription
`@functionweb_app_name`string
typePolicyTypeThe type of entity to bind to
certificatesPolicyValues[]Certificates permissions
keysPolicyValues[]Keys permissions
secretsPolicyValues[]Secrets permissions
storagePolicyValues[]Storage permissions

PolicyType

ValueDescription
FunctionAppSet the entity to be a function app name
WebAppSet the entity to be a web app name

PolicyValues

Value
Backup
Create
Delete
DeleteIssuers
Get
GetIssuers
Import
ManageContacts
ManageIssuers
Purge
Recover
Restore
SetIssuers
Update