Skip to content

Commit e90e5ad

Browse files
Update customer-managed-keys-cross-tenant.md
1 parent b7791df commit e90e5ad

1 file changed

Lines changed: 25 additions & 46 deletions

File tree

articles/azure-netapp-files/customer-managed-keys-cross-tenant.md

Lines changed: 25 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -92,21 +92,21 @@ The configuration process for cross-tenant customer-managed keys has portions th
9292
### Configure the NetApp account to use your keys
9393

9494
> [!IMPORTANT]
95-
> If the NetApp account is currently configured with same-tenant customer-managed keys, you must first switch the account back to Microsoft-managed keys before configuring cross-tenant CMK. To switch, navigate to **Encryption** for the NetApp account in the Azure portal and change the encryption key source to **Microsoft-managed key**, then select **Save**.
95+
> If the NetApp account is currently configured with same-tenant customer-managed keys, you must switch the account back to Microsoft-managed keys before configuring cross-tenant CMK. To switch, navigate to **Encryption** for the NetApp account in the Azure portal and change the encryption key source to **Microsoft-managed key**, then select **Save**.
9696
9797
#### [Portal](#tab/portal-configure)
9898

9999
1. In the Azure portal, navigate to your NetApp account and select **Encryption**.
100-
1. On the **Encryption** page, select **Customer-managed key** as the encryption key source.
101-
1. Under **Key URI**, select **Enter key URI** and provide the URI of the encryption key from the customer's key vault in the other tenant.
100+
1. Select **Customer-managed key** as the encryption key source.
101+
1. Under **Key URI**, select **Enter key URI** and provide the URI of the encryption key.
102102
1. Under **Identity type**, select **User-assigned**.
103-
1. Select **Select an identity**, then choose the user-assigned managed identity you created earlier that has the federated credential configured.
104-
1. Under **Federated client ID**, enter the application (client) ID of the multitenant application you created in step 1.
103+
1. Select **Select an identity**, then choose the user-assigned managed identity.
104+
1. Under **Federated client ID**, enter the application (client) ID of the multitenant application.
105105
1. Select **Save**.
106106

107-
After saving, verify that the account is configured for cross-tenant CMK by checking the account's JSON view for the presence of `federatedClientId` in the encryption properties.
107+
Verify that `federatedClientId` is present in the encryption properties.
108108

109-
#### [Azure CLI / REST API](#tab/cli-configure)
109+
#### [Azure CLI](#tab/cli-configure)
110110

111111
1. With the `az rest` command, configure the NetApp account to use CMK in a different tenant:
112112

@@ -138,22 +138,21 @@ After saving, verify that the account is configured for cross-tenant CMK by chec
138138
az netappfiles account show --resource-group <resourceGroupName> --name <NetAppAccountName> --query "{encryption: properties.encryption}" -o json
139139
```
140140
141-
The output should include `federatedClientId` in the encryption identity properties, confirming cross-tenant CMK is configured.
141+
The output should include `federatedClientId` in the encryption identity properties.
142142
143-
---
144143
145144
### Create a volume
146145
147146
#### [Portal](#tab/portal-volume)
148147
149-
1. From Azure NetApp Files, select **Volumes** and then **+ Add volume**.
148+
1. In the Azure portal , select **Volumes** and then select **Add volume**.
150149
1. Follow the instructions in [Configure network features for an Azure NetApp Files volume](configure-network-features.md):
151150
* [Set the Network Features option in volume creation page](configure-network-features.md#set-the-network-features-option).
152151
* The network security group for the volume's delegated subnet must allow incoming traffic from NetApp's storage VM.
153-
1. For a NetApp account configured with cross-tenant customer-managed keys, the **Create Volume** page includes the **Encryption Key Source** option.
152+
1. For a NetApp account configured with cross-tenant customer-managed keys, perform the following steps:
154153
* Select **Customer-Managed Key** in the **Encryption Key Source** dropdown menu.
155-
* When you create a volume using a customer-managed key, you must also select **Standard** for the **Network features** option. Basic network features aren't supported.
156-
* Select a **key vault private endpoint**. The dropdown menu displays private endpoints in the selected virtual network. If there's no private endpoint for the customer's key vault in the selected virtual network, the dropdown is empty. In this scenario, see [Azure Private Endpoint](../private-link/private-endpoint-overview.md).
154+
* Select **Standard** as the **Network features** option.
155+
* Select a **key vault private endpoint**.
157156
1. Continue to complete the volume creation process. Refer to:
158157
* [Create an NFS volume](azure-netapp-files-create-volumes.md)
159158
* [Create an SMB volume](azure-netapp-files-create-volumes-smb.md)
@@ -167,17 +166,21 @@ Create the volume using the CLI:
167166
az netappfiles volume create -g <resource group name> --account-name <NetApp account name> --pool-name <pool name> --name <volume name> -l southcentralus --service-level premium --usage-threshold 100 --file-path "<file path>" --vnet <virtual network name> --subnet default --network-features Standard --encryption-key-source Microsoft.KeyVault --kv-private-endpoint-id <full resource ID to the private endpoint to the customer's vault> --debug
168167
```
169168

