Start-VBREntraIDTenantBackupJob

Short Description

Starts backup jobs that protect Microsoft Entra ID tenants.

Applies to

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

Syntax

Start-VBREntraIDTenantBackupJob [-Job] <VBREntraIDTenantBackupJob[]> [-RunAsync] [<CommonParameters>]

Detailed Description

This cmdlet starts Entra ID tenant backup jobs.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Job	Specifies an array of tenant backup jobs that you want to start.	Accepts the VBREntraIDTenantBackupJob[] object. To get this object, run the Get-VBREntraIDTenantBackupJob cmdlet.	True	0	True (ByPropertyName, ByValue)
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	SwitchParameter	False	Named	False

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Job

Specifies an array of tenant backup jobs that you want to start.

Accepts the VBREntraIDTenantBackupJob[] object. To get this object, run the Get-VBREntraIDTenantBackupJob cmdlet.

True

True (ByPropertyName, ByValue)

RunAsync

Defines that the command returns immediately without waiting for the task to complete.

SwitchParameter

False

Named

False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBRBackupSession object that contains information about the job session.

Examples

This example shows how to start the Tenant Backup backup job.

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

Start-VBREntraIDTenantBackupJob -Job $backupJob

Perform the following steps:

Run the Get-VBREntraIDTenantBackupJob cmdlet. Specify the Name parameter value. Save the result to the $backupJob variable.
Run the Start-VBREntraIDTenantBackupJob cmdlet. Set the $backupJob variable as the Job parameter value.

Related Commands