Skip to content

Commit de59c1d

Browse files
authored
Merge pull request #212236 from msmbaldwin/linter
Linter pilot (control) - Managed HSM ARM template QS
2 parents 1b988d3 + 780fd59 commit de59c1d

File tree

2 files changed

+43
-35
lines changed

2 files changed

+43
-35
lines changed

articles/key-vault/managed-hsm/quick-create-template.md

Lines changed: 41 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -4,52 +4,42 @@ description: Quickstart showing how to create Azure an Azure Key Vault Managed H
44
services: key-vault
55
author: msmbaldwin
66
ms.author: mbaldwin
7-
ms.date: 09/15/2020
7+
ms.date: 09/22/2022
88
ms.topic: quickstart
99
ms.service: key-vault
1010
ms.subservice: managed-hsm
1111
tags: azure-resource-manager
12-
ms.custom: mvc, devx-track-azurecli, mode-other
12+
ms.custom: subject-armqs
1313
#Customer intent: As a security admin who is new to Azure, I want to create a managed HSM using an Azure Resource Manager template.
1414
---
1515

16-
# Quickstart: Create a Managed HSM using an Azure Resource Manager template
16+
# Quickstart: Create a Managed HSM using an ARM template
1717

18-
Managed HSM is a fully managed, highly available, single-tenant, standards-compliant cloud service that enables you to safeguards cryptographic keys for your cloud applications, using **FIPS 140-2 Level 3** validated HSMs.
18+
This quickstart describes how to use an Azure Resource Manager template (ARM template) to create an Azure Key Vault managed HSM. Managed HSM is a fully managed, highly available, single-tenant, standards-compliant cloud service that enables you to safeguards cryptographic keys for your cloud applications, using **FIPS 140-2 Level 3** validated HSMs.
1919

20-
This quickstart focuses on the process of deploying a Resource Manager template to create a Managed HSM. [Resource Manager template](../../azure-resource-manager/templates/overview.md) is a JavaScript Object Notation (JSON) file that defines the infrastructure and configuration for your project. The template uses declarative syntax, which lets you state what you intend to deploy without having to write the sequence of programming commands to create it. If you want to learn more about developing Resource Manager templates, see [Resource Manager documentation](../../azure-resource-manager/index.yml) and the [template reference](/azure/templates/microsoft.keyvault/allversions).
20+
[!INCLUDE [About Azure Resource Manager](../../../includes/resource-manager-quickstart-introduction.md)]
2121

22-
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
23-
24-
## Prerequisites
25-
26-
To complete the steps in this article, you must have the following items:
27-
28-
- A subscription to Microsoft Azure. If you don't have one, you can sign up for a [free trial](https://azure.microsoft.com/pricing/free-trial).
29-
- The Azure CLI version 2.12.0 or later. Run `az --version` to find the version. If you need to install or upgrade, see [Install the Azure CLI]( /cli/azure/install-azure-cli)
22+
If your environment meets the prerequisites and you're familiar with using ARM templates, select the **Deploy to Azure** button. The template will open in the Azure portal.
3023

24+
:::image type="content" source="../../media/template-deployments/deploy-to-azure.svg" alt-text="Screenshot of the Deploy to Azure button to deploy resources with a template." link="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.keyvault%2Fmanaged-hsm-create%2Fazuredeploy.json":::
3125

32-
[!INCLUDE [cloud-shell-try-it.md](../../../includes/cloud-shell-try-it.md)]
26+
## Prerequisites
3327

34-
## Sign in to Azure
28+
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
3529

36-
To sign in to Azure using the CLI, you can type:
30+
[!INCLUDE [Azure CLI prepare your environment](../../../includes/azure-cli-prepare-your-environment-no-header.md)]
3731

38-
```azurecli
39-
az login
40-
```
32+
## Review the template
4133

