Skip to content

Commit 3b243f5

Browse files
edits
1 parent 17307e6 commit 3b243f5

File tree

4 files changed

+46
-46
lines changed

4 files changed

+46
-46
lines changed

articles/container-registry/tutorial-customer-managed-keys.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
---
2-
title: Customer managed key - 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.
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.
44
ms.topic: tutorial
55
ms.date: 08/5/2022
66
ms.custom: subject-rbac-steps, devx-track-azurecli
77
ms.author: tejaswikolli
88
---
99

10-
# 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
1111

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

1414

1515
In this tutorial, part one in a four-part series:
1616

1717
> [!div class="checklist"]
18-
> * Customer managed key - Overview
19-
> * Enable a Customer managed key - CLI, portal, Resource Manager Template
20-
> * Rotate and revoke a Customer managed key
21-
> * Troubleshoot a Customer managed key
18+
> * customer-managed key - Overview
19+
> * 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
2222
23-
## Customer managed key - Overview
23+
## About customer-managed key
2424

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

@@ -32,19 +32,19 @@ The key features include:
3232
3333
>* **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.
3434
35-
## Before you enable a Customer managed key
35+
## Before you enable a customer-managed key
3636

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:
3838

3939
>* This feature is available in the **Premium** container registry service tier. For more information, see [ACR service tiers.](container-registry-skus.md)
4040
>* You can currently enable a customer-managed key only while creating a registry.
4141
>* You can't disable the encryption after enabling a customer-managed key on a registry.
4242
>* 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.
4343
>* 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.
4646
47-
## Update the Customer managed key version
47+
## Update the customer-managed key version
4848

4949
Azure Container Registry supports both automatic and manual rotation of registry encryption keys when a new key version is available in Azure Key Vault.
5050

