psPAS

5.5.110

Functions/Monitoring/Suspend-PASPSMSession.ps1

# .ExternalHelp psPAS-help.xml
function Suspend-PASPSMSession {
    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [Alias('SessionGuid')]
        [string]$LiveSessionId
    )

    BEGIN {
        Assert-VersionRequirement -RequiredVersion 10.2
    }#begin

    PROCESS {

        #Create URL for Request
        $URI = "$Script:BaseURI/api/LiveSessions/$($LiveSessionId | Get-EscapedString)/Suspend"

        if ($PSCmdlet.ShouldProcess($LiveSessionId, 'Suspend PSM Session')) {

            #send request to PAS web service
            Invoke-PASRestMethod -Uri $URI -Method POST -WebSession $Script:WebSession

        }

    } #process

    END { }#end

}