Stop-VBREntraIDTenantBackupJob

Short Description

Stops running backup jobs that protect Microsoft Entra ID tenants.

Applies to

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

Syntax

Stop-VBREntraIDTenantBackupJob [-Job] <VBREntraIDTenantBackupJob[]> [-RunAsync] [-Gracefully] [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet stops 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 stop.	Accepts the VBREntraIDTenantBackupJob[] object. To get this object, run the Get-VBREntraIDTenantBackupJob cmdlet.	True	0	True (ByPropertyName, ByValue)
RunAsync	Defines that the command will return immediately without waiting for the task to complete.	SwitchParameter	False	Named	False
Gracefully	Defines that the cmdlet will stop the job gracefully.	SwitchParameter	False	Named	False
WhatIf	Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.	SwitchParameter	False	Named	False
Confirm	Defines that the cmdlet will display a prompt that asks if you want to continue running the command.	SwitchParameter	False	Named	False

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

Output Object

None.

Examples

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

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

Stop-VBREntraIDTenantBackupJob -Job $backupJob -Gracefully -RunAsync

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. Specify the RunAsync and Gracefully parameter values.

Related Commands