Skip to content

Commit 98b8358

Browse files
Addressed pre-review comments
1 parent fb3cef9 commit 98b8358

File tree

4 files changed

+23
-24
lines changed

4 files changed

+23
-24
lines changed
20.4 KB
Loading
41.5 KB
Loading
25 Bytes
Loading

articles/backup/save-backup-passphrase-securely-in-azure-key-vault.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
title: Save and manage MARS agent passphrase securely in Azure Key Vault (preview)
33
description: Learn how to save MARS agent passphrase securely in Azure Key Vault and retrieve them during restore.
4-
ms.topic: conceptual
4+
ms.topic: how-to
55
ms.date: 08/18/2023
6-
ms.custom: how-to_regions
7-
ms.reviewer: sharrai
6+
ms.reviewer: sooryar
87
ms.service: backup
98
author: AbhishekMallick-MS
109
ms.author: v-abhmallick
@@ -39,7 +38,7 @@ To configure a vault, follow these steps in the given sequence to achieve the in
3938
3. Enable soft-delete and purge protection on the Azure Key Vault.
4039

4140
>[!Note]
42-
>- Once you enable this feature, you must not disable the managed identity (even temporarily). Disabling the managed identity may lead to inconsistent behaviour.
41+
>- Once you enable this feature, you must not disable the managed identity (even temporarily). Disabling the managed identity may lead to inconsistent behavior.
4342
>- User-assigned managed identity is currently not supported for saving passphrase in Azure Key Vault.
4443
4544

@@ -53,7 +52,7 @@ Follow these steps:
5352

5453
1. Go to your *Recovery Services vault* > **Identity**.
5554

56-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/recovery-services-vault-identity.png" alt-text="Screenshot shows how to go to Identity in Recovery Services vault.":::
55+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/recovery-services-vault-identity.png" alt-text="Screenshot shows how to go to Identity in Recovery Services vault." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/recovery-services-vault-identity.png":::
5756

5857
2. Select the **System assigned** tab.
5958
3. Change the **Status** to **On**.
@@ -123,7 +122,7 @@ To assign the permissions, follow these steps:
123122

