New-AzMaintenanceConfiguration
Create or Update configuration record
Syntax
New-AzMaintenanceConfiguration
[-ResourceGroupName] <String>
[-Name] <String>
[-Location] <String>
[-Tag <Hashtable>]
[-ExtensionProperty <Hashtable>]
[-MaintenanceScope <String>]
[-StartDateTime <String>]
[-ExpirationDateTime <String>]
[-Timezone <String>]
[-Duration <TimeSpan>]
[-Visibility <String>]
[-RecurEvery <String>]
[-LinuxParameterPackageNameMaskToInclude <System.Collections.Generic.HashSet`1[System.String]>]
[-LinuxParameterPackageNameMaskToExclude <System.Collections.Generic.HashSet`1[System.String]>]
[-LinuxParameterClassificationToInclude <System.Collections.Generic.HashSet`1[System.String]>]
[-WindowParameterKbNumberToInclude <System.Collections.Generic.HashSet`1[System.String]>]
[-WindowParameterKbNumberToExclude <System.Collections.Generic.HashSet`1[System.String]>]
[-WindowParameterClassificationToInclude <System.Collections.Generic.HashSet`1[System.String]>]
[-WindowParameterExcludeKbRequiringReboot <Boolean>]
[-InstallPatchRebootSetting <String>]
[-PreTask <String>]
[-PostTask <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Create or Update configuration record
Examples
Example 1
New-AzMaintenanceConfiguration -ResourceGroupName smdtest -Name workervmscentralus -MaintenanceScope Host -Location centralus -StartDateTime "2020-08-01 00:00" -ExpirationDateTime "2021-08-04 00:00" -Timezone "Pacific Standard Time" -Duration 05:00 -RecurEvery Day
Location : centralus
Tags : {}
ExtensionProperties : {}
MaintenanceScope : Host
StartDateTime : 2020-08-01 00:00
ExpirationDateTime : 2021-08-04 00:00
TimeZone : Pacific Standard Time
RecurEvery : Day
Duration : 05:00
MaintenanceScope : Host
Visibility : Custom
Id : /subscriptions/42c974dd-2c03-4f1b-96ad-b07f050aaa74/resourcegroups/smdtest/providers/Microsoft.Maintenance/maintenanceConfigurations/workervmscentralus
Name : workervmscentralus
Type : Microsoft.Maintenance/maintenanceConfigurationsCreate a maintenance configuration with scope Host
Example 2
New-AzMaintenanceConfiguration -ResourceGroupName sample-rg -Name PatchSchedule -MaintenanceScope "InGuestPatch" -Location westeurope -Timezone "UTC" -StartDateTime "2025-10-09 12:30" -Duration "3:00" -RecurEvery "Day" -LinuxParameterClassificationToInclude @('Other') -LinuxParameterPackageNameMaskToInclude @('lib', 'kernel') -LinuxParameterPackageNameMaskToExclude @('curl', 'vim') -WindowParameterClassificationToInclude @('Critical', 'Security') -WindowParameterKbNumberToInclude @('5035849', '5035857') -WindowParameterKbNumberToExclude @('5034439') -ExtensionProperty @{inGuestPatchMode="User"} -InstallPatchRebootSetting "IfRequired" -Debug
Location : westeurope
Tags : {"resource":"test"}
ExtensionProperties : {"inGuestPatchMode":"User"}
MaintenanceScope : InGuestPatch
Id :
/subscriptions/783fd652-64f3-4680-81e9-0b978c542005/resourcegroups/sample-rg/providers/Microsoft.Maintenance/maintenanceConfigurations/PatchSchedule
Name : PatchSchedule
Type : Microsoft.Maintenance/maintenanceConfigurations
StartDateTime : 2025-10-09 12:30
Duration : 03:00
Timezone : UTC
Visibility : Custom
RecurEvery : Day
LinuxParameterClassificationToInclude :
LinuxParameterPackageNameMaskToExclude :
LinuxParameterPackageNameMaskToInclude : apt
httpd
WindowParameterKbNumberToInclude :
WindowParameterKbNumberToExclude :
WindowParameterClassificationToInclude :
InstallPatchRebootSetting : IfRequiredCreate a maintenance configuration with scope InGuest
Parameters
-AsJob
Run cmdlet in the background
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Duration
The duration
| Type: | TimeSpan |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExpirationDateTime
The expirationDateTime of the schedule in format YYYY-MM-DD hh:mm
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExtensionProperty
The Extension properties per resource.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InstallPatchRebootSetting
Install Patch Reboot Option. Allowed values Never, IfRequired, Always
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LinuxParameterClassificationToInclude
List of linux patch classifications
| Type: | HashSet<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LinuxParameterPackageNameMaskToExclude
List of packages to exclude during vm patch operation
| Type: | HashSet<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LinuxParameterPackageNameMaskToInclude
List of packages to include during vm patch operation
| Type: | HashSet<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
The maintenance configuration location.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-MaintenanceScope
The Maintenance Scope.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The maintenance configuration Name.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PostTask
List of tasks executed after schedule. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}]. This parameter is used to specify a command or script that should be run after the maintenance tasks are performed. This can be used to perform any necessary follow-up actions after the maintenance tasks are completed. This parameter accepts a string value that specifies the command or script to be run. The command or script can be specified as a simple string or as an array of strings. If an array of strings is specified, each element in the array will be treated as a separate command or script.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PreTask
List of tasks executed before schedule. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}]. This parameter is used to specify a command or script that should be run before the maintenance tasks are performed. This can be used to perform any necessary preparations or cleanup actions before the maintenance tasks are run. This parameter accepts a string value that specifies the command or script to be run. The command or script can be specified as a simple string or as an array of strings. If an array of strings is specified, each element in the array will be treated as a separate command or script.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RecurEvery
The schedule recurrence
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The resource Group Name.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StartDateTime
The StartDateTime of the schedule in format YYYY-MM-DD hh:mm
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tag
The ARM Tags.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Timezone
The timezone
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Visibility
The visibility of the scope
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WindowParameterClassificationToInclude
List of windows patch classification
| Type: | HashSet<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WindowParameterExcludeKbRequiringReboot
Exclude KBs which require reboot
| Type: | Nullable<T>[Boolean] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WindowParameterKbNumberToExclude
List of KBs to exclude during vm patch operation
| Type: | HashSet<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WindowParameterKbNumberToInclude
List of KBs to include during vm patch operation
| Type: | HashSet<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Azure PowerShell
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for