Microsoft.Maintenance (preview:2021-09-01)

2025/09/05 • 26 new, 26 deleted methods

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

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}
,
]
,
}

⚐ 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 (new)
Description :  Get Public Maintenance Configuration record
Reference :  Link ¶

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
ApplyUpdates_GetParent (new)
Description :  Track maintenance updates to resource with parent
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/{applyUpdateName}
{
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 ,
resourceParentType:
{
Description: Resource parent type ,
Required: True ,
}
string ,
resourceParentName:
{
Description: Resource parent identifier ,
Required: True ,
}
string ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
applyUpdateName:
{
Description: applyUpdate Id ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The resourceId ,
Required: False ,
}
string ,
lastUpdateTime:
{
Description: Last Update time ,
Format: date-time ,
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 ,
}
,
}
ApplyUpdates_Get (new)
Description :  Track maintenance updates to resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/{applyUpdateName}
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
applyUpdateName:
{
Description: applyUpdate Id ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The resourceId ,
Required: False ,
}
string ,
lastUpdateTime:
{
Description: Last Update time ,
Format: date-time ,
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 ,
}
,
}
ApplyUpdates_CreateOrUpdateParent (new)
Description :  Apply maintenance updates to resource with parent
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceParentType:
{
Description: Resource parent type ,
Required: True ,
}
string ,
resourceParentName:
{
Description: Resource parent identifier ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The resourceId ,
Required: False ,
}
string ,
lastUpdateTime:
{
Description: Last Update time ,
Format: date-time ,
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 ,
}
,
}
ApplyUpdates_CreateOrUpdate (new)
Description :  Apply maintenance updates to resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The resourceId ,
Required: False ,
}
string ,
lastUpdateTime:
{
Description: Last Update time ,
Format: date-time ,
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 ,
}
,
}
ConfigurationAssignments_GetParent (new)
Description :  Get configuration for resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceParentType:
{
Description: Resource parent type ,
Required: True ,
}
string ,
resourceParentName:
{
Description: Resource parent identifier ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
configurationAssignmentName:
{
Description: Configuration assignment 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: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
ConfigurationAssignments_CreateOrUpdateParent (new)
Description :  Register configuration for resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceParentType:
{
Description: Resource parent type ,
Required: True ,
}
string ,
resourceParentName:
{
Description: Resource parent identifier ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
configurationAssignmentName:
{
Description: Configuration assignment name ,
Required: True ,
}
string ,
configurationAssignment:
{
Description: The configurationAssignment ,
Required: True ,
}
{
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
ConfigurationAssignments_DeleteParent (new)
Description :  Unregister configuration for resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceParentType:
{
Description: Resource parent type ,
Required: True ,
}
string ,
resourceParentName:
{
Description: Resource parent identifier ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
configurationAssignmentName:
{
Description: Unique configuration assignment 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: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
ConfigurationAssignments_Get (new)
Description :  Get configuration for resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
configurationAssignmentName:
{
Description: Configuration assignment 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: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
ConfigurationAssignments_CreateOrUpdate (new)
Description :  Register configuration for resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
configurationAssignmentName:
{
Description: Configuration assignment name ,
Required: True ,
}
string ,
configurationAssignment:
{
Description: The configurationAssignment ,
Required: True ,
}
{
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
ConfigurationAssignments_Delete (new)
Description :  Unregister configuration for resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
configurationAssignmentName:
{
Description: Unique configuration assignment 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: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
ConfigurationAssignments_ListParent (new)
Description :  List configurationAssignments for resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceParentType:
{
Description: Resource parent type ,
Required: True ,
}
string ,
resourceParentName:
{
Description: Resource parent identifier ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
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 configuration Assignments ,
Required: False ,
}
[
{
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
ConfigurationAssignments_List (new)
Description :  List configurationAssignments for resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
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 configuration Assignments ,
Required: False ,
}
[
{
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 (new)
Description :  Get Configuration record
Reference :  Link ¶

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ 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 (new)
Description :  Create or Update configuration record
Reference :  Link ¶

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}
,
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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ 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 (new)
Description :  Delete Configuration record
Reference :  Link ¶

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ 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 (new)
Description :  Patch configuration record
Reference :  Link ¶

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}
,
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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ 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 (new)
Description :  Get Configuration records within a subscription
Reference :  Link ¶

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}
,
]
,
}

⚐ 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 (new)
Description :  Get Configuration records within a subscription and resource group
Reference :  Link ¶

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
}
ApplyUpdates_List (new)
Description :  Get Configuration records within a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/applyUpdates
{
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 apply updates ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The resourceId ,
Required: False ,
}
string ,
lastUpdateTime:
{
Description: Last Update time ,
Format: date-time ,
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 ,
}
,
}
ApplyUpdateForResourceGroup_List (new)
Description :  Get Configuration records within a subscription and resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maintenance/applyUpdates
{
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 apply updates ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The resourceId ,
Required: False ,
}
string ,
lastUpdateTime:
{
Description: Last Update time ,
Format: date-time ,
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 ,
}
,
}
ConfigurationAssignmentsWithinSubscription_List (new)
Description :  [UNSUPPORTED] Get configuration assignment within a subscription. This API is not implemented yet.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/configurationAssignments
{
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 configuration Assignments ,
Required: False ,
}
[
{
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
Operations_List (new)
Description :  List the available operations supported by the Microsoft.Maintenance resource provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Maintenance/operations
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of operations ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation ,
Required: False ,
}
string ,
display:
{
Description: Display name of the operation ,
Required: False ,
}
{
provider:
{
Description: Name of the provider ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource type ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the operation ,
Required: False ,
}
object ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ 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 ,
}
,
}
Updates_ListParent (new)
Description :  Get updates to resources.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/updates
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceParentType:
{
Description: Resource parent type ,
Required: True ,
}
string ,
resourceParentName:
{
Description: Resource parent identifier ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
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 pending updates ,
Required: False ,
}
[
{
maintenanceScope:
{
Description: The impact area ,
Enum:
{
Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs. ,
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 ,
impactType:
{
Description: The impact type ,
Enum:
{
None: Pending updates has no impact on resource. ,
Freeze: Pending updates can freeze network or disk io operation on resource. ,
Restart: Pending updates can cause resource to restart. ,
Redeploy: Pending updates can redeploy resource. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
impactDurationInSec:
{
Description: Duration of impact in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
notBefore:
{
Description: Time when Azure will start force updates if not self-updated by customer before this time ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
resourceId:
{
Description: The resourceId ,
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 ,
}
,
}
Updates_List (new)
Description :  Get updates to resources.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/updates
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
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 pending updates ,
Required: False ,
}
[
{
maintenanceScope:
{
Description: The impact area ,
Enum:
{
Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs. ,
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 ,
impactType:
{
Description: The impact type ,
Enum:
{
None: Pending updates has no impact on resource. ,
Freeze: Pending updates can freeze network or disk io operation on resource. ,
Restart: Pending updates can cause resource to restart. ,
Redeploy: Pending updates can redeploy resource. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
impactDurationInSec:
{
Description: Duration of impact in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
notBefore:
{
Description: Time when Azure will start force updates if not self-updated by customer before this time ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
resourceId:
{
Description: The resourceId ,
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_List (removed)
Description :  Get Public Maintenance Configuration records
Reference :  Link ¶

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}
,
]
,
}

⚐ 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 (removed)
Description :  Get Public Maintenance Configuration record
Reference :  Link ¶

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
ApplyUpdates_GetParent (removed)
Description :  Track maintenance updates to resource with parent
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/{applyUpdateName}
{
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 ,
resourceParentType:
{
Description: Resource parent type ,
Required: True ,
}
string ,
resourceParentName:
{
Description: Resource parent identifier ,
Required: True ,
}
string ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
applyUpdateName:
{
Description: applyUpdate Id ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The resourceId ,
Required: False ,
}
string ,
lastUpdateTime:
{
Description: Last Update time ,
Format: date-time ,
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 ,
}
,
}
ApplyUpdates_Get (removed)
Description :  Track maintenance updates to resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/{applyUpdateName}
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
applyUpdateName:
{
Description: applyUpdate Id ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The resourceId ,
Required: False ,
}
string ,
lastUpdateTime:
{
Description: Last Update time ,
Format: date-time ,
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 ,
}
,
}
ApplyUpdates_CreateOrUpdateParent (removed)
Description :  Apply maintenance updates to resource with parent
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceParentType:
{
Description: Resource parent type ,
Required: True ,
}
string ,
resourceParentName:
{
Description: Resource parent identifier ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The resourceId ,
Required: False ,
}
string ,
lastUpdateTime:
{
Description: Last Update time ,
Format: date-time ,
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 ,
}
,
}
ApplyUpdates_CreateOrUpdate (removed)
Description :  Apply maintenance updates to resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The resourceId ,
Required: False ,
}
string ,
lastUpdateTime:
{
Description: Last Update time ,
Format: date-time ,
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 ,
}
,
}
ConfigurationAssignments_GetParent (removed)
Description :  Get configuration for resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceParentType:
{
Description: Resource parent type ,
Required: True ,
}
string ,
resourceParentName:
{
Description: Resource parent identifier ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
configurationAssignmentName:
{
Description: Configuration assignment 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: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
ConfigurationAssignments_CreateOrUpdateParent (removed)
Description :  Register configuration for resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceParentType:
{
Description: Resource parent type ,
Required: True ,
}
string ,
resourceParentName:
{
Description: Resource parent identifier ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
configurationAssignmentName:
{
Description: Configuration assignment name ,
Required: True ,
}
string ,
configurationAssignment:
{
Description: The configurationAssignment ,
Required: True ,
}
{
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
ConfigurationAssignments_DeleteParent (removed)
Description :  Unregister configuration for resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceParentType:
{
Description: Resource parent type ,
Required: True ,
}
string ,
resourceParentName:
{
Description: Resource parent identifier ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
configurationAssignmentName:
{
Description: Unique configuration assignment 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: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
ConfigurationAssignments_Get (removed)
Description :  Get configuration for resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
configurationAssignmentName:
{
Description: Configuration assignment 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: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
ConfigurationAssignments_CreateOrUpdate (removed)
Description :  Register configuration for resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
configurationAssignmentName:
{
Description: Configuration assignment name ,
Required: True ,
}
string ,
configurationAssignment:
{
Description: The configurationAssignment ,
Required: True ,
}
{
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
ConfigurationAssignments_Delete (removed)
Description :  Unregister configuration for resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
Required: True ,
}
string ,
configurationAssignmentName:
{
Description: Unique configuration assignment 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: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
ConfigurationAssignments_ListParent (removed)
Description :  List configurationAssignments for resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceParentType:
{
Description: Resource parent type ,
Required: True ,
}
string ,
resourceParentName:
{
Description: Resource parent identifier ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
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 configuration Assignments ,
Required: False ,
}
[
{
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
ConfigurationAssignments_List (removed)
Description :  List configurationAssignments for resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
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 configuration Assignments ,
Required: False ,
}
[
{
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 (removed)
Description :  Get Configuration record
Reference :  Link ¶

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ 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 (removed)
Description :  Create or Update configuration record
Reference :  Link ¶

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}
,
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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ 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 (removed)
Description :  Delete Configuration record
Reference :  Link ¶

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ 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 (removed)
Description :  Patch configuration record
Reference :  Link ¶

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}
,
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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ 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 (removed)
Description :  Get Configuration records within a subscription
Reference :  Link ¶

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}
,
]
,
}

⚐ 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 (removed)
Description :  Get Configuration records within a subscription and resource group
Reference :  Link ¶

⚼ 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. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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. This property only applies to Guest (InGuestPatch) scope. ,
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 ,
]
,
}
,
tasks:
{
Description: [Not supported] Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTasks:
{
Description: [Not supported] List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
postTasks:
{
Description: [Not supported] List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] ,
Required: False ,
}
[
{
parameters:
{
Description: [Not supported] Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: [Not supported] Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
taskScope:
{
Description: [Not supported] Global Task execute once when schedule trigger. Resource task execute for each VM. ,
Enum:
{
Global: No description available. ,
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
}
ApplyUpdates_List (removed)
Description :  Get Configuration records within a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/applyUpdates
{
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 apply updates ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The resourceId ,
Required: False ,
}
string ,
lastUpdateTime:
{
Description: Last Update time ,
Format: date-time ,
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 ,
}
,
}
ApplyUpdateForResourceGroup_List (removed)
Description :  Get Configuration records within a subscription and resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maintenance/applyUpdates
{
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 apply updates ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: The resourceId ,
Required: False ,
}
string ,
lastUpdateTime:
{
Description: Last Update time ,
Format: date-time ,
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 ,
}
,
}
ConfigurationAssignmentsWithinSubscription_List (removed)
Description :  [UNSUPPORTED] Get configuration assignment within a subscription. This API is not implemented yet.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/configurationAssignments
{
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 configuration Assignments ,
Required: False ,
}
[
{
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the configuration assignment ,
Required: False ,
}
{
maintenanceConfigurationId:
{
Description: The maintenance configuration Id ,
Required: False ,
}
string ,
resourceId:
{
Description: The unique resourceId ,
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 ,
}
,
}
Operations_List (removed)
Description :  List the available operations supported by the Microsoft.Maintenance resource provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Maintenance/operations
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of operations ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation ,
Required: False ,
}
string ,
display:
{
Description: Display name of the operation ,
Required: False ,
}
{
provider:
{
Description: Name of the provider ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource type ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the operation ,
Required: False ,
}
object ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ 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 ,
}
,
}
Updates_ListParent (removed)
Description :  Get updates to resources.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/updates
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceParentType:
{
Description: Resource parent type ,
Required: True ,
}
string ,
resourceParentName:
{
Description: Resource parent identifier ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
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 pending updates ,
Required: False ,
}
[
{
maintenanceScope:
{
Description: The impact area ,
Enum:
{
Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs. ,
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 ,
impactType:
{
Description: The impact type ,
Enum:
{
None: Pending updates has no impact on resource. ,
Freeze: Pending updates can freeze network or disk io operation on resource. ,
Restart: Pending updates can cause resource to restart. ,
Redeploy: Pending updates can redeploy resource. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
impactDurationInSec:
{
Description: Duration of impact in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
notBefore:
{
Description: Time when Azure will start force updates if not self-updated by customer before this time ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
resourceId:
{
Description: The resourceId ,
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 ,
}
,
}
Updates_List (removed)
Description :  Get updates to resources.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/updates
{
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 ,
providerName:
{
Description: Resource provider name ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identifier ,
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 pending updates ,
Required: False ,
}
[
{
maintenanceScope:
{
Description: The impact area ,
Enum:
{
Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs. ,
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 ,
impactType:
{
Description: The impact type ,
Enum:
{
None: Pending updates has no impact on resource. ,
Freeze: Pending updates can freeze network or disk io operation on resource. ,
Restart: Pending updates can cause resource to restart. ,
Redeploy: Pending updates can redeploy resource. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status ,
Enum:
{
Pending: There are pending updates to be installed. ,
InProgress: Updates installation are in progress. ,
Completed: All updates are successfully applied. ,
RetryNow: Updates installation failed but are ready to retry again. ,
RetryLater: Updates installation failed and should be retried later. ,
}
,
Required: False ,
}
enum ,
impactDurationInSec:
{
Description: Duration of impact in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
notBefore:
{
Description: Time when Azure will start force updates if not self-updated by customer before this time ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the apply update ,
Required: False ,
}
{
resourceId:
{
Description: The resourceId ,
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 ,
}
,
}