Skip to content

Commit 6197542

Browse files
YunhoYunho
authored andcommitted
add links to prerequisite
1 parent 435d6a7 commit 6197542

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ When you configure the Fluid Relay resource with CMK, the Azure Fluid Relay serv
2424

2525
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

2929
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.
@@ -111,7 +111,7 @@ For more information about the command, see [New-AzFluidRelayServer](/powershell
111111
### [Azure CLI](#tab/azure-cli)
112112
To create Fluid Relay with CMK enabled using Azure CLI, you need to install [fluid-relay](/cli/azure/fluid-relay) extension first. See [instructions](/cli/azure/azure-cli-extensions-overview).
113113

114-
And make sure you complete all the prerequsite steps.
114+
And make sure you complete all the [prerequsite](#prerequisites) steps.
115115

116116
Example of creating a Fluid Relay Service with CMK enabled:
117117
```azurecli
@@ -122,7 +122,8 @@ For more information about the command, see [az fluid-relay server create](/cli/
122122

123123
**Notes:**
124124

125-
- Some arguments must be provided in **stringified JSON** format.
125+
- These arguments must be provided in **stringified JSON** format.
126+
- `identity`, `key-identity`
126127
- The `type` field under `identity` **must be** `UserAssigned`. It specifies the identity type of the managed identity assigned to the Fluid Relay resource.
127128
- The `identity-type` field under `key-identity` **must also be** `UserAssigned`. It indicates the identity type to be used for Customer-Managed Key (CMK) encryption.
128129
- While multiple identities can be specified in the `identity` argument, **only** the identity defined in `key-identity` is used to access the Key Vault for CMK encryption.
@@ -146,7 +147,7 @@ Before updating the key encryption key (by identifier or version), ensure that *
146147

147148
When using the update command, you may specify only the parameters that have changed—unchanged arguments can be omitted.
148149

149-
All updates must satisfy the prerequisites described in this page.
150+
All updates must satisfy the [prerequisites](#prerequisites) described in this page.
150151

151152
### [REST API](#tab/rest)
152153
Request URL:
@@ -211,7 +212,7 @@ For more information about the command, see [az fluid-relay server update](/cli/
211212
## Troubleshooting
212213

213214
### Error: Unexpected error happened when configuring CMK
214-
- Ensure your configuration meets **all the requirements** listed in the prerequisites section.
215+
- Ensure your configuration meets **all the requirements** listed in the [prerequisites](#prerequisites) section.
215216

216217
- Check if you have firewall rules enabled in your Azure Key Vault. If so, turn on "Allow trusted Microsoft services to bypass this firewall" option. See [Key Vault firewall-enabled trusted services only](/azure/key-vault/general/network-security?WT.mc_id=Portal-Microsoft_Azure_KeyVault#key-vault-firewall-enabled-trusted-services-only)
217218

0 commit comments

Comments
 (0)