NinjaOne

0.9.0-Beta1

Public/Reset/Reset-NinjaOneAlert.ps1


using namespace System.Management.Automation
#Requires -Version 7
function Reset-NinjaOneAlert {
    <#
        .SYNOPSIS
            Resets alerts using the NinjaOne API.
        .DESCRIPTION
            Resets the status of alerts using the NinjaOne v2 API.
        .OUTPUTS
            A powershell object containing the response.
    #>
    [CmdletBinding( SupportsShouldProcess = $true, ConfirmImpact = 'Medium' )]
    [OutputType([Object])]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '', Justification = 'Uses dynamic parameter parsing.')]
    Param(
        # The alert ID to reset status for.
        [Parameter(Mandatory = $true)]
        [string]$uid
    )
    $CommandName = $MyInvocation.InvocationName
    $Parameters = (Get-Command -Name $CommandName).Parameters
    # Workaround to prevent the query string processor from adding an 'uid=' parameter by removing it from the set parameters.
    if ($uid) {
        $Parameters.Remove('uid') | Out-Null
    }
    try {
        $Resource = "v2/alert/$uid/reset"
        $RequestParams = @{
            Method = 'POST'
            Resource = $Resource
            Body = $null
        }
        if ($PSCmdlet.ShouldProcess('Alert', 'Reset')) {
            $Alert = New-NinjaOnePOSTRequest @RequestParams
            if ($Alert -eq 204) {
                Write-Information 'Alert reset successfully.'
            }
        }
    } catch {
        New-NinjaOneError -ErrorRecord $_
    }
}