Veeam Backup for Microsoft 365 6.0 [Archived]
PowerShell Reference
Related documents
Search
This is an archive version of the document. To get the most up-to-date information, see the current version.

Add-VBOAzureBlobObjectStorageRepository

Short Description

Adds the Azure Blob object storage repositories to Veeam Backup for Microsoft 365.

Syntax

This cmdlet provides parameter sets that allow you to:

  • Add Microsoft Azure Blob Storage.

Add-VBOAzureBlobObjectStorageRepository -Folder <VBOAzureBlobFolder> -Name <string> [-Description <string>] [-SizeLimit <uint64>]  [<CommonParameters>]

  • Add Microsoft Azure Archive Storage.

Add-VBOAzureBlobObjectStorageRepository -Folder <VBOAzureBlobFolder> -EnableLongTerm -Name <string> [-Description <string>] [-SizeLimit <uint64>]  [<CommonParameters>]

  • Add Microsoft Azure Archive Storage with Microsoft Azure subscription required to use archiver appliance.

Add-VBOAzureBlobObjectStorageRepository -Folder <VBOAzureBlobFolder> -EnableLongTerm -Subscription <VBOAzureSubscription> -Name <string> [-ArchiverAppliance <VBOAzureArchiverAppliance>] [-Description <string>] [-SizeLimit <uint64>]  [<CommonParameters>]

Detailed Description

This cmdlet adds the Azure Blob object storage repository to Veeam Backup for Microsoft 365.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Folder

Specifies an Azure Blob folder. The cmdlet will move the backup files to the specified folder.

Accepts the VBOAzureBlobFolder object.

To get this object, run the Get-VBOAzureBlobFolder cmdlet.

True

Named

False

False

Name

Specifies a name of Azure Blob object storage. The cmdlet will add Azure Blob storage to Veeam Backup for Microsoft 365 with this name.

String

True

Named

False

False

Description

Specifies a description of Azure Blob object storage. The cmdlet will add Azure Blob storage to Veeam Backup for Microsoft 365 with this name.

String

False

Named

False

False

SizeLimit

Specifies a soft limit in GB for your object storage consumption that can be exceeded temporarily. If the specified limit is exceeded, Veeam Backup for Microsoft 365 will not run a new job.

Permitted value: 1024 - 1073741824.

Default: 1024

Note: In PowerShell you can specify a soft limit in GB only.

UInt64

False

Named

False

False

EnableLongTerm

Defines that the cmdlet will enable adding an archive object storage that will be used as a target for backup copy jobs. Veeam Backup for Microsoft 365 supports Azure Blob Storage Archive access tier for this purpose.

SwitchParameter

True

Named

False

False

Subscription

Specifies a subscription associated with a user account that will be used to access Azure Blob storage.

Accepts the VBOAzureSubscription object.

To get this object, run the Get-VBOAzureSubscription cmdlet.

True

Named

False

False

ArchiverAppliance

Specifies the Azure archiver appliance. The cmdlet will use this archiver appliance when transferring backed-up data from Azure Blob storage to Azure Archive storage.

Accepts the VBOAzureArchiverAppliance object.

To create this object, run the New-VBOAzureArchiverAppliance cmdlet.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

The cmdlet returns the VBOAzureBlobObjectStorageRepository object that contains settings of the Azure Blob storage repository.

Examples

Add-VBOAzureBlobObjectStorageRepositoryExample 1. Adding Azure Blob Object Storage Repository

This example shows how to add the Azure Blob object storage repository. The repository will be added with default size limits.

$account = Get-VBOAzureBlobAccount -Id 133dae61-cfce-4fe0-8f8d-cbe52bd5612a

$connection = New-VBOAzureBlobConnectionSettings -Account $account -RegionType Global

$container = Get-VBOAzureBlobContainer -ConnectionSettings $connection -Name "ContainerName"

$folder = Get-VBOAzureBlobFolder -Container $container -Name "FolderName"

Add-VBOAzureBlobObjectStorageRepository -Folder $folder -Name "Music"

Perform the following steps:

  1. Run the Get-VBOAzureBlobAccount cmdlet. Save the result to the $account variable.
  2. Run the New-VBOAzureBlobConnectionSettings cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType parameter value. Save the result to the $connection variable.
  3. Run the Get-VBOAzureBlobContainer cmdlet. Set the $connection variable as the ConnectionSettings parameter value. Specify the Name parameter value. Save the result to the $container variable.
  4. Run the Get-VBOAzureBlobFolder cmdlet. Set the $container variable as the Container parameter value. Specify the Name parameter value. Save the result to the $folder variable.
  5. Run the Add-VBOAzureBlobObjectStorageRepository cmdlet. Set the $folder variable as the Folder parameter value. Specify the Name parameter value.

