You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-fluid-relay/concepts/customer-managed-keys.md
+53-53Lines changed: 53 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,71 +8,71 @@ ms.topic: reference
8
8
9
9
# Customer-managed keys for Azure Fluid Relay encryption
10
10
11
-
You can use your own encryption key to protect the data in your Azure Fluid Relay resource. When you specify a customer-managed key (CMK), that key is used to protect and control access to the key that encrypts your data. CMK offers greater flexibility to manage access controls.
11
+
You can use your own encryption key to protect the data in your Azure Fluid Relay resource. When you specify a customer-managed key (CMK), that key is used to protect and control access to the key that encrypts your data. CMK offers greater flexibility to manage access controls.
12
12
13
-
You must use one of the following Azure key stores to store your CMK:
You must create a new Azure Fluid Relay resource to enable CMK. You cannot change the CMK enablement/disablement on an existing Fluid Relay resource.
17
+
You must create a new Azure Fluid Relay resource to enable CMK. You cannot change the CMK enablement/disablement on an existing Fluid Relay resource.
18
18
19
19
Also, CMK of Fluid Relay relies on Managed Identity, and you need to assign a managed identity to the Fluid Relay resource when enabling CMK. Only user-assigned identity is allowed for Fluid Relay resource CMK. For more information about managed identities, see [here](../../active-directory/managed-identities-azure-resources/overview.md#managed-identity-types).
20
20
21
-
Configuring a Fluid Relay resource with CMK can't be done through Azure portal yet.
21
+
Configuring a Fluid Relay resource with CMK can't be done through Azure portal yet.
22
22
23
-
When you configure the Fluid Relay resource with CMK, the Azure Fluid Relay service configures the appropriate CMK encrypted settings on the Azure Storage account scope where your Fluid session artifacts are stored. For more information about CMK in Azure Storage, see [here](../../storage/common/customer-managed-keys-overview.md).
23
+
When you configure the Fluid Relay resource with CMK, the Azure Fluid Relay service configures the appropriate CMK encrypted settings on the Azure Storage account scope where your Fluid session artifacts are stored. For more information about CMK in Azure Storage, see [here](../../storage/common/customer-managed-keys-overview.md).
24
24
25
-
To verify a Fluid Relay resource is using CMK, you can check the property of the resource by sending GET and see if it has valid, non-empty property of encryption.customerManagedKeyEncryption.
25
+
To verify a Fluid Relay resource is using CMK, you can check the property of the resource by sending GET and see if it has valid, non-empty property of encryption.customerManagedKeyEncryption.
26
26
27
-
## Prerequisites:
27
+
## Prerequisites:
28
28
29
-
Before configuring CMK on your Azure Fluid Relay resource, the following prerequisites must be met:
29
+
Before configuring CMK on your Azure Fluid Relay resource, the following prerequisites must be met:
30
30
- Keys must be stored in an Azure Key Vault.
31
31
- Keys must be RSA key and not EC key since EC key doesn’t support WRAP and UNWRAP.
32
32
- A user assigned managed identity must be created with necessary permission (GET, WRAP and UNWRAP) to the key vault in step 1. More information [here](../../active-directory/managed-identities-azure-resources/tutorial-windows-vm-access-nonaad.md). Please grant GET, WRAP and UNWRAP under Key Permissions in AKV.
33
-
- Azure Key Vault, user assigned identity, and the Fluid Relay resource must be in the same region and in the same Microsoft Entra tenant.
34
-
- If you provide the key URL with a specific key version, **only that version** will be used for CMK purposes.
35
-
If you later add a new key version, you must **manually** update the key URL in the CMK settings of the Fluid Relay resource to make the new version effective.
33
+
- Azure Key Vault, user assigned identity, and the Fluid Relay resource must be in the same region and in the same Microsoft Entra tenant.
34
+
- If you provide the key URL with a specific key version, **only that version** will be used for CMK purposes.
35
+
If you later add a new key version, you must **manually** update the key URL in the CMK settings of the Fluid Relay resource to make the new version effective.
36
36
The Fluid Relay service will fail if the specified key version is deleted or disabled without updating the resource to use a valid version.
37
37
- To allow the Fluid Relay service to automatically use the latest key version of the key from your key vault, you can **omit the key version** in the encryption key URL. This enables automatic key version updates on the Fluid Relay side.
38
38
However, you are still responsible for managing and rotating key versions in your Key Vault.
39
-
> Due to resource limitations, switching to this auto-update setting may fail. If that happens, please specify a key version explicitly and perform a manual update on your Fluid Relay resource.
39
+
> Due to resource limitations, switching to this auto-update setting may fail. If that happens, please specify a key version explicitly and perform a manual update on your Fluid Relay resource for newer key versions.
40
40
41
41
42
42
## Create a Fluid Relay resource with CMK
43
43
44
44
### [REST API](#tab/rest)
45
45
```
46
-
PUT https://management.azure.com/subscriptions/<subscription ID>/resourceGroups/<resource group name> /providers/Microsoft.FluidRelay/fluidRelayServers/< Fluid Relay resource name>?api-version=2022-06-01 @"<path to request payload>"
46
+
PUT https://management.azure.com/subscriptions/<subscription ID>/resourceGroups/<resource group name> /providers/Microsoft.FluidRelay/fluidRelayServers/< Fluid Relay resource name>?api-version=2022-06-01 @"<path to request payload>"
47
47
```
48
48
49
-
Request payload format:
49
+
Request payload format:
50
50
51
51
```
52
-
{
53
-
"location": "<the region you selected for Fluid Relay resource>",
Example keyEncryptionKeyUrl: `https://test-key-vault.vault.azure.net/keys/testKey/testKeyVersionGuid`
78
78
@@ -97,23 +97,23 @@ For more information about the command, see [az fluid-relay server create](/cli/
97
97
**Notes:**
98
98
99
99
- Some arguments must be provided in **stringified JSON** format.
100
-
- The `type` field under `identity`**must be**`UserAssigned`. This specifies the identity type of the managed identity assigned to the Fluid Relay resource.
100
+
- The `type` field under `identity`**must be**`UserAssigned`. This specifies the identity type of the managed identity assigned to the Fluid Relay resource.
101
101
- The `identity-type` field under `key-identity`**must also be**`UserAssigned`. This indicates the identity type to be used for Customer-Managed Key (CMK) encryption.
102
102
- While multiple identities can be specified in the `identity` argument, **only** the identity defined in `key-identity` will be used to access the Key Vault for CMK encryption.
103
-
- The `user-assigned-identities` field under `key-identity` should be set to the **resource ID** of the user-assigned identity intended for CMK access.
103
+
- The `user-assigned-identities` field under `key-identity` should be set to the **resource ID** of the user-assigned identity intended for CMK access.
104
104
- This identity must already be listed in the `identity` field.
105
-
- It must also be assigned to the Fluid Relay resource **before** it can be used for CMK.
105
+
- It must also be assigned to the Fluid Relay resource **before** it can be used for CMK.
106
106
- Additionally, it needs the necessary permissions on the key specified in `key-url`.
107
107
-`key-url` is the **key identifier** used for CMK.
108
108
109
109
---
110
110
111
-
## Update CMK settings of an existing Fluid Relay resource
111
+
## Update CMK settings of an existing Fluid Relay resource
112
112
113
-
You can update the following CMK settings on existing Fluid Relay resource:
113
+
You can update the following CMK settings on existing Fluid Relay resource:
114
114
- Change the identity that is used for accessing the key encryption key.
115
115
- Change the key encryption key identifier (key URL).
116
-
- Change the key version of the key encryption key.
116
+
- Change the key version of the key encryption key.
117
117
118
118
Note that you cannot disable CMK on existing Fluid Relay resource once it is enabled.
119
119
@@ -124,23 +124,23 @@ When using the update command, you may specify only the parameters that have cha
124
124
All updates must satisfy the prerequisites described above.
125
125
126
126
### [REST API](#tab/rest)
127
-
Request URL:
127
+
Request URL:
128
128
129
129
```
130
-
PATCH https://management.azure.com/subscriptions/<subscription id>/resourceGroups/<resource group name>/providers/Microsoft.FluidRelay/fluidRelayServers/<fluid relay server name>?api-version=2022-06-01 @"path to request payload"
130
+
PATCH https://management.azure.com/subscriptions/<subscription id>/resourceGroups/<resource group name>/providers/Microsoft.FluidRelay/fluidRelayServers/<fluid relay server name>?api-version=2022-06-01 @"path to request payload"
131
131
```
132
132
133
133
Request payload example for updating key encryption key URL:
0 commit comments