通过

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

Job - Create

服务:
Automation
API 版本:
2024-10-23

创建 Runbook 的作业。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}?api-version=2024-10-23

URI 参数

名称 在 必需 类型 说明
automationAccountName
 path True

string

自动化帐户的名称。
jobName
 path True

string

作业名称。
resourceGroupName
 path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._]+$

Azure 资源组的名称。
subscriptionId
 path True

string

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

string

客户端 API 版本。

请求头

名称 必需 类型 说明
clientRequestId

string

标识此特定的客户端请求。

请求正文

名称 类型 说明
properties.parameters

object

获取或设置作业的参数。
properties.runOn

string

获取或设置 runOn，它指定要在其中执行作业的组名称。
properties.runbook

RunbookAssociationProperty

获取或设置 Runbook。

响应

名称 类型 说明
201 Created

Job

已创建
Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Create job

示例请求

PUT https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/foo?api-version=2024-10-23

{
  "properties": {
    "runbook": {
      "name": "TestRunbook"
    },
    "parameters": {
      "key01": "value01",
      "key02": "value02"
    },
    "runOn": ""
  }
}

示例响应

状态代码:
201 
{
  "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": "",
    "jobRuntimeEnvironment": {
      "runtimeEnvironmentName": "environmentName"
    }
  }
}

定义

名称 说明
createdByType

创建资源的标识的类型。
ErrorResponse

操作失败的错误响应
Job

作业的定义。
JobCreateParameters

提供给创建作业作的参数。
JobProvisioningState

作业的当前预配状态。
JobRuntimeEnvironment

与实体关联的 Runbook 属性。
JobStatus

获取或设置作业的状态。
RunbookAssociationProperty

与实体关联的 Runbook 属性。
systemData

与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值 说明
User
Application
ManagedIdentity
Key

ErrorResponse

Object

操作失败的错误响应

名称 类型 说明
code

string

错误代码
message

string

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

Job

Object

作业的定义。

名称 类型 说明
id

string (arm-id)

资源的完全限定的资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name

string

资源的名称
properties.creationTime

string (date-time)

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

string (date-time)

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

string

获取或设置作业的异常。
properties.jobId

string (uuid)

获取或设置作业的 ID。
properties.jobRuntimeEnvironment

JobRuntimeEnvironment

运行时环境属性
properties.lastModifiedTime

string (date-time)

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

string (date-time)

获取或设置作业的最后一次状态修改时间。
properties.parameters

object

获取或设置作业的参数。
properties.provisioningState

JobProvisioningState

作业的当前预配状态。
properties.runOn

string

获取或设置 runOn，它指定要在其中执行作业的组名称。
properties.runbook

RunbookAssociationProperty

获取或设置 Runbook。
properties.startTime

string (date-time)

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

string

获取或设置从其开始的作业。
properties.status

JobStatus

获取或设置作业的状态。
properties.statusDetails

string

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

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

JobCreateParameters

Object

提供给创建作业作的参数。

名称 类型 说明
properties.parameters

object

获取或设置作业的参数。
properties.runOn

string

获取或设置 runOn，它指定要在其中执行作业的组名称。
properties.runbook

RunbookAssociationProperty

获取或设置 Runbook。

JobProvisioningState

枚举

作业的当前预配状态。

值 说明
Failed
Succeeded
Suspended
Processing

JobRuntimeEnvironment

Object

与实体关联的 Runbook 属性。

名称 类型 说明
runtimeEnvironmentName

string

运行时环境的名称。

JobStatus

枚举

获取或设置作业的状态。

值 说明
New
Activating
Running
Completed
Failed
Stopped
Blocked
Suspended
Disconnected
Suspending
Stopping
Resuming
Removing

RunbookAssociationProperty

Object

与实体关联的 Runbook 属性。

名称 类型 说明
name

string

获取或设置 Runbook 的名称。

systemData

Object

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳（UTC）。
createdBy

string

创建资源的标识。
createdByType

createdByType

创建资源的标识的类型。
lastModifiedAt

string (date-time)

上次修改的资源时间戳（UTC）
lastModifiedBy

string

上次修改资源的标识。
lastModifiedByType

createdByType

上次修改资源的标识的类型。