Microsoft.Maintenance (stable:2023-04-01)

2025/01/08 • 8 updated methods

PublicMaintenanceConfigurations_List (updated)
Description :  Get Public Maintenance Configuration records
Reference :  Link ¶

⚶ Changes

{
  "#id": "PublicMaintenanceConfigurations_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "installPatches": [
                  {
                    "windowsParameters": [
                      {
                        "#name": "classificationsToInclude",
                        "Description": {
                          "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'.",
                          "old": "Classification category of patches to be patched"
                        }
                      }
                    ]
                  },
                  {
                    "linuxParameters": [
                      {
                        "#name": "classificationsToInclude",
                        "Description": {
                          "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'.",
                          "old": "Classification category of patches to be patched"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of maintenance Configurations ,
Required: False ,
}
[
{
location:
{
Description: Gets or sets location of the resource ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags of the resource ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets properties of the resource ,
Required: False ,
}
{
namespace:
{
Description: Gets or sets namespace of the resource ,
Required: False ,
}
string ,
extensionProperties:
{
Description: Gets or sets extensionProperties of the maintenanceConfiguration ,
Required: False ,
}
object ,
maintenanceScope:
{
Description: Gets or sets maintenanceScope of the configuration ,
Enum:
{
Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs. ,
Resource: This maintenance scope controls the default update maintenance of the Azure Resource ,
OSImage: This maintenance scope controls os image installation on VM/VMSS ,
Extension: This maintenance scope controls extension installation on VM/VMSS ,
InGuestPatch: This maintenance scope controls installation of windows and linux packages on VM/VMSS ,
SQLDB: This maintenance scope controls installation of SQL server platform updates. ,
SQLManagedInstance: This maintenance scope controls installation of SQL managed instance platform update. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Definition of a MaintenanceWindow ,
Required: False ,
}
{
startDateTime:
{
Description: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. ,
Required: False ,
}
string ,
expirationDateTime:
{
Description: Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59. ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. ,
Required: False ,
}
string ,
timeZone:
{
Description: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. ,
Required: False ,
}
string ,
recurEvery:
{
Description: Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are 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. ,
Required: False ,
}
string ,
}
,
visibility:
{
Description: Gets or sets the visibility of the configuration. The default value is 'Custom' ,
Enum:
{
Custom: Only visible to users with permissions. ,
Public: Visible to all users. ,
}
,
Required: False ,
}
enum ,
installPatches:
{
Description: The input parameters to be passed to the patch run operation. ,
Required: False ,
}
{
rebootSetting:
{
Description: Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. ,
Enum:
{
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
windowsParameters:
{
Description: Input parameters specific to patching a Windows machine. For Linux machines, do not pass this property. ,
Required: False ,
}
{
kbNumbersToExclude:
{
Description: Windows KBID to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
kbNumbersToInclude:
{
Description: Windows KBID to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'. ,
Required: False ,
}
[
string ,
]
,
excludeKbsRequiringReboot:
{
Description: Exclude patches which need reboot ,
Required: False ,
}
boolean ,
}
,
linuxParameters:
{
Description: Input parameters specific to patching Linux machine. For Windows machines, do not pass this property. ,
Required: False ,
}
{
packageNameMasksToExclude:
{
Description: Package names to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToInclude:
{
Description: Package names to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Details of the error ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
}
PublicMaintenanceConfigurations_Get (updated)
Description :  Get Public Maintenance Configuration record
Reference :  Link ¶

⚶ Changes

{
  "#id": "PublicMaintenanceConfigurations_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "installPatches": [
              {
                "windowsParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              },
              {
                "linuxParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/{resourceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceName:
{
Description: Maintenance Configuration Name ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets location of the resource ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags of the resource ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets properties of the resource ,
Required: False ,
}
{
namespace:
{
Description: Gets or sets namespace of the resource ,
Required: False ,
}
string ,
extensionProperties:
{
Description: Gets or sets extensionProperties of the maintenanceConfiguration ,
Required: False ,
}
object ,
maintenanceScope:
{
Description: Gets or sets maintenanceScope of the configuration ,
Enum:
{
Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs. ,
Resource: This maintenance scope controls the default update maintenance of the Azure Resource ,
OSImage: This maintenance scope controls os image installation on VM/VMSS ,
Extension: This maintenance scope controls extension installation on VM/VMSS ,
InGuestPatch: This maintenance scope controls installation of windows and linux packages on VM/VMSS ,
SQLDB: This maintenance scope controls installation of SQL server platform updates. ,
SQLManagedInstance: This maintenance scope controls installation of SQL managed instance platform update. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Definition of a MaintenanceWindow ,
Required: False ,
}
{
startDateTime:
{
Description: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. ,
Required: False ,
}
string ,
expirationDateTime:
{
Description: Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59. ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. ,
Required: False ,
}
string ,
timeZone:
{
Description: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. ,
Required: False ,
}
string ,
recurEvery:
{
Description: Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are 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. ,
Required: False ,
}
string ,
}
,
visibility:
{
Description: Gets or sets the visibility of the configuration. The default value is 'Custom' ,
Enum:
{
Custom: Only visible to users with permissions. ,
Public: Visible to all users. ,
}
,
Required: False ,
}
enum ,
installPatches:
{
Description: The input parameters to be passed to the patch run operation. ,
Required: False ,
}
{
rebootSetting:
{
Description: Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. ,
Enum:
{
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
windowsParameters:
{
Description: Input parameters specific to patching a Windows machine. For Linux machines, do not pass this property. ,
Required: False ,
}
{
kbNumbersToExclude:
{
Description: Windows KBID to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
kbNumbersToInclude:
{
Description: Windows KBID to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'. ,
Required: False ,
}
[
string ,
]
,
excludeKbsRequiringReboot:
{
Description: Exclude patches which need reboot ,
Required: False ,
}
boolean ,
}
,
linuxParameters:
{
Description: Input parameters specific to patching Linux machine. For Windows machines, do not pass this property. ,
Required: False ,
}
{
packageNameMasksToExclude:
{
Description: Package names to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToInclude:
{
Description: Package names to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of the error ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
}
MaintenanceConfigurations_Get (updated)
Description :  Get Configuration record
Reference :  Link ¶

⚶ Changes

{
  "#id": "MaintenanceConfigurations_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "installPatches": [
              {
                "windowsParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              },
              {
                "linuxParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Maintenance/maintenanceConfigurations/{resourceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
resourceName:
{
Description: Maintenance Configuration Name ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets location of the resource ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags of the resource ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets properties of the resource ,
Required: False ,
}
{
namespace:
{
Description: Gets or sets namespace of the resource ,
Required: False ,
}
string ,
extensionProperties:
{
Description: Gets or sets extensionProperties of the maintenanceConfiguration ,
Required: False ,
}
object ,
maintenanceScope:
{
Description: Gets or sets maintenanceScope of the configuration ,
Enum:
{
Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs. ,
Resource: This maintenance scope controls the default update maintenance of the Azure Resource ,
OSImage: This maintenance scope controls os image installation on VM/VMSS ,
Extension: This maintenance scope controls extension installation on VM/VMSS ,
InGuestPatch: This maintenance scope controls installation of windows and linux packages on VM/VMSS ,
SQLDB: This maintenance scope controls installation of SQL server platform updates. ,
SQLManagedInstance: This maintenance scope controls installation of SQL managed instance platform update. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Definition of a MaintenanceWindow ,
Required: False ,
}
{
startDateTime:
{
Description: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. ,
Required: False ,
}
string ,
expirationDateTime:
{
Description: Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59. ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. ,
Required: False ,
}
string ,
timeZone:
{
Description: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. ,
Required: False ,
}
string ,
recurEvery:
{
Description: Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are 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. ,
Required: False ,
}
string ,
}
,
visibility:
{
Description: Gets or sets the visibility of the configuration. The default value is 'Custom' ,
Enum:
{
Custom: Only visible to users with permissions. ,
Public: Visible to all users. ,
}
,
Required: False ,
}
enum ,
installPatches:
{
Description: The input parameters to be passed to the patch run operation. ,
Required: False ,
}
{
rebootSetting:
{
Description: Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. ,
Enum:
{
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
windowsParameters:
{
Description: Input parameters specific to patching a Windows machine. For Linux machines, do not pass this property. ,
Required: False ,
}
{
kbNumbersToExclude:
{
Description: Windows KBID to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
kbNumbersToInclude:
{
Description: Windows KBID to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'. ,
Required: False ,
}
[
string ,
]
,
excludeKbsRequiringReboot:
{
Description: Exclude patches which need reboot ,
Required: False ,
}
boolean ,
}
,
linuxParameters:
{
Description: Input parameters specific to patching Linux machine. For Windows machines, do not pass this property. ,
Required: False ,
}
{
packageNameMasksToExclude:
{
Description: Package names to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToInclude:
{
Description: Package names to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of the error ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
}
MaintenanceConfigurations_CreateOrUpdate (updated)
Description :  Create or Update configuration record
Reference :  Link ¶

⚶ Changes

{
  "#id": "MaintenanceConfigurations_CreateOrUpdate",
  "$parameters": {
    "configuration": {
      "$properties": {
        "properties": [
          {
            "installPatches": [
              {
                "windowsParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              },
              {
                "linuxParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "installPatches": [
              {
                "windowsParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              },
              {
                "linuxParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "installPatches": [
              {
                "windowsParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              },
              {
                "linuxParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Maintenance/maintenanceConfigurations/{resourceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
resourceName:
{
Description: Maintenance Configuration Name ,
Required: True ,
}
string ,
configuration:
{
Description: The configuration ,
Required: True ,
}
{
location:
{
Description: Gets or sets location of the resource ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags of the resource ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets properties of the resource ,
Required: False ,
}
{
namespace:
{
Description: Gets or sets namespace of the resource ,
Required: False ,
}
string ,
extensionProperties:
{
Description: Gets or sets extensionProperties of the maintenanceConfiguration ,
Required: False ,
}
object ,
maintenanceScope:
{
Description: Gets or sets maintenanceScope of the configuration ,
Enum:
{
Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs. ,
Resource: This maintenance scope controls the default update maintenance of the Azure Resource ,
OSImage: This maintenance scope controls os image installation on VM/VMSS ,
Extension: This maintenance scope controls extension installation on VM/VMSS ,
InGuestPatch: This maintenance scope controls installation of windows and linux packages on VM/VMSS ,
SQLDB: This maintenance scope controls installation of SQL server platform updates. ,
SQLManagedInstance: This maintenance scope controls installation of SQL managed instance platform update. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Definition of a MaintenanceWindow ,
Required: False ,
}
{
startDateTime:
{
Description: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. ,
Required: False ,
}
string ,
expirationDateTime:
{
Description: Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59. ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. ,
Required: False ,
}
string ,
timeZone:
{
Description: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. ,
Required: False ,
}
string ,
recurEvery:
{
Description: Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are 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. ,
Required: False ,
}
string ,
}
,
visibility:
{
Description: Gets or sets the visibility of the configuration. The default value is 'Custom' ,
Enum:
{
Custom: Only visible to users with permissions. ,
Public: Visible to all users. ,
}
,
Required: False ,
}
enum ,
installPatches:
{
Description: The input parameters to be passed to the patch run operation. ,
Required: False ,
}
{
rebootSetting:
{
Description: Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. ,
Enum:
{
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
windowsParameters:
{
Description: Input parameters specific to patching a Windows machine. For Linux machines, do not pass this property. ,
Required: False ,
}
{
kbNumbersToExclude:
{
Description: Windows KBID to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
kbNumbersToInclude:
{
Description: Windows KBID to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'. ,
Required: False ,
}
[
string ,
]
,
excludeKbsRequiringReboot:
{
Description: Exclude patches which need reboot ,
Required: False ,
}
boolean ,
}
,
linuxParameters:
{
Description: Input parameters specific to patching Linux machine. For Windows machines, do not pass this property. ,
Required: False ,
}
{
packageNameMasksToExclude:
{
Description: Package names to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToInclude:
{
Description: Package names to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets location of the resource ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags of the resource ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets properties of the resource ,
Required: False ,
}
{
namespace:
{
Description: Gets or sets namespace of the resource ,
Required: False ,
}
string ,
extensionProperties:
{
Description: Gets or sets extensionProperties of the maintenanceConfiguration ,
Required: False ,
}
object ,
maintenanceScope:
{
Description: Gets or sets maintenanceScope of the configuration ,
Enum:
{
Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs. ,
Resource: This maintenance scope controls the default update maintenance of the Azure Resource ,
OSImage: This maintenance scope controls os image installation on VM/VMSS ,
Extension: This maintenance scope controls extension installation on VM/VMSS ,
InGuestPatch: This maintenance scope controls installation of windows and linux packages on VM/VMSS ,
SQLDB: This maintenance scope controls installation of SQL server platform updates. ,
SQLManagedInstance: This maintenance scope controls installation of SQL managed instance platform update. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Definition of a MaintenanceWindow ,
Required: False ,
}
{
startDateTime:
{
Description: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. ,
Required: False ,
}
string ,
expirationDateTime:
{
Description: Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59. ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. ,
Required: False ,
}
string ,
timeZone:
{
Description: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. ,
Required: False ,
}
string ,
recurEvery:
{
Description: Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are 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. ,
Required: False ,
}
string ,
}
,
visibility:
{
Description: Gets or sets the visibility of the configuration. The default value is 'Custom' ,
Enum:
{
Custom: Only visible to users with permissions. ,
Public: Visible to all users. ,
}
,
Required: False ,
}
enum ,
installPatches:
{
Description: The input parameters to be passed to the patch run operation. ,
Required: False ,
}
{
rebootSetting:
{
Description: Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. ,
Enum:
{
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
windowsParameters:
{
Description: Input parameters specific to patching a Windows machine. For Linux machines, do not pass this property. ,
Required: False ,
}
{
kbNumbersToExclude:
{
Description: Windows KBID to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
kbNumbersToInclude:
{
Description: Windows KBID to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'. ,
Required: False ,
}
[
string ,
]
,
excludeKbsRequiringReboot:
{
Description: Exclude patches which need reboot ,
Required: False ,
}
boolean ,
}
,
linuxParameters:
{
Description: Input parameters specific to patching Linux machine. For Windows machines, do not pass this property. ,
Required: False ,
}
{
packageNameMasksToExclude:
{
Description: Package names to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToInclude:
{
Description: Package names to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (201)

{
location:
{
Description: Gets or sets location of the resource ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags of the resource ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets properties of the resource ,
Required: False ,
}
{
namespace:
{
Description: Gets or sets namespace of the resource ,
Required: False ,
}
string ,
extensionProperties:
{
Description: Gets or sets extensionProperties of the maintenanceConfiguration ,
Required: False ,
}
object ,
maintenanceScope:
{
Description: Gets or sets maintenanceScope of the configuration ,
Enum:
{
Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs. ,
Resource: This maintenance scope controls the default update maintenance of the Azure Resource ,
OSImage: This maintenance scope controls os image installation on VM/VMSS ,
Extension: This maintenance scope controls extension installation on VM/VMSS ,
InGuestPatch: This maintenance scope controls installation of windows and linux packages on VM/VMSS ,
SQLDB: This maintenance scope controls installation of SQL server platform updates. ,
SQLManagedInstance: This maintenance scope controls installation of SQL managed instance platform update. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Definition of a MaintenanceWindow ,
Required: False ,
}
{
startDateTime:
{
Description: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. ,
Required: False ,
}
string ,
expirationDateTime:
{
Description: Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59. ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. ,
Required: False ,
}
string ,
timeZone:
{
Description: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. ,
Required: False ,
}
string ,
recurEvery:
{
Description: Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are 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. ,
Required: False ,
}
string ,
}
,
visibility:
{
Description: Gets or sets the visibility of the configuration. The default value is 'Custom' ,
Enum:
{
Custom: Only visible to users with permissions. ,
Public: Visible to all users. ,
}
,
Required: False ,
}
enum ,
installPatches:
{
Description: The input parameters to be passed to the patch run operation. ,
Required: False ,
}
{
rebootSetting:
{
Description: Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. ,
Enum:
{
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
windowsParameters:
{
Description: Input parameters specific to patching a Windows machine. For Linux machines, do not pass this property. ,
Required: False ,
}
{
kbNumbersToExclude:
{
Description: Windows KBID to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
kbNumbersToInclude:
{
Description: Windows KBID to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'. ,
Required: False ,
}
[
string ,
]
,
excludeKbsRequiringReboot:
{
Description: Exclude patches which need reboot ,
Required: False ,
}
boolean ,
}
,
linuxParameters:
{
Description: Input parameters specific to patching Linux machine. For Windows machines, do not pass this property. ,
Required: False ,
}
{
packageNameMasksToExclude:
{
Description: Package names to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToInclude:
{
Description: Package names to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of the error ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
}
MaintenanceConfigurations_Delete (updated)
Description :  Delete Configuration record
Reference :  Link ¶

⚶ Changes

{
  "#id": "MaintenanceConfigurations_Delete",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "installPatches": [
              {
                "windowsParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              },
              {
                "linuxParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Maintenance/maintenanceConfigurations/{resourceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
resourceName:
{
Description: Maintenance Configuration Name ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets location of the resource ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags of the resource ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets properties of the resource ,
Required: False ,
}
{
namespace:
{
Description: Gets or sets namespace of the resource ,
Required: False ,
}
string ,
extensionProperties:
{
Description: Gets or sets extensionProperties of the maintenanceConfiguration ,
Required: False ,
}
object ,
maintenanceScope:
{
Description: Gets or sets maintenanceScope of the configuration ,
Enum:
{
Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs. ,
Resource: This maintenance scope controls the default update maintenance of the Azure Resource ,
OSImage: This maintenance scope controls os image installation on VM/VMSS ,
Extension: This maintenance scope controls extension installation on VM/VMSS ,
InGuestPatch: This maintenance scope controls installation of windows and linux packages on VM/VMSS ,
SQLDB: This maintenance scope controls installation of SQL server platform updates. ,
SQLManagedInstance: This maintenance scope controls installation of SQL managed instance platform update. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Definition of a MaintenanceWindow ,
Required: False ,
}
{
startDateTime:
{
Description: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. ,
Required: False ,
}
string ,
expirationDateTime:
{
Description: Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59. ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. ,
Required: False ,
}
string ,
timeZone:
{
Description: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. ,
Required: False ,
}
string ,
recurEvery:
{
Description: Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are 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. ,
Required: False ,
}
string ,
}
,
visibility:
{
Description: Gets or sets the visibility of the configuration. The default value is 'Custom' ,
Enum:
{
Custom: Only visible to users with permissions. ,
Public: Visible to all users. ,
}
,
Required: False ,
}
enum ,
installPatches:
{
Description: The input parameters to be passed to the patch run operation. ,
Required: False ,
}
{
rebootSetting:
{
Description: Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. ,
Enum:
{
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
windowsParameters:
{
Description: Input parameters specific to patching a Windows machine. For Linux machines, do not pass this property. ,
Required: False ,
}
{
kbNumbersToExclude:
{
Description: Windows KBID to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
kbNumbersToInclude:
{
Description: Windows KBID to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'. ,
Required: False ,
}
[
string ,
]
,
excludeKbsRequiringReboot:
{
Description: Exclude patches which need reboot ,
Required: False ,
}
boolean ,
}
,
linuxParameters:
{
Description: Input parameters specific to patching Linux machine. For Windows machines, do not pass this property. ,
Required: False ,
}
{
packageNameMasksToExclude:
{
Description: Package names to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToInclude:
{
Description: Package names to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Details of the error ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
}
MaintenanceConfigurations_Update (updated)
Description :  Patch configuration record
Reference :  Link ¶

⚶ Changes

{
  "#id": "MaintenanceConfigurations_Update",
  "$parameters": {
    "configuration": {
      "$properties": {
        "properties": [
          {
            "installPatches": [
              {
                "windowsParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              },
              {
                "linuxParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "installPatches": [
              {
                "windowsParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              },
              {
                "linuxParameters": [
                  {
                    "#name": "classificationsToInclude",
                    "Description": {
                      "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'.",
                      "old": "Classification category of patches to be patched"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Maintenance/maintenanceConfigurations/{resourceName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
resourceName:
{
Description: Maintenance Configuration Name ,
Required: True ,
}
string ,
configuration:
{
Description: The configuration ,
Required: True ,
}
{
location:
{
Description: Gets or sets location of the resource ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags of the resource ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets properties of the resource ,
Required: False ,
}
{
namespace:
{
Description: Gets or sets namespace of the resource ,
Required: False ,
}
string ,
extensionProperties:
{
Description: Gets or sets extensionProperties of the maintenanceConfiguration ,
Required: False ,
}
object ,
maintenanceScope:
{
Description: Gets or sets maintenanceScope of the configuration ,
Enum:
{
Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs. ,
Resource: This maintenance scope controls the default update maintenance of the Azure Resource ,
OSImage: This maintenance scope controls os image installation on VM/VMSS ,
Extension: This maintenance scope controls extension installation on VM/VMSS ,
InGuestPatch: This maintenance scope controls installation of windows and linux packages on VM/VMSS ,
SQLDB: This maintenance scope controls installation of SQL server platform updates. ,
SQLManagedInstance: This maintenance scope controls installation of SQL managed instance platform update. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Definition of a MaintenanceWindow ,
Required: False ,
}
{
startDateTime:
{
Description: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. ,
Required: False ,
}
string ,
expirationDateTime:
{
Description: Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59. ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. ,
Required: False ,
}
string ,
timeZone:
{
Description: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. ,
Required: False ,
}
string ,
recurEvery:
{
Description: Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are 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. ,
Required: False ,
}
string ,
}
,
visibility:
{
Description: Gets or sets the visibility of the configuration. The default value is 'Custom' ,
Enum:
{
Custom: Only visible to users with permissions. ,
Public: Visible to all users. ,
}
,
Required: False ,
}
enum ,
installPatches:
{
Description: The input parameters to be passed to the patch run operation. ,
Required: False ,
}
{
rebootSetting:
{
Description: Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. ,
Enum:
{
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
windowsParameters:
{
Description: Input parameters specific to patching a Windows machine. For Linux machines, do not pass this property. ,
Required: False ,
}
{
kbNumbersToExclude:
{
Description: Windows KBID to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
kbNumbersToInclude:
{
Description: Windows KBID to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'. ,
Required: False ,
}
[
string ,
]
,
excludeKbsRequiringReboot:
{
Description: Exclude patches which need reboot ,
Required: False ,
}
boolean ,
}
,
linuxParameters:
{
Description: Input parameters specific to patching Linux machine. For Windows machines, do not pass this property. ,
Required: False ,
}
{
packageNameMasksToExclude:
{
Description: Package names to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToInclude:
{
Description: Package names to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Gets or sets location of the resource ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags of the resource ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets properties of the resource ,
Required: False ,
}
{
namespace:
{
Description: Gets or sets namespace of the resource ,
Required: False ,
}
string ,
extensionProperties:
{
Description: Gets or sets extensionProperties of the maintenanceConfiguration ,
Required: False ,
}
object ,
maintenanceScope:
{
Description: Gets or sets maintenanceScope of the configuration ,
Enum:
{
Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs. ,
Resource: This maintenance scope controls the default update maintenance of the Azure Resource ,
OSImage: This maintenance scope controls os image installation on VM/VMSS ,
Extension: This maintenance scope controls extension installation on VM/VMSS ,
InGuestPatch: This maintenance scope controls installation of windows and linux packages on VM/VMSS ,
SQLDB: This maintenance scope controls installation of SQL server platform updates. ,
SQLManagedInstance: This maintenance scope controls installation of SQL managed instance platform update. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Definition of a MaintenanceWindow ,
Required: False ,
}
{
startDateTime:
{
Description: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. ,
Required: False ,
}
string ,
expirationDateTime:
{
Description: Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59. ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. ,
Required: False ,
}
string ,
timeZone:
{
Description: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. ,
Required: False ,
}
string ,
recurEvery:
{
Description: Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are 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. ,
Required: False ,
}
string ,
}
,
visibility:
{
Description: Gets or sets the visibility of the configuration. The default value is 'Custom' ,
Enum:
{
Custom: Only visible to users with permissions. ,
Public: Visible to all users. ,
}
,
Required: False ,
}
enum ,
installPatches:
{
Description: The input parameters to be passed to the patch run operation. ,
Required: False ,
}
{
rebootSetting:
{
Description: Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. ,
Enum:
{
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
windowsParameters:
{
Description: Input parameters specific to patching a Windows machine. For Linux machines, do not pass this property. ,
Required: False ,
}
{
kbNumbersToExclude:
{
Description: Windows KBID to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
kbNumbersToInclude:
{
Description: Windows KBID to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'. ,
Required: False ,
}
[
string ,
]
,
excludeKbsRequiringReboot:
{
Description: Exclude patches which need reboot ,
Required: False ,
}
boolean ,
}
,
linuxParameters:
{
Description: Input parameters specific to patching Linux machine. For Windows machines, do not pass this property. ,
Required: False ,
}
{
packageNameMasksToExclude:
{
Description: Package names to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToInclude:
{
Description: Package names to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of the error ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
}
MaintenanceConfigurations_List (updated)
Description :  Get Configuration records within a subscription
Reference :  Link ¶

⚶ Changes

{
  "#id": "MaintenanceConfigurations_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "installPatches": [
                  {
                    "windowsParameters": [
                      {
                        "#name": "classificationsToInclude",
                        "Description": {
                          "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'.",
                          "old": "Classification category of patches to be patched"
                        }
                      }
                    ]
                  },
                  {
                    "linuxParameters": [
                      {
                        "#name": "classificationsToInclude",
                        "Description": {
                          "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'.",
                          "old": "Classification category of patches to be patched"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/maintenanceConfigurations
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of maintenance Configurations ,
Required: False ,
}
[
{
location:
{
Description: Gets or sets location of the resource ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags of the resource ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets properties of the resource ,
Required: False ,
}
{
namespace:
{
Description: Gets or sets namespace of the resource ,
Required: False ,
}
string ,
extensionProperties:
{
Description: Gets or sets extensionProperties of the maintenanceConfiguration ,
Required: False ,
}
object ,
maintenanceScope:
{
Description: Gets or sets maintenanceScope of the configuration ,
Enum:
{
Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs. ,
Resource: This maintenance scope controls the default update maintenance of the Azure Resource ,
OSImage: This maintenance scope controls os image installation on VM/VMSS ,
Extension: This maintenance scope controls extension installation on VM/VMSS ,
InGuestPatch: This maintenance scope controls installation of windows and linux packages on VM/VMSS ,
SQLDB: This maintenance scope controls installation of SQL server platform updates. ,
SQLManagedInstance: This maintenance scope controls installation of SQL managed instance platform update. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Definition of a MaintenanceWindow ,
Required: False ,
}
{
startDateTime:
{
Description: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. ,
Required: False ,
}
string ,
expirationDateTime:
{
Description: Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59. ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. ,
Required: False ,
}
string ,
timeZone:
{
Description: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. ,
Required: False ,
}
string ,
recurEvery:
{
Description: Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are 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. ,
Required: False ,
}
string ,
}
,
visibility:
{
Description: Gets or sets the visibility of the configuration. The default value is 'Custom' ,
Enum:
{
Custom: Only visible to users with permissions. ,
Public: Visible to all users. ,
}
,
Required: False ,
}
enum ,
installPatches:
{
Description: The input parameters to be passed to the patch run operation. ,
Required: False ,
}
{
rebootSetting:
{
Description: Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. ,
Enum:
{
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
windowsParameters:
{
Description: Input parameters specific to patching a Windows machine. For Linux machines, do not pass this property. ,
Required: False ,
}
{
kbNumbersToExclude:
{
Description: Windows KBID to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
kbNumbersToInclude:
{
Description: Windows KBID to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'. ,
Required: False ,
}
[
string ,
]
,
excludeKbsRequiringReboot:
{
Description: Exclude patches which need reboot ,
Required: False ,
}
boolean ,
}
,
linuxParameters:
{
Description: Input parameters specific to patching Linux machine. For Windows machines, do not pass this property. ,
Required: False ,
}
{
packageNameMasksToExclude:
{
Description: Package names to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToInclude:
{
Description: Package names to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Details of the error ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
}
MaintenanceConfigurationsForResourceGroup_List (updated)
Description :  Get Configuration records within a subscription and resource group
Reference :  Link ¶

⚶ Changes

{
  "#id": "MaintenanceConfigurationsForResourceGroup_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "installPatches": [
                  {
                    "windowsParameters": [
                      {
                        "#name": "classificationsToInclude",
                        "Description": {
                          "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'.",
                          "old": "Classification category of patches to be patched"
                        }
                      }
                    ]
                  },
                  {
                    "linuxParameters": [
                      {
                        "#name": "classificationsToInclude",
                        "Description": {
                          "new": "Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'.",
                          "old": "Classification category of patches to be patched"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maintenance/maintenanceConfigurations
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of maintenance Configurations ,
Required: False ,
}
[
{
location:
{
Description: Gets or sets location of the resource ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags of the resource ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets properties of the resource ,
Required: False ,
}
{
namespace:
{
Description: Gets or sets namespace of the resource ,
Required: False ,
}
string ,
extensionProperties:
{
Description: Gets or sets extensionProperties of the maintenanceConfiguration ,
Required: False ,
}
object ,
maintenanceScope:
{
Description: Gets or sets maintenanceScope of the configuration ,
Enum:
{
Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs. ,
Resource: This maintenance scope controls the default update maintenance of the Azure Resource ,
OSImage: This maintenance scope controls os image installation on VM/VMSS ,
Extension: This maintenance scope controls extension installation on VM/VMSS ,
InGuestPatch: This maintenance scope controls installation of windows and linux packages on VM/VMSS ,
SQLDB: This maintenance scope controls installation of SQL server platform updates. ,
SQLManagedInstance: This maintenance scope controls installation of SQL managed instance platform update. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Definition of a MaintenanceWindow ,
Required: False ,
}
{
startDateTime:
{
Description: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. ,
Required: False ,
}
string ,
expirationDateTime:
{
Description: Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59. ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. ,
Required: False ,
}
string ,
timeZone:
{
Description: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. ,
Required: False ,
}
string ,
recurEvery:
{
Description: Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are 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. ,
Required: False ,
}
string ,
}
,
visibility:
{
Description: Gets or sets the visibility of the configuration. The default value is 'Custom' ,
Enum:
{
Custom: Only visible to users with permissions. ,
Public: Visible to all users. ,
}
,
Required: False ,
}
enum ,
installPatches:
{
Description: The input parameters to be passed to the patch run operation. ,
Required: False ,
}
{
rebootSetting:
{
Description: Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. ,
Enum:
{
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
windowsParameters:
{
Description: Input parameters specific to patching a Windows machine. For Linux machines, do not pass this property. ,
Required: False ,
}
{
kbNumbersToExclude:
{
Description: Windows KBID to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
kbNumbersToInclude:
{
Description: Windows KBID to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'. ,
Required: False ,
}
[
string ,
]
,
excludeKbsRequiringReboot:
{
Description: Exclude patches which need reboot ,
Required: False ,
}
boolean ,
}
,
linuxParameters:
{
Description: Input parameters specific to patching Linux machine. For Windows machines, do not pass this property. ,
Required: False ,
}
{
packageNameMasksToExclude:
{
Description: Package names to be excluded for patching. ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToInclude:
{
Description: Package names to be included for patching. ,
Required: False ,
}
[
string ,
]
,
classificationsToInclude:
{
Description: Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Details of the error ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
}