Remove-LMLogPartition
Syntax
Id (Default)
Remove-LMLogPartition -Id <Int32> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
Name
Remove-LMLogPartition -Name <String> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
Description
The Remove-LMLogPartition function removes a LogicMonitor log partition based on the specified Id or Name. It requires a valid API authentication and authorization.
Examples
Example 1
Remove-LMLogPartition -Id 123Removes the LogicMonitor log partition with the Id 123.
Example 2
Remove-LMLogPartition -Name "customerA"Removes the LogicMonitor log partition with the Name "customerA".
Parameters
-Id
The Id of the log partition to be removed. This parameter is mandatory when using the ‘Id’ parameter set.
Type: Int32Parameter Sets: IdAliases:
Required: TruePosition: NamedDefault value: 0Accept pipeline input: True (ByPropertyName)Accept wildcard characters: False
-Name
The Name of the log partition to be removed. This parameter is mandatory when using the ‘Name’ parameter set.
Type: StringParameter Sets: NameAliases:
Required: TruePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameterParameter Sets: (All)Aliases: wi
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameterParameter Sets: (All)Aliases: cf
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 function.
Outputs
Returns a PSCustomObject containing the ID of the removed log partition and a success message confirming the removal.
Notes
This function requires a valid API authentication and authorization. Use Connect-LMAccount to log in before running this command.