Public/Remove-LMLogsource.ps1
|
<# .SYNOPSIS Removes a LogicMonitor log source. .DESCRIPTION The Remove-LMLogsource function removes a specified log source from LogicMonitor. The log source can be identified by either its ID or name. .PARAMETER Id Specifies the ID of the log source to remove. This parameter is mandatory when using the 'Id' parameter set. .PARAMETER Name Specifies the name of the log source to remove. This parameter is mandatory when using the 'Name' parameter set. .EXAMPLE Remove-LMLogsource -Id 123 Removes the log source with ID 123. .EXAMPLE Remove-LMLogsource -Name "MyLogSource" Removes the log source named "MyLogSource". .INPUTS You can pipe objects to this function. .OUTPUTS Returns a PSCustomObject containing the ID of the removed log source and a message confirming the successful removal. .NOTES This function requires a valid LogicMonitor API authentication. Make sure you are logged in before running any commands. #> Function Remove-LMLogsource { [CmdletBinding(DefaultParameterSetName = 'Id', SupportsShouldProcess, ConfirmImpact = 'High')] Param ( [Parameter(Mandatory, ParameterSetName = 'Id', ValueFromPipelineByPropertyName)] [Int]$Id, [Parameter(Mandatory, ParameterSetName = 'Name')] [String]$Name ) Begin {} Process { #Check if we are logged in and have valid api creds If ($Script:LMAuth.Valid) { #Lookup Id if supplying username If ($Name) { $LookupResult = (Get-LMLogSource -Name $Name).Id If (Test-LookupResult -Result $LookupResult -LookupString $Name) { return } $Id = $LookupResult } #Build header and uri $ResourcePath = "/setting/logsources/$Id" If ($PSItem) { $Message = "Id: $Id | Name: $($PSItem.name)" } Elseif ($Name) { $Message = "Id: $Id | Name: $Name" } Else { $Message = "Id: $Id" } Try { If ($PSCmdlet.ShouldProcess($Message, "Remove Logsource")) { $Headers = New-LMHeader -Auth $Script:LMAuth -Method "DELETE" -ResourcePath $ResourcePath $Uri = "https://$($Script:LMAuth.Portal).logicmonitor.com/santaba/rest" + $ResourcePath Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation #Issue request $Response = Invoke-RestMethod -Uri $Uri -Method "DELETE" -Headers $Headers[0] -WebSession $Headers[1] $Result = [PSCustomObject]@{ Id = $Id Message = "Successfully removed ($Message)" } Return $Result } } Catch [Exception] { $Proceed = Resolve-LMException -LMException $PSItem If (!$Proceed) { Return } } } Else { Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." } } End {} } |