Add-VBRAzureRestoreProxy

Short Description

Creates a proxy appliance used for restoring workloads to Microsoft Azure.

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

Syntax

Add-VBRAzureRestoreProxy -Name <String> -Description <String> -MaxConcurrentTasks <Int32> -CredentialsId <Guid>

-TrafficPort <Int32> -Subscription <VBRAzureSubscription> -Location <VBRAzureLocation>

-VmSize <VBRAzureVMSize> -StorageAccount <VBRAzureStorageAccount> -ResourceGroup <VBRAzureResourceGroup>

-DnsNameLabel <String> -VirtualNetwork <VBRAzureVirtualNetwork> -VirtualSubnet <VBRAzureNetworkSubnet>

[-NetworkSecurityGroup <VBRNetworkSecurityGroup>] [-SkipNetworkSecurityGroup] [-Wait] [<CommonParameters>]

Detailed Description

This cmdlet creates a Windows-based proxy appliance. You can use this proxy appliance to restore Windows-based and Linux-based workloads to Microsoft Azure.

Note

When you specify a name of a restore proxy appliance, consider the following requirements:

The name must not be longer than 15 characters.
The name must contain only alphanumeric characters and hyphens.
The name must start with a letter and end with a letter or number.
The name must not contain only numeric characters.
The name must not contain special characters: `!@#$%^&()+=_\;:.'",<>/?.*

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
CredentialsId	Specifies credentials of a user that will be assigned the Local Administrator permissions on the restore proxy appliance. Note: You cannot use reserved names such as `administrator`, `admin`, `user`, `abc@123`, `P@$$w0rd` and so on as a user name and password of the local administrator account. You must specify the user name without a domain or Microsoft Azure machine name. The password must be at least 8 characters long, and must contain at least 1 uppercase character, 1 lowercase character, 1 numeric character and 1 special character.	`Guid`	True	Named	False
Description	Specifies a description for the restore proxy appliance.	`String`	True	Named	False
DnsNameLabel	Specifies a DNS name label for the public IP that will be created.	`String`	True	Named	False
Location	Specifies the geographic region to which you want to place the restore proxy appliance. Accepts the `VBRAzureLocation` object. To get this object, run the `Get-VBRAzureLocation` cmdlet.	`VBRAzureLocation`	True	Named	False
MaxConcurrentTasks	Specifies a number of concurrent tasks that the Azure restore proxy appliance must handle in parallel. Recommended value: 4 tasks.	`Int32`	True	Named	False
Name	Specifies a name for the restore proxy appliance.	`String`	True	Named	False
NetworkSecurityGroup	Specifies the network security group for the restore proxy appliance. If you do not specify a network security group, Veeam Backup & Replication will automatically create a new group, allow RDP and SSH on it and connect network interfaces to it. Accepts the `VBRNetworkSecurityGroup` object. To get this object, run the `Get-VBRAzureNetworkSecurityGroup` cmdlet.	`VBRNetworkSecurityGroup`	False	Named	False
ResourceGroup	Specifies the resource group to which the proxy appliance must be placed. Accepts the `VBRAzureResourceGroup` object. To get this object, run the `Get-VBRAzureResourceGroup` cmdlet.	`VBRAzureResourceGroup`	True	Named	False
SkipNetworkSecurityGroup	Defines that the cmdlet will not assign a network security group to the restore proxy appliance.	`SwitchParameter`	False	Named	False
StorageAccount	Specifies the storage account you want to use to deploy the restore proxy appliance VM. Accepts the `VBRAzureStorageAccount` object. To get this object, run the `Get-VBRAzureStorageAccount` cmdlet.	`VBRAzureStorageAccount`	True	Named	False
Subscription	Specifies the Microsoft Azure subscription whose resources you want to use to deploy the restore proxy appliance. Accepts the `VBRAzureSubscription` object. To create this object, run the `Get-VBRAzureSubscription` cmdlet.	`VBRAzureSubscription`	True	Named	False
TrafficPort	Specifies a port number. The cmdlet will use this port to control components installed on the restore proxy appliance and transport workload disks data to Blob storage. Default: 443.	`Int32`	True	Named	False
VirtualNetwork	Specifies a virtual network.	`VBRAzureVirtualNetwork`	True	Named	False
VirtualSubnet	Specifies the virtual network subnet to which you want to connect the restore proxy appliance. Accepts the `VBRAzureNetworkSubnet` object. To create this object, run the `Get-VBRAzureVirtualNetworkSubnet` cmdlet.	`VBRAzureNetworkSubnet`	True	Named	False
VmSize	Specifies the size for the proxy appliance VM. Accepts the `VBRAzureVMSize` object. To create this object, run the `Get-VBRAzureVMSize` cmdlet.	`VBRAzureVMSize`	True	Named	False
Wait	Defines that the command waits for the process to complete before accepting more input.	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRAzureRestoreProxy

Examples

Creating Microsoft Azure Restore Proxy Appliance

This example shows how to create a restore proxy appliance for restoring backups to Microsoft Azure VMs

$account = Get-VBRAzureAccount -Name "azcomputeaccount"

$subscription = Get-VBRAzureSubscription -Account $account -Name "ContosoProd"

$location = Get-VBRAzureLocation -Subscription $subscription -Name "westeurope"

$rg = Get-VBRAzureResourceGroup -Subscription $subscription -Name "azprx01-rg"

$storage = Get-VBRAzureStorageAccount -Subscription $subscription -Name "veeamstorage01"

$vnet = Get-VBRAzureVirtualNetwork -Subscription $subscription -Name "veeamvnet"

$subnet = Get-VBRAzureVirtualNetworkSubnet -Network $vnet -Name "default"

$vmSize = Get-VBRAzureVMSize -Subscription $subscription -Location $location -Name "Standard_F4s_v2"

$creds = Add-VBRCredentials -Type "Windows" -User "veeamadmin" -Password "P@ssw0rd!"

Add-VBRAzureRestoreProxy -Name "azprx01" -Description "Azure restore proxy appliance" -MaxConcurrentTasks 4 -CredentialsId $creds.Id -TrafficPort 443 -Subscription $subscription -Location $location -VmSize $vmSize -StorageAccount $storage -ResourceGroup $rg -DnsNameLabel "azprx01" -VirtualNetwork $vnet -VirtualSubnet $subnet -Wait

Perform the following steps:

Run the Get-VBRAzureAccount cmdlet. Specify the Name parameter value. Save the result to the $account variable.
Run the Get-VBRAzureSubscription cmdlet. Specify the Account and Name parameters value. Save the result to the $subscription variable.
Run the Get-VBRAzureLocation cmdlet. Specify the Subscription and Name parameters values. Save the result to the $location variable.
Run the Get-VBRAzureResourceGroup cmdlet. Specify the Subscription and Name parameters values. Save the result to the $rg variable.
Run the Get-VBRAzureStorageAccount cmdlet. Specify the ResourceGroup and Name parameters values. Save the result to the $storage variable.
Run the Get-VBRAzureVirtualNetwork cmdlet. Specify the ResourceGroup and Name parameters values. Save the result to the $vnet variable.
Run the Get-VBRAzureNetworkSubnet cmdlet. Specify the VirtualNetwork and Name parameters values. Save the result to the $subnet variable.
Run the Get-VBRAzureVMSize cmdlet. Specify the Subscription, Location and Name parameters values. Save the result to the $vmSize variable.
Run the Add-VBRCredentials cmdlet. Specify the Type, User, and Password parameter values. Save the result to the $cred variable.
Run the Add-VBRAzureRestoreProxy cmdlet. Specify the following settings:
- Specify the Name parameter value.
- Specify the Description parameter value.
- Specify the MaxConcurrentTasks parameter value.
- Set the $creds.Id as the CredentialsId parameter value.
- Specify the TrafficPort parameter value.
- Set the $subscription as the Subscription parameter value.
- Set the $location as the Location parameter value.
- Set the $vmSize as the VmSize parameter value.
- Set the $storage as the StorageAccount parameter value.
- Set the $rg as the ResourceGroup parameter value.
- Specify the DnsNameLabel parameter value.
- Set the $vnet as the VirtualNetwork parameter value.
- Set the $subnet as the VirtualSubnet parameter value.
- Provide the Wait parameter.