Edit

Restore for disconnected operations for Azure Local

Important

The restore operation supports restoring the backup to the same version of Azure Local disconnected environment.

This article explains the restore process for disconnected operations for Azure Local environments. It provides practical steps to trigger a restore and parameter configurations to customize it. Operators need access to the Operator subscription and role-based access control (RBAC) permissions.

For more information, see Disconnected operations for Azure Local.

Tip

Restore disconnected operations for Azure Local before cloud deployment on the new instance to avoid repair registration of the management cluster. If you restore on the same instance as the backup, you can run the restore after cloud deployment. In that case, follow the management cluster rehydration sequence to re-register the management cluster. For the recommended end-to-end order, see Post-restore rehydration overview for disconnected operations.

Overview

The backup feature currently backs up only the control plane VM data. It doesn't include associated workloads or configured clusters. The restore functionality restores the control plane data from the backup. So, ensure that you configure the same version of Azure Local disconnected where you restore the backup.

Why back up and restore operations?

Backup capability is critical because the Azure Local with disconnected operations virtual machine (VM) acts as the control plane. It stores authoritative metadata for subscriptions, resource groups, policies, and connected Azure Local resources. Any corruption or loss of this control plane disrupts the entire environment. Regular backups protect against catastrophic failures, infrastructure loss, or misconfigurations by capturing the control plane state at specific points in time. The restore functionality helps return your environment to its state at the time of the backup.

Prerequisites

Before you restore your system, complete these prerequisites:

  • Operator access: Ensure your identity has the required OperatorRP RBAC role in the Operator subscription.

  • Environment Setup: Ensure that you have a fresh Azure Local Disconnected environment that you set up and that the version matches the backup version. Cross-version restores aren't supported.

  • Root Certificate: For the restore VM, ensure that the new VM uses the same root certificate authority (CA) to maintain trust.

  • Server Message Block (SMB) share: Ensure the SMB share that stores the backup file is accessible from the new environment.

  • Decryption key: Ensure the decryption key that you stored externally is available. You need to provide it during the restore process.

  • Import restore module (required): Before you run any restore cmdlets, import the restore module from your Operations Module by using its full path:

    # Import the restore cmdlets from the Operations Module (use the full path on your system)
    Import-Module "<full path to Operations Module>\Azure.Local.Restore.psm1"
    

Trigger and monitor a restore

To trigger the restore, open an administrator PowerShell session and invoke the restore operation by passing the requested parameters. This operation initiates the restore process, which runs in the background.

To trigger and monitor the restore, follow these steps:

  1. Trigger the restore operation.

    Start-ApplianceRestore
    

    Here's an example output:

    Screenshot of the Start-ApplianceRestore command output.

  2. Track the restore status until it completes, where status refreshes every 30 seconds.

    Wait-ApplianceRestore
    

    Here's an example output:

    Screenshot of Wait-ApplianceRestore command output.

  3. Restore Completion - After a few hours, the restore operation completes. You can check the status by using the following command:

    Get-ApplianceRestore 
    

    Here's an example output:

    Screenshot of the Get-ApplianceRestore command output.

Post restore environment mismatch

Important

Before you initiate a restore, the backup state and the current environment state might have differences in the workload state of the control plane data. The restore operation can cause a drift in the resource metadata.

Next steps

This feature is available only in Azure Local 2603 or later.