Public/Invoke-VisitSignOut.ps1
|
<#
.SYNOPSIS Signs out a visit. .DESCRIPTION Signs out a visit. If the result returns null, try the parameter "-Verbose" to get more details. .EXAMPLE .LINK https://github.com/erwindevreugd/PSDataConduIT .EXTERNALHELP PSDataConduIT-help.xml #> function Invoke-VisitSignOut { [Alias("Set-VisitSignedOut")] [CmdletBinding()] [OutputType([int])] param ( [Parameter( Position = 0, Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'The name of the server where the DataConduIT service is running or localhost.')] [string] $Server = $Script:Server, [Parameter( Position = 1, Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'The credentials used to authenticate the user to the DataConduIT service.')] [PSCredential] $Credential = $Script:Credential, [Parameter( Mandatory = $true, ValueFromPipelineByPropertyName = $true, HelpMessage = 'Specifies the visit id to sign out.')] [int] $VisitID, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $false, HelpMessage = 'Returns an object that represents the visit. By default, this cmdlet does not generate any output.')] [switch] $PassThru ) process { $parameters = @{ Server = $Server; VisitID = $VisitID; } if ($Credential -ne $null) { $parameters.Add("Credential", $Credential) } if (($visit = Get-Visit @parameters) -eq $null) { Write-Error -Message ("Visit id '$($VisitID)' not found") return } $visit.SignOutVisit.Invoke() | Out-Null Write-Verbose -Message ("Visit '$($visit.VisitID)' signed out") if ($PassThru) { Get-Visit @parameters } } } |