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/container-registry/tutorial-customer-managed-keys.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,26 +1,26 @@
1
1
---
2
-
title: Customer managed key - Overview
3
-
description: Learn about the customermanaged keys, an overview on its key features and considerations before you encrypt your Premium registry with a customer-managed key stored in Azure Key Vault.
2
+
title: About customer-managed keys - Overview
3
+
description: Learn about the customer-managed keys, an overview on its key features and considerations before you encrypt your Premium registry with a customer-managed key stored in Azure Key Vault.
# Tutorial: An overview of a Customer managed key encryption for your Azure Container Registry
10
+
# Tutorial: An overview of a customer-managed key encryption for your Azure Container Registry
11
11
12
-
Azure container registry, automatically encrypts the images and other artifacts you store. By default, Azure automatically encrypts the registry content at rest with [service-managed keys](../security/fundamentals/encryption-models.md). You can supplement default encryption with an additional encryption layer using a Customer managed key.
12
+
Azure Container Registry, automatically encrypts the images and other artifacts you store. By default, Azure automatically encrypts the registry content at rest with [service-managed keys](../security/fundamentals/encryption-models.md). You can supplement default encryption with an additional encryption layer using a customer-managed key.
> * Enable a customer-managed key - CLI, Portal, and Resource Manager Template
20
+
> * Rotate and revoke a customer-managed key
21
+
> * Troubleshoot a customer-managed key
22
22
23
-
## Customer managed key - Overview
23
+
## About customer-managed key
24
24
25
25
A customer-managed key gives you the ownership to bring your own key in the [Azure Key Vault](../key-vault/general/overview.md). The customer-managed key also allows you to manage key rotations, controls the access and permissions to use the key, and audit the usage of the key.
26
26
@@ -32,19 +32,19 @@ The key features include:
32
32
33
33
>***Key life cycle management**: Integrating customer-managed keys with [Azure Key Vault](../key-vault/general/overview.md), will give you full control and responsibility for the key lifecycle, including rotation and management.
34
34
35
-
## Before you enable a Customer managed key
35
+
## Before you enable a customer-managed key
36
36
37
-
Configure Azure Container Registry (ACR) with a Customer managed key consider knowing:
37
+
Configure Azure Container Registry (ACR) with a customer-managed key consider knowing:
38
38
39
39
>* This feature is available in the **Premium** container registry service tier. For more information, see [ACR service tiers.](container-registry-skus.md)
40
40
>* You can currently enable a customer-managed key only while creating a registry.
41
41
>* You can't disable the encryption after enabling a customer-managed key on a registry.
42
42
>* You have to configure a *user-assigned* managed identity to access the key vault. Later, if required you can enable the registry's *system-assigned* managed identity for key vault access.
43
43
>* Azure Container Registry supports only RSA or RSA-HSM keys. Elliptic curve keys aren't currently supported.
44
-
>* In a registry encrypted with a Customer managed key, you can retain logs for [ACR Tasks](container-registry-tasks-overview.md) only for 24 hours. To retain logs for a longer period, see guidance to [export and store task run logs.](container-registry-tasks-logs.md#alternative-log-storage)
45
-
>*[Content trust](container-registry-content-trust.md) is currently not supported in a registry encrypted with a Customer managed key.
44
+
>* In a registry encrypted with a customer-managed key, you can retain logs for [ACR Tasks](container-registry-tasks-overview.md) only for 24 hours. To retain logs for a longer period, see guidance to [export and store task run logs.](container-registry-tasks-logs.md#alternative-log-storage)
45
+
>*[Content trust](container-registry-content-trust.md) is currently not supported in a registry encrypted with a customer-managed key.
46
46
47
-
## Update the Customer managed key version
47
+
## Update the customer-managed key version
48
48
49
49
Azure Container Registry supports both automatic and manual rotation of registry encryption keys when a new key version is available in Azure Key Vault.
50
50
@@ -59,9 +59,9 @@ For details, see [Choose key ID with version](tutorial-enable-customer-managed-k
59
59
60
60
## Next steps
61
61
62
-
In this tutorial, you have an overview on a Customer managed keys, their key features, and a brief of the considerations to enable a Customer managed keys to your registry and types of updating key versions.
62
+
In this tutorial, you have an overview on a customer-managed keys, their key features, and a brief of the considerations to enable a customer-managed key to your registry and types of updating key versions.
63
63
64
-
Advance to the next [tutorial](tutorial-enable-customer-managed-keys.md) to enable your container registry with a Customer managed keys using Azure CLI, Azure portal, and Azure Resource Manager template.
64
+
Advance to the next [tutorial](tutorial-enable-customer-managed-keys.md) to enable your container registry with a customer-managed keys using Azure CLI, Azure portal, and Azure Resource Manager template.
65
65
* Learn more about [encryption at rest in Azure](../security/fundamentals/encryption-atrest.md).
66
66
* Learn more about access policies and how to [secure access to a key vault](../key-vault/general/security-features.md).
# Tutorial: Encrypt Azure Container Registry with a Customer managed key
9
+
# Tutorial: Encrypt Azure Container Registry with a customer-managed key
10
10
11
-
This article is part two in a four-part tutorial series. In [part one](tutorial-customer-managed-keys.md), you have an overview about a Customer managed key, key features, and the considerations before you enable a Customer managed key on your registry. This article walks you through the steps using the Azure CLI, Azure portal, or a Resource Manager template.
11
+
This article is part two in a four-part tutorial series. In [part one](tutorial-customer-managed-keys.md), you have an overview about a customer-managed key, key features, and the considerations before you enable a customer-managed key on your registry. This article walks you through the steps using the Azure CLI, Azure portal, or a Resource Manager template.
>* Enable a customer-managed key - Azure Resource Manager template
18
18
19
19
## Prerequisites
20
20
21
21
>* See [Install Azure CLI][azure-cli] or run in [Azure Cloud Shell.](../cloud-shell/quickstart.md).
22
22
>* Sign into [Azure Portal](https://ms.portal.azure.com/)
23
23
24
-
## Enable a Customer managed key - Azure CLI
24
+
## Enable a customer-managed key - Azure CLI
25
25
26
26
### Create a resource group
27
27
@@ -192,7 +192,7 @@ keyID=$(az keyvault key show \
192
192
keyID=$(echo $keyID | sed -e "s/\/[^/]*$//")
193
193
```
194
194
195
-
### Create a registry with a Customer managed key
195
+
### Create a registry with a customer-managed key
196
196
197
197
1. Run the [az acr create][az-acr-create](/cli/azure/acr#az-acr-create) command to create a registry in the *Premium* service tier and enable the customer-managed key.
198
198
@@ -230,7 +230,7 @@ az acr encryption show --name <container-registry-name>
230
230
}
231
231
```
232
232
233
-
## Enable a Customer managed key - Azure portal
233
+
## Enable a customer-managed key - Azure Portal
234
234
235
235
### Create a user-assigned managed identity
236
236
@@ -288,7 +288,7 @@ Create a key in the key vault and use it to encrypt the registry. Follow these s
288
288
1. Accept the remaining default values and select **Create**.
289
289
1. After creation, select the key and then select the current version. Copy the **Key identifier** for the key version.
290
290
291
-
### Create Azure container registry
291
+
### Create Azure Container Registry
292
292
293
293
1. Select **Create a resource** > **Containers** > **Container Registry**.
294
294
1. In the **Basics** tab, select or create a resource group, and enter a registry name. In **SKU**, select **Premium**.
@@ -306,9 +306,9 @@ Create a key in the key vault and use it to encrypt the registry. Follow these s
306
306
307
307
To see the encryption status of your registry in the portal, navigate to your registry. Under **Settings**, select **Encryption**.
## Enable a customer-managed key - Azure Resource Manager template
310
310
311
-
You can use a Resource Manager template to create a registry and enable encryption with a Customer managed key.
311
+
You can use a Resource Manager template to create a registry and enable encryption with a customer-managed key.
312
312
313
313
The following Resource Manager template creates a new container registry and a *user-assigned* managed identity.
314
314
@@ -443,7 +443,7 @@ az acr encryption show --name <registry-name>
443
443
444
444
## Next steps
445
445
446
-
In this tutorial, you've learned to enable a customer-managed key on your Azure container registry using Azure CLI, portal, and Resource Manager template. This article also explains how to create resources for the encryption and verify the encryption status of your registry.
446
+
In this tutorial, you've learned to enable a customer-managed key on your Azure Container Registry using Azure CLI, portal, and Resource Manager template. This article also explains how to create resources for the encryption and verify the encryption status of your registry.
447
447
448
448
Advance to the next [tutorial](tutorial-rotate-revoke-customer-managed-keys.md), to have a walk-through of performing the customer-managed key rotation, update key versions, and revoke a customer-managed key.
This article is part three in a four-part tutorial series. In [part one](tutorial-customer-managed-keys.md), you have an overview of the customer-managed key, their key features, and the considerations before you enable a Customer managed key on your registry. In [part two](tutorial-enable-customer-managed-keys.md), you've learned to enable a Customer managed key using the Azure CLI, Azure portal, or a Resource Manager template. In this article walks you to rotate a Customer managed key, update key version and revoke the key.
13
+
This article is part three in a four-part tutorial series. In [part one](tutorial-customer-managed-keys.md), you have an overview of the customer-managed key, their key features, and the considerations before you enable a customer-managed key on your registry. In [part two](tutorial-enable-customer-managed-keys.md), you've learned to enable a customer-managed key using the Azure CLI, Azure portal, or a Resource Manager template. In this article walks you to rotate a customer-managed key, update key version and revoke the key.
14
14
15
-
## Rotate a Customer managed key
15
+
## Rotate a customer-managed key
16
16
17
17
>* To rotate a key, you can either update the key version in Azure Key Vault or create a new key.
18
18
>* While rotating the key, you can specify the same identity you have used to create the registry.
@@ -40,7 +40,7 @@ az keyvault key create \
40
40
> [!TIP]
41
41
> When you run `az-acr-encryption-rotate-key`, you can pass either a versioned key ID or a non-versioned key ID. If you use a non-versioned key ID, the registry is then configured to automatically detect later key version updates.
42
42
43
-
Update a Customer managed key version manually:
43
+
Update a customer-managed key version manually:
44
44
45
45
1. Rotate key and use user-assigned identity
46
46
@@ -66,7 +66,7 @@ az acr encryption rotate-key \
66
66
67
67
### Create or update key version - Portal
68
68
69
-
Use the registry's **Encryption** settings to update the key vault, key, or identity settings used for a Customer managed key.
69
+
Use the registry's **Encryption** settings to update the key vault, key, or identity settings used for a customer-managed key.
70
70
71
71
For example, to configure a new key:
72
72
@@ -79,9 +79,9 @@ For example, to configure a new key:
79
79
* Select **Enter key URI**, and provide a key identifier directly. You can provide either a versioned key URI (for a key that must be rotated manually) or a non-versioned key URI (which enables automatic key rotation).
80
80
1. Complete the key selection and select **Save**.
81
81
82
-
## Revoke a Customer managed key
82
+
## Revoke a customer-managed key
83
83
84
-
>* You can revoke a Customer managed encryption key by changing the access policy, or changing the permissions on the key vault, or by deleting the key.
84
+
>* You can revoke a customer-managed encryption key by changing the access policy, or changing the permissions on the key vault, or by deleting the key.
85
85
86
86
1. Run the [az-keyvault-delete-policy](/cli/azure/keyvault#az-keyvault-delete-policy) command to change the access policy of the managed identity used by your registry:
87
87
@@ -101,12 +101,12 @@ az keyvault key delete \
101
101
--object-id $identityPrincipalID \
102
102
```
103
103
104
-
>* Revoking a Customer managed key will block access to all registry data.
104
+
>* Revoking a customer-managed key will block access to all registry data.
105
105
>* If you enable access to the key or restore a deleted key, the registry will pick the key, and you can gain back control on access to the encrypted registry data.
106
106
107
107
## Next steps
108
108
109
-
In this tutorial, you've learned to perform key rotations, update key versions using CLI and Portal, and revoking a Customer managed key on your Azure container registry.
109
+
In this tutorial, you've learned to perform key rotations, update key versions using CLI and Portal, and revoking a customer-managed key on your Azure Container Registry.
110
110
111
111
Advance to the next tutorial to [troubleshoot](tutorial-troubleshoot-customer-managed-keys.md) most common issues like removing a managed identity, 403 errors, and restoring accidental key deletes.
This article is part four in a four-part tutorial series. In [part one](tutorial-customer-managed-keys.md), you have an overview of the customer-managed key, their key features, and the considerations before you enable a customer-managed key on your registry. In [part two](tutorial-enable-customer-managed-keys.md), you've learned to enable customer-managed keys using the Azure CLI, Azure portal, or a Resource Manager template. In [part three](tutorial-rotate-revoke-customer-managed-keys.md), you'll learn to rotate, update, revoke a Customer managed key. In this article, learn to troubleshoot any issues with customer-managed keys.
13
+
This article is part four in a four-part tutorial series. In [part one](tutorial-customer-managed-keys.md), you have an overview of the customer-managed keys, their key features, and the considerations before you enable a customer-managed key on your registry. In [part two](tutorial-enable-customer-managed-keys.md), you've learned to enable customer-managed keys using the Azure CLI, Azure portal, or a Resource Manager template. In [part three](tutorial-rotate-revoke-customer-managed-keys.md), you'll learn to rotate, update, revoke a customer-managed key. In this article, learn to troubleshoot any issues with customer-managed keys.
14
14
15
-
## Troubleshoot a Customer managed key
15
+
## Troubleshoot a customer-managed key
16
16
17
17
This article helps you to troubleshoot and resolve most common issues such as authentication issues, accidental deletions of keys, etc.
18
18
## Removing managed identity
@@ -48,7 +48,7 @@ If issue occurs while you try to remove a system-assigned identity, please [crea
48
48
49
49
## Enabling the key vault firewall
50
50
51
-
If you enable a key vault firewall or virtual network after creating an encrypted registry, you might see HTTP 403 or other errors with image import or automated key rotation. To correct this problem, reconfigure the managed identity and key you used initially for encryption. See steps in [Rotate a customermanaged key.](tutorial-rotate-revoke-customer-managed-keys.md#rotate-a-customer-managed-key)
51
+
If you enable a key vault firewall or virtual network after creating an encrypted registry, you might see HTTP 403 or other errors with image import or automated key rotation. To correct this problem, reconfigure the managed identity and key you used initially for encryption. See steps in [Rotate a customer-managed key.](tutorial-rotate-revoke-customer-managed-keys.md#rotate-a-customer-managed-key)
52
52
53
53
If the problem persists, please contact Azure Support.
0 commit comments