Share via

Stop-OBJob

  • Reference
Module:
MSOnlineBackup

Stops the specified backup or recovery job.

Syntax

Stop-OBJob
    [-Job] <CBJob>
    [-Confirm]
    [-WhatIf]

Description

The Stop-OBJob cmdlet stops currently running job, such as backup or recovery.

This cmdlet supports the WhatIf and the Confirm parameters. The cmdlet prompts the user for confirmation by default. The WhatIf parameter gives a verbose description of what the cmdlet does without performing any operation. The Confirm parameter specifies whether the cmdlet should prompt the user. Specify -Confirm:$FALSE to override the prompt.

To use Microsoft Azure Backup cmdlets, the user needs to be an administrator on the protected machine.

Examples

EXAMPLE 1

$job = Get-OBJob



Stop-OBJob -Job $job

This example stops a job.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Job

Specifies the job to be stopped.

Type:CBJob
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

Microsoft.Internal.CloudBackup.Client.Cmdlets.OBJob