New-VBRAzureContainer

Short Description

Defines a scope of Azure VMs, Azure tags or Azure Availability Zone for a protection group.

Applies to

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

Syntax

New-VBRAzureContainer -Subscription <VBRAzureSubscription> -Location <VBRAzureLocation> -Entity <Object[]> [-ExcludeEntities] [-ExcludedEntity <Object[]>]  [<CommonParameters>]

Detailed Description

This cmdlet defines the VBRAzureContainer object. This object contains a scope of Azure VMs, Azure tags or Azure Availability Zone for a protection group.

Use this object to create a protection group with the Add-VBRProtectionGroup cmdlet. After you create a protection group, Veeam Backup & Replication will deploy Veeam Agent on Azure VMs, Azure tags or Azure Availability Zone added to the scope of the protection group.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Subscription

Specifies subscriptions associated with a Microsoft Azure account.

Accepts the VBRAzureSubscription object. To create this object, run the Get-VBRAzureSubscription cmdlet.

True

Named

True (ByValue, ByPropertyName)

Location

Specifies Microsoft Azure region.

Accepts the VBRAzureLocation object. To get this object, run the Get-VBRAzureLocation cmdlet.

True

Named

True (ByValue, ByPropertyName)

Entity

Specifies an array of the following entities that the cmdlet till add to a scope of a protection group:

  • Azure VMs.
  • Azure tags.
  • Azure Availability Zone.

Accepts the Object[] object. To get this object, run the following  cmdlets:

True

Named

True (ByValue, ByPropertyName)

ExcludeEntities

Specifies an array of the following entities that the cmdlet will exclude from a scope of a protection group:

  • Azure VMs.
  • Azure tags.
  • Azure Availability Zone.

SwitchParameter

False

Named

True (ByValue, ByPropertyName)

ExcludedEntity

Specifies an array of the following entities that the cmdlet will exclude from a scope of a protection group:

  • Azure VMs.
  • Azure tags.
  • Azure Availability Zone.

Accepts the Object[] object. To get this object, run the following  cmdlets:

False

Named

True (ByValue, ByPropertyName)

<CommonParameters>

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

Output Object

VBRAzureContainer

Examples

Defining Scope of Azure VMs for Protection Group

This example shows how to define the scope of Azure VMs to add them to a protection group.

$account = Get-VBRAzureAccount -Type ResourceManager -Name "AzureRM@tech.com"

$subscription = Get-VBRAzureSubscription -Account $account

$location = Get-VBRAzureLocation -Subscription $subscription

$VMs = Get-VBRAzureVM -Subscription $subscription -Location $location

$scope = New-VBRAzureContainer -Subscription $subscription -Location $location -Entity $VMs

Perform the following steps:

  1. Run the Get-VBRAzureAccount cmdlet. Specify the Type and the Name parameter values. Save the result to the $account variable.
  2. Run the Get-VBRAzureSubscription cmdlet. Set the $account variable as the Account parameter value. Save the result to the $subscription variable.
  3. Run the Get-VBRAzureLocation cmdlet. Set the $subscription variable as the Subscription parameter value. Save the result to the $location variable.
  4. Run the Get-VBRAzureVM cmdlet. Specify the Subscription and the Location parameter values. Save the result to the $VMs variable.
  5. Run the New-VBRAzureContainer cmdlet. Set the $subscription variable as the Subscription parameter value. Set the $location variable as the Location parameter value. Set the $VMs variable as the Entity parameter value. Save the result to the $scope variable.

Related Commands