Wait-AzureRmBackupJob
Waits for a Backup job to finish.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Wait-AzureRmBackupJob
-Job <Object>
[-TimeOut <Int64>]
[-DefaultProfile <IAzureContextContainer>]
[<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.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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 |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-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: | Nullable<T>[Int64] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Parameters: Job (ByValue)