Get-AzureRmBackupJobDetails

Reference

Module:: AzureRM.Backup

Gets the details of a Backup job.

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

Get-AzureRmBackupJobDetails
   -Job <AzureRMBackupJob>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmBackupJobDetails
   -Vault <AzureRMBackupVault>
   -JobId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmBackupJobDetails cmdlet gets the details of an Azure Backup job. You can use this cmdlet to gather information about a job that fails.

Examples

Example 1: Display the details of a failed job

PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" 
PS C:\> $Jobs = Get-AzureRmBackupJob -Vault $Vault -Status Failed
PS C:\> $JobDetails = Get-AzureRmBackupJobDetails -Job $Jobs[0]
PS C:\> $JobDetails.ErrorDetails
ErrorCode ErrorMessage                            Recommendations
--------- ------------                            ---------------
   400001 Command execution failed.               {Another operation is currently in p...

The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores that object in the $Vault variable. The second command gets failed jobs from the vault in $Vault, and then stores them in the $Jobs array variable. The third job gets details for the first job in the $Jobs variable, and then stores those details in the $JobDetails variable. The final command displays the ErrorDetails property of $JobDetails by using standard dot syntax.

Example 2: Display the recommended action for a failed job

PS C:\>$JobDetails.ErrorDetails.Recommendations
Another operation is currently in progress on this item. Please wait until the previous operation is completed, and then retry.

This command displays the recommended action from the $JobDetails variable that was created in the first example.

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 for which this cmdlet gets details. To obtain an AzureRmBackupJob object, use the Get-AzureRmBackupJob cmdlet.

Type:	AzureRMBackupJob
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-JobId

Specifies the ID of a job for which this cmdlet gets details. The ID is the InstanceId property of an AzureRmBackupJob object. To obtain an AzureRmBackupJob object, use Get-AzureRmBackupJob.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Vault

Specifies the Backup vault for which this cmdlet gets job details. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet.

Type:	AzureRMBackupVault
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

AzureRMBackupJob

Parameters: Job (ByValue)

Outputs

AzureRMBackupJobDetails