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

Schedule - Update

参考

Service:: Automation

API Version:: 2023-11-01

更新按计划名称标识的计划。

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

URI 参数

名称	在	必需	类型	说明
automationAccountName	path	True	string	自动化帐户的名称。
resourceGroupName	path	True	string	Azure 资源组的名称。 Regex pattern: `^[-\w\._]+$`
scheduleName	path	True	string	计划名称。
subscriptionId	path	True	string	获取唯一标识 Microsoft Azure 订阅的订阅凭据。此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

请求正文

名称	类型	说明
name	string	获取或设置 Schedule 的名称。
properties.description	string	获取或设置计划的说明。
properties.isEnabled	boolean	获取或设置一个值，该值指示是否启用此计划。

响应

名称	类型	说明
200 OK	Schedule	确定
Other Status Codes	ErrorResponse	描述操作失败原因的自动化错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Update a schedule

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/schedules/mySchedule?api-version=2023-11-01

{
  "name": "mySchedule",
  "properties": {
    "description": "my updated description of schedule goes here",
    "isEnabled": false
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/schedules/mySchedule",
  "name": "mySchedule",
  "properties": {
    "description": "my updated description of schedule goes here",
    "startTime": "2017-03-27T17:28:00+00:00",
    "startTimeOffsetMinutes": 0,
    "expiryTime": "2017-04-01T17:28:00+00:00",
    "expiryTimeOffsetMinutes": 0,
    "isEnabled": false,
    "nextRun": "2017-03-27T17:28:00+00:00",
    "nextRunOffsetMinutes": 0,
    "interval": 1,
    "frequency": "Hour",
    "creationTime": "2017-03-27T16:59:22.697+00:00",
    "lastModifiedTime": "2017-03-27T16:59:22.697+00:00",
    "timeZone": "UTC"
  }
}

定义

名称	说明
AdvancedSchedule	创建高级计划的属性。
AdvancedScheduleMonthlyOccurrence	创建高级计划每月发生的属性。
ErrorResponse	操作失败的错误响应
Schedule	计划的定义。
ScheduleDay	发生日期。必须是星期一、星期二、星期三、星期四、星期五、星期六、星期日之一。
ScheduleFrequency	获取或设置计划的频率。
ScheduleUpdateParameters	提供给更新计划操作的参数。

AdvancedSchedule

创建高级计划的属性。

名称	类型	说明
monthDays	integer[]	应执行作业的月份中的天数。必须介于 1 和 31 之间。
monthlyOccurrences	AdvancedScheduleMonthlyOccurrence[]	一个月内的天数。
weekDays	string[]	执行作业的星期数。

AdvancedScheduleMonthlyOccurrence

创建高级计划每月发生的属性。

名称	类型	说明
day	ScheduleDay	发生日期。必须是星期一、星期二、星期三、星期四、星期五、星期六、星期日之一。
occurrence	integer	当月内发生一周的情况。必须介于 1 和 5 之间

ErrorResponse

操作失败的错误响应

名称	类型	说明
code	string	错误代码
message	string	指示操作失败原因的错误消息。

Schedule

计划的定义。

名称	类型	默认值	说明
id	string		资源的完全限定资源 ID
name	string		资源的名称
properties.advancedSchedule	AdvancedSchedule		获取或设置高级计划。
properties.creationTime	string		获取或设置创建时间。
properties.description	string		获取或设置说明。
properties.expiryTime	string		获取或设置计划的结束时间。
properties.expiryTimeOffsetMinutes	number		获取或设置过期时间的偏移量（以分钟为单位）。
properties.frequency	ScheduleFrequency		获取或设置计划的频率。
properties.interval			获取或设置计划的间隔。
properties.isEnabled	boolean	False	获取或设置一个值，该值指示是否启用此计划。
properties.lastModifiedTime	string		获取或设置上次修改时间。
properties.nextRun	string		获取或设置计划的下一个运行时。
properties.nextRunOffsetMinutes	number		获取或设置下一个运行时的偏移量（以分钟为单位）。
properties.startTime	string		获取或设置计划的开始时间。
properties.startTimeOffsetMinutes	number		获取开始时间的偏移量（以分钟为单位）。
properties.timeZone	string		获取或设置计划的时区。
type	string		资源类型。

ScheduleDay

发生日期。必须是星期一、星期二、星期三、星期四、星期五、星期六、星期日之一。

名称	类型	说明
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ScheduleFrequency

获取或设置计划的频率。

名称	类型	说明
Day	string
Hour	string
Minute	string	分钟计划允许的最小间隔为 15 分钟。
Month	string
OneTime	string
Week	string

ScheduleUpdateParameters

提供给更新计划操作的参数。

名称	类型	说明
name	string	获取或设置 Schedule 的名称。
properties.description	string	获取或设置计划的说明。
properties.isEnabled	boolean	获取或设置一个值，该值指示是否启用此计划。