public/service_desk/Get-ServiceDeskQueue.ps1
|
Function Get-ServiceDeskQueue { <# .DESCRIPTION Returns information about service desk queues. .PARAMETER Server The fully qualified name (FQDN) of the SMA Appliance. Example: https://kace.example.com .PARAMETER Org The SMA Organization you want to retrieve information from. If not provided, 'Default' is used. .PARAMETER Credential A credential for the kace appliance that has permissions to interact with the API. To run interactively, use -Credential (Get-Credential) .PARAMETER QueueID (Optional) If used, this is the ID of the queue you'd like information about. If not provided, all queues are returned .PARAMETER QueryParameters (Optional) Any additional query parameters to be included. String must begin with a <?> character. .INPUTS .OUTPUTS PSCustomObject .EXAMPLE Get-SmaServiceDeskQueues -Server https://kace.example.com -Org Default -Credential (Get-Credential) Retrieves information about all queues in the org. .EXAMPLE Get-SmaServiceDeskQueues -Server https://kace.example.com -Org Default -Credential (Get-Credential) -QueueID 1234 Retrieves information about a queue with ID 1234. .NOTES #> [cmdletBinding( SupportsShouldProcess = $true, ConfirmImpact = 'low' )] param( [Parameter(Mandatory = $true)] [string] $Server, [Parameter()] [string] $Org = 'Default', [Parameter(Mandatory = $true)] [PSCredential] $Credential, [Parameter()] [int] $QueueID, [Parameter()] [ValidatePattern("^\?")] [string] $QueryParameters ) Begin { $Endpoint = "/api/service_desk/queues" If ($QueueID) { $Endpoint = "/api/service_desk/queues/$QueueID" } } Process { If ($PSCmdlet.ShouldProcess($Server, "GET $Endpoint")) { New-ApiGETRequest -Server $Server -Endpoint $Endpoint -Org $Org -QueryParameters $QueryParameters -Credential $Credential } } End {} } |