Public/Remove-LMLogPartition.ps1
|
<# .SYNOPSIS Removes a LogicMonitor log partition. .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. .PARAMETER Id The Id of the log partition to be removed. This parameter is mandatory when using the 'Id' parameter set. .PARAMETER Name The Name of the log partition to be removed. This parameter is mandatory when using the 'Name' parameter set. .EXAMPLE Remove-LMLogPartition -Id 123 Removes the LogicMonitor log partition with the Id 123. .EXAMPLE Remove-LMLogPartition -Name "customerA" Removes the LogicMonitor log partition with the Name "customerA". .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. #> Function Remove-LMLogPartition { [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-LMLogPartition -Name $Name).Id If (Test-LookupResult -Result $LookupResult -LookupString $Name) { return } $Id = $LookupResult } #Build header and uri $ResourcePath = "/log/partitions/$Id" If ($PSItem) { $Message = "Id: $Id | Name: $($PSItem.name)" } Elseif ($Name) { $Message = "Id: $Id | Name: $Name" } Else { $Message = "Id: $Id" } #Loop through requests Try { If ($PSCmdlet.ShouldProcess($Message, "Remove Log Partition")) { $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 $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 {} } |