Skip to content

Commit b302aa1

Browse files
Merge pull request #293682 from b-ahibbard/eddie
update transition cmk statement
2 parents d2cf47c + be6d37b commit b302aa1

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

articles/azure-netapp-files/configure-customer-managed-keys.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: b-ahibbard
66
ms.service: azure-netapp-files
77
ms.topic: how-to
88
ms.custom: references_regions, devx-track-azurecli, devx-track-azurepowershell
9-
ms.date: 09/05/2024
9+
ms.date: 01/28/2025
1010
ms.author: anfdocs
1111
---
1212

@@ -32,9 +32,9 @@ The following diagram demonstrates how customer-managed keys work with Azure Net
3232
* For increased security, you can select the **Disable public access** option within the network settings of your key vault. When selecting this option, you must also select **Allow trusted Microsoft services to bypass this firewall** to permit the Azure NetApp Files service to access your encryption key.
3333
* Customer-managed keys support automatic Managed System Identity (MSI) certificate renewal. If your certificate is valid, you don't need to manually update it.
3434
* Applying Azure network security groups on the private link subnet to Azure Key Vault isn't supported for Azure NetApp Files customer-managed keys. Network security groups don't affect connectivity to Private Link unless `Private endpoint network policy` is enabled on the subnet. It's _required_ to keep this option disabled.
35-
* If Azure NetApp Files fails to create a customer-managed key volume, error messages are displayed. Refer to the [Error messages and troubleshooting](#error-messages-and-troubleshooting) section for more information.
35+
* If Azure NetApp Files fails to create a customer-managed key volume, error messages are displayed. For more information, see [Error messages and troubleshooting](#error-messages-and-troubleshooting).
3636
* Do not make any changes to the underlying Azure Key Vault or Azure Private Endpoint after creating a customer-managed keys volume. Making changes can make the volumes inaccessible.
37-
* Azure NetApp Files supports the ability to [seamlessly transition existing volumes from platform-managed keys to customer-managed-keys](#transition-volumes).
37+
* Azure NetApp Files supports the ability to [transition existing volumes from platform-managed keys (PMK) to customer-managed keys (CMK) without data migration](#transition-volumes). This provides flexibility with the encryption key lifecycle (renewals, rotations) and extra security for regulated industry requirements.
3838
* If Azure Key Vault becomes inaccessible, Azure NetApp Files loses its access to the encryption keys and the ability to read or write data to volumes enabled with customer-managed keys. In this situation, create a support ticket to have access manually restored for the affected volumes.
3939
* Azure NetApp Files supports customer-managed keys on source and data replication volumes with cross-region replication or cross-zone replication relationships.
4040

@@ -98,7 +98,7 @@ Before creating your first customer-managed key volume, you must set up:
9898
* The key vault must have an [Azure Private Endpoint](../private-link/private-endpoint-overview.md).
9999
* The private endpoint must reside in a different subnet than the one delegated to Azure NetApp Files. The subnet must be in the same VNet as the one delegated to Azure NetApp.
100100

101-
For more information about Azure Key Vault and Azure Private Endpoint, refer to:
101+
For more information about Azure Key Vault and Azure Private Endpoint, see:
102102
* [Quickstart: Create a key vault ](/azure/key-vault/general/quick-create-portal)
103103
* [Create or import a key into the vault](/azure/key-vault/keys/quick-create-portal)
104104
* [Create a private endpoint](../private-link/create-private-endpoint-portal.md)
@@ -140,11 +140,11 @@ For more information about Azure Key Vault and Azure Private Endpoint, refer to:
140140
* `Microsoft.KeyVault/vaults/keys/decrypt/action`
141141
The user-assigned identity you select is added to your NetApp account. Due to the customizable nature of role-based access control (RBAC), the Azure portal doesn't configure access to the key vault. See [Provide access to Key Vault keys, certificates, and secrets with an Azure role-based access control](/azure/key-vault/general/rbac-guide) for details on configuring Azure Key Vault.
142142

143-
1. Select **Save** then observe the notification communicating the status of the operation. If the operation was not successful, an error message displays. Refer to [error messages and troubleshooting](#error-messages-and-troubleshooting) for assistance in resolving the error.
143+
1. Select **Save** then observe the notification communicating the status of the operation. If the operation isn't successful, an error message displays. For assistance in resolving the error, see [error messages and troubleshooting](#error-messages-and-troubleshooting).
144144

145145
### [Azure CLI](#tab/azure-cli)
146146

147-
How you configure a NetApp account with customer-managed keys with the Azure CLI depends on whether you are using a [system-assigned identity](#use-a-system-assigned-identity) or an [user-assigned identity](#use-a-new-user-assigned-identity).
147+
How you configure a NetApp account with customer-managed keys with the Azure CLI depends on whether you're using a [system-assigned identity](#use-a-system-assigned-identity) or an [user-assigned identity](#use-a-new-user-assigned-identity).
148148

149149
#### Use a system-assigned identity
150150

@@ -157,7 +157,7 @@ How you configure a NetApp account with customer-managed keys with the Azure CLI
157157
--identity-type SystemAssigned
158158
```
159159
160-
1. To use an access policy, create a variable that includes the principal ID of the account identity, then run `az keyvault set-policy` and assign permissions of "Get", "Encrypt", and "Decrypt".
160+
1. To use an access policy, create a variable that includes the principal ID of the account identity, then run `az keyvault set-policy` and assign permissions of "Get," "Encrypt," and "Decrypt."
161161
162162
```azurecli
163163
netapp_account_principal=$(az netappfiles account show \
@@ -240,7 +240,7 @@ How you configure a NetApp account with customer-managed keys with the Azure CLI
240240
241241
### [Azure PowerShell](#tab/azure-powershell)
242242
243-
The process to configure a NetApp account with customer-managed keys in the Azure CLI depends on whether you are using a [system-assigned identity](#enable-access-for-system-assigned-identity) or an [user-assigned identity](#enable-access-for-user-assigned-identity).
243+
The process to configure a NetApp account with customer-managed keys in the Azure CLI depends on whether you're using a [system-assigned identity](#enable-access-for-system-assigned-identity) or an [user-assigned identity](#enable-access-for-user-assigned-identity).
244244
245245
#### Enable access for system-assigned identity
246246
@@ -250,7 +250,7 @@ The process to configure a NetApp account with customer-managed keys in the Azur
250250
$netappAccount = Update-AzNetAppFilesAccount -ResourceGroupName <resource_group> -Name <account_name> -AssignIdentity
251251
```
252252
253-
1. To use an access policy, run `Set-AzKeyVaultAccessPolicy` with the key vault name, the principal ID of the account identity, and the permissions "Get", "Encrypt", and "Decrypt".
253+
1. To use an access policy, run `Set-AzKeyVaultAccessPolicy` with the key vault name, the principal ID of the account identity, and the permissions "Get," "Encrypt," and "Decrypt."
254254
255255
```azurepowershell
256256
Set-AzKeyVaultAccessPolicy -VaultName <key_vault_name> -ResourceGroupname <resource_group> -ObjectId $netappAccount.Identity.PrincipalId -PermissionsToKeys get,encrypt,decrypt
@@ -476,7 +476,7 @@ This section lists error messages and possible resolutions when Azure NetApp Fil
476476
| `The operation failed because the specified key vault key was not found` | When entering key URI manually, ensure that the URI is correct. |
477477
| `Azure Key Vault key is not a valid RSA key` | Ensure that the selected key is of type RSA. |
478478
| `Azure Key Vault key is not enabled` | Ensure that the selected key is enabled. |
479-
| `Azure Key Vault key is expired` | Ensure that the selected key is not expired. |
479+
| `Azure Key Vault key is expired` | Ensure that the selected key is valid. |
480480
| `Azure Key Vault key has not been activated` | Ensure that the selected key is active. |
481481
| `Key Vault URI is invalid` | When entering key URI manually, ensure that the URI is correct. |
482482
| `Azure Key Vault is not recoverable. Make sure that Soft-delete and Purge protection are both enabled on the Azure Key Vault` | Update the key vault recovery level to: <br> `“Recoverable/Recoverable+ProtectedSubscription/CustomizedRecoverable/CustomizedRecoverable+ProtectedSubscription”` |
@@ -489,7 +489,7 @@ This section lists error messages and possible resolutions when Azure NetApp Fil
489489
| `Volume cannot be encrypted with Microsoft.KeyVault, NetAppAccount has not been configured with KeyVault encryption` | Your NetApp account doesn't have customer-managed key encryption enabled. Configure the NetApp account to use customer-managed key. |
490490
| `EncryptionKeySource cannot be changed` | No resolution. The `EncryptionKeySource` property of a volume can't be changed. |
491491
| `Unable to use the configured encryption key, please check if key is active` | Check that: <br> -Are all access policies correct on the key vault: Get, Encrypt, Decrypt? <br> -Does a private endpoint for the key vault exist? <br> -Is there a Virtual Network NAT in the VNet, with the delegated Azure NetApp Files subnet enabled? |
492-
| `Could not connect to the KeyVault` | Ensure that the private endpoint is set up correctly and the firewalls are not blocking the connection from your Virtual Network to your KeyVault. |
492+
| `Could not connect to the KeyVault` | Ensure that the private endpoint is set up correctly and the firewalls aren't blocking the connection from your Virtual Network to your KeyVault. |
493493
494494
## Next steps
495495

0 commit comments

Comments
 (0)