170-
---
171-
172169
## Troubleshoot cross-tenant customer-managed keys
173170

174-
This section describes common issues encountered when configuring cross-tenant CMK and how to resolve them.
171+
This section describes issues encountered when configuring cross-tenant CMK and the steps to resolve them.
175172

176173
### Verify cross-tenant CMK configuration
177174

178175
To confirm whether a NetApp account is correctly configured for cross-tenant CMK, check for the presence of `federatedClientId` in the account's encryption properties.
179176

180-
#### Use the Azure CLI
177+
#### [Portal](#tab/portal-volume)
178+
179+
1. Navigate to your NetApp account, select **Overview**, then select **JSON View**.
180+
181+
If cross-tenant CMK is correctly configured, the encryption properties should include `federatedClientId`.
182+
183+
#### [Azure CLI](#tab/cli-volume)
181184

182185
Run the following command to inspect the account's encryption configuration:
183186

@@ -188,44 +191,20 @@ az netappfiles account show \
188191
--query "{keySource: encryption.keySource, federatedClientId: encryption.identity.federatedClientId, userAssignedIdentity: encryption.identity.userAssignedIdentity}" \
189192
-o json
190193
```
191-
192-
The output should include:
193-
- `keySource` set to `Microsoft.KeyVault`
194-
- `federatedClientId` set to the application (client) ID of the multitenant application
195-
- `userAssignedIdentity` set to the resource ID of the user-assigned managed identity
196-
197-
If `federatedClientId` is missing or `null`, the account is configured with same-tenant CMK, not cross-tenant CMK.
198-
199-
#### Use the Azure portal
200-
201-
Navigate to your NetApp account, select **Overview**, then select **JSON View**. The encryption properties include `federatedClientId` if cross-tenant CMK is correctly configured.
194+
If `federatedClientId` is missing, the account is configured with the same-tenant CMK and not with cross-tenant CMK.
202195

203196
### Missing Key URI or Encryption Key Source option in the portal
204197

205198
**Symptom:** When creating a volume in the Azure portal, the **Encryption Key Source** dropdown menu doesn't show **Customer-Managed Key**, or fields for **Key URI**, **subscription**, or **identity type** aren't visible.
206199

207-
**Cause:** This symptom typically occurs when the NetApp account is configured with same-tenant CMK instead of cross-tenant CMK, or the account hasn't been configured for CMK at all.
208-
209200
**Resolution:**
210-
1. First, verify the current configuration using the CLI or portal JSON view as described in [Verify cross-tenant CMK configuration](#verify-cross-tenant-cmk-configuration).
211-
1. If the account is configured with same-tenant CMK (no `federatedClientId`), switch the account to Microsoft-managed keys first:
212-
1. Navigate to the NetApp account's **Encryption** page in the Azure portal.
201+
1. Verify if the NetApp account is correctly configured for cross-tenant CMK as described in [Verify cross-tenant CMK configuration](#verify-cross-tenant-cmk-configuration).
202+
1. If the account does not have `federatedClientId`, switch the account to Microsoft-managed keys:
203+
1. In the Azure portal, navigate to the **Encryption** page.
213204
1. Change the encryption key source to **Microsoft-managed key**.
214205
1. Select **Save**.
215206
1. Reconfigure the account for cross-tenant CMK by following the steps in [Configure the NetApp account to use your keys](#configure-the-netapp-account-to-use-your-keys).
216207

217-
### Volume creation fails with cross-tenant CMK
218-
219-
**Symptom:** Volume creation via REST API or portal fails with errors related to encryption key access.
220-
221-
**Cause:** This can happen due to misconfigured federated identity, expired keys, or incorrect private endpoint configuration.
222-
223-
**Resolution:**
224-
1. Verify the `federatedClientId` is correctly set using `az netappfiles account show`.
225-
1. Verify the multitenant application is installed in the customer tenant and has the correct key vault access (Get, Encrypt, Decrypt permissions).
226-
1. Verify the private endpoint to the customer's key vault is approved and connected.
227-
1. Verify the encryption key in the customer's key vault is active and not expired.
228-
229208
## Next steps
230209
* [Configure customer-managed keys](configure-customer-managed-keys.md)
231-
* [Understand data encryption in Azure NetApp Files](understand-data-encryption.md)
210+
* [Understand data encryption in Azure NetApp Files](understand-data-encryption.md)

0 commit comments

Comments
 (0)