Skip to content

Commit 5d6c0fc

Browse files
authored
Merge pull request #267164 from paulth1/two-chaos-studio-articles
[AQ] edit pass: two-chaos-studio-articles
2 parents e109b86 + c7d0663 commit 5d6c0fc

File tree

2 files changed

+86
-99
lines changed

2 files changed

+86
-99
lines changed
Lines changed: 50 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Configure customer-managed keys [preview] for experiment encryption
2+
title: Configure customer-managed keys (preview) for experiment encryption
33
titleSuffix: Azure Chaos Studio
4-
description: Learn how to configure customer-managed keys (preview) for your Azure Chaos Studio experiment resource using Azure Blob Storage
4+
description: Learn how to configure customer-managed keys (preview) for your Azure Chaos Studio experiment resource by using Azure Blob Storage.
55
services: chaos-studio
66
ms.service: chaos-studio
77
ms.author: abbyweisberg
@@ -11,54 +11,47 @@ ms.date: 10/06/2023
1111
ms.topic: how-to
1212
---
1313

14-
# Configure customer-managed keys [preview] for Azure Chaos Studio using Azure Blob Storage
15-
16-
Azure Chaos Studio automatically encrypts all data stored in your experiment resource with keys that Microsoft provides (service-managed keys). As an optional feature, you can add a second layer of security by also providing your own (customer-managed) encryption key(s). Customer-managed keys offer greater flexibility for controlling access and key-rotation policies.
17-
18-
When you use customer-managed encryption keys, you need to specify a user-assigned managed identity (UMI) to retrieve the key. The UMI you create needs to match the UMI that you use for the Chaos Studio experiment.
19-
20-
When configured, Azure Chaos Studio uses Azure Storage, which uses the customer-managed key to encrypt all of your experiment execution and result data within your own Storage account.
14+
# Configure customer-managed keys (preview) for Azure Chaos Studio by using Azure Blob Storage
15+
16+
Azure Chaos Studio automatically encrypts all data stored in your experiment resource with service-managed keys that Microsoft provides. As an optional feature, you can add a second layer of security by also providing your own customer-managed encryption keys. Customer-managed keys (CMKs) offer greater flexibility for controlling access and key-rotation policies.
17+
18+
When you use CMKs, you need to specify a user-assigned managed identity (UMI) to retrieve the key. The UMI you create must match the UMI that you use for the Chaos Studio experiment.
19+
20+
When configured, Chaos Studio uses Azure Storage, which uses the CMK to encrypt all your experiment execution and result data within your own storage account.
2121

