Skip to content

Commit cef7d4c

Browse files
authored
Merge pull request #266242 from johndowns/aoai-cmk-key-vault
Azure OpenAI - Update information about key vault requirements for CMK
2 parents 4945a2a + b08b3f6 commit cef7d4c

File tree

2 files changed

+42
-13
lines changed

2 files changed

+42
-13
lines changed
166 KB
Loading

articles/ai-services/openai/encrypt-data-at-rest.md

Lines changed: 42 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: mrbullwinkle
66
manager: nitinme
77
ms.service: azure-ai-openai
88
ms.topic: conceptual
9-
ms.date: 11/14/2022
9+
ms.date: 2/21/2024
1010
ms.author: mbullwin
1111
---
1212

@@ -22,37 +22,66 @@ Azure OpenAI is part of Azure AI services. Azure AI services data is encrypted a
2222

2323
By default, your subscription uses Microsoft-managed encryption keys. There's also the option to manage your subscription with your own keys called customer-managed keys (CMK). CMK offers greater flexibility to create, rotate, disable, and revoke access controls. You can also audit the encryption keys used to protect your data.
2424

25-
## Customer-managed keys with Azure Key Vault
25+
## Use customer-managed keys with Azure Key Vault
2626

2727
Customer-managed keys (CMK), also known as Bring your own key (BYOK), offer greater flexibility to create, rotate, disable, and revoke access controls. You can also audit the encryption keys used to protect your data.
2828

2929
You must use Azure Key Vault to store your customer-managed keys. You can either create your own keys and store them in a key vault, or you can use the Azure Key Vault APIs to generate keys. The Azure AI services resource and the key vault must be in the same region and in the same Microsoft Entra tenant, but they can be in different subscriptions. For more information about Azure Key Vault, see [What is Azure Key Vault?](../../key-vault/general/overview.md).
3030

31-
To enable customer-managed keys, you must also enable both the **Soft Delete** and **Do Not Purge** properties on the key vault.
31+
To enable customer-managed keys, the key vault containing your keys must meet these requirements:
3232

33-
Only RSA keys of size 2048 are supported with Azure AI services encryption. For more information about keys, see **Key Vault keys** in [About Azure Key Vault keys, secrets and certificates](../../key-vault/general/about-keys-secrets-certificates.md).
33+
- You must enable both the **Soft Delete** and **Do Not Purge** properties on the key vault.
34+
- If you use the [Key Vault firewall](/azure/key-vault/general/access-behind-firewall), you must allow trusted Microsoft services to access the key vault.
35+
- The key vault must use [legacy access policies](/azure/key-vault/general/assign-access-policy).
36+
- You must grant the Azure OpenAI resource's system-assigned managed identity the following permissions on your key vault: *get key*, *wrap key*, *unwrap key*.
3437

35-
## Enable customer-managed keys for your resource
38+
Only RSA and RSA-HSM keys of size 2048 are supported with Azure AI services encryption. For more information about keys, see **Key Vault keys** in [About Azure Key Vault keys, secrets and certificates](../../key-vault/general/about-keys-secrets-certificates.md).
39+
40+
### Enable your Azure OpenAI resource's managed identity
41+
42+
1. Go to your Azure AI services resource.
43+
1. On the left, under **Resource Management**, select **Identity**.
44+
1. Switch the system-assigned managed identity status to **On**.
45+
1. Save your changes, and confirm that you want to enable the system-assigned managed identity.
46+
47+
### Configure your key vault's access permissions
48+
49+
1. In the Azure portal, go to your key vault.
50+
1. On the left, select **Access policies**.
51+
52+
If you see a message advising you that access policies aren't available, [reconfigure your key vault to use legacy access policies](/azure/key-vault/general/assign-access-policy) before continuing.
53+
1. Select **Create**.
54+
1. Under **Key permissions**, select **Get**, **Wrap Key**, and **Unwrap Key**. Leave the remaining checkboxes unselected.
55+
56+
:::image type="content" source="../media/cognitive-services-encryption/key-vault-access-policy.png" alt-text="Screenshot of the Azure portal page for a key vault access policy. The permissions selected are Get Key, Wrap Key, and Unwrap Key.":::
57+
58+
1. Select **Next**.
59+
1. Search for the name of your Azure OpenAI resource and select its managed identity.
60+
1. Select **Next**.
61+
1. Select **Next** to skip configuring any application settings.
62+
1. Select **Create**.
63+
64+
### Enable customer-managed keys on your Azure OpenAI resource
3665

3766
To enable customer-managed keys in the Azure portal, follow these steps:
3867

3968
1. Go to your Azure AI services resource.
40-
1. On the left, select **Encryption**.
69+
1. On the left, under **Resource Management**, select **Encryption**.
4170
1. Under **Encryption type**, select **Customer Managed Keys**, as shown in the following screenshot.
4271

43-
> [!div class="mx-imgBorder"]
44-
> ![Screenshot of create a resource user experience](./media/encryption/encryption.png)
72+
> [!div class="mx-imgBorder"]
73+
> ![Screenshot of create a resource user experience.](./media/encryption/encryption.png)
4574
46-
## Specify a key
75+
### Specify a key
4776

4877
After you enable customer-managed keys, you can specify a key to associate with the Azure AI services resource.
4978

50-
### Specify a key as a URI
79+
#### Specify a key as a URI
5180

5281
To specify a key as a URI, follow these steps:
5382

5483
1. In the Azure portal, go to your key vault.
55-
1. Under **Settings**, select **Keys**.
84+
1. Under **Objects**, select **Keys**.
5685
1. Select the desired key, and then select the key to view its versions. Select a key version to view the settings for that version.
5786
1. Copy the **Key Identifier** value, which provides the URI.
5887

@@ -67,9 +96,9 @@ To specify a key as a URI, follow these steps:
6796
1. Under **Subscription**, select the subscription that contains the key vault.
6897
1. Save your changes.
6998

70-
### Specify a key from a key vault
99+
#### Select a key from a key vault
71100

72-
To specify a key from a key vault, first make sure that you have a key vault that contains a key. Then follow these steps:
101+
To select a key from a key vault, first make sure that you have a key vault that contains a key. Then follow these steps:
73102

74103
1. Go to your Azure AI services resource, and then select **Encryption**.
75104
1. Under **Encryption key**, select **Select from Key Vault**.

0 commit comments

Comments
 (0)