New-VBREntraIDBackupSecondaryTarget
Short Description
Defines secondary repository settings.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
New-VBREntraIDBackupSecondaryTarget -BackupRepository <CBackupRepository> [-CustomRetentionType <VBRUnstructuredBackupShortTermRetentionType>] [-CustomRetentionPeriod <Int32>] [-CustomEncryptionKey <VBREncryptionKey>] [-BackupWindow <VBRBackupWindowOptions>] [<CommonParameters>] |
Detailed Description
This cmdlet defines secondary repository settings for a Entra ID tenant backup job.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
---|---|---|---|---|---|
BackupRepository | Specifies the backup repository to use as a secondary target for Entra ID tenant backups. | Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet. | True | Named | False |
BackupWindow | Specifies a time interval within which a backup job is allowed to create copies of Entra ID tenant backups. | Accepts the VBRBackupWindowOptions object. To get this object, run the New-VBRBackupWindowOptions cmdlet. | False | Named | False |
CustomEncryptionKey | Specifies an encryption key. Veeam Backup & Replication will use this key to encrypt data that is stored in the secondary repository. Note: If you do not specify this parameter, Veeam Backup & Replication will apply an encryption key set for the backup job. | Accepts the VBREncryptionKey object. To get this object, run the Get-VBREncryptionKey cmdlet. | False | Named | False |
CustomRetentionPeriod | Specifies the period of time to keep data on the secondary repository. When this period is expired, Veeam Backup & Replication will move data to the long-term repository. | Int32 | False | Named | False |
CustomRetentionType | Specifies a retention policy for the secondary repository. You can set retention policy to either of the following periods:
Note: If you do not specify this parameter, Veeam Backup & Replication will apply the retention policy configured for the backup job. | VBRUnstructuredBackupShortTermRetentionType | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
The cmdlet returns the VBREntraIDBackupSecondaryTarget object that defines secondary repository settings.
Examples
Example 1. Defining Secondary Repository Settings
This example shows how to define the following secondary repository settings for a Entra ID tenant backup job:
Perform the following steps:
|
Example 2. Defining Secondary Repository Settings with Custom Retention Policy
This example shows how to define the secondary repository settings with a custom retention policy. Veeam Backup & Replication will keep versions of backup files on the secondary backup repository for 7 days.
Perform the following steps:
|
Example 3. Defining Secondary Repository Settings with Backup Window
This example shows how to define the secondary repository settings with a custom schedule settings. Veeam Backup & Replication will copy data to the secondary repository according to the following schedule:
Perform the following steps:
|
Related Commands