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

Maintenance Configurations - Create Or Update

在指定的托管群集中创建或更新维护配置。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}?api-version=2025-03-01

URI 参数

名称 必需 类型 说明
configName
path True

string

维护配置的名称。

resourceGroupName
path True

string

minLength: 1
maxLength: 90

资源组的名称。 此名称不区分大小写。

resourceName
path True

string

minLength: 1
maxLength: 63
pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$

托管群集资源的名称。

subscriptionId
path True

string (uuid)

目标订阅的 ID。 该值必须是 UUID。

api-version
query True

string

minLength: 1

用于此操作的 API 版本。

请求正文

名称 类型 说明
properties.maintenanceWindow

MaintenanceWindow

维护配置的维护时段。

properties.notAllowedTime

TimeSpan[]

不允许升级的时间段。

properties.timeInWeek

TimeInWeek[]

允许计划内维护继续的一周中的时间段。
如果两个数组条目指定一周中的同一天,则应用的配置是这两个条目中的时间联合。

响应

名称 类型 说明
200 OK

MaintenanceConfiguration

已成功更新现有的维护配置。

201 Created

MaintenanceConfiguration

已成功创建新的维护配置。

Other Status Codes

CloudError

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

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Create/Update Maintenance Configuration
Create/Update Maintenance Configuration with Maintenance Window

Create/Update Maintenance Configuration

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default?api-version=2025-03-01

{
  "properties": {
    "timeInWeek": [
      {
        "day": "Monday",
        "hourSlots": [
          1,
          2
        ]
      }
    ],
    "notAllowedTime": [
      {
        "start": "2020-11-26T03:00:00Z",
        "end": "2020-11-30T12:00:00Z"
      }
    ]
  }
}

示例响应

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default",
  "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations",
  "name": "default",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "timeInWeek": [
      {
        "day": "Monday",
        "hourSlots": [
          1,
          2
        ]
      }
    ],
    "notAllowedTime": [
      {
        "start": "2020-11-26T03:00:00Z",
        "end": "2020-11-30T12:00:00Z"
      }
    ]
  }
}
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default",
  "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations",
  "name": "default",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "timeInWeek": [
      {
        "day": "Monday",
        "hourSlots": [
          1,
          2
        ]
      }
    ],
    "notAllowedTime": [
      {
        "start": "2020-11-26T03:00:00Z",
        "end": "2020-11-30T12:00:00Z"
      }
    ]
  }
}

Create/Update Maintenance Configuration with Maintenance Window

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule?api-version=2025-03-01

{
  "properties": {
    "maintenanceWindow": {
      "schedule": {
        "relativeMonthly": {
          "intervalMonths": 3,
          "weekIndex": "First",
          "dayOfWeek": "Monday"
        }
      },
      "durationHours": 10,
      "utcOffset": "+05:30",
      "startDate": "2023-01-01",
      "startTime": "08:30",
      "notAllowedDates": [
        {
          "start": "2023-02-18",
          "end": "2023-02-25"
        },
        {
          "start": "2023-12-23",
          "end": "2024-01-05"
        }
      ]
    }
  }
}

示例响应

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule",
  "name": "aksManagedAutoUpgradeSchedule",
  "properties": {
    "maintenanceWindow": {
      "schedule": {
        "weekly": {
          "intervalWeeks": 3,
          "dayOfWeek": "Monday"
        }
      },
      "durationHours": 10,
      "utcOffset": "+05:30",
      "startDate": "2023-01-01",
      "startTime": "08:30",
      "notAllowedDates": [
        {
          "start": "2023-02-18",
          "end": "2023-02-25"
        },
        {
          "start": "2023-12-23",
          "end": "2024-01-05"
        }
      ]
    }
  }
}
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule",
  "name": "aksManagedAutoUpgradeSchedule",
  "properties": {
    "maintenanceWindow": {
      "schedule": {
        "weekly": {
          "intervalWeeks": 3,
          "dayOfWeek": "Monday"
        }
      },
      "durationHours": 10,
      "utcOffset": "+05:30",
      "startDate": "2023-01-01",
      "startTime": "08:30",
      "notAllowedDates": [
        {
          "start": "2023-02-18",
          "end": "2023-02-25"
        },
        {
          "start": "2023-12-23",
          "end": "2024-01-05"
        }
      ]
    }
  }
}

定义

名称 说明
AbsoluteMonthlySchedule

对于计划,例如:“15 日每月递归”或“20 日每 3 个月递归一次”。

CloudError

容器服务的错误响应。

CloudErrorBody

容器服务的错误响应。

createdByType

创建资源的标识的类型。

DailySchedule

对于计划,例如:“每天递归”或“每 3 天递归一次”。

DateSpan

日期范围。

MaintenanceConfiguration

计划内维护配置,用于配置何时可以将更新部署到托管群集。

MaintenanceWindow

用于为托管群集配置计划的自动升级的维护时段。

RelativeMonthlySchedule

对于计划,例如:“在第一个星期一每月递归”或“上周五每 3 个月递归一次”。

Schedule

应指定一种和仅一种计划类型。 为维护计划选择“daily”、“weekly”、“absoluteMonthly”或“relativeMonthly”。

systemData

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

TimeInWeek

一周内的时间。

TimeSpan

时间范围。

type

周索引。

WeekDay

工作日枚举。

WeeklySchedule

对于计划,例如:“每周一递归”或“周三每 3 周重复一次”。

AbsoluteMonthlySchedule

