Job - Get

Retrieve the job identified by job name.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}?api-version=2017-05-15-preview

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

Name of an Azure Resource group.

Regex pattern: ^[-\w\._]+$

automationAccountName
path True
  • string

The name of the automation account.

jobName
path True
  • string

The job name.

api-version
query True
  • string

Client Api Version.

Request Header

Name Required Type Description
clientRequestId
  • string

Identifies this specific client request.

Responses

Name Type Description
200 OK

OK

Other Status Codes

Automation error response describing why the operation failed.

Examples

Get job

Sample Request

GET https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/foo?api-version=2017-05-15-preview

Sample Response

{
  "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/jobName",
  "name": "foo",
  "type": "Microsoft.Automation/AutomationAccounts/Jobs",
  "properties": {
    "jobId": "5b8a3960-e8ab-45f6-bec6-567df8467d1a",
    "runbook": {
      "name": "TestRunbook"
    },
    "provisioningState": "Processing",
    "creationTime": "2018-02-01T05:53:30.243+00:00",
    "endTime": null,
    "exception": null,
    "lastModifiedTime": "2018-02-01T05:53:30.243+00:00",
    "lastStatusModifiedTime": "2018-02-01T05:53:30.243+00:00",
    "startTime": null,
    "status": "New",
    "statusDetails": "None",
    "parameters": {
      "tag01": "value01",
      "tag02": "value02"
    },
    "runOn": ""
  }
}

Definitions

ErrorResponse

Error response of an operation failure

Job

Definition of the job.

JobProvisioningState

The current provisioning state of the job.

JobStatus

Gets or sets the status of the job.

RunbookAssociationProperty

The runbook property associated with the entity.

ErrorResponse

Error response of an operation failure

Name Type Description
code
  • string

Error code

message
  • string

Error message indicating why the operation failed.

Job

Definition of the job.

Name Type Description
id
  • string

Fully qualified resource Id for the resource

name
  • string

The name of the resource

properties.creationTime
  • string

Gets or sets the creation time of the job.

properties.endTime
  • string

Gets or sets the end time of the job.

properties.exception
  • string

Gets or sets the exception of the job.

properties.jobId
  • string

Gets or sets the id of the job.

properties.lastModifiedTime
  • string

Gets or sets the last modified time of the job.

properties.lastStatusModifiedTime
  • string

Gets or sets the last status modified time of the job.

properties.parameters
  • object

Gets or sets the parameters of the job.

properties.provisioningState

The current provisioning state of the job.

properties.runOn
  • string

Gets or sets the runOn which specifies the group name where the job is to be executed.

properties.runbook

Gets or sets the runbook.

properties.startTime
  • string

Gets or sets the start time of the job.

properties.startedBy
  • string

Gets or sets the job started by.

properties.status

Gets or sets the status of the job.

properties.statusDetails
  • string

Gets or sets the status details of the job.

type
  • string

The type of the resource.

JobProvisioningState

The current provisioning state of the job.

Name Type Description
Failed
  • string
Processing
  • string
Succeeded
  • string
Suspended
  • string

JobStatus

Gets or sets the status of the job.

Name Type Description
Activating
  • string
Blocked
  • string
Completed
  • string
Disconnected
  • string
Failed
  • string
New
  • string
Removing
  • string
Resuming
  • string
Running
  • string
Stopped
  • string
Stopping
  • string
Suspended
  • string
Suspending
  • string

RunbookAssociationProperty

The runbook property associated with the entity.

Name Type Description
name
  • string

Gets or sets the name of the runbook.