New-CMAlertSubscription
Creates an alert subscription object.
Syntax
New-CMAlertSubscription
-AddEmailAddress <String[]>
[-AlertId <Int32[]>]
[-LocaleId <Int32>]
-Name <String>
[-RequireValidLocaleId]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The New-CMAlertSubscription cmdlet creates a subscription that sends alert notifications to one or more users when specific events occur in Configuration Manager. Before you create an alert subscription, make sure that you have configured email settings for sending alert notifications, and that you have at least one alert configured in Configuration Manager.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Create an alert subscription
PS XYZ:\> New-CMAlertSubscription -Name "Subscription01" -EmailAddress "[email protected]" -LocaleId 1033 -AlertIds 16777219This command creates an alert subscription named Subscription01. If there is an event that pertains to the specified alert, this subscription sends alert notifications to an email recipient. Because the command specifies a locale ID of 1033, the subscription uses US English.
Parameters
-AddEmailAddress
| Type: | String[] |
| Aliases: | EmailAddresses, EmailAddress, AddEmailAddresses |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AlertId
Specifies an array of alert identifiers for the subscription.
| Type: | Int32[] |
| Aliases: | AlertIds |
| 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: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LocaleId
Specifies a locale for alert messages. For more information and a list of locale identifiers, see Appendix A: Product Behavior.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of an alert subscription object.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequireValidLocaleId
| Type: | SwitchParameter |
| 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 doesn't run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None
Outputs
IResultObject