Add-VBOAzureArchiveRepository
Short Description
Adds Azure Blob Storage Archive to the Veeam Backup for Microsoft 365 infrastructure.
Syntax
This cmdlet provides the following parameter sets:
-
DefaultParameterSet (Default)Add-VBOAzureArchiveRepository [-IgnoreProxyPoolApplianceAccessValidation]
-ObjectStorageSettings <VBOAzureBlobObjectStorageRepository> [-ObjectStorageEncryptionKey <IVBOCredentialKey>]
[-SyncNow] [-SizeLimit <UInt64>] [-EnableImmutability] [-EnableImmutabilityGovernanceMode] [-Proxy <VBOProxy>]
[-ProxyPool <VBOProxyPool>] -Name <String> [-Description <String>] [-RetentionType <VBORetentionType>]
[-Force] [<CommonParameters>]
-
DailyParameterSetAdd-VBOAzureArchiveRepository [-IgnoreProxyPoolApplianceAccessValidation]
-ObjectStorageSettings <VBOAzureBlobObjectStorageRepository> -RetentionPeriod <VBORetentionPeriod>
-RetentionFrequencyType <VBORetentionFrequencyType> -DailyTime <TimeSpan> -DailyType <VBODailyType>
[-ObjectStorageEncryptionKey <IVBOCredentialKey>] [-SyncNow] [-SizeLimit <UInt64>] [-EnableImmutability]
[-EnableImmutabilityGovernanceMode] [-Proxy <VBOProxy>] [-ProxyPool <VBOProxyPool>] -Name <String>
[-Description <String>] [-RetentionType <VBORetentionType>] [-Force] [<CommonParameters>]
-
MonthlyParameterSetAdd-VBOAzureArchiveRepository [-IgnoreProxyPoolApplianceAccessValidation]
-ObjectStorageSettings <VBOAzureBlobObjectStorageRepository> -RetentionPeriod <VBORetentionPeriod>
-RetentionFrequencyType <VBORetentionFrequencyType> -MonthlyTime <TimeSpan>
-MonthlyDayNumber <VBOMonthlyDayNumber> -MonthlyDayOfWeek <DayOfWeek>
[-ObjectStorageEncryptionKey <IVBOCredentialKey>] [-SyncNow] [-SizeLimit <UInt64>] [-EnableImmutability]
[-EnableImmutabilityGovernanceMode] [-Proxy <VBOProxy>] [-ProxyPool <VBOProxyPool>] -Name <String>
[-Description <String>] [-RetentionType <VBORetentionType>] [-Force] [<CommonParameters>]
-
DailyCustomRetentionParameterSetAdd-VBOAzureArchiveRepository [-IgnoreProxyPoolApplianceAccessValidation]
-ObjectStorageSettings <VBOAzureBlobObjectStorageRepository>
-CustomRetentionPeriodType <VBORetentionPeriodType> -CustomRetentionPeriod <Int32>
-RetentionFrequencyType <VBORetentionFrequencyType> -DailyTime <TimeSpan> -DailyType <VBODailyType>
[-ObjectStorageEncryptionKey <IVBOCredentialKey>] [-SyncNow] [-SizeLimit <UInt64>] [-EnableImmutability]
[-EnableImmutabilityGovernanceMode] [-Proxy <VBOProxy>] [-ProxyPool <VBOProxyPool>] -Name <String>
[-Description <String>] [-RetentionType <VBORetentionType>] [-Force] [<CommonParameters>]
-
MonthlyCustomRetentionParameterSetAdd-VBOAzureArchiveRepository [-IgnoreProxyPoolApplianceAccessValidation]
-ObjectStorageSettings <VBOAzureBlobObjectStorageRepository>
-CustomRetentionPeriodType <VBORetentionPeriodType> -CustomRetentionPeriod <Int32>
-RetentionFrequencyType <VBORetentionFrequencyType> -MonthlyTime <TimeSpan>
-MonthlyDayNumber <VBOMonthlyDayNumber> -MonthlyDayOfWeek <DayOfWeek>
[-ObjectStorageEncryptionKey <IVBOCredentialKey>] [-SyncNow] [-SizeLimit <UInt64>] [-EnableImmutability]
[-EnableImmutabilityGovernanceMode] [-Proxy <VBOProxy>] [-ProxyPool <VBOProxyPool>] -Name <String>
[-Description <String>] [-RetentionType <VBORetentionType>] [-Force] [<CommonParameters>]
Detailed Description
This cmdlet adds a backup repository of the Azure Blob object storage type, in particular — Azure Blob Storage Archive access tier, to the Veeam Backup for Microsoft 365 infrastructure. Veeam Backup for Microsoft 365 uses backup repositories as storage systems for backups and backup copies created for Microsoft 365 and on-premises Microsoft organizations. Every backup repository has the retention policy that defines how long you want to keep backups on a backup repository.
You can specify the following retention policy settings:
- Retention period to specify how long you want to keep data on a backup repository. You can set the period to years, months or days.
- Retention policy schedule to specify the day and time when Veeam Backup for Microsoft 365 must check the backup repository and remove the outdated backups. You can set the schedule to daily or monthly.
- Retention policy type to set it to Item-level or to snapshot-based types.
For more information on retention policy, see the Retention Policy section of the Veeam Backup for Microsoft 365 User Guide.
Parameters
|
Parameter |
Description |
Type |
Required |
Position |
Accept Pipeline Input |
|---|---|---|---|---|---|
|
CustomRetentionPeriod |
For the
Specifies the retention period to keep data on the object storage repository. The retention period is defined according to the
Veeam Backup for Microsoft 365 will remove items from the object storage repository once this period is passed. |
|
True |
Named |
False |
|
CustomRetentionPeriodType |
Specifies a type of custom retention period. Veeam Backup for Microsoft 365 will remove items from the object storage repository once this period is passed. You can set the custom retention period to either of the following types:
Set the |
|
True |
Named |
False |
|
DailyTime |
For daily retention policy schedule. Specifies the time of the day when Veeam Backup for Microsoft 365 must apply the retention policy. Default: 00:00:00 |
|
True |
Named |
False |
|
DailyType |
For daily retention policy schedule. Specifies the days when Veeam Backup for Microsoft 365 must apply the retention policy:
Default: Everyday |
|
True |
Named |
False |
|
Description |
Specifies a description of Azure Blob Storage Archive. The cmdlet will add an object storage repository with this description. The default description contains information on the user who added the object storage repository, date and time when the object storage repository was added. |
|
False |
Named |
False |
|
EnableImmutability |
Defines that the cmdlet will add the object storage repository to the Veeam Backup for Microsoft 365 infrastructure with the immutability feature enabled. Veeam Backup for Microsoft 365 allows you to prohibit deletion of data from the object storage repository by making that data temporarily immutable and to protect data against malware activity. For more information about the immutability feature, see the Immutability section of the Veeam Backup for Microsoft 365 User Guide. Default: False |
|
False |
Named |
False |
|
EnableImmutabilityGovernanceMode |
Defines that a retention policy will be unlocked on the Azure container and a storage administrator with specific permissions to be allowed to override the lock settings and to delete the protected backups in the object storage repository added by the cmdlet. Default: False |
|
False |
Named |
False |
|
Force |
Defines that the cmdlet will add the object storage repository to the Veeam Backup for Microsoft 365 infrastructure without notifying the user. Default: False |
|
False |
Named |
False |
|
IgnoreProxyPoolApplianceAccessValidation |
Defines that the cmdlet will ignore check whether backup proxy servers that belong to the specified backup proxy pool can access the archiver appliance. Default: False |
|
False |
Named |
False |
|
MonthlyDayNumber |
For monthly retention policy schedule. Specifies the order number for the day of the week when Veeam Backup for Microsoft 365 must apply the retention policy.
Default: First |
|
True |
Named |
False |
|
MonthlyDayOfWeek |
For monthly retention policy schedule. Specifies the day of the week when Veeam Backup for Microsoft 365 must apply the retention policy.
Default: Monday |
|
True |
Named |
False |
|
MonthlyTime |
For monthly retention policy schedule. Specifies the time of the day when Veeam Backup for Microsoft 365 must apply the retention policy. Default: 18:00:00 |
|
True |
Named |
False |
|
Name |
Specifies a name of Azure Blob Storage Archive. The cmdlet will add an object storage repository with this name. |
|
True |
Named |
False |
|
ObjectStorageEncryptionKey |
Specifies object storage encryption key. Veeam Backup for Microsoft 365 will encrypt data that is saved to this object storage repository.
Accepts the
To get this object, run the |
|
False |
Named |
False |
|
ObjectStorageSettings |
Specifies the Azure Blob Storage Archive settings.
Accepts the
To get this object, run the |
True |
Named |
False |
|
|
Proxy |
Specifies a backup proxy server. The cmdlet will map a new Azure Blob Storage Archive to this backup proxy server.
Accepts the
To get this object, run the |
False |
Named |
False |
|
|
ProxyPool |
Specifies a backup proxy pool. The cmdlet will map a new Azure Blob Storage Archive to this backup proxy pool.
Accepts the
To get this object, run the |
False |
Named |
False |
|
|
RetentionFrequencyType |
Specifies retention policy schedule. Veeam Backup for Microsoft 365 will check the object storage repository and will remove the outdated backups according to this schedule. You can set either of the following types of schedule:
Default: Daily |
|
True |
Named |
False |
|
RetentionPeriod |
Specifies the retention period in years. Veeam Backup for Microsoft 365 will remove items from the object storage repository once this period is passed. You can set either of the following periods:
Default: Years3
Note: Apply the |
|
True |
Named |
False |
|
RetentionType |
Specifies a type of retention policy. You can set either of the following types:
Default: SnapshotBased |
|
False |
Named |
False |
|
SizeLimit |
Specifies a soft limit in GB for the object storage repository consumption that can be exceeded temporarily. If the specified limit is exceeded, Veeam Backup for Microsoft 365 will not run a new job. Permitted values: 1024–1073741824. Default: 1024 Note: In PowerShell you can specify a soft limit in GB only. |
|
False |
Named |
False |
|
SyncNow |
Defines that the cmdlet will start to synchronize cache between the object storage repository and the PersistentCache database on the PostgreSQL instance. Default: False |
|
False |
Named |
False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.
Output Object
The cmdlet returns the VBOAzureBlobObjectStorageRepository object that contains settings of Azure Blob Storage Archive.
Examples
Example 1: Adding Azure Blob Storage Archive with Default Retention Policy Period
|
This example shows how to add the Azure Blob Storage Archive object storage repository. The retention type is set to snapshot-based.
Perform the following steps:
|
Example 2: Adding Azure Blob Storage Archive with Yearly Retention Period [Policy Applied Daily]
|
This example shows how to add the Azure Blob Storage Archive object storage repository. The retention settings will be the following:
Perform the following steps:
|
Example 3: Adding Azure Blob Storage Archive with Yearly Retention Period [Policy Applied Monthly]
|
This example shows how to add the Azure Blob Storage Archive object storage repository. The retention settings will be the following:
Perform the following steps:
|
Example 4: Adding Azure Blob Storage Archive with Custom Retention period [Policy Applied Daily]
|
This example shows how to add the Azure Blob Storage Archive object storage repository. The retention settings will be the following:
Perform the following steps:
|
Example 5: Adding Azure Blob Storage Archive with Custom Retention period [Policy Applied Monthly]
|
This example shows how to add the Azure Blob Storage Archive object storage repository. The retention settings will be the following:
Perform the following steps:
|
Related Commands
Get-VBOProxyReturns backup proxy servers added to the Veeam Backup for Microsoft 365 infrastructure.Get-VBOProxyPoolReturns backup proxy pools added to the Veeam Backup for Microsoft 365 infrastructure.Get-VBOEncryptionKeyReturns encryption keys.Get-VBOAzureBlobAccountReturns Microsoft Azure Blob Storage account credentials.New-VBOAzureBlobConnectionSettingsDefines connection settings to Microsoft Azure Blob Storage.Get-VBOAzureBlobContainerReturns Microsoft Azure Blob containers.Get-VBOAzureBlobFolderReturns Microsoft Azure Blob folders.New-VBOAzureBlobObjectStorageSettingsDefines the Azure Blob Storage settings.