Get-AzureRmBackupJobDetails

NAME Get-AzureRmBackupJobDetails



SYNOPSIS

Gets the details of a Backup job.





SYNTAX

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



Get-AzureRmBackupJobDetails [-DefaultProfile <IAzureContextContainer>] -JobId <String> -Vault <AzureRMBackupVault> [<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.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Job <AzureRMBackupJob>

Specifies a job for which this cmdlet gets details. To obtain an AzureRmBackupJob object, use the Get-AzureRmBackupJob cmdlet.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-JobId <String>

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.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Vault <AzureRMBackupVault>

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

cmdlet.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None







OUTPUTS

AzureRmBackupJobDetails







NOTES





* None



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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... jobdetails

Get-AzureRmBackupJob

Get-AzureRmBackupVault