Skip to content

Commit 68ef820

Browse files
Merge pull request #2669 from msmbaldwin/security-docsets-placeholders
Fix Acrolinx issues in access-payshield-manager-ssh.md
2 parents 6c33f1f + 53ebda5 commit 68ef820

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

articles/payment-hsm/access-payshield-manager-ssh.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
---
2-
title: Access the payShield manager for your Azure Payment HSM
3-
description: Access the payShield manager for your Azure Payment HSM
2+
title: Use SSH to access the payShield manager for your payment HSM
3+
description: Learn how to use SSH to access the payShield manager for your Azure Payment HSM.
44
services: payment-hsm
55
ms.service: azure-payment-hsm
66
author: msmbaldwin
77
ms.author: mbaldwin
8-
ms.topic: quickstart
8+
ms.topic: tutorial
99
ms.devlang: azurecli
1010
ms.custom: devx-track-azurecli, devx-track-azurepowershell, sfi-image-nochange
1111
ms.date: 04/10/2025
1212
---
1313

1414
# Tutorial: Use SSH to access the payShield manager for your payment HSM
1515

16-
After you [Create an Azure Payment HSM](create-payment-hsm.md), you can create a virtual machine on the same virtual network and use it to access the Thales payShield manager.
16+
After you [create an Azure Payment HSM](create-payment-hsm.md), you can create a virtual machine on the same virtual network and use it to access the Thales payShield manager.
1717

1818
In this tutorial, you learn how to:
1919

2020
> [!div class="checklist"]
2121
> * Create a subnet for your virtual machine
2222
> * Create a virtual machine
23-
> * Test Connectivity to your VM, and from the VM to your payment HSM
24-
> * Log into the VM to access the payShield manager
23+
> * Test connectivity to your VM, and from the VM to your payment HSM
24+
> * Log in to the VM to access the payShield manager
2525
26-
To complete this tutorial you need:
26+
To complete this tutorial, you need:
2727

2828
- The name of your payment HSM's virtual network.
2929
- The address space of your virtual network (for example, "10.0.0.0/16").
@@ -32,7 +32,7 @@ To complete this tutorial you need:
3232

3333
# [Azure CLI](#tab/azure-cli)
3434

