---
title: "Set-VBREntraIDLogsBackupJob"
description: "This cmdlet modifies a backup job that protect Entra ID audit and sign-in logs."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrentraidlogsbackupjob.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Microsoft EntraID Support > Log Backup Jobs > Set-VBREntraIDLogsBackupJob"
dateModified: "2026-08-19"
---

# Set-VBREntraIDLogsBackupJob

## Short Description
Modifies a Microsoft Entra ID log backup job.

**Product Edition**: Enterprise Plus, Veeam Universal License

## Syntax
```
Set-VBREntraIDLogsBackupJob -Job <VBREntraIdLogsBackupJob> [-Tenant <VBREntraIDTenant>]
 [-ShortTermRetentionType <VBREntraIdLogsBackupShortTermRetentionType>] [-ShortTermRetentionPeriod <Int32>]
 [-Name <String>] [-Description <String>] [-ShortTermBackupRepository <CBackupRepository>]
 [-EnableSecondaryTarget] [-SecondaryTarget <VBRUnstructuredBackupSecondaryTarget[]>]
 [-StorageOptions <VBRStorageOptions>] [-HealthCheckOptions <VBRFullBackupOptions>]
 [-NotificationOptions <VBRNotificationOptions>] [-ScriptOptions <VBRJobScriptOptions>] [-EnableSchedule]
 [-ScheduleOptions <VBRServerScheduleOptions>] [-Force] [-HighPriority] [<CommonParameters>]
```

## Detailed Description
This cmdlet modifies a backup job that protect Entra ID audit and sign-in logs.

## 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">Description</span></p>
        </td>
        <td>
          <p>Specifies the description of the log backup job.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</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">EnableSchedule</span></p>
        </td>
        <td>
          <p>Enables the job schedule.</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">EnableSecondaryTarget</span></p>
        </td>
        <td>
          <p>Enables copying log backups to the secondary backup 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">Force</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will create a log backup job without showing warnings or errors in the PowerShell console.</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">HealthCheckOptions</span></p>
        </td>
        <td>
          <p>Specifies the healthcheck schedule. The cmdlet will create the log backup job with this healthcheck schedule.</p><p>Accepts the <code>VBRFullBackupOptions</code> object. To create this object, run the <a href="new-vbrfullbackupoptions.md"><code>New-VBRFullBackupOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRFullBackupOptions</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">HighPriority</span></p>
        </td>
        <td>
          <p>Defines that Veeam Backup & Replication will prioritize this job higher than other similar jobs and will allocate resources to it in the first place.</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">Job</span></p>
        </td>
        <td>
          <p>Specifies the log backup job that you want to modify.</p><p>Accepts the <code>VBREntraIdLogsBackupJob</code> object. To get this object, run the <a href="get-vbrentraidlogsbackupjob.md"><code>Get-VBREntraIDLogsBackupJob</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrentraidlogsbackupjob.md"><code>VBREntraIdLogsBackupJob</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">Name</span></p>
        </td>
        <td>
          <p>Specifies the name of the log backup job.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</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">NotificationOptions</span></p>
        </td>
        <td>
          <p>Specifies notification options. The cmdlet will create the log backup job with these notification options.</p><p>Accepts the <code>VBRNotificationOptions</code> object. To create this object, run the <a href="new-vbrnotificationoptions.md"><code>New-VBRNotificationOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrnotificationoptions.md"><code>VBRNotificationOptions</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">ScheduleOptions</span></p>
        </td>
        <td>
          <p>Specifies schedule options. The cmdlet will create the log backup job with these schedule options.</p><p>Accepts the <code>VBRServerScheduleOptions</code> object. To create this object, run the <a href="new-vbrserverscheduleoptions.md"><code>New-VBRServerScheduleOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRServerScheduleOptions</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">ScriptOptions</span></p>
        </td>
        <td>
          <p>Specifies pre-job and post-job script options. The cmdlet will create the log backup job with these script options.</p><p>Accepts the <code>VBRJobScriptOptions</code> object. To create this object, run the <a href="new-vbrjobscriptoptions.md"><code>New-VBRJobScriptOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrjobscriptoptions.md"><code>VBRJobScriptOptions</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">SecondaryTarget</span></p>
        </td>
        <td>
          <p>Specifies the secondary backup repository. The cmdlet will use this repository as the secondary repository for the log backup job.</p><p><strong>Note</strong>: The cmdlet will create a new backup chain in the new repository and detach backups stored in the old repository.</p><p>Accepts the <code>VBRUnstructuredBackupSecondaryTarget[]</code> object. To create this object, run the <a href="new-vbrunstructuredbackupsecondarytarget.md"><code>New-VBRUnstructuredBackupSecondaryTarget</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRUnstructuredBackupSecondaryTarget[]</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">ShortTermBackupRepository</span></p>
        </td>
        <td>
          <p>Specifies the primary backup repository. The cmdlet will use this repository as a primary storage for storing log backups.</p><p><strong>Note</strong>: You can change the primary backup repository only if there are no backups or they are detached from the job.</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">ShortTermRetentionPeriod</span></p>
        </td>
        <td>
          <p>For the <code>ShortTermRetentionType</code> option.</p><p>Specifies the period of time to keep data in the primary backup 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">ShortTermRetentionType</span></p>
        </td>
        <td>
          <p>Specifies the type of the retention policy for the primary backup repository.</p><p>Use the <code>ShortTermRetentionPeriod</code> parameter to specify the number of days, months or years.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBREntraIdLogsBackupShortTermRetentionType</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">StorageOptions</span></p>
        </td>
        <td>
          <p>Specifies storage optimization settings. The cmdlet will create the log backup job with these settings.</p><p>Accepts the <code>VBRStorageOptions</code> object. To create this object, run the <a href="new-vbrstorageoptions.md"><code>New-VBRStorageOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRStorageOptions</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">Tenant</span></p>
        </td>
        <td>
          <p>Specifies the tenant whose logs you want to back up.</p><p>Accepts the <code>VBREntraIDTenant</code> object. To get this object, run the <a href="get-vbrentraidtenant.md"><code>Get-VBREntraIDTenant</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrentraidtenant.md"><code>VBREntraIDTenant</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>
    </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 [`VBREntraIdLogsBackupJob`](vbrentraidlogsbackupjob.md) object that contains settings of the Entra ID log backup job.

