---
title: "Set-VBREntraIDBackupSecondaryTarget"
description: "This cmdlet modifies secondary repository settings of an Entra ID tenant backup job. To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrentraidbackupsecondarytarget.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Microsoft EntraID Support > Infrastructure Components > Set-VBREntraIDBackupSecondaryTarget"
dateModified: "2026-08-19"
---

# Set-VBREntraIDBackupSecondaryTarget

## Short Description
Modifies secondary repository settings.

**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 an 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

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">BackupRepository</span></p>
        </td>
        <td>
          <p>Specifies the backup repository to use as a secondary target for Entra ID tenant backups.</p><p>Accepts the <code>CBackupRepository</code> object. To get this object, run the <a href="get-vbrbackuprepository.md"><code>Get-VBRBackupRepository</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CBackupRepository</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">BackupWindow</span></p>
        </td>
        <td>
          <p>Specifies a time interval within which a backup job is allowed to create copies of Entra ID tenant backups.</p><p>Accepts the <a href="vbrbackupwindowoptions.md"><code>VBRBackupWindowOptions</code></a> object. To get this object, run the <a href="new-vbrbackupwindowoptions.md"><code>New-VBRBackupWindowOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrbackupwindowoptions.md"><code>VBRBackupWindowOptions</code></a></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">CustomEncryptionKey</span></p>
        </td>
        <td>
          <p>Specifies an encryption key. Veeam Backup & Replication will use this key to encrypt data that is stored in the secondary repository.</p><p><strong>Note</strong>: If you do not specify this parameter, Veeam Backup & Replication will apply an encryption key set for the backup job.</p><p>Accepts the <code>VBREncryptionKey</code> object. To get this object, run the <a href="get-vbrencryptionkey.md"><code>Get-VBREncryptionKey</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBREncryptionKey</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">CustomRetentionPeriod</span></p>
        </td>
        <td>
          <p>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.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">CustomRetentionType</span></p>
        </td>
        <td>
          <p>Specifies a retention policy for the secondary repository. You can set retention policy to either of the following periods:</p><ul><li><code>Daily:</code> use this option if you want Veeam Backup & Replication to apply retention policy daily.</li><li><code>Monthly:</code> use this option if you want Veeam Backup & Replication to apply retention policy monthly.</li></ul><p><strong>Note</strong>: If you do not specify this parameter, Veeam Backup & Replication will apply the retention policy configured for the backup job.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRUnstructuredBackupShortTermRetentionType</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableBackupWindow</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will enable the backup window option.</p><p>If you provide this parameter, Veeam Backup & Replication will create copies of backups that were created by the backup job according to these settings.</p><p>Otherwise, Veeam Backup & Replication will copy data to the repository continuously.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableCustomRetention</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will enable the custom retention policy.</p><p>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.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">SecondaryTarget</span></p>
        </td>
        <td>
          <p>Specifies the secondary backup repository. The cmdlet will modify this repository.</p><p>Accepts the <code>VBREntraIDBackupSecondaryTarget</code> object. To get this object, run the <a href="new-vbrentraidbackupsecondarytarget.md"><code>New-VBREntraIDBackupSecondaryTarget</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrentraidbackupsecondarytarget.md"><code>VBREntraIDBackupSecondaryTarget</code></a></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName, ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">UseCustomEncryptionKey</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will enable the custom encryption key option.</p><p>If you provide this parameter, Veeam Backup & Replication will use the encryption key to encrypt data that is stored in the secondary repository.</p><p>Otherwise, Veeam Backup & Replication will apply an encryption key that is set for the backup job.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Output Object
The cmdlet returns the [`VBREntraIDBackupSecondaryTarget`](vbrentraidbackupsecondarytarget.md) object that defines secondary repository settings.

## Examples

::: example
### 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:

- Veeam Backup & Replication will apply retention policy daily.
- Veeam Backup & Replication will keep data in the secondary repository for 7 days.

```
$repository = Get-VBRBackupRepository -Name "SecondaryBackupRepository08"
Set-VBREntraIDBackupSecondaryTarget -SecondaryTarget $repository -EnableCustomRetention -CustomRetentionType Daily -CustomRetentionPeriod 7
```

Perform the following steps:

1. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$repository` variable.
2. Run the `Set-VBREntraIDBackupSecondaryTarget` cmdlet. Specify the following settings:

   - Set the `$repository` variable as the `SecondaryTarget` parameter value.
   - Provide the `EnableCustomRetention` parameter value.
   - Set the `Daily` option for the `CustomRetentionType` parameter.
   - Specify the `CustomRetentionPeriod` parameter value.

:::

::: example
### Example 2. Enabling Custom Encryption Key

This example shows how to enable custom encryption key for the `SecondaryBackupRepository08` secondary repository.

```
$repository = Get-VBRBackupRepository -Name "SecondaryBackupRepository08"
$key = Get-VBREncryptionKey -Description "KeyForEncryption"
Set-VBREntraIDBackupSecondaryTarget -SecondaryTarget $repository -UseCustomEncryptionKey -CustomEncryptionKey $key
```

Perform the following steps:

1. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$repository` variable.
2. Run the [`Get-VBREncryptionKey`](get-vbrencryptionkey.md) cmdlet. Specify the `Description` parameter value. Save the result to the `$key` variable.
3. Run the `Set-VBREntraIDBackupSecondaryTarget` cmdlet. Specify the following settings:

   - Set the `$repository` as the `SecondaryTarget` parameter value.
   - Provide the `UseCustomEncryptionKey` parameter.
   - Set the `$key` variable as the `CustomEncryptionKey` parameter value.

:::

::: example
### Example 3. Modifying Secondary Repository Settings for Existing Entra ID Tenant Backup Job

This example shows how to modify secondary repository settings for the existing Entra ID tenant backup job.

```
$repository = Get-VBRBackupRepository -Name 'Off-site repository'
$job = Get-VBREntraIDTenantBackupJob -Name 'Tenant backup'
$secondaryTarget = $job.SecondaryTarget
$newSecondaryOptions = Set-VBREntraIDBackupSecondaryTarget -SecondaryTarget $secondaryTarget -BackupRepository $repository
Set-VBREntraIDTenantBackupJob -Job $job -SecondaryTarget $newSecondaryOptions
```

Perform the following steps:

1. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$repository` variable.
2. Run the [`Get-VBREntraIDTenantBackupJob`](get-vbrentraidtenantbackupjob.md) cmdlet. Specify the Name parameter value. Save the result to the `$job` variable.
3. Specify the `SecondaryTarget` property for the `$job` variable. Save the result to the `$secondaryTarget` variable.
4. Run the `Set-VBREntraIDBackupSecondaryTarget` cmdlet. Set the `$secondaryTarget` as the `SecondaryTarget` parameter value. Set the `$repository` as the `BackupRepository` parameter value.
5. Run the [`Set-VBREntraIDTenantBackupJob`](set-vbrentraidtenantbackupjob.md) cmdlet. Set the `$job` as the `Job` parameter value. Set the `$newSecondaryOptions` as the `SecondaryTarget` parameter value.

:::

## Related Commands

- [`New-VBREntraIDBackupSecondaryTarget`](new-vbrentraidbackupsecondarytarget.md)
- [`Get-VBRBackupRepository`](get-vbrbackuprepository.md)
- [`New-VBRBackupWindowOptions`](new-vbrbackupwindowoptions.md)
- [`Get-VBREncryptionKey`](get-vbrencryptionkey.md)