Skip to content
Logic.Monitor PowerShell Module

Remove-LMRecipientGroup

Syntax

Id (Default)

Terminal window
Remove-LMRecipientGroup -Id <Int32> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Name

Terminal window
Remove-LMRecipientGroup -Name <String> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Description

The Remove-LMRecipientGroup function removes a LogicMonitor recipient group based on the specified Id or Name. It requires valid API credentials to be logged in.

Examples

Example 1

Terminal window
Remove-LMRecipientGroup -Id 123
Removes the recipient group with Id 123.

Example 2

Terminal window
Remove-LMRecipientGroup -Name "MyRecipientGroup"
Removes the recipient group with the name "MyRecipientGroup".

Parameters

-Id

The Id of the recipient group to remove. This parameter is mandatory when using the ‘Id’ parameter set.

Type: Int32
Parameter Sets: Id
Aliases:


Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

The name of the recipient group to remove. This parameter is mandatory when using the ‘Name’ parameter set.

Type: String
Parameter Sets: Name
Aliases:


Required: True
Position: Named
Default value: None
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

-ProgressAction

Fill ProgressAction Description

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga


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

You can pipe input to this function.

Outputs

Returns a PSCustomObject containing the ID of the removed recipient group and a success message confirming the removal.

Notes