New-LMRecipientGroup
Syntax
New-LMRecipientGroup [-Name] <String> [[-Description] <String>] [-Recipients] <Array> [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
The New-LMRecipientGroup function creates a new LogicMonitor recipient group with the specified parameters.
Examples
Example 1
$recipients = @( New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'email' New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'sms' New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'voice' New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method 'smsemail' New-LMRecipient -Type 'ADMIN' -Addr 'user@domain.com' -Method '<name_of_existing_integration>' New-LMRecipient -Type 'ARBITRARY' -Addr 'someone@other.com' -Method 'email' New-LMRecipient -Type 'GROUP' -Addr 'Helpdesk')New-LMRecipientGroup -Name "MyRecipientGroup" -Description "This is a test recipient group" -Recipients $recipientsThis example creates a new LogicMonitor recipient group named "MyRecipientGroup" with a description and recipients built using the New-LMRecipient function.
Parameters
-Name
The name of the recipient group. This parameter is mandatory.
Type: StringParameter Sets: (All)Aliases:
Required: TruePosition: 1Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False
-Description
The description of the recipient group.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 2Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False
-Recipients
A object containing the recipients for the recipient group. The object must contain a “method”, “type” and “addr” key.
Type: ArrayParameter Sets: (All)Aliases:
Required: TruePosition: 3Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False
-ProgressAction
Fill ProgressAction Description
Type: ActionPreferenceParameter Sets: (All)Aliases: proga
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept 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
None. You cannot pipe objects to this command.
Outputs
Returns LogicMonitor.RecipientGroup object.
Notes
This function requires a valid LogicMonitor API authentication. Use Connect-LMAccount to authenticate before running this command.