## Examples

::: example
### Modifying Settings of Log Backup Job

This example shows how to change the settings of the `Log Backup` backup job and enable scheduling.

```
$backupJob = Get-VBREntraIDLogsBackupJob -Name "Log Backup"
$daily = New-VBRDailyOptions -DayOfWeek Friday -Period 7:00
$scheduleOptions = New-VBRServerScheduleOptions -Type Daily -DailyOptions $daily
Set-VBREntraIDLogsBackupJob -Job $backupJob -Description "Backup of Entra ID tenant logs" -EnableSchedule -ScheduleOptions $scheduleOptions
```

Perform the following steps:

1. Run the [`Get-VBREntraIDLogsBackupJob`](get-vbrentraidlogsbackupjob.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$backupJob` variable.
2. Run the [`New-VBRDailyOptions`](new-vbrdailyoptions.md) cmdlet. Specify the `DayOfWeek` and `Period` parameter values. Save the result to the `$daily` variable.
3. Run the [`New-VBRServerScheduleOptions`](new-vbrserverscheduleoptions.md) cmdlet. Specify the following settings:

   - Set the `Daily` value as the `Type` parameter value.
   - Set the `$daily` variable as the `DailyOptions` parameter value.
   - Save the result to the `$scheduleOptions` variable.

4. Run the `Set-VBREntraIDTenantBackupJob` cmdlet. Specify the following settings:

   - Set the `$backupJob` variable as the `Job` parameter value.
   - Specify the `Description` parameter value.
   - Provide the `EnableSchedule` parameter.
   - Set the `$scheduleOptions` variable as the `ScheduleOptions` parameter value.

:::

## Related Commands

- [`Get-VBREntraIDLogsBackupJob`](get-vbrentraidlogsbackupjob.md)
- [`New-VBRDailyOptions`](new-vbrdailyoptions.md)
- [`New-VBRServerScheduleOptions`](new-vbrserverscheduleoptions.md)