Add-VBRAzureArchiveRepository

Short Description

Adds Azure Archive repository to the backup infrastructure.

Platform: VMware, Hyper-V

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

Syntax

Add-VBRAzureArchiveRepository -Connection <VBRAzureBlobConnection> -AzureBlobFolder <VBRAzureBlobFolder>

[-EnableBackupImmutability] [-ImmutabilityMode <VBRRepositoryImmutabilityMode>] [-ImmutabilityPeriod <Int32>]

[-AzureProxySpec <VBRAzureComputeProxyAppliance>] [-Name <String>] [-Description <String>]

[-UseInstantRetrieval] [-EnableReadOnlyMode] [-Force] [<CommonParameters>]

Detailed Description

This cmdlet adds Azure Archive repository to the backup infrastructure.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
AzureBlobFolder	Specifies an Azure Blob folder. Veeam Backup & Replication will move backup files into this folder. Accepts the `VBRAzureBlobFolder` object. To create this object, run the `New-VBRAzureBlobFolder` cmdlet.	`VBRAzureBlobFolder`	True	Named	False
AzureProxySpec	Specifies an archiver appliance that transfers data from Azure Blob storage to Azure Archive Storage. Accepts the `VBRAzureComputeProxyAppliance` object. To create this object, run the `New-VBRAzureComputeProxyAppliance` cmdlet.	`VBRAzureComputeProxyAppliance`	False	Named	False
Connection	Specifies an active session with an Azure Archive repository that you want to add to the backup infrastructure. Accepts the `VBRAzureBlobConnection` object. To create this object, run the `Connect-VBRAzureBlobService` cmdlet and set the `ArchiveTier` property as the `ServiceType` parameter value.	`VBRAzureBlobConnection`	True	Named	True (ByPropertyName, ByValue)
Description	Specifies a description of an Azure Archive repository. The cmdlet will add an archive repository with this description.	`String`	False	Named	False
EnableBackupImmutability	Defines that the cmdlet will enable the immutability option. Default: `False.`	`SwitchParameter`	False	Named	False
EnableReadOnlyMode	Defines that the cmdlet will add the object storage repository in the read-only mode. If you enable this option, Veeam Backup & Replication will not write or modify data in the object storage repository. You can use the object storage repository for restore operations only. Default: `False`.	`SwitchParameter`	False	Named	False
Force	Defines that the cmdlet will add an object storage repository without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
ImmutabilityMode	Specifies the immutability retention period: `BackupRetention`: Use this option if you want the immutability period to depend on the backup job retention. `RepositoryRetention`: Use this option if you want to ignore the job retention and specify the immutability period explicitly.	`VBRRepositoryImmutabilityMode`	False	Named	False
ImmutabilityPeriod	For the `EnableBackupImmutability` parameter. Defines the immutability period in days. Default: `30` days. Maximum: `999` days.	`Int32`	False	Named	False
Name	Specifies a name of an Azure Archive repository. The cmdlet will add an archive repository with this name.	`String`	False	Named	False
UseInstantRetrieval	Defines that the cmdlet will create a repository where data blocks are marked with the cool access tier. Note: If you do not provide the `UseInstantRetrieval` parameter, the cmdlet will create a repository where blocks are marked as the archive access tier. Default: `False`.	`SwitchParameter`	False	Named	False

<CommonParameters>

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

Output Object

VBRAzureArchiveRepository

Examples

Adding Azure Archive Repository

This example shows how to add the Azure Archive repository to the backup infrastructure.

$account = Get-VBRAzureBlobAccount -Name "Azure_Blob"

$connection = Connect-VBRAzureBlobService -Account $account -RegionType Global -ServiceType ArchiveTier

$container = Get-VBRAzureBlobContainer -Connection $connection -Name "container01"

$folder = Get-VBRAzureBlobFolder -Container $container -Connection $connection -Name "folder02"

$subscriptaccount = Get-VBRAzureAccount

$subscription = Get-VBRAzureSubscription -Account $subscriptaccount

$location = Get-VBRAzureLocation -Subscription $subscription

$vmsize = Get-VBRAzureVMSize -Subscription $subscription -Location $location

$network = Get-VBRAzureVirtualNetwork -Subscription $subscription -Name "VeeamInternalNetwork"

$subnet = Get-VBRAzureVirtualNetworkSubnet -Network $network -Name "VeeamInternalSubnet"

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

$proxy = New-VBRAzureComputeProxyAppliance -VMSize $vmsize -Network $network -Subnet $subnet -ResourceGroup $rg -RedirectorPort 443

Add-VBRAzureArchiveRepository -Connection $connection -AzureBlobFolder $folder -AzureProxySpec $proxy -Name "MyAzureArchive"

Perform the following steps:

Specify Azure connection settings:
- Run the Get-VBRAzureBlobAccount cmdlet. Specify the Name parameter value. Save the result to the $account variable.
- Run the Connect-VBRAzureBlobService cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType and ServiceType parameter values. Save the result to the $connection variable.
Specify object storage settings:
- Run the Get-VBRAzureBlobContainer cmdlet. Set the $connection variable as the Connection parameter value. Specify the Name parameter value. Save the result to the $container variable.
- Run the Get-VBRAzureBlobFolder cmdlet. Set the $container variable as the Container parameter value. Set the $connection variable as the Connection parameter value. Specify the Name parameter value. Save the result to the $folder variable.
Define the Azure proxy settings:
- Run the Get-VBRAzureAccount cmdlet. Save the result to the $subscriptaccount variable.
- Run the Get-VBRAzureSubscription cmdlet. Set the $subscriptaccount variable as the Account parameter value. Save the result to the $subscription variable.
- Run the Get-VBRAzureLocation cmdlet. Set the $subscription variable the Subscription parameter value. Save the result to the $location variable.
- Run the Get-VBRAzureVMSize cmdlet. Set the $subscription variable as the Subscription parameter value. Set the $location variable as the Location parameter value. Save the result to the $vmsize variable.
- Run the Get-VBRAzureVirtualNetwork cmdlet. Set the $subscription variable as the Subscription parameter value. Specify the Name parameter value. Save the result to the $network variable.
- Run the Get-VBRAzureVirtualNetworkSubnet cmdlet. Set the $network variable as the Network parameter value. Specify the Name parameter values. Save the result to the $subnet variable.
- Run the Get-VBRAzureResourceGroup cmdlet. Set the $subscription variable as the Subscription parameter value. Specify the Name parameter value. Save the result to the $rg variable.
- Run the New-VBRAzureComputeProxyAppliance cmdlet. Set the $vmsize variable as the VMSize parameter value. Set the $network variable as the Network parameter value. Set the $subnet variable as the Subnet parameter value. Set the $rg variable as the ResourceGroup parameter value. Specify the RedirectorPort parameter value. Save the result to the $proxy variable.
Run the Add-VBRAzureArchiveRepository cmdlet. Specify the following settings:
- Set the $connection variable as the Connection parameter value.
- Set the $folder variable as the AzureBlobFolder parameter value.
- Set the $proxy variable as the AzureProxySpec parameter value.
- Specify the Name parameter value.