Maintenance Configurations - List

服务:

Maintenance

API 版本:

2023-09-01-preview

获取订阅中的配置记录

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/maintenanceConfigurations?api-version=2023-09-01-preview

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	唯一标识Microsoft Azure 订阅的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string	要用于客户端请求的 API 的版本。

响应

名称	类型	说明
200 OK	ListMaintenanceConfigurationsResult	还行
Other Status Codes	MaintenanceError	BadRequest

示例

MaintenanceConfigurations_List

示例请求

HTTP

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/maintenanceConfigurations?api-version=2023-09-01-preview

示例响应

状态代码:

200

{
  "value": [
    {
      "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1",
      "name": "configuration1",
      "location": "westus2",
      "properties": {
        "namespace": "Microsoft.Maintenance",
        "maintenanceScope": "OSImage",
        "visibility": "Custom",
        "maintenanceWindow": {
          "startDateTime": "2020-04-30 08:00",
          "expirationDateTime": "9999-12-31 00:00",
          "duration": "05:00",
          "timeZone": "Pacific Standard Time",
          "recurEvery": "Week Saturday,Sunday"
        }
      }
    }
  ]
}

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorDetails	从 Azure 维护服务收到的错误响应详细信息。
InputLinuxParameters	用于修补 Linux 计算机的输入属性。
InputPatchConfiguration	修补程序运行的输入配置
InputWindowsParameters	用于修补 Windows 计算机的输入属性。
ListMaintenanceConfigurationsResult	MaintenanceConfigurations 响应列表
MaintenanceConfiguration	维护配置记录类型
MaintenanceError	从 Azure 维护服务收到的错误响应。
MaintenanceScope	获取或设置配置的 maintenanceScope
RebootOptions	根据用户定义的可能的重新启动首选项，根据该首选项，决定在完成修补操作后重启计算机。
systemData	与创建和上次修改资源相关的元数据。
Visibility	获取或设置配置的可见性。 默认值为“Custom”

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorDetails

Object

从 Azure 维护服务收到的错误响应详细信息。

名称	类型	说明
code	string	服务定义的错误代码。 此代码充当响应中指定的 HTTP 错误代码的子状态。
message	string	错误的人工可读表示形式。

InputLinuxParameters

Object

用于修补 Linux 计算机的输入属性。

名称	类型	说明
classificationsToInclude	string[]	要修补的修补程序的分类类别。 允许的值为“Critical”、“Security”和“Other”。
packageNameMasksToExclude	string[]	要排除用于修补的包名称。
packageNameMasksToInclude	string[]	要包括用于修补的包名称。

InputPatchConfiguration

Object

修补程序运行的输入配置

名称	类型	默认值	说明
linuxParameters	InputLinuxParameters		特定于修补 Linux 计算机的输入参数。 对于 Windows 计算机，请不要传递此属性。
rebootSetting	RebootOptions	IfRequired	根据用户定义的可能的重新启动首选项，根据该首选项，决定在完成修补操作后重启计算机。
windowsParameters	InputWindowsParameters		特定于修补 Windows 计算机的输入参数。 对于 Linux 计算机，请不要传递此属性。

InputWindowsParameters

Object

用于修补 Windows 计算机的输入属性。

名称	类型	说明
classificationsToInclude	string[]	要修补的修补程序的分类类别。 允许的值为“Critical”、“Security”、“UpdateRollup”、“FeaturePack”、“ServicePack”、“Definition”、“Tools”和“Updates”。
excludeKbsRequiringReboot	boolean	排除需要重新启动的修补程序
kbNumbersToExclude	string[]	要排除用于修补的 Windows KBID。
kbNumbersToInclude	string[]	要包括用于修补的 Windows KBID。

ListMaintenanceConfigurationsResult

Object

MaintenanceConfigurations 响应列表

名称	类型	说明
value	MaintenanceConfiguration[]	维护配置列表

MaintenanceConfiguration

Object

维护配置记录类型

