Set-LMRecipientGroup
Syntax
Id (Default)
Set-LMRecipientGroup -Id <String> [-NewName <String>] [-Description <String>] [-Recipients <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Name
Set-LMRecipientGroup -Name <String> [-NewName <String>] [-Description <String>] [-Recipients <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
The Set-LMRecipientGroup function updates a 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')Set-LMRecipientGroup -Id "1234567890" -NewName "MyRecipientGroupUpdated" -Description "This is a test recipient group updated" -Recipients $recipientsThis example updates a LogicMonitor recipient group named "MyRecipientGroupUpdated" with a description and recipients built using the New-LMRecipient function.
Parameters
-Id
The id of the recipient group. This parameter is mandatory.
Type: StringParameter Sets: IdAliases:
Required: TruePosition: NamedDefault value: NoneAccept pipeline input: True (ByPropertyName)Accept wildcard characters: False
-Name
The name of the recipient group to lookup instead of the id. This parameter is optional.
Type: StringParameter Sets: NameAliases:
Required: TruePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False
-NewName
The new name of the recipient group. This parameter is optional.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False
-Description
The description of the recipient group. This parameter is optional.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False
-Recipients
A object containing the recipients for the recipient group.
Type: PSObjectParameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault 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.