Skip to content

Set AlertRules

CI edited this page Apr 24, 2020 · 1 revision

external help file: Pinja.Azure.Alerts-help.xml Module Name: Pinja.Azure.Alerts online version: schema: 2.0.0

Set-AlertRules

SYNOPSIS

Set alert rules to resource group.

SYNTAX

Set-AlertRules [-ResourceGroup] <String> [-AlertRules] <PSObject[]> [[-OverWrites] <PSObject[]>]
 [-ActionGroupReceiver] <Object> [-DisableAlerts] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Set alert rules to resource group. Get all resources from group and applies all given alert rules, overwrites if defined with default alert group `azure-alerts`. You must supply action group receiver where alerts are sent when triggered.

EXAMPLES

EXAMPLE 1

An example

PARAMETERS

-ResourceGroup

Resource group in azure.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AlertRules

In simplest form output from Get-DefaultAlertRules, rules that will be applied based on resource type.

Type: PSObject[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OverWrites

You can overwrite specific alerts in specific resources when needed. See Get-AlertRuleOverwrite for more information.

Type: PSObject[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: @()
Accept pipeline input: False
Accept wildcard characters: False

-ActionGroupReceiver

Parameter description

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DisableAlerts

Parameter description

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 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
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Management.Automation.PSObject[]

NOTES

General notes

RELATED LINKS