对于计划,例如:“15 日每月递归”或“20 日每 3 个月递归一次”。

名称 类型 说明
dayOfMonth

integer (int32)

minimum: 1
maximum: 31

月份的日期。

intervalMonths

integer (int32)

minimum: 1
maximum: 6

指定每个匹配项集之间的月数。

CloudError

容器服务的错误响应。

名称 类型 说明
error

CloudErrorBody

有关错误的详细信息。

CloudErrorBody

容器服务的错误响应。

名称 类型 说明
code

string

错误的标识符。 代码是固定的,旨在以编程方式使用。

details

CloudErrorBody[]

有关错误的其他详细信息的列表。

message

string

描述错误的消息,旨在适合在用户界面中显示。

target

string

特定错误的目标。 例如,错误属性的名称。

createdByType

创建资源的标识的类型。

说明
Application
Key
ManagedIdentity
User

DailySchedule

对于计划,例如:“每天递归”或“每 3 天递归一次”。

名称 类型 说明
intervalDays

integer (int32)

minimum: 1
maximum: 7

指定每个匹配项集之间的天数。

DateSpan

日期范围。

名称 类型 说明
end

string (date)

日期范围的结束日期。

start

string (date)

日期范围的开始日期。

MaintenanceConfiguration

计划内维护配置,用于配置何时可以将更新部署到托管群集。

名称 类型 说明
id

string

资源 ID。

name

string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.maintenanceWindow

MaintenanceWindow

维护配置的维护时段。

properties.notAllowedTime

TimeSpan[]

不允许升级的时间段。

properties.timeInWeek

TimeInWeek[]

允许计划内维护继续的一周中的时间段。
如果两个数组条目指定一周中的同一天,则应用的配置是这两个条目中的时间联合。

systemData

systemData

与此资源相关的系统元数据。

type

string

资源类型

MaintenanceWindow

用于为托管群集配置计划的自动升级的维护时段。

名称 类型 默认值 说明
durationHours

integer (int32)

minimum: 4
maximum: 24
24

维护时段的长度从 4 小时到 24 小时不等。

notAllowedDates

DateSpan[]

不允许升级的日期范围。 “utcOffset”适用于此字段。 例如,将“utcOffset: +02:00”和“dateSpan”设置为“2022-12-23”到“2023-01-03”, 在 UTC 时间,维护将被阻止从“2022-12-22 22:00”到“2023-01-03 22:00”。

schedule

Schedule

维护时段的定期计划。

startDate

string (date)

维护时段激活的日期。 如果当前日期在此日期之前,则维护时段处于非活动状态,不会用于升级。 如果未指定,则维护时段将立即处于活动状态。

startTime

string

pattern: ^\d{2}:\d{2}$

维护时段的开始时间。 接受的值从“00:00”到“23:59”。 “utcOffset”适用于此字段。 例如:带有“utcOffset: +02:00”的“02:00”表示 UTC 时间“00:00”。

utcOffset

string

pattern: ^(-|\+)[0-9]{2}:[0-9]{2}$

格式为 +/-HH:mm 的 UTC 偏移量。 例如,IST 的“+05:30”和 PST 的“-07:00”。 如果未指定,则默认值为“+00:00”。

RelativeMonthlySchedule

对于计划,例如:“在第一个星期一每月递归”或“上周五每 3 个月递归一次”。

名称 类型 说明
dayOfWeek

WeekDay

指定发生维护的星期几。

intervalMonths

integer (int32)

minimum: 1
maximum: 6

指定每个匹配项集之间的月数。

weekIndex

type

周索引。
指定应用 dayOfWeek 的月份中的哪一周。

Schedule

应指定一种和仅一种计划类型。 为维护计划选择“daily”、“weekly”、“absoluteMonthly”或“relativeMonthly”。

名称 类型 说明
absoluteMonthly

AbsoluteMonthlySchedule

对于计划,例如:“15 日每月递归”或“20 日每 3 个月递归一次”。

daily

DailySchedule

对于计划,例如:“每天递归”或“每 3 天递归一次”。

relativeMonthly

RelativeMonthlySchedule

对于计划,例如:“在第一个星期一每月递归”或“上周五每 3 个月递归一次”。

weekly

WeeklySchedule

对于计划,例如:“每周一递归”或“周三每 3 周重复一次”。

systemData

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

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳(UTC)。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识的类型。

lastModifiedAt

string (date-time)

上次修改的资源时间戳(UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

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

TimeInWeek

一周内的时间。

名称 类型 说明
day

WeekDay

一周中的一天。

hourSlots

integer[] (int32)

minimum: 0
maximum: 23

用于标识时间范围的一天中的小时列表。
每个整数小时表示一个时间范围,从下一小时结束的小时后 0 米(非含)。 0 对应于 00:00 UTC,23 对应于 23:00 UTC。 指定 [0, 1] 表示 00:00 - 02:00 UTC 时间范围。

TimeSpan

时间范围。

名称 类型 说明
end

string (date-time)

时间跨度结束

start

string (date-time)

时间跨度的开始

type

周索引。

说明
First

当月的第一周。

Fourth

每月第四周。

Last

本月的最后一周。

Second

每月的第二周。

Third

每月第三周。

WeekDay

工作日枚举。

说明
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

WeeklySchedule

对于计划,例如:“每周一递归”或“周三每 3 周重复一次”。

名称 类型 说明
dayOfWeek

WeekDay

指定发生维护的星期几。

intervalWeeks

integer (int32)

minimum: 1
maximum: 4

指定每组重复间隔的周数。