@@ -59,9 +59,9 @@ For details, see [Choose key ID with version](tutorial-enable-customer-managed-k
5959

6060
## Next steps
6161

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

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.
6565
* Learn more about [encryption at rest in Azure](../security/fundamentals/encryption-atrest.md).
6666
* Learn more about access policies and how to [secure access to a key vault](../key-vault/general/security-features.md).
6767

articles/container-registry/tutorial-enable-customer-managed-keys.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
---
2-
title: Enable a Customer managed key on Azure Container Registry
2+
title: Enable a customer-managed key on Azure Container Registry
33
description: In this tutorial, learn to encrypt your Premium registry with a customer-managed key stored in Azure Key Vault using Azure CLI.
44
ms.topic: tutorial
55
ms.date: 08/5/2022
66
ms.custom: subject-rbac-steps, devx-track-azurecli
77
---
88

9-
# Tutorial: Encrypt Azure Container Registry with a Customer managed key
9+
# Tutorial: Encrypt Azure Container Registry with a customer-managed key
1010

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

1313
In this article
1414

15-
>* Enable a Customer managed key - Azure CLI
16-
>* Enable a Customer managed key - Azure Portal
17-
>* Enable a Customer managed key - Azure Resource Manager template
15+
>* Enable a customer-managed key - Azure CLI
16+
>* Enable a customer-managed key - Azure Portal
17+
>* Enable a customer-managed key - Azure Resource Manager template
1818
1919
## Prerequisites
2020

2121
>* See [Install Azure CLI][azure-cli] or run in [Azure Cloud Shell.](../cloud-shell/quickstart.md).
2222
>* Sign into [Azure Portal](https://ms.portal.azure.com/)
2323
24-
## Enable a Customer managed key - Azure CLI
24+
## Enable a customer-managed key - Azure CLI
2525

2626
### Create a resource group
2727

@@ -192,7 +192,7 @@ keyID=$(az keyvault key show \
192192
keyID=$(echo $keyID | sed -e "s/\/[^/]*$//")
193193
```
194194

195-
### Create a registry with a Customer managed key
195+
### Create a registry with a customer-managed key
196196

197197
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.
198198

@@ -230,7 +230,7 @@ az acr encryption show --name <container-registry-name>
230230
}
231231
```
232232

233-
## Enable a Customer managed key - Azure portal
233+
## Enable a customer-managed key - Azure Portal
234234

235235
### Create a user-assigned managed identity
236236

@@ -288,7 +288,7 @@ Create a key in the key vault and use it to encrypt the registry. Follow these s
288288
1. Accept the remaining default values and select **Create**.
289289
1. After creation, select the key and then select the current version. Copy the **Key identifier** for the key version.
290290

291-
### Create Azure container registry
291+
### Create Azure Container Registry
292292

293293
1. Select **Create a resource** > **Containers** > **Container Registry**.
294294
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
306306

307307
To see the encryption status of your registry in the portal, navigate to your registry. Under **Settings**, select **Encryption**.
308308

309-
## Enable a Customer managed key - Azure Resource Manager template
309+
## Enable a customer-managed key - Azure Resource Manager template
310310

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

313313
The following Resource Manager template creates a new container registry and a *user-assigned* managed identity.
314314

@@ -443,7 +443,7 @@ az acr encryption show --name <registry-name>
443443

444444
## Next steps
445445

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

448448
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.
449449

articles/container-registry/tutorial-rotate-revoke-customer-managed-keys.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
2-
title: Rotate and Revoke a Customer managed key
3-
description: Learn how to rotate, update, revoke a Customer managed key.
2+
title: Rotate and Revoke a customer-managed key
3+
description: Learn how to rotate, update, revoke a customer-managed key.
44
ms.topic: tutorial
55
ms.date: 08/5/2022
66
ms.custom: subject-rbac-steps, devx-track-azurecli
77
ms.author: tejaswikolli
88
---
99

1010

11-
# Rotate and Revoke a Customer managed key
11+
# Rotate and Revoke a customer-managed key
1212

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

15-
## Rotate a Customer managed key
15+
## Rotate a customer-managed key
1616

1717
>* To rotate a key, you can either update the key version in Azure Key Vault or create a new key.
1818
>* 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 \
4040
> [!TIP]
4141
> 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.
4242
43-
Update a Customer managed key version manually:
43+
Update a customer-managed key version manually:
4444

4545
1. Rotate key and use user-assigned identity
4646

@@ -66,7 +66,7 @@ az acr encryption rotate-key \
6666

6767
### Create or update key version - Portal
6868

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

7171
For example, to configure a new key:
7272

@@ -79,9 +79,9 @@ For example, to configure a new key:
7979
* 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).
8080
1. Complete the key selection and select **Save**.
8181

82-
## Revoke a Customer managed key
82+
## Revoke a customer-managed key
8383

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.
8585
8686
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:
8787

@@ -101,12 +101,12 @@ az keyvault key delete \
101101
--object-id $identityPrincipalID \
102102
```
103103

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.
105105
>* 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.
106106
107107
## Next steps
108108

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

111111
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.
112112

articles/container-registry/tutorial-troubleshoot-customer-managed-keys.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
2-
title: Troubleshoot a Customer managed key
3-
description: Tutorial to troubleshoot the most common issues from a registry enabled with a Customer managed key.
2+
title: Troubleshoot a customer-managed key
3+
description: Tutorial to troubleshoot the most common issues from a registry enabled with a customer-managed key.
44
author: tejaswikolli-web
55
ms.topic: tutorial
66
ms.date: 08/5/2022
77
ms.custom: subject-rbac-steps, devx-track-azurecli
88
ms.author: tejaswikolli
99
---
1010

11-
# Troubleshoot a Customer managed key
11+
# Troubleshoot a customer-managed key
1212

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

15-
## Troubleshoot a Customer managed key
15+
## Troubleshoot a customer-managed key
1616

1717
This article helps you to troubleshoot and resolve most common issues such as authentication issues, accidental deletions of keys, etc.
1818
## Removing managed identity
@@ -48,7 +48,7 @@ If issue occurs while you try to remove a system-assigned identity, please [crea
4848

4949
## Enabling the key vault firewall
5050

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)
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)
5252

5353
If the problem persists, please contact Azure Support.
5454

0 commit comments

Comments
 (0)