Get-VBRAzureLinuxRestoreAppliance

In this article

    Short Description

    Returns helper appliances for restoring Linux VMs to Microsoft Azure.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    This cmdlet provides 3 parameter sets.

    • For looking for all helper appliances:

    Get-VBRAzureLinuxRestoreAppliance  [<CommonParameters>]

    • For looking for helper appliances by ID:

    Get-VBRAzureLinuxRestoreAppliance [-Id <guid[]>]  [<CommonParameters>]

    • For looking for helper appliances associated with a particular account:

    Get-VBRAzureLinuxRestoreAppliance [-Account <VBRAzureAccount>]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns helper appliances for restoring Linux VMs to Microsoft Azure.

    Important

    This cmdlet does not support Microsoft Azure accounts with the Azure Service Manager type of a subscription (ASM, also known as a "classic" type subscription).

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Id

    Specifies the ID of the helper appliance you want to get.

    False

    Named

    False

    False

    Account

    Specifies the account. The cmdlet will return helper appliances associated with this account.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Return Type

    VBRAzureLinuxRestoreAppliance

    Example 1

    This command returns all Linux VM restore helper appliances.

    Get-VBRAzureLinuxRestoreAppliance

    Example 2

    This example shows how to get a Linux VM restore helper appliance created for a Microsoft Azure account:

    1. Get the Microsoft Azure account: run Get-VBRAzureAccount and save the result to the $account variable.
    2. Run Get-VBRAzureLinuxRestoreAppliance with the $account variable. Pass the result to the Select-Object cmdlet to select the first helper appliance in the list.

    $account = Get-VBRAzureAccount -Type ResourceManager -Name "RestoreToAzureRM@Veeam.com"

    Get-VBRAzureLinuxRestoreAppliance -Account $account | Select-Object -First 1

    Related Commands

    Get-VBRAzureAccount

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.