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

Microsoft.Maintenance maintenanceConfigurations 2021-09-01-preview

Bicep 资源定义

可以使用目标操作部署 maintenanceConfigurations 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Maintenance/maintenanceConfigurations 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Maintenance/maintenanceConfigurations@2021-09-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    extensionProperties: {
      {customized property}: 'string'
    }
    installPatches: {
      linuxParameters: {
        classificationsToInclude: [
          'string'
        ]
        packageNameMasksToExclude: [
          'string'
        ]
        packageNameMasksToInclude: [
          'string'
        ]
      }
      rebootSetting: 'string'
      tasks: {
        postTasks: [
          {
            parameters: {
              {customized property}: 'string'
            }
            source: 'string'
            taskScope: 'string'
          }
        ]
        preTasks: [
          {
            parameters: {
              {customized property}: 'string'
            }
            source: 'string'
            taskScope: 'string'
          }
        ]
      }
      windowsParameters: {
        classificationsToInclude: [
          'string'
        ]
        excludeKbsRequiringReboot: bool
        kbNumbersToExclude: [
          'string'
        ]
        kbNumbersToInclude: [
          'string'
        ]
      }
    }
    maintenanceScope: 'string'
    maintenanceWindow: {
      duration: 'string'
      expirationDateTime: 'string'
      recurEvery: 'string'
      startDateTime: 'string'
      timeZone: 'string'
    }
    namespace: 'string'
    visibility: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

InputLinuxParameters

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

InputPatchConfiguration

名字 描述 价值
linuxParameters 特定于修补 Linux 计算机的输入参数。 对于 Windows 计算机,请不要传递此属性。 此属性仅适用于 Guest (InGuestPatch) 范围。 InputLinuxParameters
rebootSetting 根据用户定义的可能的重新启动首选项,根据该首选项,决定在完成修补操作后重启计算机。 此属性仅适用于 Guest (InGuestPatch) 范围。 “Always”
“IfRequired”
“永不”
任务 [不支持]软件更新配置的任务信息。 SoftwareUpdateConfigurationTasks
windowsParameters 特定于修补 Windows 计算机的输入参数。 对于 Linux 计算机,请不要传递此属性。 此属性仅适用于 Guest (InGuestPatch) 范围。 InputWindowsParameters

InputWindowsParameters

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

MaintenanceConfigurationProperties

名字 描述 价值
extensionProperties 获取或设置 maintenanceConfiguration 的 extensionProperties MaintenanceConfigurationPropertiesExtensionProperties
installPatches 要传递给修补程序运行操作的输入参数。 此属性仅适用于 Guest (InGuestPatch) 范围。 InputPatchConfiguration
maintenanceScope 获取或设置配置的 maintenanceScope “Extension”
“Host”
“InGuestPatch”
“OSImage”
“SQLDB”
“SQLManagedInstance”
maintenanceWindow MaintenanceWindow 的定义 MaintenanceWindow
Namespace 获取或设置资源的命名空间 字符串
能见度 获取或设置配置的可见性。 默认值为“Custom” “Custom”
“Public”

MaintenanceConfigurationPropertiesExtensionProperties

名字 描述 价值

MaintenanceConfigurationTags

名字 描述 价值

MaintenanceWindow

