Update-AzScheduledQueryRule
Update a scheduled query rule.
Syntax
UpdateExpanded (Default)
Update-AzScheduledQueryRule
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-ActionCustomProperty <Hashtable>]
[-ActionGroupResourceId <String[]>]
[-AutoMitigate]
[-CheckWorkspaceAlertsStorageConfigured]
[-CriterionAllOf <ICondition[]>]
[-Description <String>]
[-DisplayName <String>]
[-Enabled]
[-EvaluationFrequency <TimeSpan>]
[-MuteActionsDuration <TimeSpan>]
[-OverrideQueryTimeRange <TimeSpan>]
[-Scope <String[]>]
[-Severity <Int64>]
[-SkipQueryValidation]
[-Tag <Hashtable>]
[-TargetResourceType <String[]>]
[-WindowSize <TimeSpan>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzScheduledQueryRule
-InputObject <IScheduledQueryRuleIdentity>
[-ActionCustomProperty <Hashtable>]
[-ActionGroupResourceId <String[]>]
[-AutoMitigate]
[-CheckWorkspaceAlertsStorageConfigured]
[-CriterionAllOf <ICondition[]>]
[-Description <String>]
[-DisplayName <String>]
[-Enabled]
[-EvaluationFrequency <TimeSpan>]
[-MuteActionsDuration <TimeSpan>]
[-OverrideQueryTimeRange <TimeSpan>]
[-Scope <String[]>]
[-Severity <Int64>]
[-SkipQueryValidation]
[-Tag <Hashtable>]
[-TargetResourceType <String[]>]
[-WindowSize <TimeSpan>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update a scheduled query rule.
Examples
Example 1: Update scheduled query rule
$subscriptionId=(Get-AzContext).Subscription.Id
Update-AzScheduledQueryRule -Name test-rule -ResourceGroupName test-group -Scope "/subscriptions/$subscriptionId/resourceGroups/test-group/providers/Microsoft.Compute/virtualMachines/test-vm" -ActionGroupResourceId "/subscriptions/$subscriptionId/resourceGroups/test-group/providers/microsoft.insights/actionGroups/test-action-group" -AutoMitigate:$false
Update scheduled query rule
Parameters
-ActionCustomProperty
The properties of an alert payload.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ActionGroupResourceId
Action Group resource Ids to invoke when the alert fires.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoMitigate
The flag that indicates whether the alert should be automatically resolved or not.
The default is true.
Relevant only for rules of the kind LogAlert.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
The flag which indicates whether this scheduled query rule should be stored in the customer's storage.
The default is false.
Relevant only for rules of the kind LogAlert.
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CriterionAllOf
A list of conditions to evaluate against the specified scopes
To construct, see NOTES section for CRITERIONALLOF properties and create a hash table.
Parameter properties
Type: ICondition [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Description
The description of the scheduled query rule.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DisplayName
The display name of the alert rule
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Enabled
The flag which indicates whether this scheduled query rule is enabled.
Value should be true or false
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EvaluationFrequency
How often the scheduled query rule is evaluated represented in ISO 8601 duration format.
Relevant and required only for rules of the kind LogAlert.
Parameter properties
Type: TimeSpan
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
UpdateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-MuteActionsDuration
Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired.
Relevant only for rules of the kind LogAlert.
Parameter properties
Type: TimeSpan
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the rule.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OverrideQueryTimeRange
If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods).
Relevant only for rules of the kind LogAlert.
Parameter properties
Type: TimeSpan
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Scope
The list of resource id's that this scheduled query rule is scoped to.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Severity
Severity of the alert.
Should be an integer between [0-4].
Value of 0 is severest.
Relevant and required only for rules of the kind LogAlert.
Parameter properties
Type: Int64
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SkipQueryValidation
The flag which indicates whether the provided query should be validated or not.
The default is false.
Relevant only for rules of the kind LogAlert.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
Resource tags
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TargetResourceType
List of resource type of the target resource(s) on which the alert is created/updated.
For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria.
Relevant only for rules of the kind LogAlert
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WindowSize
The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size).
Relevant and required only for rules of the kind LogAlert.
Parameter properties
Type: TimeSpan
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