35-
Create a subnet for your virtual machine, on the same virtual network as your payment HSM, using the Azure CLI [az network vnet subnet create](/cli/azure/network/vnet/subnet#az-network-vnet-subnet-create) command. You must provide a value to the--address-prefixes argument that falls within the VNet's address space, but differs from the payment HSM subnet addresses.
35+
Create a subnet for your virtual machine, on the same virtual network as your payment HSM, using the Azure CLI [az network vnet subnet create](/cli/azure/network/vnet/subnet#az-network-vnet-subnet-create) command. You must provide a value to the `--address-prefixes` argument that falls within the VNet's address space, but differs from the payment HSM subnet addresses.
3636

3737
```azurecli-interactive
3838
az network vnet subnet create -g "<resource-group>" --vnet-name "<vnet-name>" -n "<vm-subnet-name>" --address-prefixes "10.0.1.0/24"
@@ -52,7 +52,7 @@ First, save the details of your VNet to a variable using the Azure PowerShell [G
5252
$vnet = Get-AzVirtualNetwork -Name "<vnet-name>" -ResourceGroupName "<resource-group>"
5353
```
5454

55-
Next, configure a subnet for your virtual machine, on the same virtual network as your payment HSM, using the Azure PowerShell [New-AzVirtualNetworkSubnetConfig](/powershell/module/az.network/new-azvirtualnetworksubnetconfig) command. You must provide a value to the `--address-prefixes` argument that falls within the VNet's address space, but differs from the payment HSM subnet addresses.
55+
Next, configure a subnet for your virtual machine, on the same virtual network as your payment HSM, using the Azure PowerShell [New-AzVirtualNetworkSubnetConfig](/powershell/module/az.network/new-azvirtualnetworksubnetconfig) command. You must provide a value to the `-AddressPrefix` argument that falls within the VNet's address space, but differs from the payment HSM subnet addresses.
5656

5757
```azurepowershell-interactive
5858
$vmSubnet = New-AzVirtualNetworkSubnetConfig -Name "<vm-subnet-name>" -AddressPrefix "10.0.1.0/24"
@@ -82,7 +82,7 @@ Create your VM subnet using either Azure CLI or Azure PowerShell. You can use th
8282

8383
# [Azure CLI](#tab/azure-cli)
8484

85-
Create a VM on your new subnet, using the Azure CLI [az vm create](/cli/azure/vm#az-vm-create) command. (In this example we create a Linux VM, but you could also create a Windows VM by augmenting the instructions found at [Create a Windows virtual machine with the Azure CLI](/azure/virtual-machines/windows/quick-create-cli).)
85+
Create a VM on your new subnet, using the Azure CLI [az vm create](/cli/azure/vm#az-vm-create) command. This example creates a Linux VM, but you can also create a Windows VM by augmenting the instructions found at [Create a Windows virtual machine with the Azure CLI](/azure/virtual-machines/windows/quick-create-cli).
8686

8787
```azurecli-interactive
8888
az vm create \
@@ -95,17 +95,17 @@ az vm create \
9595
--generate-ssh-keys
9696
```
9797

98-
Make a note of where the public SSH key is saved, and the value for "publicIpAddress".
98+
Note where the public SSH key is saved, and the value for "publicIpAddress".
9999

100100
# [Azure PowerShell](#tab/azure-powershell)
101101

102-
To create a VM on your new subnet, first set your credentials with the [Get-Credential](/powershell/module/microsoft.powershell.security/get-credential) cmdlet. Provide a username of "azureuser" and a password of your choice, saving the object as $cred.
102+
To create a VM on your new subnet, first set your credentials with the [Get-Credential](/powershell/module/microsoft.powershell.security/get-credential) cmdlet. Provide a username of "azureuser" and a password of your choice, and save the object as $cred.
103103

104104
```azurepowershell-interactive
105105
$cred = Get-Credential
106106
```
107107

108-
Now create your VM using the Azure PowerShell [New-AzVm](/powershell/module/az.compute/new-azvm) command. (In this example we create a Linux VM, but you could also create a Windows VM by augmenting the instructions found at [Create a Windows virtual machine with the Azure PowerShell](/azure/virtual-machines/windows/quick-create-powershell).)
108+
Next, create your VM using the Azure PowerShell [New-AzVm](/powershell/module/az.compute/new-azvm) command. This example creates a Linux VM, but you can also create a Windows VM by augmenting the instructions found at [Create a Windows virtual machine with the Azure PowerShell](/azure/virtual-machines/windows/quick-create-powershell).
109109

110110
```azurepowershell-interactive
111111
New-AzVm `
@@ -122,7 +122,7 @@ New-AzVm `
122122
-SshKeyName "myVM_key"
123123
```
124124

125-
Make a note of where the private SSH key is saved, and the value for "FullyQualifiedDomainName".
125+
Note where the private SSH key is saved, and the value for "FullyQualifiedDomainName".
126126

127127
# [Portal](#tab/azure-portal)
128128

@@ -142,16 +142,16 @@ To create a VM on your new subnet:
142142

143143
## Test connectivity
144144

145-
To access connectivity to your virtual machine, and from your VM to the management NIC IP (10.0.0.4) and host NIC IP, SSH into your VM. Connect to either the public IP address (for example, [email protected]) or the fully qualified domain name (for example, [email protected])
145+
To test connectivity to your virtual machine, and from your VM to the management NIC IP (10.0.0.4) and host NIC IP, SSH into your VM. Connect to either the public IP address (for example, [email protected]) or the fully qualified domain name (for example, [email protected])
146146

147147
> [!NOTE]
148-
> If created your VM using Azure PowerShell, the Azure portal, or if you did not ask Azure CLI to autogenerate ssh keys when you created the VM, you must supply the private key to the ssh command using the `-i` flag (for example, `ssh -i "path/to/sshkey" azureuser@<publicIpAddress-or-FullyQualifiedDomainName>`). The private key **must** be protected ("chmod 400 myVM_key.pem").
148+
> If you created your VM using Azure PowerShell, the Azure portal, or if you didn't ask Azure CLI to autogenerate SSH keys when you created the VM, you must supply the private key to the SSH command using the `-i` flag (for example, `ssh -i "path/to/sshkey" azureuser@<publicIpAddress-or-FullyQualifiedDomainName>`). The private key **must** be protected ("chmod 400 myVM_key.pem").
149149
150150
```bash
151151
ssh azureuser@<publicIpAddress-or-FullyQualifiedDomainName>
152152
```
153153

154-
If ssh hangs or refuses the connection, review your NSG rules to ensure that you are able to connect to your VM.
154+
If SSH hangs or refuses the connection, review your NSG rules to ensure that you can connect to your VM.
155155

156156
If the connection is successful, you should be able to ping both the management NIC IP (10.0.0.4) and the host NIC IP (10.0.0.5) from your VM:
157157

@@ -191,15 +191,15 @@ For example, if you used "10.0.0.0" as the address prefix for your Payment HSM s
191191
ssh -L 44300:10.0.0.5:443 azureuser@<publicIpAddress-or-FullyQualifiedDomainName>
192192
```
193193

194-
Now go to a browser on your local machine and open `https://localhost:44300` to access the payShield manager.
194+
Open a browser on your local machine and go to `https://localhost:44300` to access the payShield manager.
195195

196196
:::image type="content" source="./media/payshield-manager.png" alt-text="Screenshot of the payShield manager for Azure Payment HSM.":::
197197

198-
Here you can commission the device, install or generate LMKs, test the API, and so on. Follow payShield documentation, and contact Thales support if any issues related to payShield commission, setup, and API testing.
198+
From the payShield manager, you can commission the device, install or generate LMKs, and test the API. Follow payShield documentation, and contact Thales support for any issues related to payShield commission, setup, and API testing.
199199

200200
## Next steps
201201

202-
Advance to the next article to learn how to remove a commissioned payment HSM through the payShield manager.
202+
Learn how to remove a commissioned payment HSM through the payShield manager.
203203
> [!div class="nextstepaction"]
204204
> [Remove a commissioned payment HSM](remove-payment-hsm.md)
205205

0 commit comments

Comments
 (0)