Public/Remove-LMDashboardGroup.ps1
|
<# .SYNOPSIS Removes a LogicMonitor dashboard group. .DESCRIPTION The Remove-LMDashboardGroup function removes a LogicMonitor dashboard group based on the specified Id or Name. .PARAMETER Id The Id of the dashboard group to remove. This parameter is mandatory when using the 'Id' parameter set. .PARAMETER Name The name of the dashboard group to remove. This parameter is mandatory when using the 'Name' parameter set. .EXAMPLE Remove-LMDashboardGroup -Id 123 Removes the dashboard group with Id 123. .EXAMPLE Remove-LMDashboardGroup -Name "MyDashboardGroup" Removes the dashboard group with the name "MyDashboardGroup". .INPUTS None. #> Function Remove-LMDashboardGroup { [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 dashboard name If ($Name) { $LookupResult = (Get-LMDashboardGroup -Name $Name).Id If (Test-LookupResult -Result $LookupResult -LookupString $Name) { return } $Id = $LookupResult } #Build header and uri $ResourcePath = "/dashboard/groups/$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 Dashboard Group")) { $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 {} } |