Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Get-AzureAutomationJob

Get-AzureAutomationJob

microsoft.windowsazure.commands.dll, microsoft.azure.commands.automation.dll, microsoft.azure.commands.resourcemanager.automation.dll

Synopsis

Gets one or more Azure Automation runbook jobs.

Syntax

Get-AzureAutomationJob [-AutomationAccountName] [-EndTime] [-StartTime] [<CommonParameters>]

Get-AzureAutomationJob [-AutomationAccountName] [-Id] [<CommonParameters>]

Get-AzureAutomationJob [-AutomationAccountName] [-EndTime] [-StartTime] [-RunbookId] [<CommonParameters>]

Get-AzureAutomationJob [-AutomationAccountName] [-EndTime] [-StartTime] [-RunbookName] [<CommonParameters>]

Detailed Description

The Get-AzureAutomationJob cmdlet gets one or more runbook jobs in Microsoft Azure Automation.

Parameters

-AutomationAccountName <String>

Specifies the name of an Azure Automation account.

Aliases

none

Required?

true

Position

1

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

-EndTime <DateTime>

Specifies the end time for a job as a DateTime object. This cmdlet gets jobs that have an end time at or before the value that this parameter specifies. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Id <Guid>

Specifies the ID of a job.

Aliases

JobId

Required?

true

Position

named

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

-RunbookId <Guid>

Specifies the ID of a runbook.

Aliases

none

Required?

true

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-RunbookName <String>

Specifies the name of a runbook.

Aliases

none

Required?

true

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-StartTime <DateTime>

Specifies the start time of a job as a DateTime object. This cmdlet gets jobs that have a start time at or after the value that this parameter specifies. To obtain a DateTime object, use the Get-Date cmdlet.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Get a runbook job

This command gets the job that has the specified GUID.

PS C:\>Get-AzureAutomationJob -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b647

Online Version
Resume-AzureAutomationJob
Stop-AzureAutomationJob
Suspend-AzureAutomationJob