2222
## Prerequisites
23-
23+
2424
- An Azure account with an active subscription. If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
25-
26-
- An existing user-assigned managed identity. For more information about creating a user-assigned managed identity, see [Manage user-assigned managed identities](../active-directory/managed-identities-azure-resources/how-manage-user-assigned-managed-identities.md?pivots=identity-mi-methods-azp#create-a-user-assigned-managed-identity).
25+
- An existing UMI. For more information about how to create a UMI, see [Manage user-assigned managed identities](../active-directory/managed-identities-azure-resources/how-manage-user-assigned-managed-identities.md?pivots=identity-mi-methods-azp#create-a-user-assigned-managed-identity).
26+
- A public-access-enabled storage account.
2727

28-
- A public-access enabled Azure storage account
29-
3028
## Limitations
31-
32-
- Azure Chaos Studio experiments can't automatically rotate the customer-managed key to use the latest version of the encryption key. You would do key rotation directly in your chosen Azure Storage account.
33-
34-
- You will need to use our **2023-10-27-preview REST API** to create and use CMK-enabled experiments ONLY. There is **no** support for CMK-enabled experiments in our GA-stable REST API until H1 2024.
3529

36-
- Azure Chaos Studio currently **only supports creating Chaos Studio Customer-Managed-Key experiments via the Command Line using our 2023-10-27-preview REST API**. As a result, you **cannot** create a Chaos Studio experiment with CMK enabled via the Azure portal. We plan to add this functionality in H1 of 2024.
30+
- Azure Chaos Studio experiments can't automatically rotate the CMK to use the latest version of the encryption key. You do key rotation directly in your chosen storage account.
31+
- You need to use our *2023-10-27-preview REST API* to create and use CMK-enabled experiments only. There's *no* support for CMK-enabled experiments in our general availability-stable REST API until H1 2024.
32+
- Chaos Studio currently *only supports creating Chaos Studio CMK experiments via the command line by using our 2023-10-27-preview REST API*. As a result, you *can't* create a Chaos Studio experiment with CMK enabled via the Azure portal. We plan to add this functionality in H1 of 2024.
33+
- The storage account must have *public access from all networks* enabled for Chaos Studio experiments to be able to use it. If you have a hard requirement from your organization, reach out to your CSA for potential solutions.
3734

38-
- The storage account must have **public access from all networks** enabled for Azure Chaos Studio experiments to be able to use it. If you have a hard requirement from your organization, reach out to your CSA for potential solutions.
35+
## Configure your storage account
3936

40-
## Configure your Azure storage account
41-
42-
When creating and/or updating your storage account to use for a CMK experiment, you need to navigate to the encryption tab and set the Encryption type to Customer-managed keys (CMK) and fill out all required information.
37+
When you create or update your storage account to use it for a CMK experiment, you need to go to the **Encryption** tab and set **Encryption type** to **Customer-managed keys (CMK)** and fill out all the required information.
4338
> [!NOTE]
44-
> The User-assigned managed identity that you use should match the one you use for the corresponding Chaos Studio CMK-enabled experiment.
45-
46-
## Use customer-managed keys with Azure Chaos Studio
47-
48-
You can only configure customer-managed encryption keys when you create a new Azure Chaos Studio experiment resource. When you specify the encryption key details, you also have to select a user-assigned managed identity to retrieve the key from Azure Key Vault.
39+
> The UMI that you use should match the one you use for the corresponding Chaos Studio CMK-enabled experiment.
40+
41+
## Use customer-managed keys with Chaos Studio
42+
43+
You can only configure customer-managed encryption keys when you create a new Chaos Studio experiment resource. When you specify the encryption key details, you also have to select a UMI to retrieve the key from Azure Key Vault.
4944

5045
> [!NOTE]
51-
> The UMI should be the SAME user-assigned managed identity you use with your Chaos Studio experiment resource, otherwise the Chaos Studio CMK experiment fails to Create/Update.
52-
46+
> The UMI should be the *same* UMI you use with your Chaos Studio experiment resource. Otherwise, the Chaos Studio CMK experiment fails to create or update.
5347
54-
# [Azure CLI](#tab/azure-cli)
48+
## Azure CLI
5549

56-
57-
The following code sample shows an example PUT command for creating or updating a Chaos Studio experiment resource to enable customer-managed keys:
50+
The following code sample shows an example `PUT` command for creating or updating a Chaos Studio experiment resource to enable CMKs.
5851

5952
> [!NOTE]
60-
>The two parameters specific to CMK experiments are under the "CustomerDataStorage" block, in which we ask for the Subscription ID of the Azure Blob Storage Account you want to use to storage your experiment data and the name of the Blob Storage container to use or create.
61-
53+
>The two parameters specific to CMK experiments are under the `CustomerDataStorage` block, in which we ask for the subscription ID of the Azure Blob Storage account that you want to use to store your experiment data and the name of the Blob Storage container to use or create.
54+
6255
```HTTP
6356
PUT https://management.azure.com/subscriptions/<yourSubscriptionID>/resourceGroups/exampleRG/providers/Microsoft.Chaos/experiments/exampleExperiment?api-version=2023-10-27-preview
6457
@@ -112,35 +105,35 @@ PUT https://management.azure.com/subscriptions/<yourSubscriptionID>/resourceGrou
112105
}
113106
```
114107
## Disable CMK on a Chaos Studio experiment
115-
116-
If you run the same PUT command from the previous example on an existing CMK-enabled experiment resource, but leave the fields in "customerDataStorage" empty, CMK is disabled on an experiment.
117108

118-
## Re-enable CMK on a Chaos Studio experiment
119-
120-
If you run the same PUT command from the previous example on an existing experiment resource using the 2023-10-27-preview REST API and populate the fields in "customerDataStorage", CMK is re-enabled on an experiment.
109+
If you run the same `PUT` command from the previous example on an existing CMK-enabled experiment resource, but you leave the fields in `customerDataStorage` empty, CMK is disabled on an experiment.
110+
111+
## Reenable CMK on a Chaos Studio experiment
112+
113+
If you run the same `PUT` command from the previous example on an existing experiment resource by using the 2023-10-27-preview REST API and populate the fields in `customerDataStorage`, CMK is reenabled on an experiment.
121114

122115
## Change the user-assigned managed identity for retrieving the encryption key
123-
124-
You can change the managed identity for customer-managed keys for an existing Chaos Studio experiment at any time. The outcome would be identical to updating the User-assigned Managed identity for any Chaos Studio experiment.
116+
117+
You can change the managed identity for CMKs for an existing Chaos Studio experiment at any time. The outcome would be identical to updating the UMI for any Chaos Studio experiment.
125118
> [!NOTE]
126-
>If the User-Assigned Managed Identity does NOT have the correct permissions to retrieve the CMK from your key vault and write to the Blob Storage, the PUT command to update the UMI fails.
119+
>If the UMI does *not* have the correct permissions to retrieve the CMK from your key vault and write to Blob Storage, the `PUT` command to update the UMI fails.
127120
128121
### List whether an experiment is CMK-enabled or not
129-
130-
Using the "Get Experiment" command from the 2023-10-27-preview REST API, the response shows you whether the "CustomerDataStorage" properties have been populated or not, which is how you can tell whether an experiment has CMK enabled or not.
131-
132-
## Update the customer-managed encryption key being used by your Azure Storage Account
133-
134-
You can change the key that you're using at any time, since Azure Chaos Studio is using your own Azure Storage account for encryption using your CMK.
135122

123+
When you use the `Get Experiment` command from the 2023-10-27-preview REST API, the response shows you whether the `CustomerDataStorage` properties were populated or not. In this way, you can tell whether an experiment is CMK enabled or not.
124+
125+
## Update the customer-managed encryption key being used by your storage account
126+
127+
You can change the key that you're using at any time because Chaos Studio is using your own storage account for encryption by using your CMK.
136128

137-
138129
## Frequently asked questions
139-
130+
131+
Here are some answers to common questions.
132+
140133
### Is there an extra charge to enable customer-managed keys?
141-
142-
While there's no charge associated directly from Azure Chaos Studio, the use of Azure Blob Storage and Azure Key Vault could carry some additional cost subject to those services' individual pricing.
143-
144-
### Are customer-managed keys supported for existing Azure Chaos Studio experiments?
145-
146-
This feature is currently only available for Azure Chaos Studio experiments created using our **2023-10-27-preview** REST API.
134+
135+
There's no charge associated directly from Chaos Studio. The use of Blob Storage and Key Vault might carry extra cost subject to those services' individual pricing.
136+
137+
### Are customer-managed keys supported for existing Chaos Studio experiments?
138+
139+
This feature is currently only available for Chaos Studio experiments created by using our 2023-10-27-preview REST API.

0 commit comments

Comments
 (0)