Add-VBOAzureBlobObjectStorageRepositoryExample 2. Adding Azure Blob Object Storage Repository with Description

This example shows how to add the Azure Blob object storage repository with description.

$account = Get-VBOAzureBlobAccount -Id 133dae61-cfce-4fe0-8f8d-cbe52bd5612a

$connection = New-VBOAzureBlobConnectionSettings -Account $account -RegionType Global

$container = Get-VBOAzureBlobContainer -ConnectionSettings $connection -Name "ContainerName"

$folder = Get-VBOAzureBlobFolder -Container $container -Name "FolderName"

Add-VBOAzureBlobObjectStorageRepository -Folder $folder -Name "Documents" -Description "Added by Administrator"

Perform the following steps:

  1. Run the Get-VBOAzureBlobAccount cmdlet. Save the result to the $account variable.
  2. Run the New-VBOAzureBlobConnectionSettings cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType parameter value. Save the result to the $connection variable.
  3. Run the Get-VBOAzureBlobContainer cmdlet. Set the $connection variable as the ConnectionSettings parameter value. Specify the Name parameter value. Save the result to the $container variable.
  4. Run the Get-VBOAzureBlobFolder cmdlet. Set the $container variable as the Container parameter value. Specify the Name parameter value. Save the result to the $folder variable.
  5. Run the Add-VBOAzureBlobObjectStorageRepository cmdlet. Specify the following settings:
  • Set the $folder variable as the Folder parameter value.
  • Specify the Name parameter value.
  • Specify the Description parameter value.

Add-VBOAzureBlobObjectStorageRepositoryExample 3. Adding Azure Blob Object Storage Repository with Specified Size Limits

This example shows how to add the Azure Blob object storage repository. The repository will be added with size limits set to 5120 GB.

$account = Get-VBOAzureBlobAccount -Id 133dae61-cfce-4fe0-8f8d-cbe52bd5612a

$connection = New-VBOAzureBlobConnectionSettings -Account $account -RegionType Global

$container = Get-VBOAzureBlobContainer -ConnectionSettings $connection -Name "ContainerName"

$folder = Get-VBOAzureBlobFolder -Container $container -Name "FolderName"

Add-VBOAzureBlobObjectStorageRepository -Folder $folder -Name "Documents" -SizeLimit 5120

Perform the following steps:

  1. Run the Get-VBOAzureBlobAccount cmdlet. Save the result to the $account variable.
  2. Run the New-VBOAzureBlobConnectionSettings cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType parameter value. Save the result to the $connection variable.
  3. Run the Get-VBOAzureBlobContainer cmdlet. Set the $connection variable as the ConnectionSettings parameter value. Specify the Name parameter value. Save the result to the $container variable.
  4. Run the Get-VBOAzureBlobFolder cmdlet. Set the $container variable as the Container parameter value. Specify the Name parameter value. Save the result to the $folder variable.
  5. Run the Add-VBOAzureBlobObjectStorageRepository cmdlet. Specify the following settings:
  • Set the $folder variable as the Folder parameter value.
  • Specify the Name parameter value.
  • Specify the SizeLimit parameter value.

Add-VBOAzureBlobObjectStorageRepositoryExample 4. Adding Azure Archive Storage

This example shows how to add the Azure Archive Storage.

$account = Get-VBOAzureBlobAccount -Id 133dae61-cfce-4fe0-8f8d-cbe52bd5612a

$connection = New-VBOAzureBlobConnectionSettings -Account $account -RegionType Global

$container = Get-VBOAzureBlobContainer -ConnectionSettings $connection -Name "ContainerName"

$folder = Get-VBOAzureBlobFolder -Container $container -Name "FolderName"

Add-VBOAzureBlobObjectStorageRepository -Folder $folder -EnableLongTerm -Name "Archived Documents"

Perform the following steps:

  1. Run the Get-VBOAzureBlobAccount cmdlet. Save the result to the $account variable.
  2. Run the New-VBOAzureBlobConnectionSettings cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType parameter value. Save the result to the $connection variable.
  3. Run the Get-VBOAzureBlobContainer cmdlet. Set the $connection variable as the ConnectionSettings parameter value. Specify the Name parameter value. Save the result to the $container variable.
  4. Run the Get-VBOAzureBlobFolder cmdlet. Set the $container variable as the Container parameter value. Specify the Name parameter value. Save the result to the $folder variable.
  5. Run the Add-VBOAzureBlobObjectStorageRepository cmdlet. Specify the following settings:
  • Set the $folder variable as the Folder parameter value.
  • Provide the EnableLongTerm parameter.
  • Specify the Name parameter value.

Related Commands

View all results across Veeam
Back to document search