名称	类型	说明
id	string	资源的完全限定标识符
location	string	获取或设置资源的位置
name	string	资源的名称
properties.extensionProperties	object	获取或设置 maintenanceConfiguration 的 extensionProperties
properties.installPatches	InputPatchConfiguration	要传递给修补程序运行操作的输入参数。
properties.maintenanceScope	MaintenanceScope	获取或设置配置的 maintenanceScope
properties.maintenanceWindow.duration	string	HH：mm 格式的维护时段持续时间。 如果未提供，将根据提供的维护范围使用默认值。 示例：05：00。
properties.maintenanceWindow.expirationDateTime	string	YYYY-MM-DD hh：mm 格式的维护时段的有效到期日期。 该窗口将在提供的时区中创建，并根据该时区调整为夏令时制。 到期日期必须设置为将来的日期。 如果未提供，它将设置为最大日期时间 9999-12-31 23：59：59。
properties.maintenanceWindow.recurEvery	string	维护时段应递归的速率。 费率可以表示为每日、每周或每月计划。 每日计划的格式为递归：[频率为整数]['Day（s）']。 如果未提供任何频率，则默认频率为 1。 每日计划示例为 recurEvery：Day、recurEvery：3Days。 每周计划的格式为递归：[频率为整数]['Week（s）'] [可选逗号分隔的工作日星期一-星期日列表]。 每周计划示例为 recurEvery：3Weeks、recurEvery：Week Week，Sunday。 每月计划的格式为 [Frequency as integer]['Month（s）'] [以逗号分隔的月日列表] 或 [Frequency as integer]['Month（s）'] [Month of Month （First， Second， Third， Fourth， Last）] [Weekday Monday-Sunday] [Optional Offset（No. days）]。 偏移值必须介于 -6 到 6（含 6） 之间。 每月计划示例为 recurEvery： Month， recurEvery： 2Months， recurEvery： Month day23，day24， recurEvery： Month Last Sunday， recurEvery： Month Fourth Monday， recurEvery： Month Last Sunday Offset-3， recurEvery： Month Third Sunday Offset6.
properties.maintenanceWindow.startDateTime	string	YYYY-MM-DD hh：mm 格式的维护时段的有效开始日期。 开始日期可以设置为当前日期或将来日期。 该窗口将在提供的时区中创建，并根据该时区调整为夏令时制。
properties.maintenanceWindow.timeZone	string	时区的名称。 可以通过在 PowerShell 中执行 [System.TimeZoneInfo]：：GetSystemTimeZones（）来获取时区列表。 示例：太平洋标准时间、UTC、W. 欧洲标准时间、韩国标准时间、Cen。 澳大利亚标准时间。
properties.namespace	string	获取或设置资源的命名空间
properties.visibility	Visibility	获取或设置配置的可见性。 默认值为“Custom”
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	获取或设置资源的标记
type	string	资源的类型

MaintenanceError

Object

从 Azure 维护服务收到的错误响应。

名称	类型	说明
error	ErrorDetails	错误的详细信息

MaintenanceScope

枚举

获取或设置配置的 maintenanceScope

值	说明
Host	此维护范围控制 Azure 平台更新的安装，即托管客户 VM 的物理节点上的服务。
Resource	此维护范围控制 Azure 资源的默认更新维护
OSImage	此维护范围控制 VM/VMSS 上的 OS 映像安装
Extension	此维护范围控制 VM/VMSS 上的扩展安装
InGuestPatch	此维护范围控制 VM/VMSS 上 Windows 和 linux 包的安装
SQLDB	此维护范围控制 SQL Server 平台更新的安装。
SQLManagedInstance	此维护范围控制 SQL 托管实例平台更新的安装。

RebootOptions

枚举

根据用户定义的可能的重新启动首选项，根据该首选项，决定在完成修补操作后重启计算机。

值	说明
IfRequired
Never
Always

systemData

Object

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

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

Visibility

枚举

获取或设置配置的可见性。 默认值为“Custom”

值	说明
Custom	仅对具有权限的用户可见。
Public	对所有用户可见。