42-
For more information on login options via the CLI, see [sign in with Azure CLI](/cli/azure/authenticate-azure-cli)
34+
The template used in this quickstart is from [Azure Quickstart Templates](https://azure.microsoft.com/resources/templates/managed-hsm-create):
4335

44-
## Create a Managed HSM
36+
:::code language="json" source="~/quickstart-templates/quickstarts/microsoft.keyvault/managed-hsm-create/azuredeploy.json":::
4537

46-
The template used in this quickstart is from [Azure Quickstart templates](https://azure.microsoft.com/resources/templates/managed-hsm-create/).
38+
The Azure resource defined in the template is:
4739

48-
The Azure resource defined in the template:
40+
* **Microsoft.KeyVault/managedHSMs**: Create an Azure Key Vault Managed HSM.
4941

50-
* **Microsoft.KeyVault/managedHSMs**: create an Azure Key Vault Managed HSM.
51-
52-
More Azure Key Vault template samples can be found [here](https://azure.microsoft.com/resources/templates/?resourceType=Microsoft.Keyvault).
42+
## Deploy the template
5343

5444
The template requires the object ID associated with your account. To find it, use the Azure CLI [az ad user show](/cli/azure/ad/user#az-ad-user-show) command, passing your email address to the `--id` parameter. You can limit the output to the object ID only with the `--query` parameter.
5545

@@ -63,25 +53,42 @@ You may also need your tenant ID. To find it, use the Azure CLI [az ad user show
6353
az account show --query "tenantId"
6454
```
6555

66-
1. Select the following image to sign in to Azure and open a template. The template creates a Managed HSM.
56+
You can now deploy the ARM template:
6757

68-
<a href="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2F%2Fmaster%2Fquickstarts%2Fmicrosoft.keyvault%2Fmanaged-hsm-create%2Fazuredeploy.json"><img src="../media/deploy-to-azure.svg" alt="deploy to azure"/></a>
58+
1. Select the following image to sign in to Azure and open a template. The template creates a Managed HSM.
6959

70-
2. Select or enter the following values.
60+
:::image type="content" source="../../media/template-deployments/deploy-to-azure.svg" alt-text="Screenshot of the Deploy to Azure button to deploy resources with a template." link="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.keyvault%2Fmanaged-hsm-create%2Fazuredeploy.json":::
7161

72-
Unless it is specified, use the default value to create the Managed HSM.
62+
1. Select or enter the following values. Unless specified, use the default value to create the Managed HSM.
7363

7464
- **Subscription**: Select an Azure subscription.
75-
- **Resource group**: Select **Create new**, enter a unique name for the resource group, and then select **OK**.
65+
- **Resource group**: Select **Create new**, enter "myResourceGroup" as the name, and then select **OK**.
7666
- **Location**: Select a location. For example, **West US 3**.
7767
- **managedHSMName**: Enter a name for your Managed HSM.
78-
- **Tenant ID**: The template function automatically retrieves your tenant ID; don't change the default value. If there is no value, enter the Tenant ID that you retrieved in [Prerequisites](#prerequisites).
79-
* **initialAdminObjectIds**: Enter the Object ID that you retrieved in [Prerequisites](#prerequisites).
68+
- **Tenant ID**: The template function automatically retrieves your tenant ID; don't change the default value. If there is no value, enter the Tenant ID that you retrieved above.
69+
- **initialAdminObjectIds**: Enter the Object ID that you retrieved above.
8070

81-
3. Select **Purchase**. After the Managed HSM has been deployed successfully, you get a notification:
71+
1. Select **Purchase**. After the Managed HSM has been deployed successfully, you get a notification:
8272

8373
The Azure portal is used to deploy the template. In addition to the Azure portal, you can also use the Azure PowerShell, Azure CLI, and REST API. To learn other deployment methods, see [Deploy templates](../../azure-resource-manager/templates/deploy-powershell.md).
8474

75+
## Validate the deployment
76+
77+
You can verify that the managed HSM was created with the Azure CLI [az keyvault list](/cli/azure/keyvault#az-keyvault-list) command. You will find the output easier to read if you format the results as a table:
78+
79+
```azurecli-interactive
80+
az keyvault list -o table
81+
```
82+
83+
You should see the name of your newly created managed HSM.
84+
85+
## Clean up resources
86+
87+
[!INCLUDE [Delete resource group](../../../includes/cli-rg-delete.md)]
88+
89+
> [!WARNING]
90+
> Deleting the resource group puts the Managed HSM into a soft-deleted state. The Managed HSM will continue to be billed until it is purged. See [Managed HSM soft-delete and purge protection](recovery.md)
91+
8592
## Next steps
8693

8794
In this quickstart, you created a Managed HSM. This Managed HSM will not be fully functional until it is activated. See [Activate your Managed HSM](quick-create-cli.md#activate-your-managed-hsm) to learn how to activate your HSM.

articles/key-vault/managed-hsm/toc.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ items:
1313
href: quick-create-cli.md
1414
- name: PowerShell
1515
href: quick-create-powershell.md
16-
- name: Azure Resource Manager template
16+
- name: ARM template
17+
displayName: Resource Manager
1718
href: quick-create-template.md
1819

1920
- name: Tutorials

0 commit comments

Comments
 (0)