124123
You can select a *built-in role* such as **Key Vault Secrets Officer** that has the permission (along with other permissions not required for this feature) or [create a custom role](../key-vault/general/rbac-guide.md?tabs=azurepowershell#creating-custom-roles) with only Set permission on Secret.
125124

126-
Select **Details** to view the permissions granted by the role and ensure Set permission on Secret is available.
125+
Select **Details** to view the permissions granted by the role and ensure Set permission on Secret is available.
127126

128127
4. Select **Next** to proceed to select Members for assignment.
129128

@@ -179,25 +178,25 @@ Follow these steps:
179178

180179
1. Go to your *Azure Key Vault* > **Access Policies** > **Access policies**, and then select **+ Create**.
181180

182-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/create-access-policies.png" alt-text="Screenshot shows how to start creating a Key Vault.":::
181+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/create-access-policies.png" alt-text="Screenshot shows how to start creating a Key Vault." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/create-access-policies.png":::
183182

184183
2. Under **Secret Permissions**, select **Set operation**.
185184

186185
This specifies the allowed actions on the Secret.
187186

188-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/set-secret-permissions.png" alt-text="Screenshot shows how to start setting permissions.":::
187+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/set-secret-permissions.png" alt-text="Screenshot shows how to start setting permissions." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/set-secret-permissions.png":::
189188

190189
3. Go to **Select Principal** and search for your *vault* in the search box using its name or managed identity.
191190

192191
Select the *vault* from the search result and choose **Select**.
193192

194-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/assign-principal.png" alt-text="Screenshot shows the assignment of permission to a selected vault.":::
193+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/assign-principal.png" alt-text="Screenshot shows the assignment of permission to a selected vault." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/assign-principal.png":::
195194

196195
4. Go to **Review + create**, ensure that **Set permission** is available and **Principal** is the correct *Recovery Services vault*, and then select **Create**.
197196

198-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/review-and-create-access-policy.png" alt-text="Screenshot shows the verification of the assigned Recovery Services vault and create the Key Vault.":::
197+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/review-and-create-access-policy.png" alt-text="Screenshot shows the verification of the assigned Recovery Services vault and create the Key Vault." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/review-and-create-access-policy.png":::
199198

200-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/check-access-policies.png" alt-text="Screenshot shows how to verify the access present.":::
199+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/check-access-policies.png" alt-text="Screenshot shows how to verify the access present." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/check-access-policies.png":::
201200

202201

203202
# [PowerShell](#tab/powershell)
@@ -239,7 +238,7 @@ You can enable soft-delete and purge protection from the Azure Key Vault.
239238

240239
Alternatively, you can set these properties while creating the Key Vault. [Learn more](../key-vault/general/soft-delete-overview.md) about these Key Vault properties.
241240

242-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/enable-soft-delete-and-purge-protection.png" alt-text="Screenshot shows how to enable spft-delete.":::
241+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/enable-soft-delete-and-purge-protection.png" alt-text="Screenshot shows how to enable spft-delete." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/enable-soft-delete-and-purge-protection.png":::
243242

244243
# [PowerShell](#tab/powershell)
245244

@@ -314,20 +313,20 @@ Before proceeding to install the MARS agent, ensure that you have [configured t
314313

315314
2. After providing the *Recovery Services vault credentials* during registration, in the **Encryption Setting**, select the option to save the passphrase to Azure Key Vault.
316315

317-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/save-passphrase.png" alt-text="Screenshot shows the option to save the passphrase to Azure Key Vault to be selected.":::
316+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/save-passphrase.png" alt-text="Screenshot shows the option to save the passphrase to Azure Key Vault to be selected." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/save-passphrase.png":::
318317

319318
3. Enter your *passphrase* or select **Generate Passphrase**.
320319
4. In the *Azure portal*, open your *Key Vault*, copy the *Key Vault URI*.
321320

322-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/copy-key-vault-url.png" alt-text="Screenshot shows how to copy the Key Vault URI.":::
321+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/copy-key-vault-url.png" alt-text="Screenshot shows how to copy the Key Vault URI." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/copy-key-vault-url.png":::
323322

324323
5. Paste the *Key Vault URI* in the *MARS console*, and then select **Register**.
325324

326325
If you encounter an error, [check the troubleshooting section](#troubleshoot-common-scenarios) for more information.
327326

328327
6. Once the registration succeeds, the option to *copy the identifier to the Secret* is created and the passphrase is NOT saved to a file locally.
329328

330-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/server-registration-success.png" alt-text="Screenshot shows the option to copy the identifier to the Secret gets creates.":::
329+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/server-registration-success.png" alt-text="Screenshot shows the option to copy the identifier to the Secret gets creates." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/server-registration-success.png":::
331330

332331
If you change the passphrase in the future for this MARS agent, a new version of the Secret will be added with the latest passphrase.
333332

@@ -352,26 +351,26 @@ To save the passphrase to Key Vault:
352351

353352
Alternatively, select **Change Properties** > **Change Passphrase** to proceed.
354353

355-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/save-passphrase-key-vault.png" alt-text="Screenshot shows how to start changing passphrase for an existing MARS installation.":::
354+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/save-passphrase-key-vault.png" alt-text="Screenshot shows how to start changing passphrase for an existing MARS installation." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/save-passphrase-key-vault.png":::
356355

357356
2. In the **Change Properties** dialog box, the option to *save passphrase to Key Vault by providing a Key Vault URI* appears.
358357

359358
>[!Note]
360359
>If the machine is already configured to save passphrase to Key Vault, the Key Vault URI will be populated in the text box automatically.
361360
362-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/enter-key-vault-url.png" alt-text="Screenshot shows the option to save passphrase to Key Vault by providing a Key Vault URI gets generated.":::
361+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/enter-key-vault-url.png" alt-text="Screenshot shows the option to save passphrase to Key Vault by providing a Key Vault URI gets generated." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/enter-key-vault-url.png":::
363362

364363
3. Open the *Azure portal*, open your *Key Vault*, and then *copy the Key Vault URI*.
365364

366-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/copy-key-vault-url.png" alt-text="Screenshot shows how to copy the Key Vault URI.":::
365+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/copy-key-vault-url.png" alt-text="Screenshot shows how to copy the Key Vault URI." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/copy-key-vault-url.png":::
367366

368367
4. *Paste the Key Vault URI* in the *MARS console*, and then select **OK**.
369368

370369
If you encounter an error, [check the troubleshooting section](#troubleshoot-common-scenarios) for more information.
371370

372371
5. Once the change passphrase operation succeeds, an option to *copy the identifier to the Secret* gets created and the passphrase is NOT saved to a file locally.
373372

374-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/passphrase-saved-to-key-vault.png" alt-text="Screenshot shows an option to copy the identifier to the Secret gets created.":::
373+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/passphrase-saved-to-key-vault.png" alt-text="Screenshot shows an option to copy the identifier to the Secret gets created." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/passphrase-saved-to-key-vault.png":::
375374

376375
If you change the passphrase in the future for this MARS agent, a new version of the *Secret* will be added with the latest passphrase.
377376

@@ -391,13 +390,13 @@ To locate the machine’s passphrase:
391390

392391
2. Select **Secrets** and search for the secret named `AzBackup-<machine name>-<vaultname>`.
393392

394-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/locate-passphrase.png" alt-text="Screenshot shows bow to check for the secret name.":::
393+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/locate-passphrase.png" alt-text="Screenshot shows bow to check for the secret name." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/locate-passphrase.png":::
395394

396395
3. Select the **Secret**, open the latest version and *copy the value of the Secret*.
397396

398397
This is the passphrase of the machine to be used during recovery.
399398

400-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/copy-passphrase-from-secret.png" alt-text="Screenshot shows selection of the secret.":::
399+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/copy-passphrase-from-secret.png" alt-text="Screenshot shows selection of the secret." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/copy-passphrase-from-secret.png":::
401400

402401
If you have a large number of Secrets in the Key Vault, use the Key Vault CLI to list and search for the secret.
403402

@@ -426,7 +425,7 @@ This section lists commonly encountered errors when saving the passphrase to Azu
426425
2. Ensure that the Key Vault URI corresponds to the intended Key Vault.
427426
3. Ensure that the Recovery Services vault name is listed under Key Vault -> Access policies -> Application, with Secret Permissions as Set.
428427

429-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/check-secret-permissions-is-set.png" alt-text="Screenshot shows the Recovery Services vault name is listed under Key Vault.":::
428+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/check-secret-permissions-is-set.png" alt-text="Screenshot shows the Recovery Services vault name is listed under Key Vault." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/check-secret-permissions-is-set.png":::
430429

431430
If it's not listed, [configure the permission again](#assign-permissions-to-save-the-passphrase-in-azure-key-vault).
432431

@@ -436,15 +435,15 @@ This section lists commonly encountered errors when saving the passphrase to Azu
436435

437436
**Recommended action**: Ensure that you have entered a Key Vault URI copied from the Azure portal. For example, `https://myvault.vault.azure.net/`.
438437

439-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/copy-key-vault-url.png" alt-text="Screenshot shows how to copy Kay Vault URL.":::
438+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/copy-key-vault-url.png" alt-text="Screenshot shows how to copy Kay Vault URL." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/copy-key-vault-url.png":::
440439

441440
### Registration is incomplete
442441

443442
**Cause**: You didn't complete the MARS registration by registering the passphrase. So, you'll not be able to configure backups until you register.
444443

445444
**Recommended action**: Select the warning message and complete the registration.
446445

447-
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/registration-incomplete-warning.png" alt-text="Screenshot shows how to complete the registration.":::
446+
:::image type="content" source="./media/save-backup-passphrase-securely-in-azure-key-vault/registration-incomplete-warning.png" alt-text="Screenshot shows how to complete the registration." lightbox="./media/save-backup-passphrase-securely-in-azure-key-vault/registration-incomplete-warning.png":::
448447

449448

450449

0 commit comments

Comments
 (0)