Public/Set-ArmorAccountContext.ps1
|
function Set-ArmorAccountContext { <# .SYNOPSIS Sets the Armor account context, so that all future requests reference the specified account. .DESCRIPTION { required: more detailed description of the function's purpose } .NOTES Troy Lindsay Twitter: @troylindsay42 GitHub: tlindsay42 .INPUTS System.UInt16 .LINK https://github.com/tlindsay42/ArmorPowerShell .LINK https://docs.armor.com/display/KBSS/Armor+API+Guide .LINK https://developer.armor.com/ .EXAMPLE {required: show one or more examples using the function} #> [CmdletBinding()] [OutputType( 'ArmorAccount' )] param ( <# Specifies which Armor account should be used for the context of all subsequent requests. #> [Parameter( Position = 0, ValueFromPipeline = $true )] [ValidateScript( { $_ -in ( Get-ArmorIdentity ).Accounts.ID } )] [UInt16] $ID = $null ) begin { $function = $MyInvocation.MyCommand.Name Write-Verbose -Message ( 'Beginning {0}.' -f $function ) Test-ArmorSession } # End of begin process { [ArmorAccount] $return = $Global:ArmorSession.SetAccountContext( $ID ) $return } # End of process end { Write-Verbose -Message ( 'Ending {0}.' -f $function ) } # End of end } # End of function |