New-VBRAzureApplianceTemplateDeploymentOptions

Short Description

Defines deployment options for a helper appliance template.

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

Syntax

This cmdlet provides the following parameter sets:

Template (Default)

New-VBRAzureApplianceTemplateDeploymentOptions -Template <VBRAzureApplianceTemplate>

[-ResourceGroup <VBRAzureResourceGroup>] [-StorageAccount <VBRAzureStorageAccount>]

[-VirtualNetwork <VBRAzureVirtualNetwork>] [-NetworkSubnet <VBRAzureNetworkSubnet>] [-Tags <VBRAzureTag[]>] [<CommonParameters>]

SubscriptionLocation

New-VBRAzureApplianceTemplateDeploymentOptions -Subscription <VBRAzureSubscription>

-Location <VBRAzureLocation> [-ResourceGroup <VBRAzureResourceGroup>]

[-StorageAccount <VBRAzureStorageAccount>] [-VirtualNetwork <VBRAzureVirtualNetwork>]

[-NetworkSubnet <VBRAzureNetworkSubnet>] [-Tags <VBRAzureTag[]>] [<CommonParameters>]

Detailed Description

This cmdlet creates the object that defines options for a helper appliance template.

You can create a completely new template by specifying Subscription and Location parameters. Alternatively, you create a template basing on options of a template existing in the same Azure region by specifying the Template parameter. To specify other options for the new template, use the StorageAccount, VirtualNetwork and other parameters.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Location	Specifies the Microsoft Azure region where you want to deploy the template. Accepts the `VBRAzureLocation` object. To get this object, run the `Get-VBRAzureLocation` cmdlet.	`VBRAzureLocation`	True	Named	True (ByPropertyName)
NetworkSubnet	Specifies a virtual network subnet. The cmdlet will use this virtual network subnet for template creation. If you do not specify this parameter, the cmdlet creates a virtual network subnet. This subnet will be deleted after the template is deployed. Accepts the `VBRAzureNetworkSubnet` object. To get this object, run the `Get-VBRAzureVirtualNetworkSubnet` cmdlet.	`VBRAzureNetworkSubnet`	False	Named	True (ByPropertyName)
ResourceGroup	Specifies the resource group where you want to deploy the template. If you do not specify this parameter, the cmdlet creates a resource group automatically. Accepts the `VBRAzureResourceGroup` object. To get this object, run the `Get-VBRAzureResourceGroup` cmdlet.	`VBRAzureResourceGroup`	False	Named	True (ByPropertyName)
StorageAccount	Specifies a storage account. The cmdlet will use this storage account to load services and components required for template creation. If you do not specify this parameter, the cmdlet creates a storage account. This account will be deleted after the template is deployed. Accepts the `VBRAzureStorageAccount` object. To get this object, run the `Get-VBRAzureStorageAccount` cmdlet.	`VBRAzureStorageAccount`	False	Named	True (ByPropertyName)
Subscription	Specifies the Microsoft Azure subscription where you want to deploy the template. Accepts the `VBRAzureSubscription` object. To get this object, run the `Get-VBRAzureSubscription` cmdlet.	`VBRAzureSubscription`	True	Named	True (ByPropertyName)
Tags	Specifies tags that you want to assign to the template. Accepts the `VBRAzureTag[]` object. To create this object, run the `New-VBRAzureTag` cmdlet.	`VBRAzureTag[]`	False	Named	False
Template	Specifies a helper appliance template existing in the same Azure region. The cmdlet will modify settings of this helper appliance template and will deploy a new helper appliance template. Accepts the `VBRAzureApplianceTemplate` object. To get this object, run the `Get-VBRAzureApplianceTemplate` cmdlet.	`VBRAzureApplianceTemplate`	True	Named	True (ByPropertyName)
VirtualNetwork	Specifies a virtual network. The cmdlet will use this virtual network for template creation. If you do not specify this parameter, the cmdlet creates a virtual network. This network will be deleted after the template is deployed. Accepts the `VBRAzureVirtualNetwork` object. To get this object, run the `Get-VBRAzureVirtualNetwork` cmdlet.	`VBRAzureVirtualNetwork`	False	Named	True (ByPropertyName)

<CommonParameters>

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

Output Object

VBRAzureApplianceTemplateDeploymentOptions

Examples

Example 1. Defining Helper Appliance Template Deployment Options

This example shows how to define helper appliance template options.

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

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

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

$templateOpt = New-VBRAzureApplianceTemplateDeploymentOptions -Subscription $subscription -Location $location

Perform the following steps:

Run the Get-VBRAzureAccount cmdlet. Set the ResourceManager value as the Type parameter value. Specify the Name parameter value. Save it to the $account variable.
Run the Get-VBRAzureSubscription cmdlet. Set the $account variable as the Account parameter value. Specify the Name parameter value. Save it to the $subscription variable.
Run the Get-VBRAzureLocation cmdlet. Set the $subscription variable as the Subscription parameter value. Specify the Name parameter value. Save it to the $location variable.
Run the New-VBRAzureApplianceTemplateDeploymentOptions cmdlet. Set the $subscription variable as the Subscription parameter value. Set the $location variable as the Location parameter value. Save it to the $templateOpt variable.