Wait-​Azure​Rm​Backup​Job

Waits for a Backup job to finish.

Syntax

Wait-AzureRmBackupJob
    -Job <Object>
    [-TimeOut <Int64>]
    [<CommonParameters>]

Description

The Wait-AzureRmBackupJob cmdlet waits for an Azure Backup job to finish. Backup jobs can take a long time. If you run a backup job as part of a script, you may want to force the script to wait for job to finish before it continues to other tasks.

A script that includes this cmdlet can be simpler than one that polls the Backup service for the job status.

Examples

1:

Required Parameters

-Job

Specifies a job that this cmdlet cancels. To obtain an AzureRmBackupJob object, use the Get-AzureRmBackupJob cmdlet.

Type:Object
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-TimeOut

Specifies the maximum time, in seconds, that this cmdlet waits for the job to finish. We recommend that you specify a time-out value.

Type:Int64
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

AzureRmBackupJob

Outputs

AzureRmBackupJob[]