名字 描述 价值
期间 HH:mm 格式的维护时段持续时间。 如果未提供,将根据提供的维护范围使用默认值。 示例:05:00。 字符串
expirationDateTime YYYY-MM-DD hh:mm 格式的维护时段的有效到期日期。 该窗口将在提供的时区中创建,并根据该时区调整为夏令时制。 到期日期必须设置为将来的日期。 如果未提供,它将设置为最大日期时间 9999-12-31 23:59:59。 字符串
recurEvery 维护时段应递归的速率。 费率可以表示为每日、每周或每月计划。 每日计划的格式为递归:[频率为整数]['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. 字符串
startDateTime YYYY-MM-DD hh:mm 格式的维护时段的有效开始日期。 开始日期可以设置为当前日期或将来日期。 该窗口将在提供的时区中创建,并根据该时区调整为夏令时制。 字符串
timeZone 时区的名称。 可以通过在 PowerShell 中执行 [System.TimeZoneInfo]::GetSystemTimeZones()来获取时区列表。 示例:太平洋标准时间、UTC、W. 欧洲标准时间、韩国标准时间、Cen。 澳大利亚标准时间。 字符串

Microsoft.Maintenance/maintenanceConfigurations

名字 描述 价值
位置 获取或设置资源的位置 字符串
名字 资源名称 string (必需)
性能 获取或设置资源的属性 MaintenanceConfigurationProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

SoftwareUpdateConfigurationTasks

名字 描述 价值
postTasks [不支持]帖子任务列表。 例如 [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] TaskProperties[]
preTasks [不支持]预任务列表。 例如 [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] TaskProperties[]

TaskProperties

名字 描述 价值
参数 [不支持]获取或设置任务的参数。 TaskPropertiesParameters
[不支持]获取或设置 Runbook 的名称。 字符串
taskScope [不支持]计划触发器时,全局任务执行一次。 为每个 VM 执行资源任务。 “Global”
“Resource”

TaskPropertiesParameters

名字 描述 价值

ARM 模板资源定义

可以使用目标操作部署 maintenanceConfigurations 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Maintenance/maintenanceConfigurations 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Maintenance/maintenanceConfigurations",
  "apiVersion": "2021-09-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "extensionProperties": {
      "{customized property}": "string"
    },
    "installPatches": {
      "linuxParameters": {
        "classificationsToInclude": [ "string" ],
        "packageNameMasksToExclude": [ "string" ],
        "packageNameMasksToInclude": [ "string" ]
      },
      "rebootSetting": "string",
      "tasks": {
        "postTasks": [
          {
            "parameters": {
              "{customized property}": "string"
            },
            "source": "string",
            "taskScope": "string"
          }
        ],
        "preTasks": [
          {
            "parameters": {
              "{customized property}": "string"
            },
            "source": "string",
            "taskScope": "string"
          }
        ]
      },
      "windowsParameters": {
        "classificationsToInclude": [ "string" ],
        "excludeKbsRequiringReboot": "bool",
        "kbNumbersToExclude": [ "string" ],
        "kbNumbersToInclude": [ "string" ]
      }
    },
    "maintenanceScope": "string",
    "maintenanceWindow": {
      "duration": "string",
      "expirationDateTime": "string",
      "recurEvery": "string",
      "startDateTime": "string",
      "timeZone": "string"
    },
    "namespace": "string",
    "visibility": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

InputLinuxParameters

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

InputPatchConfiguration

名字 描述 价值
linuxParameters 特定于修补 Linux 计算机的输入参数。 对于 Windows 计算机,请不要传递此属性。 此属性仅适用于 Guest (InGuestPatch) 范围。 InputLinuxParameters
rebootSetting 根据用户定义的可能的重新启动首选项,根据该首选项,决定在完成修补操作后重启计算机。 此属性仅适用于 Guest (InGuestPatch) 范围。 “Always”
“IfRequired”
“永不”
任务 [不支持]软件更新配置的任务信息。 SoftwareUpdateConfigurationTasks
windowsParameters 特定于修补 Windows 计算机的输入参数。 对于 Linux 计算机,请不要传递此属性。 此属性仅适用于 Guest (InGuestPatch) 范围。 InputWindowsParameters

InputWindowsParameters

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

MaintenanceConfigurationProperties

