你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Job - Get

检索由作业名称标识的作业。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}?api-version=2023-11-01

URI 参数

名称 必需 类型 说明
automationAccountName
path True

string

自动化帐户的名称。

jobName
path True

string

作业名称。

resourceGroupName
path True

string

Azure 资源组的名称。

正则表达式模式: ^[-\w\._]+$

subscriptionId
path True

string

获取唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

客户端 API 版本。

请求头

名称 必需 类型 说明
clientRequestId

string

标识此特定客户端请求。

响应

名称 类型 说明
200 OK

Job

确定

Other Status Codes

ErrorResponse

描述操作失败原因的自动化错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Get job

示例请求

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

示例响应

{
  "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": ""
  }
}

定义

名称 说明
ErrorResponse

操作失败的错误响应

Job

作业的定义。

JobProvisioningState

作业的当前预配状态。

JobStatus

获取或设置作业的状态。

RunbookAssociationProperty

与实体关联的 Runbook 属性。

ErrorResponse

操作失败的错误响应

名称 类型 说明
code

string

错误代码

message

string

指示操作失败原因的错误消息。

Job

作业的定义。

名称 类型 说明
id

string

资源的完全限定资源 ID

name

string

资源的名称

properties.creationTime

string

获取或设置作业的创建时间。

properties.endTime

string

获取或设置作业的结束时间。

properties.exception

string

获取或设置作业的异常。

properties.jobId

string

获取或设置作业的 ID。

properties.lastModifiedTime

string

获取或设置作业的上次修改时间。

properties.lastStatusModifiedTime

string

获取或设置作业的上次状态修改时间。

properties.parameters

object

获取或设置作业的参数。

properties.provisioningState

JobProvisioningState

作业的当前预配状态。

properties.runOn

string

获取或设置 runOn,它指定要在其中执行作业的组名。

properties.runbook

RunbookAssociationProperty

获取或设置 Runbook。

properties.startTime

string

获取或设置作业的开始时间。

properties.startedBy

string

获取或设置启动的作业。

properties.status

JobStatus

获取或设置作业的状态。

properties.statusDetails

string

获取或设置作业的状态详细信息。

type

string

资源类型。

JobProvisioningState

作业的当前预配状态。

名称 类型 说明
Failed

string

Processing

string

Succeeded

string

Suspended

string

JobStatus

获取或设置作业的状态。

名称 类型 说明
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

与实体关联的 Runbook 属性。

名称 类型 说明
name

string

获取或设置 Runbook 的名称。