Public/Remove-LMDatasource.ps1
|
<# .SYNOPSIS Removes a LogicMonitor datasource. .DESCRIPTION The Remove-LMDatasource function removes a LogicMonitor datasource based on the specified parameters. It requires the user to be logged in and have valid API credentials. .PARAMETER Id Specifies the ID of the datasource to be removed. This parameter is mandatory and can be provided as an integer. .PARAMETER Name Specifies the name of the datasource to be removed. This parameter is mandatory when using the 'Name' parameter set and can be provided as a string. .PARAMETER DisplayName Specifies the display name of the datasource to be removed. This parameter is mandatory when using the 'DisplayName' parameter set and can be provided as a string. .EXAMPLE Remove-LMDatasource -Id 123 Removes the datasource with the ID 123. .EXAMPLE Remove-LMDatasource -Name "MyDatasource" Removes the datasource with the name "MyDatasource". .EXAMPLE Remove-LMDatasource -DisplayName "My Datasource" Removes the datasource with the display name "My Datasource". .INPUTS You can pipe input to this function. .OUTPUTS System.Management.Automation.PSCustomObject #> Function Remove-LMDatasource { [CmdletBinding(DefaultParameterSetName = 'Id', SupportsShouldProcess, ConfirmImpact = 'High')] Param ( [Parameter(Mandatory, ParameterSetName = 'Id', ValueFromPipelineByPropertyName)] [Int]$Id, [Parameter(Mandatory, ParameterSetName = 'Name')] [String]$Name, [Parameter(Mandatory, ParameterSetName = 'DisplayName')] [String]$DisplayName ) 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-LMDatasource -Name $Name).Id If (Test-LookupResult -Result $LookupResult -LookupString $Name) { return } $Id = $LookupResult } #Lookup Id if supplying displayname If ($DisplayName) { $LookupResult = (Get-LMDatasource -DisplayName $DisplayName).Id If (Test-LookupResult -Result $LookupResult -LookupString $DisplayName) { return } $Id = $LookupResult } #Build header and uri $ResourcePath = "/setting/datasources/$Id" If ($PSItem) { $Message = "Id: $Id | Name: $($PSItem.name) | DisplayName: $($PSItem.displayName)" } Else { $Message = "Id: $Id" } Try { If ($PSCmdlet.ShouldProcess($Message, "Remove Datasource")) { $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 {} } |