Set-VBREntraIDBackupSecondaryTarget
Short Description
Modifies secondary repository settings.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Set-VBREntraIDBackupSecondaryTarget -SecondaryTarget <VBREntraIDBackupSecondaryTarget> [-BackupRepository <CBackupRepository>] [-EnableCustomRetention] [-CustomRetentionType <VBRUnstructuredBackupShortTermRetentionType>] [-CustomRetentionPeriod <Int32>] [-UseCustomEncryptionKey] [-CustomEncryptionKey <VBREncryptionKey>] [-EnableBackupWindow] [-BackupWindow <VBRBackupWindowOptions>] [<CommonParameters>] |
Detailed Description
This cmdlet modifies secondary repository settings of a Entra ID tenant backup job.
Note |
To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged. |
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
---|---|---|---|---|---|
SecondaryTarget | Specifies the secondary backup repository. The cmdlet will modify this repository. | Accepts the VBREntraIDBackupSecondaryTarget object. To get this object, run the New-VBREntraIDBackupSecondaryTarget cmdlet. | True | Named | True (ByValue, ByPropertyName) |
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 |
EnableBackupWindow | Defines that the cmdlet will enable the backup window option. If you provide this parameter, Veeam Backup & Replication will create copies of backups that were created by the backup job according to these settings. Otherwise, Veeam Backup & Replication will copy data to the repository continuously. | SwitchParameter | False | 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 |
UseCustomEncryptionKey | Defines that the cmdlet will enable the custom encryption key option. If you provide this parameter, Veeam Backup & Replication will use the encryption key to encrypt data that is stored in the secondary repository. Otherwise, Veeam Backup & Replication will apply an encryption key that is set for the backup job. | SwitchParameter | 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 |
EnableCustomRetention | Defines that the cmdlet will enable the custom retention policy. If you provide this parameter, Veeam Backup & Replication will apply this policy for backups located on the secondary backup repository. Otherwise, Veeam Backup & Replication will apply the retention policy of the backup job to the secondary repository. | SwitchParameter | 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. Enabling Custom Retention Policy
This example shows how to enable custom retention policy for the SecondaryBackupRepository08 secondary repository. The custom retention policy will be enabled with the following settings:
Perform the following steps:
|
Example 2. Enabling Custom Encryption Key
This example shows how to enable custom encryption key for the SecondaryBackupRepository08 secondary repository.
Perform the following steps:
|
Related Commands