Set-VBREntraIDTenantBackupJob

Short Description

Modifies a backup job that protects a Microsoft Entra ID tenant.

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

Syntax

Set-VBREntraIDTenantBackupJob -Job <VBREntraIDTenantBackupJob> [-Name <String>] [-Description <String>]

[-RetentionPolicy <Int32>] [-NotificationOptions <VBRNotificationOptions>] [-EnableSchedule]

[-ScheduleOptions <VBRServerScheduleOptions>] [-EncryptionOptions <VBREncryptionOptions>]

[-EnableSecondaryTarget] [-SecondaryTarget <VBREntraIDBackupSecondaryTarget[]>]

[-TargetBackup <VBREntraIDTenantBackup>] [<CommonParameters>]

Detailed Description

This cmdlet modifies an Entra ID tenant backup job.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Description	Specifies the description of the tenant backup job.	`String`	False	Named	False
EnableSchedule	Defines that the cmdlet will enable the custom schedule for the tenant backup job. If you provide this parameter, the tenant backup job will run according to the schedule specified in `ScheduleOptions`. Otherwise, to run the job, you will need to start it manually.	`SwitchParameter`	False	Named	False
EnableSecondaryTarget	Enables copying tenant backups to the secondary backup repository.	`SwitchParameter`	False	Named	False
EncryptionOptions	Specifies encryption options. Accepts the `VBREncryptionOptions` object. To create this object, run the `New-VBREncryptionOptions` cmdlet.	`VBREncryptionOptions`	False	Named	False
Job	Specifies the tenant backup job that you want to modify. Accepts the `VBREntraIDTenantBackupJob` object. To get this object, run the `Get-VBREntraIDTenantBackupJob` cmdlet.	`VBREntraIDTenantBackupJob`	True	Named	True (ByPropertyName, ByValue)
Name	Specifies the name of the tenant backup job.	`String`	False	Named	False
NotificationOptions	Specifies notification options. The cmdlet will create the log backup job with these notification options. Accepts the `VBRNotificationOptions` object. To create this object, run the `New-VBRNotificationOptions` cmdlet.	`VBRNotificationOptions`	False	Named	False
RetentionPolicy	Specifies the retention policy in days for backups created by the tenant backup job.	`Int32`	False	Named	False
ScheduleOptions	Specifies schedule options. Accepts the `VBRServerScheduleOptions` object. To create this object, run the `New-VBRServerScheduleOptions` cmdlet.	`VBRServerScheduleOptions`	False	Named	True (ByPropertyName, ByValue)
SecondaryTarget	Specifies secondary repository settings. Accepts the `VBREntraIDBackupSecondaryTarget` object. To create this object, run the `New-VBREntraIDBackupSecondaryTarget` cmdlet.	`VBREntraIDBackupSecondaryTarget[]`	False	Named	False
TargetBackup	Specifies Entra ID backup copy settings. The cmdlet will use data of this backup to create a backup chain instead of creating the chain anew. Accepts the `VBREntraIDTenantBackup` object. To get this object, run the `Get-VBREntraIDTenantBackup` cmdlet.	`VBREntraIDTenantBackup`	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 VBREntraIDTenantBackupJob object that contains setting of the created tenant backup job.

Examples

Changing Settings of Entra ID Backup Job

This example shows how to change the settings of the Tenant Backup backup job and disable encryption.

$backupJob = Get-VBREntraIDTenantBackupJob -Name "Tenant Backup"

$encOptions = New-VBREncryptionOptions -EnableEncryption:$false

Set-VBREntraIDTenantBackupJob -Job $backupJob -Description "Backup of Entra ID tenant" -RetentionPolicy 12 -EncryptionOptions $encOptions

Perform the following steps:

Run the Get-VBREntraIDTenantBackupJob cmdlet. Specify the Name parameter value. Save the result to the $backupJob variable.
Run the New-VBREncryptionOptions cmdlet. Set the EnableEncryption parameter value to $false. Save the result to the $encOptions variable.
Run the Set-VBREntraIDTenantBackupJob cmdlet. Specify the following:
- Set the $backupJob variable as the Job parameter value.
- Specify the Description and RetentionPolicy parameter values.
- Set the $encOptions variable as the EncryptionOptions parameter value.