名字 描述 价值
extensionProperties 获取或设置 maintenanceConfiguration 的 extensionProperties MaintenanceConfigurationPropertiesExtensionProperties
installPatches 要传递给修补程序运行操作的输入参数。 此属性仅适用于 Guest (InGuestPatch) 范围。 InputPatchConfiguration
maintenanceScope 获取或设置配置的 maintenanceScope “Extension”
“Host”
“InGuestPatch”
“OSImage”
“SQLDB”
“SQLManagedInstance”
maintenanceWindow MaintenanceWindow 的定义 MaintenanceWindow
Namespace 获取或设置资源的命名空间 字符串
能见度 获取或设置配置的可见性。 默认值为“Custom” “Custom”
“Public”

MaintenanceConfigurationPropertiesExtensionProperties

名字 描述 价值

MaintenanceConfigurationTags

名字 描述 价值

MaintenanceWindow

名字 描述 价值
期间 HH:mm 格式的维护时段持续时间。 如果未提供,将根据提供的维护范围使用默认值。 示例:05:00。 字符串
expirationDateTime YYYY-MM-DD hh:mm 格式的维护时段的有效到期日期。 该窗口将在提供的时区中创建,并根据该时区调整为夏令时制。 到期日期必须设置为将来的日期。 如果未提供,它将设置为最大日期时间 9999-12-31 23:59:59。 字符串
recurEvery 维护时段应递归的速率。 费率可以表示为每日、每周或每月计划。 每日计划的格式为递归:[频率为整数]['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. 字符串
startDateTime YYYY-MM-DD hh:mm 格式的维护时段的有效开始日期。 开始日期可以设置为当前日期或将来日期。 该窗口将在提供的时区中创建,并根据该时区调整为夏令时制。 字符串
timeZone 时区的名称。 可以通过在 PowerShell 中执行 [System.TimeZoneInfo]::GetSystemTimeZones()来获取时区列表。 示例:太平洋标准时间、UTC、W. 欧洲标准时间、韩国标准时间、Cen。 澳大利亚标准时间。 字符串

Microsoft.Maintenance/maintenanceConfigurations

名字 描述 价值
apiVersion API 版本 '2021-09-01-preview'
位置 获取或设置资源的位置 字符串
名字 资源名称 string (必需)
性能 获取或设置资源的属性 MaintenanceConfigurationProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Maintenance/maintenanceConfigurations”

SoftwareUpdateConfigurationTasks

名字 描述 价值
postTasks [不支持]帖子任务列表。 例如 [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] TaskProperties[]
preTasks [不支持]预任务列表。 例如 [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] TaskProperties[]

TaskProperties

名字 描述 价值
参数 [不支持]获取或设置任务的参数。 TaskPropertiesParameters
[不支持]获取或设置 Runbook 的名称。 字符串
taskScope [不支持]计划触发器时,全局任务执行一次。 为每个 VM 执行资源任务。 “Global”
“Resource”

TaskPropertiesParameters

名字 描述 价值

Terraform (AzAPI 提供程序)资源定义

可以使用目标操作部署 maintenanceConfigurations 资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Maintenance/maintenanceConfigurations 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Maintenance/maintenanceConfigurations@2021-09-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      extensionProperties = {
        {customized property} = "string"
      }
      installPatches = {
        linuxParameters = {
          classificationsToInclude = [
            "string"
          ]
          packageNameMasksToExclude = [
            "string"
          ]
          packageNameMasksToInclude = [
            "string"
          ]
        }
        rebootSetting = "string"
        tasks = {
          postTasks = [
            {
              parameters = {
                {customized property} = "string"
              }
              source = "string"
              taskScope = "string"
            }
          ]
          preTasks = [
            {
              parameters = {
                {customized property} = "string"
              }
              source = "string"
              taskScope = "string"
            }
          ]
        }
        windowsParameters = {
          classificationsToInclude = [
            "string"
          ]
          excludeKbsRequiringReboot = bool
          kbNumbersToExclude = [
            "string"
          ]
          kbNumbersToInclude = [
            "string"
          ]
        }
      }
      maintenanceScope = "string"
      maintenanceWindow = {
        duration = "string"
        expirationDateTime = "string"
        recurEvery = "string"
        startDateTime = "string"
        timeZone = "string"
      }
      namespace = "string"
      visibility = "string"
    }
  })
}

