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

Job Schedule - Create

创建作业计划。

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

URI 参数

名称 必需 类型 说明
automationAccountName
path True

string

自动化帐户的名称。

jobScheduleId
path True

string

uuid

作业计划名称。

resourceGroupName
path True

string

Azure 资源组的名称。

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

subscriptionId
path True

string

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

api-version
query True

string

客户端 API 版本。

请求正文

名称 必需 类型 说明
properties.runbook True

RunbookAssociationProperty

获取或设置 Runbook。

properties.schedule True

ScheduleAssociationProperty

获取或设置计划。

properties.parameters

object

获取或设置作业属性的列表。

properties.runOn

string

获取或设置计划作业应在其上运行的混合辅助角色组。

响应

名称 类型 说明
201 Created

JobSchedule

创建

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Create a job schedule

示例请求

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobSchedules/0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc?api-version=2023-11-01

{
  "properties": {
    "schedule": {
      "name": "ScheduleNameGoesHere332204b5-debe-4348-a5c7-6357457189f2"
    },
    "runbook": {
      "name": "TestRunbook"
    },
    "parameters": {
      "jobscheduletag01": "jobschedulevalue01",
      "jobscheduletag02": "jobschedulevalue02"
    }
  }
}

示例响应

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobSchedules/0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
  "properties": {
    "jobScheduleId": "0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
    "runbook": {
      "name": "TestRunbook"
    },
    "schedule": {
      "name": "ScheduleNameGoesHere332204b5-debe-4348-a5c7-6357457189f2"
    },
    "runOn": null,
    "parameters": {
      "jobscheduletag01": "jobschedulevalue01",
      "jobscheduletag02": "jobschedulevalue02"
    }
  }
}

定义

名称 说明
ErrorResponse

操作失败的错误响应

JobSchedule

作业计划的定义。

JobScheduleCreateParameters

提供给创建作业计划操作的参数。

RunbookAssociationProperty

与实体关联的 Runbook 属性。

ScheduleAssociationProperty

与实体关联的 schedule 属性。

ErrorResponse

操作失败的错误响应

名称 类型 说明
code

string

错误代码

message

string

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

JobSchedule

作业计划的定义。

名称 类型 说明
id

string

获取资源的 ID。

name

string

获取变量名。

properties.jobScheduleId

string

获取或设置作业计划的 ID。

properties.parameters

object

获取或设置作业计划的参数。

properties.runOn

string

获取或设置计划作业应在其上运行的混合辅助角色组。

properties.runbook

RunbookAssociationProperty

获取或设置 Runbook。

properties.schedule

ScheduleAssociationProperty

获取或设置计划。

type

string

资源类型

JobScheduleCreateParameters

提供给创建作业计划操作的参数。

名称 类型 说明
properties.parameters

object

获取或设置作业属性的列表。

properties.runOn

string

获取或设置计划作业应在其上运行的混合辅助角色组。

properties.runbook

RunbookAssociationProperty

获取或设置 Runbook。

properties.schedule

ScheduleAssociationProperty

获取或设置计划。

RunbookAssociationProperty

与实体关联的 Runbook 属性。

名称 类型 说明
name

string

获取或设置 Runbook 的名称。

ScheduleAssociationProperty

与实体关联的 schedule 属性。

名称 类型 说明
name

string

获取或设置 Schedule 的名称。