Skip to content

Commit 1f8c894

Browse files
Merge pull request #105191 from erindormier/users/erindormier/cmk
CMK file added
2 parents 30d0e93 + e384968 commit 1f8c894

27 files changed

+574
-1
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Content Moderator encryption of data at rest
3+
titleSuffix: Azure Cognitive Services
4+
description: Content Moderator encryption of data at rest.
5+
author: erindormier
6+
manager: venkyv
7+
8+
ms.service: cognitive-services
9+
ms.subservice: content-moderator
10+
ms.topic: conceptual
11+
ms.date: 03/13/2020
12+
ms.author: egeaney
13+
#Customer intent: As a user of the Content Moderator service, I want to learn how encryption at rest works.
14+
---
15+
16+
# Content Moderator encryption of data at rest
17+
18+
Content Moderator automatically encrypts your data when it is persisted to the cloud, helping to meet your organizational security and compliance goals.
19+
20+
[!INCLUDE [cognitive-services-about-encryption](../../../includes/cognitive-services-about-encryption.md)]
21+
22+
> [!IMPORTANT]
23+
> Customer-managed keys are only available on the E0 pricing tier. To request the ability to use customer-managed keys, fill out and submit the [Content Moderator Customer-Managed Key Request Form](https://aka.ms/cogsvc-cmk). It will take approximately 3-5 business days to hear back on the status of your request. Depending on demand, you may be placed in a queue and approved as space becomes available. Once approved for using CMK with the Content Moderator service, you will need to create a new Content Moderator resource and select E0 as the Pricing Tier. Once your Content Moderator resource with the E0 pricing tier is created, you can use Azure Key Vault to set up your managed identity.
24+
25+
[!INCLUDE [cognitive-services-cmk](../../../includes/cognitive-services-cmk-regions.md)]
26+
27+
[!INCLUDE [cognitive-services-cmk](../../../includes/cognitive-services-cmk.md)]
28+
29+
## Enable data encryption for your Content Moderator Team
30+
31+
To enable data encryption for your Content Moderator Review Team, see the [Quickstart: Try Content Moderator on the web](quick-start.md#create-a-review-team).
32+
33+
> [!NOTE]
34+
> You'll need to provide a _Resource ID_ with the Content Moderator E0 pricing tier.
35+
36+
37+
## Next steps
38+
39+
* [Content Moderator Customer-Managed Key Request Form](https://aka.ms/cogsvc-cmk)
40+
* [Learn more about Azure Key Vault](https://docs.microsoft.com/azure/key-vault/key-vault-overview)

articles/cognitive-services/Content-Moderator/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,3 +134,5 @@
134134
href: https://azure.microsoft.com/global-infrastructure/services/?products=cognitive-services
135135
- name: Compliance
136136
href: https://azure.microsoft.com/support/legal/cognitive-services-compliance-and-privacy/
137+
- name: Encryption
138+
href: content-moderator-encryption-of-data-at-rest.md
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
title: Use the Azure portal to configure customer-managed keys
3+
titleSuffix: Cognitive Services
4+
description: Learn how to use the Azure portal to configure customer-managed keys with Azure Key Vault. Customer-managed keys enable you to create, rotate, disable, and revoke access controls.
5+
services: cognitive-services
6+
author: erindormier
7+
8+
ms.service: cognitive-services
9+
ms.topic: include
10+
ms.date: 03/11/2020
11+
ms.author: egeaney
12+
---
13+
14+
# Configure customer-managed keys with Azure Key Vault by using the Azure portal
15+
16+
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 Cognitive Services resource and the key vault must be in the same region and in the same Azure Active Directory (Azure AD) tenant, but they can be in different subscriptions. For more information about Azure Key Vault, see [What is Azure Key Vault?](https://docs.microsoft.com/azure/key-vault/key-vault-overview).
17+
18+
This article shows how to configure an Azure Key Vault with customer-managed keys using the [Azure portal](https://portal.azure.com/). To learn how to create a key vault using the Azure portal, see [Quickstart: Set and retrieve a secret from Azure Key Vault using the Azure portal](../../key-vault/quick-create-portal.md).
19+
20+
## Configure Azure Key Vault
21+
22+
Using customer-managed keys requires that two properties be set on the key vault, **Soft Delete** and **Do Not Purge**. These properties are not enabled by default, but can be enabled using either PowerShell or Azure CLI on a new or existing key vault.
23+
24+
> [!IMPORTANT]
25+
> If you do not have the **Soft Delete** and **Do Not Purge** properties enabled and you delete your key, you won't be able to recover the data in your Cognitive Service resource.
26+
27+
To learn how to enable these properties on an existing key vault, see the sections titled **Enabling soft-delete** and **Enabling Purge Protection** in one of the following articles:
28+
29+
- [How to use soft-delete with PowerShell](https://docs.microsoft.com/azure/key-vault/key-vault-soft-delete-powershell).
30+
- [How to use soft-delete with CLI](https://docs.microsoft.com/azure/key-vault/key-vault-soft-delete-cli).
31+
32+
Only RSA keys of size 2048 are supported with Azure Storage encryption. For more information about keys, see **Key Vault keys** in [About Azure Key Vault keys, secrets and certificates](https://docs.microsoft.com/azure/key-vault/about-keys-secrets-and-certificates#key-vault-keys).
33+
34+
## Enable customer-managed keys
35+
36+
To enable customer-managed keys in the Azure portal, follow these steps:
37+
38+
1. Navigate to your Cognitive Services resource.
39+
1. On the **Settings** blade for your Cognitive Services resource, click **Encryption**. Select the **Customer Managed Keys** option, as shown in the following figure.
40+
41+
![Screenshot showing how to select Customer Managed Keys](../media/cognitive-services-encryption/selectcmk.png)
42+
43+
## Specify a key
44+
45+
After you enable customer-managed keys, you'll have the opportunity to specify a key to associate with the Cognitive Services resource.
46+
47+
### Specify a key as a URI
48+
49+
To specify a key as a URI, follow these steps:
50+
51+
1. To locate the key URI in the Azure portal, navigate to your key vault, and select the **Keys** setting. Select the desired key, then click the key to view its versions. Select a key version to view the settings for that version.
52+
1. Copy the value of the **Key Identifier** field, which provides the URI.
53+
54+
![Screenshot showing key vault key URI](../media/cognitive-services-encryption/key-uri-portal.png)
55+
56+
1. In the **Encryption** settings for your storage account, choose the **Enter key URI** option.
57+
1. Paste the URI that you copied into the **Key URI** field.
58+
59+
![Screenshot showing how to enter key URI](../media/cognitive-services-encryption/ssecmk2.png)
60+
61+
1. Specify the subscription that contains the key vault.
62+
1. Save your changes.
63+
64+
### Specify a key from a key vault
65+
66+
To specify a key from a key vault, first make sure that you have a key vault that contains a key. To specify a key from a key vault, follow these steps:
67+
68+
1. Choose the **Select from Key Vault** option.
69+
1. Select the key vault containing the key you want to use.
70+
1. Select the key from the key vault.
71+
72+
![Screenshot showing customer-managed key option](../media/cognitive-services-encryption/ssecmk3.png)
73+
74+
1. Save your changes.
75+
76+
## Update the key version
77+
78+
When you create a new version of a key, update the Cognitive Services resource to use the new version. Follow these steps:
79+
80+
1. Navigate to your Cognitive Services resource and display the **Encryption** settings.
81+
1. Enter the URI for the new key version. Alternately, you can select the key vault and the key again to update the version.
82+
1. Save your changes.
83+
84+
## Use a different key
85+
86+
To change the key used for encryption, follow these steps:
87+
88+
1. Navigate to your Cognitive Services resource and display the **Encryption** settings.
89+
1. Enter the URI for the new key. Alternately, you can select the key vault and choose a new key.
90+
1. Save your changes.
91+
92+
## Disable customer-managed keys
93+
94+
When you disable customer-managed keys, your Cognitive Services resource is then encrypted with Microsoft-managed keys. To disable customer-managed keys, follow these steps:
95+
96+
1. Navigate to your Cognitive Services resource and display the **Encryption** settings.
97+
1. Deselect the checkbox next to the **Use your own key** setting.
98+
99+
## Next steps
100+
101+
* [What is Azure Key Vault](https://docs.microsoft.com/azure/key-vault/key-vault-overview)?
102+
* [Cognitive Services Customer-Managed Key Request Form](https://aka.ms/cogsvc-cmk)
103+
* [Face Services encryption of data at rest](../Face/face-encryption-of-data-at-rest.md)
104+
* [QnA Maker encryption of data at rest](../QnAMaker/qna-maker-encryption-of-data-at-rest.md)
105+
* [Language Understanding service encryption of data at rest](../LUIS/luis-encryption-of-data-at-rest.md)
106+
* [Content Moderator encryption of data at rest](../Content-Moderator/content-moderator-encryption-of-data-at-rest.md)
107+
* [Translator encryption of data at rest](../translator/translator-encryption-of-data-at-rest.md)
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Face service encryption of data at rest
3+
titleSuffix: Azure Cognitive Services
4+
description: Face service encryption of data at rest.
5+
author: erindormier
6+
manager: venkyv
7+
8+
ms.service: cognitive-services
9+
ms.subservice: face-api
10+
ms.topic: conceptual
11+
ms.date: 03/11/2020
12+
ms.author: egeaney
13+
#Customer intent: As a user of the Face service, I want to learn how encryption at rest works.
14+
---
15+
16+
# Face service encryption of data at rest
17+
18+
The Face service automatically encrypts your data when persisted it to the cloud. The Face service encryption protects your data and to help you to meet your organizational security and compliance commitments.
19+
20+
[!INCLUDE [cognitive-services-about-encryption](../../../includes/cognitive-services-about-encryption.md)]
21+
22+
> [!IMPORTANT]
23+
> Customer-managed keys are only available on the E0 pricing tier. To request the ability to use customer-managed keys, fill out and submit the [Face Service Customer-Managed Key Request Form](https://aka.ms/cogsvc-cmk). It will take approximately 3-5 business days to hear back on the status of your request. Depending on demand, you may be placed in a queue and approved as space becomes available. Once approved for using CMK with the Face service, you will need to create a new Face resource and select E0 as the Pricing Tier. Once your Face resource with the E0 pricing tier is created, you can use Azure Key Vault to set up your managed identity.
24+
25+
[!INCLUDE [cognitive-services-cmk](../../../includes/cognitive-services-cmk-regions.md)]
26+
27+
[!INCLUDE [cognitive-services-cmk](../../../includes/cognitive-services-cmk.md)]
28+
29+
## Next steps
30+
31+
* [Face Service Customer-Managed Key Request Form](https://aka.ms/cogsvc-cmk)
32+
* [Learn more about Azure Key Vault](https://docs.microsoft.com/azure/key-vault/key-vault-overview)
33+
34+

articles/cognitive-services/Face/toc.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,8 @@
114114
- name: Regional availability
115115
href: https://azure.microsoft.com/global-infrastructure/services/?products=cognitive-services
116116
- name: Compliance
117-
href: https://azure.microsoft.com/support/legal/cognitive-services-compliance-and-privacy/
117+
href: https://azure.microsoft.com/support/legal/cognitive-services-compliance-and-privacy/
118+
- name: Encryption
119+
href: face-encryption-of-data-at-rest.md
118120
- name: Release notes
119121
href: ReleaseNotes.md
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
title: Language Understanding service encryption of data at rest
3+
titleSuffix: Azure Cognitive Services
4+
description: Language Understanding service encryption of data at rest.
5+
author: erindormier
6+
manager: venkyv
7+
8+
ms.service: cognitive-services
9+
ms.subservice: language-understanding
10+
ms.topic: conceptual
11+
ms.date: 03/13/2020
12+
ms.author: egeaney
13+
#Customer intent: As a user of the Language Understanding (LUIS) service, I want to learn how encryption at rest works.
14+
---
15+
16+
# Language Understanding service encryption of data at rest
17+
18+
The Language Understanding service automatically encrypts your data when it is persisted to the cloud. The Language Understanding service encryption protects your data and helps you meet your organizational security and compliance commitments.
19+
20+
## About Cognitive Services encryption
21+
22+
Data is encrypted and decrypted using [FIPS 140-2](https://en.wikipedia.org/wiki/FIPS_140-2) compliant [256-bit AES](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) encryption. Encryption and decryption are transparent, meaning encryption and access are managed for you. Your data is secure by default and you don’t need to modify your code or applications to take advantage of encryption.
23+
24+
## About encryption key management
25+
26+
By default, your subscription uses Microsoft-managed encryption keys. There is also an option to manage your subscription with your own keys. Customer-managed keys (CMK), offer greater flexibility to create, rotate, disable, and revoke access controls. You can also audit the encryption keys used to protect your data.
27+
28+
## Customer-managed keys with Azure Key Vault
29+
30+
There is also an option to manage your subscription with your own keys. 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.
31+
32+
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 Cognitive Services resource and the key vault must be in the same region and in the same Azure Active Directory (Azure AD) tenant, but they can be in different subscriptions. For more information about Azure Key Vault, see [What is Azure Key Vault?](https://docs.microsoft.com/azure/key-vault/key-vault-overview).
33+
34+
### Customer-managed keys for Language Understanding
35+
36+
To request the ability to use customer-managed keys, fill out and submit the [LUIS Service Customer-Managed Key Request Form](https://aka.ms/cogsvc-cmk). It will take approximately 3-5 business days to hear back on the status of your request. Depending on demand, you may be placed in a queue and approved as space becomes available. Once approved for using CMK with LUIS, you'll need to create a new Language Understanding resource from the Azure portal and select E0 as the Pricing Tier. The new SKU will function the same as the F0 SKU that is already available except for CMK. Users won’t be able to upgrade from the F0 to the new E0 SKU.
37+
38+
E0 resources are only available for Authoring service and that the E0 tier will initially only be supported in West US Region.
39+
40+
![LUIS subscription image](../media/cognitive-services-encryption/luis-subscription.png)
41+
42+
### Regional availability
43+
44+
Customer-managed keys are currently available in the **West US** region.
45+
46+
### Limitations
47+
48+
There are some limitations when using the E0 tier with existing/previously created applications:
49+
50+
* Migration to an E0 resource will be blocked. Users will only be able to migrate their apps to F0 resources. After you've migrated an existing resource to F0, you can create a new resource in the E0 tier. Learn more about [migration here](https://docs.microsoft.com/azure/cognitive-services/luis/luis-migration-authoring).
51+
* Moving applications to or from an E0 resource will be blocked. A work around for this limitation is to export your existing application, and import it as an E0 resource.
52+
* The Bing Spell check feature isn't supported.
53+
* Logging end-user traffic is disabled if your application is E0.
54+
* The Speech priming capability from the Azure Bot service isn't supported for applications in the E0 tier. This feature is available via the Azure Bot Service, which doesn't support CMK.
55+
* The speech priming capability from the portal requires Azure Blob Storage. For more information, see [bring your own storage](../Speech-Service/speech-encryption-of-data-at-rest.md#bring-your-own-storage-byos-for-customization-and-logging).
56+
57+
### Enable customer-managed keys
58+
59+
A new Cognitive Services resource is always encrypted using Microsoft-managed keys. It's not possible to enable customer-managed keys at the time that the resource is created. Customer-managed keys are stored in Azure Key Vault, and the key vault must be provisioned with access policies that grant key permissions to the managed identity that is associated with the Cognitive Services resource. The managed identity is available only after the resource is created using the Pricing Tier for CMK.
60+
61+
To learn how to use customer-managed keys with Azure Key Vault for Cognitive Services encryption, see:
62+
63+
- [Configure customer-managed keys with Key Vault for Cognitive Services encryption from the Azure portal](../Encryption/cognitive-services-encryption-keys-portal.md)
64+
65+
Enabling customer managed keys will also enable a system assigned managed identity, a feature of Azure AD. Once the system assigned managed identity is enabled, this resource will be registered with Azure Active Directory. After being registered, the managed identity will be given access to the Key Vault selected during customer managed key setup. You can learn more about [Managed Identities](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview).
66+
67+
> [!IMPORTANT]
68+
> If you disable system assigned managed identities, access to the key vault will be removed and any data encrypted with the customer keys will no longer be accessible. Any features depended on this data will stop working.
69+
70+
> [!IMPORTANT]
71+
> Managed identities do not currently support cross-directory scenarios. When you configure customer-managed keys in the Azure portal, a managed identity is automatically assigned under the covers. If you subsequently move the subscription, resource group, or resource from one Azure AD directory to another, the managed identity associated with the resource is not transferred to the new tenant, so customer-managed keys may no longer work. For more information, see **Transferring a subscription between Azure AD directories** in [FAQs and known issues with managed identities for Azure resources](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/known-issues#transferring-a-subscription-between-azure-ad-directories).
72+
73+
### Store customer-managed keys in Azure Key Vault
74+
75+
To enable customer-managed keys, you must use an Azure Key Vault to store your keys. You must enable both the **Soft Delete** and **Do Not Purge** properties on the key vault.
76+
77+
Only RSA keys of size 2048 are supported with Cognitive Services encryption. For more information about keys, see **Key Vault keys** in [About Azure Key Vault keys, secrets and certificates](https://docs.microsoft.com/azure/key-vault/about-keys-secrets-and-certificates#key-vault-keys).
78+
79+
### Rotate customer-managed keys
80+
81+
You can rotate a customer-managed key in Azure Key Vault according to your compliance policies. When the key is rotated, you must update the Cognitive Services resource to use the new key URI. To learn how to update the resource to use a new version of the key in the Azure portal, see the section titled **Update the key version** in [Configure customer-managed keys for Cognitive Services by using the Azure portal](../Encryption/cognitive-services-encryption-keys-portal.md).
82+
83+
Rotating the key does not trigger re-encryption of data in the resource. There is no further action required from the user.
84+
85+
### Revoke access to customer-managed keys
86+
87+
To revoke access to customer-managed keys, use PowerShell or Azure CLI. For more information, see [Azure Key Vault PowerShell](https://docs.microsoft.com/powershell/module/az.keyvault//) or [Azure Key Vault CLI](https://docs.microsoft.com/cli/azure/keyvault). Revoking access effectively blocks access to all data in the Cognitive Services resource, as the encryption key is inaccessible by Cognitive Services.
88+
89+
## Next steps
90+
91+
* [LUIS Service Customer-Managed Key Request Form](https://aka.ms/cogsvc-cmk)
92+
* [Learn more about Azure Key Vault](https://docs.microsoft.com/azure/key-vault/key-vault-overview)

articles/cognitive-services/LUIS/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -410,6 +410,8 @@
410410
href: https://azure.microsoft.com/pricing/details/cognitive-services/language-understanding-intelligent-services/
411411
- name: Compliance
412412
href: https://azure.microsoft.com/support/legal/cognitive-services-compliance-and-privacy/
413+
- name: Encryption
414+
href: luis-encryption-of-data-at-rest.md
413415
- name: Stack Overflow
414416
href: https://stackoverflow.com/questions/tagged/LUIS
415417
- name: UserVoice

0 commit comments

Comments
 (0)