Key Vault references in App Service in Azure - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Key Vault reference in Azure App Service?

A Key Vault reference in Azure App Service is a way to securely access secrets, keys, or certificates stored in Azure Key Vault directly from your app's configuration without exposing them in your code.

intermediate

How do you enable a Key Vault reference in an Azure App Service application setting?

You set the application setting value to a special syntax: @Microsoft.KeyVault(SecretUri=https://{vault-name}.vault.azure.net/secrets/{secret-name}/{secret-version}), which tells App Service to fetch the secret from Key Vault at runtime.

intermediate

What permission must the App Service have to access secrets in Key Vault?

The App Service's managed identity must have 'Get' permission on secrets in the Key Vault's access policies or via Azure RBAC to retrieve secrets securely.

beginner

Why use Key Vault references instead of storing secrets directly in App Service settings?

Using Key Vault references keeps secrets out of app settings, reducing risk of exposure. It centralizes secret management, supports automatic secret rotation, and improves security compliance.

intermediate

Can Key Vault references in App Service automatically update when the secret changes?

Yes, App Service periodically refreshes Key Vault references, so when a secret is updated in Key Vault, the app can get the new value without redeployment.

What syntax is used to reference a Key Vault secret in an App Service application setting?

A @Microsoft.KeyVault(SecretUri=https://{vault-name}.vault.azure.net/secrets/{secret-name}/{secret-version})

B https://{vault-name}.vault.azure.net/secrets/{secret-name}

C KeyVaultSecret:{secret-name}

D vault://{vault-name}/secret/{secret-name}

The correct syntax uses @Microsoft.KeyVault with the full SecretUri to tell App Service to fetch the secret at runtime.

Which identity must have permission to access Key Vault secrets for App Service Key Vault references to work?

A App Service's managed identity

B User's personal Azure account

C Azure subscription owner

D Any Azure AD user

The App Service's managed identity needs 'Get' permission on Key Vault secrets to access them securely.

What is a key benefit of using Key Vault references in App Service?

A Secrets are hardcoded in application code

B Secrets are securely fetched at runtime without exposing them

C Secrets are stored in plain text in app settings

D Secrets are emailed to developers automatically

Key Vault references allow secure runtime fetching of secrets without exposing them in app settings or code.

How does App Service handle secret updates in Key Vault when using Key Vault references?

A App Service requires manual redeployment to update secrets

B Secrets never update once app is running

C App Service automatically refreshes secrets periodically

D Secrets are updated only when app restarts

App Service periodically refreshes Key Vault references to get updated secret values automatically.

What permission is specifically required on Key Vault for App Service to read secrets?

A List

B Set

C Delete

D Get

The 'Get' permission allows reading secrets from Key Vault, which is necessary for App Service to access them.

Explain how Key Vault references improve security in Azure App Service.

Think about how secrets are handled and accessed without exposing them.

Describe the steps to configure an Azure App Service to use a Key Vault reference for a secret.

Consider identity, permissions, and app settings.

Practice

1. What is the main purpose of using Key Vault references in an Azure App Service?

easy

A. To speed up the app's startup time

B. To enable automatic scaling of the app service

C. To securely access secrets without storing them directly in app settings

D. To create backups of the app's configuration

Solution

1. Step 1: Understand Key Vault references purpose

   Key Vault references allow apps to use secrets securely by referencing them instead of storing secrets directly in app settings.

2. Step 2: Identify the correct purpose

   The other options describe unrelated features like speeding up startup time, enabling automatic scaling, or creating backups, which are not the purpose of Key Vault references.

3. Final Answer:

   To securely access secrets without storing them directly in app settings -> Option C

4. Quick Check:

   Key Vault references = secure secret access [OK]

Hint: Key Vault references keep secrets out of app settings [OK]

Common Mistakes:

• Thinking Key Vault references improve app speed
• Confusing Key Vault references with scaling features
• Assuming Key Vault references create backups

2. Which syntax correctly references a Key Vault secret named DbPassword in an Azure App Service application setting?

easy

A. @Microsoft.KeyVault(SecretUri=https://myvault.vault.azure.net/secrets/DbPassword/)

B. KeyVaultSecret:DbPassword

C. vault://myvault/DbPassword

D. SecretRef(DbPassword)

Solution

1. Step 1: Recall correct Key Vault reference syntax

   The correct syntax uses @Microsoft.KeyVault(SecretUri=...) with the full secret URI.

2. Step 2: Compare options

   The other options do not follow the required Azure App Service Key Vault reference format.

3. Final Answer:

   @Microsoft.KeyVault(SecretUri=https://myvault.vault.azure.net/secrets/DbPassword/) -> Option A

4. Quick Check:

   Correct syntax starts with @Microsoft.KeyVault(SecretUri=...) [OK]

Hint: Use @Microsoft.KeyVault(SecretUri=...) for secret references [OK]

Common Mistakes:

• Omitting the full secret URI
• Using incorrect prefixes like KeyVaultSecret or vault://
• Not including parentheses and SecretUri keyword

3. Given this app setting in Azure App Service:
MySecret = @Microsoft.KeyVault(SecretUri=https://vault123.vault.azure.net/secrets/ApiKey/)
What happens when the app tries to read MySecret if the managed identity lacks access to the Key Vault?

medium

A. The app setting returns an empty string

B. The app fails to start or throws an authentication error

C. The app receives the secret value successfully

D. The app uses a cached secret value from previous runs

Solution

1. Step 1: Understand managed identity role

   The app's managed identity must have access permissions to read secrets from Key Vault.

2. Step 2: Effect of missing access

   If access is missing, the app cannot retrieve the secret and will fail with an authentication or authorization error.

3. Final Answer:

   The app fails to start or throws an authentication error -> Option B

4. Quick Check:

   No access = authentication error [OK]

Hint: Managed identity needs Key Vault access to avoid errors [OK]

Common Mistakes:

• Assuming the app gets empty string instead of error
• Thinking the app uses cached secrets automatically
• Believing the app can read secrets without permissions

4. You configured a Key Vault reference in your App Service but the app still shows the literal reference string instead of the secret value. What is the most likely cause?

medium

A. Managed identity is not enabled on the App Service

B. The secret name in the reference is misspelled

C. The App Service is in a different region than the Key Vault

D. The app setting key is not named correctly

Solution

1. Step 1: Check managed identity status

   Key Vault references require the App Service to have a managed identity enabled to authenticate to Key Vault.

2. Step 2: Understand effect of missing managed identity

   If managed identity is not enabled, the app cannot resolve the reference and shows the literal string.

3. Final Answer:

   Managed identity is not enabled on the App Service -> Option A

4. Quick Check:

   No managed identity = literal reference shown [OK]

Hint: Enable managed identity to resolve Key Vault references [OK]

Common Mistakes:

• Assuming region mismatch causes this issue
• Thinking misspelled secret name shows literal string
• Believing app setting key name affects reference resolution

5. You want to securely use multiple secrets from Azure Key Vault in your App Service. Which combination of steps ensures best practice for this setup?

hard

A. Use connection strings in app settings without managed identity, and manually update secrets

B. Store secrets directly in app settings, enable managed identity, and use environment variables

C. Enable managed identity, grant 'List' permission only, and use custom code to fetch secrets

D. Enable managed identity on App Service, grant it 'Get' secret permission in Key Vault, use @Microsoft.KeyVault references in app settings

Solution

1. Step 1: Enable managed identity and grant 'Get' permission

   The managed identity must be enabled and granted 'Get' permission on secrets in Key Vault to allow secure access.

2. Step 2: Use Key Vault references in app settings

   Use the special syntax @Microsoft.KeyVault(SecretUri=...) in app settings to link secrets securely without storing them directly.

3. Final Answer:

   Enable managed identity on App Service, grant it 'Get' secret permission in Key Vault, use @Microsoft.KeyVault references in app settings -> Option D

4. Quick Check:

   Managed identity + Get permission + Key Vault references = best practice [OK]

Hint: Managed identity + Get permission + Key Vault references = secure setup [OK]

Common Mistakes:

• Storing secrets directly in app settings
• Granting only 'List' permission without 'Get'
• Not enabling managed identity on App Service