属性值

InputLinuxParameters

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

InputPatchConfiguration

名字 描述 价值
linuxParameters 特定于修补 Linux 计算机的输入参数。 对于 Windows 计算机,请不要传递此属性。 此属性仅适用于 Guest (InGuestPatch) 范围。 InputLinuxParameters
rebootSetting 根据用户定义的可能的重新启动首选项,根据该首选项,决定在完成修补操作后重启计算机。 此属性仅适用于 Guest (InGuestPatch) 范围。 “Always”
“IfRequired”
“永不”
任务 [不支持]软件更新配置的任务信息。 SoftwareUpdateConfigurationTasks
windowsParameters 特定于修补 Windows 计算机的输入参数。 对于 Linux 计算机,请不要传递此属性。 此属性仅适用于 Guest (InGuestPatch) 范围。 InputWindowsParameters

InputWindowsParameters

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

MaintenanceConfigurationProperties

名字 描述 价值
extensionProperties 获取或设置 maintenanceConfiguration 的 extensionProperties MaintenanceConfigurationPropertiesExtensionProperties
installPatches 要传递给修补程序运行操作的输入参数。 此属性仅适用于 Guest (InGuestPatch) 范围。 InputPatchConfiguration
maintenanceScope 获取或设置配置的 maintenanceScope “Extension”
“Host”
“InGuestPatch”
“OSImage”
“SQLDB”
“SQLManagedInstance”
maintenanceWindow MaintenanceWindow 的定义 MaintenanceWindow
Namespace 获取或设置资源的命名空间 字符串
能见度 获取或设置配置的可见性。 默认值为“Custom” “Custom”
“Public”

MaintenanceConfigurationPropertiesExtensionProperties

名字 描述 价值

MaintenanceConfigurationTags

名字 描述 价值

MaintenanceWindow

名字 描述 价值
期间 HH:mm 格式的维护时段持续时间。 如果未提供,将根据提供的维护范围使用默认值。 示例:05:00。 字符串
expirationDateTime YYYY-MM-DD hh:mm 格式的维护时段的有效到期日期。 该窗口将在提供的时区中创建,并根据该时区调整为夏令时制。 到期日期必须设置为将来的日期。 如果未提供,它将设置为最大日期时间 9999-12-31 23:59:59。 字符串
recurEvery 维护时段应递归的速率。 费率可以表示为每日、每周或每月计划。 每日计划的格式为递归:[频率为整数]['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. 字符串
startDateTime YYYY-MM-DD hh:mm 格式的维护时段的有效开始日期。 开始日期可以设置为当前日期或将来日期。 该窗口将在提供的时区中创建,并根据该时区调整为夏令时制。 字符串
timeZone 时区的名称。 可以通过在 PowerShell 中执行 [System.TimeZoneInfo]::GetSystemTimeZones()来获取时区列表。 示例:太平洋标准时间、UTC、W. 欧洲标准时间、韩国标准时间、Cen。 澳大利亚标准时间。 字符串

Microsoft.Maintenance/maintenanceConfigurations

名字 描述 价值
位置 获取或设置资源的位置 字符串
名字 资源名称 string (必需)
性能 获取或设置资源的属性 MaintenanceConfigurationProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Maintenance/maintenanceConfigurations@2021-09-01-preview”

SoftwareUpdateConfigurationTasks

名字 描述 价值
postTasks [不支持]帖子任务列表。 例如 [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] TaskProperties[]
preTasks [不支持]预任务列表。 例如 [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] TaskProperties[]

TaskProperties

名字 描述 价值
参数 [不支持]获取或设置任务的参数。 TaskPropertiesParameters
[不支持]获取或设置 Runbook 的名称。 字符串
taskScope [不支持]计划触发器时,全局任务执行一次。 为每个 VM 执行资源任务。 “Global”
“Resource”

TaskPropertiesParameters

名字 描述 价值