Skip to content

Commit 69e47bc

Browse files
YunhoYunho
authored andcommitted
minor fixes
1 parent 08729c4 commit 69e47bc

File tree

1 file changed

+53
-53
lines changed

1 file changed

+53
-53
lines changed

articles/azure-fluid-relay/concepts/customer-managed-keys.md

Lines changed: 53 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -8,71 +8,71 @@ ms.topic: reference
88

99
# Customer-managed keys for Azure Fluid Relay encryption
1010

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.
1212

13-
You must use one of the following Azure key stores to store your CMK:
14-
- [Azure Key Vault](/azure/key-vault/general/overview)
13+
You must use one of the following Azure key stores to store your CMK:
14+
- [Azure Key Vault](/azure/key-vault/general/overview)
1515
- [Azure Key Vault Managed Hardware Security Module (HSM)](/azure/key-vault/managed-hsm/overview)
1616

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.
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.
1818

1919
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).
2020

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.
2222

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).
2424

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.
2626

27-
## Prerequisites:
27+
## Prerequisites:
2828

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:
3030
- Keys must be stored in an Azure Key Vault.
3131
- Keys must be RSA key and not EC key since EC key doesn’t support WRAP and UNWRAP.
3232
- 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.
3636
The Fluid Relay service will fail if the specified key version is deleted or disabled without updating the resource to use a valid version.
3737
- 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.
3838
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.
4040
4141

4242
## Create a Fluid Relay resource with CMK
4343

4444
### [REST API](#tab/rest)
4545
```
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>"
4747
```
4848

49-
Request payload format:
49+
Request payload format:
5050

5151
```
52-
{
53-
"location": "<the region you selected for Fluid Relay resource>",
54-
"identity": {
55-
"type": "UserAssigned",
56-
"userAssignedIdentities": {
57-
“<User assigned identity resource ID>": {}
58-
}
59-
},
60-
"properties": {
61-
"encryption": {
62-
"customerManagedKeyEncryption": {
63-
"keyEncryptionKeyIdentity": {
64-
"identityType": "UserAssigned",
65-
"userAssignedIdentityResourceId": "<User assigned identity resource ID>"
66-
},
67-
"keyEncryptionKeyUrl": "<key identifier>"
68-
}
69-
}
70-
}
71-
}
52+
{
53+
"location": "<the region you selected for Fluid Relay resource>",
54+
"identity": {
55+
"type": "UserAssigned",
56+
"userAssignedIdentities": {
57+
“<User assigned identity resource ID>": {}
58+
}
59+
},
60+
"properties": {
61+
"encryption": {
62+
"customerManagedKeyEncryption": {
63+
"keyEncryptionKeyIdentity": {
64+
"identityType": "UserAssigned",
65+
"userAssignedIdentityResourceId": "<User assigned identity resource ID>"
66+
},
67+
"keyEncryptionKeyUrl": "<key identifier>"
68+
}
69+
}
70+
}
71+
}
7272
```
7373

74-
Example userAssignedIdentities and userAssignedIdentityResourceId:
75-
/subscriptions/ xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testUserAssignedIdentity
74+
Example userAssignedIdentities and userAssignedIdentityResourceId:
75+
/subscriptions/ xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testUserAssignedIdentity
7676

7777
Example keyEncryptionKeyUrl: `https://test-key-vault.vault.azure.net/keys/testKey/testKeyVersionGuid`
7878

@@ -97,23 +97,23 @@ For more information about the command, see [az fluid-relay server create](/cli/
9797
**Notes:**
9898

9999
- 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.
101101
- 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.
102102
- 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.
104104
- 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.
106106
- Additionally, it needs the necessary permissions on the key specified in `key-url`.
107107
- `key-url` is the **key identifier** used for CMK.
108108

109109
---
110110

111-
## Update CMK settings of an existing Fluid Relay resource
111+
## Update CMK settings of an existing Fluid Relay resource
112112

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:
114114
- Change the identity that is used for accessing the key encryption key.
115115
- 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.
117117

118118
Note that you cannot disable CMK on existing Fluid Relay resource once it is enabled.
119119

@@ -124,23 +124,23 @@ When using the update command, you may specify only the parameters that have cha
124124
All updates must satisfy the prerequisites described above.
125125

126126
### [REST API](#tab/rest)
127-
Request URL:
127+
Request URL:
128128

129129
```
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"
131131
```
132132

133133
Request payload example for updating key encryption key URL:
134134

135135
```
136-
{
137-
"properties": {
138-
"encryption": {
139-
"customerManagedKeyEncryption": {
140-
"keyEncryptionKeyUrl": "https://test_key_vault.vault.azure.net/keys/testKey /xxxxxxxxxxxxxxxx"
141-
}
142-
}
143-
}
136+
{
137+
"properties": {
138+
"encryption": {
139+
"customerManagedKeyEncryption": {
140+
"keyEncryptionKeyUrl": "https://test_key_vault.vault.azure.net/keys/testKey /xxxxxxxxxxxxxxxx"
141+
}
142+
}
143+
}
144144
}
145145
```
146146

0 commit comments

Comments
 (0)