psPAS

5.5.110

Functions/Monitoring/Stop-PASPSMSession.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 # .ExternalHelp psPAS-help.xml
function Stop-PASPSMSession {
    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [Alias('SessionGuid')]
        [string]$LiveSessionId
    )

    BEGIN {
        Assert-VersionRequirement -RequiredVersion 10.1
    }#begin

    PROCESS {

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

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

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

        }

    } #process

    END { }#end

}