Public/Get-ArmorAccount.ps1
|
function Get-ArmorAccount { <# .SYNOPSIS Retrieves a list of Armor account memberships for the currently authenticated user. .DESCRIPTION { required: more detailed description of the function's purpose } .NOTES Troy Lindsay Twitter: @troylindsay42 GitHub: tlindsay42 .PARAMETER ApiVersion The API version. The default value is $Global:ArmorSession.ApiVersion. .INPUTS None You cannot pipe objects to Get-ArmorAccount. .OUTPUTS System.Collections.Hashtable .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()] param ( [Parameter( Position = 0 )] [String] $Name = '', [ValidateRange( 1, 65535 )] [UInt16] $ID = 0, [ValidateSet( 'v1.0' )] [String] $ApiVersion = $Global:ArmorSession.ApiVersion ) begin { $function = $MyInvocation.MyCommand.Name Write-Verbose -Message ( 'Beginning {0}.' -f $function ) Test-ArmorSession } # End of begin process { $return = $null Write-Verbose -Message ( 'Gather API Data for {0}.' -f $function ) $resources = Get-ArmorApiData -Endpoint $function -ApiVersion $ApiVersion $uri = New-ArmorApiUriString -Endpoints $resources.Uri $uri = New-ArmorApiUriQueryString -QueryKeys $resources.Query.Keys -Parameters ( Get-Command -Name $function ).Parameters.Values -Uri $uri $results = Submit-ArmorApiRequest -Uri $uri -Method $resources.Method -Description $resources.Description $results = Select-ArmorApiResult -Results $results -Filter $resources.Filter if ( $results.Count -eq 0 ) { Write-Host -Object 'Armor account not found.' } else { $return = [ArmorAccount[]] $results } return $return } # End of process end { Write-Verbose -Message ( 'Ending {0}.' -f $function ) } # End of end } # End of function |