Add-VBRAzureBlobRepository

Short Description

Adds Azure Blob object storage repository to the backup infrastructure.

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Add-VBRAzureBlobRepository [-Name <String>] [-Description <String>] -AzureBlobFolder <VBRAzureBlobFolder>

-Connection <VBRAzureBlobConnection> [-EnableSizeLimit] [-SizeLimit <Int32>] [-EnableCoolAccessTier]

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

[-MountServerOptions <VBRRepositoryMountServerOptions[]>] [-AzureProxySpec <VBRAzureComputeProxyAppliance>]

[-EnableConcurrentTasksLimit] [-MaxConcurrentTasks <Int32>] [-ForceOwnershipChange] [-EnableReadOnlyMode]

[-Force] [<CommonParameters>]

Detailed Description

This cmdlet adds Azure Blob object storage repository to the backup infrastructure.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
AzureBlobFolder	Specifies an Azure Blob folder. The cmdlet will map object storage repository to this folder. Accepts the `VBRAzureBlobFolder` object. To create this object, run the `Get-VBRAzureBlobFolder` cmdlet.	`VBRAzureBlobFolder`	True	Named	True (ByValue)
AzureProxySpec	Specifies a helper appliance. Veeam Backup & Replication will use this appliance to perform a health check of backup files and apply retention to file backup job files. Accepts the `VBRAzureComputeProxyAppliance` object. To create this object, run the `New-VBRAzureComputeProxyAppliance` cmdlet.	`VBRAzureComputeProxyAppliance`	False	Named	False
Connection	Specifies an active session with Azure Blob storage that you want to add as the backup repository. Accepts the `VBRAzureBlobConnection` object. To get this object, run the `Connect-VBRAzureBlobService` cmdlet and set the `CapacityTier` property as the `ServiceType` parameter value.	`VBRAzureBlobConnection`	True	Named	False
Description	Specifies a description of Azure Blob storage. The cmdlet will add Azure Blob storage to the backup infrastructure with this description.	`String`	False	Named	False
EnableBackupImmutability	Defines that the cmdlet will enable the immutability option. Default: `False.`	`SwitchParameter`	False	Named	False
EnableConcurrentTasksLimit	Enables limits for concurrent tasks that can be processed by the object storage repository. Use the `MaxConcurrentTasks` parameter to specify the number of tasks.	`SwitchParameter`	False	Named	False
EnableCoolAccessTier	Defines that Veeam Backup & Replication will keep blocks of data in the Cool access tier. 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
EnableSizeLimit	Defines that the cmdlet will enable size limits for an Azure Blob storage that you want to add as a backup repository. Use the `SizeLimit` parameter to specify the size limits.	`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
ForceOwnershipChange	Defines that the cmdlet will force ownership change of the object storage folder. If you do not provide this parameter and the object storage folder is owned by another host, you will not be able to add object storage to the backup infrastructure.	`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.	`Int32`	False	Named	False
MaxConcurrentTasks	Specifies a maximum number of concurrent tasks that can be processed at once by the object storage repository.	`Int32`	False	Named	False
MountServerOptions	Specifies settings of a mount server for object storage repositories. Note: This parameter is required for object storage repositories that you want to add as performance extents to a scale-out backup repository.	`VBRRepositoryMountServerOptions[]`	False	Named	True (ByPropertyName)
Name	Specifies a name of an object storage. The cmdlet will add Azure Blob storage to the backup infrastructure with this name.	`String`	False	Named	False
SizeLimit	For the `EnableSizeLimit` parameter. Specifies size limits in GB for data blocks that you want to store in Azure Blob storage that you want to add as an object storage repository. Permitted value: `1024 - 1073741824`. Default: `10240`.	`Int32`	False	Named	False

<CommonParameters>

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

Output Object

VBRAzureBlobRepository

Examples

Add-VBRAzureBlobRepository Example 1. Adding Microsoft Azure Object Storage [Mapping to Existing Folder]

This example shows how to add Microsoft Azure Object Storage to the backup infrastructure and map object storage repository to an existing folder.

$account = Get-VBRAzureBlobAccount -Name "Azure Blob"

$connect = Connect-VBRAzureBlobService -Account $account -RegionType Global -ServiceType CapacityTier

$container = Get-VBRAzureBlobContainer -Connection $connect

$folder = Get-VBRAzureBlobFolder -Container $container -Connection $connect

Add-VBRAzureBlobRepository -AzureBlobFolder $folder[3] -Connection $connect

Perform the following steps:

Run the Get-VBRAzureBlobAccount cmdlet. Specify the Name parameter value. Save the result to the $account variable.
Run the Connect-VBRAzureBlobService cmdlet. Specify the Account, RegionType and ServiceType parameter values. Save the result to the $connect variable.
Run the Get-VBRAzureBlobContainer cmdlet. Specify the Connection parameter value. Save the result to the $container variable.
Run the Get-VBRAzureBlobFolder cmdlet. Specify the Container and Connection parameter values. Save the result to the $folder variable.
The Get-VBRAzureBlobFolder cmdlet will return an array of folders. Mind the ordinal number of the necessary folders (in our example, it is the fourth restore point in the array).
Run the Add-VBRAzureBlobRepository cmdlet. Set the $folder variable as the AzureBlobFolder parameter value. Set the $connect variable as the Connection parameter value.

Add-VBRAzureBlobRepository Example 2. Adding Microsoft Azure Object Storage [Mapping to New Folder]

This example shows how to add Microsoft Azure Object Storage to the backup infrastructure and map object storage repository to a new folder. The cmdlet will map object storage repository to the Images folder.

$account = Get-VBRAzureBlobAccount -Name "Azure Blob"

$connect = Connect-VBRAzureBlobService -Account $account -RegionType Global -ServiceType CapacityTier

$container = Get-VBRAzureBlobContainer -Connection $connect

$folder = New-VBRAzureBlobFolder -Container $container -Connection $connect -Name "Images"

Add-VBRAzureBlobRepository -AzureBlobFolder $folder -Connection $connect

Perform the following steps:

Run the Get-VBRAzureBlobAccount cmdlet. Specify the Name parameter value. Save the result to the $account variable.
Run the Connect-VBRAzureBlobService cmdlet. Specify the Account, RegionType and ServiceType parameter values. Save the result to the $connect variable.
Run the Get-VBRAzureBlobContainer cmdlet. Specify the Connection parameter value. Save the result to the $container variable.
Run the New-VBRAzureBlobFolder cmdlet. Specify the Container, Connection and Name parameter values. Save the result to the $folder variable.
Run the Add-VBRAzureBlobRepository cmdlet. Set the $folder variable as the AzureBlobFolder parameter value. Set the $connect variable as the Connection parameter value.