Public/Remove-LMIntegration.ps1
|
<# .SYNOPSIS Removes a LogicMonitor integration. .DESCRIPTION The Remove-LMIntegration function removes a LogicMonitor integration based on either its ID or name. .PARAMETER Id Specifies the ID of the integration to be removed. This parameter is mandatory when using the 'Id' parameter set. .PARAMETER Name Specifies the name of the integration to be removed. This parameter is mandatory when using the 'Name' parameter set. .EXAMPLE Remove-LMIntegration -Id 12345 Removes the LogicMonitor integration with ID 12345. .EXAMPLE Remove-LMIntegration -Name "Slack-Integration" Removes the LogicMonitor integration with the name "Slack-Integration". .INPUTS You can pipe input to this function. .OUTPUTS Returns a PSCustomObject containing the ID of the removed integration and a message indicating the success of the removal operation. #> function Remove-LMIntegration { [CmdletBinding(DefaultParameterSetName = 'Id', SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory, ParameterSetName = 'Id', ValueFromPipelineByPropertyName)] [Int]$Id, [Parameter(Mandatory, ParameterSetName = 'Name')] [String]$Name ) #Check if we are logged in and have valid api creds begin {} process { if ($Script:LMAuth.Valid) { #Lookup Id if supplying name if ($Name) { $LookupResult = (Get-LMIntegration -Name $Name).Id if (Test-LookupResult -Result $LookupResult -LookupString $Name) { return } $Id = $LookupResult } if ($PSItem) { $Message = "Id: $Id | Name: $($PSItem.name)" } elseif ($Name) { $Message = "Id: $Id | Name: $Name" } else { $Message = "Id: $Id" } #Build header and uri $ResourcePath = "/setting/integrations/$Id" if ($PSCmdlet.ShouldProcess($Message, "Remove Integration")) { $Headers = New-LMHeader -Auth $Script:LMAuth -Method "DELETE" -ResourcePath $ResourcePath $Uri = "https://$($Script:LMAuth.Portal).$(Get-LMPortalURI)" + $ResourcePath Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation #Issue request Invoke-LMRestMethod -CallerPSCmdlet $PSCmdlet -Uri $Uri -Method "DELETE" -Headers $Headers[0] -WebSession $Headers[1] | Out-Null $Result = [PSCustomObject]@{ Id = $Id Message = "Successfully removed ($Message)" } return $Result } } else { Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." } } end {} } |