Skip to main content

Get-AtriaWorkSpaceIcon

SYNOPSIS​

Retrieves an icon from the Atria workspace service by icon ID.

SYNTAX​

Get-AtriaWorkSpaceIcon -IconId <Int> [<CommonParameters>]

DESCRIPTION​

Retrieves detailed information about a specific workspace icon from the Atria API by specifying the icon's unique identifier.

PARAMETERS​

  • IconId <Int> (Required)
    The unique identifier (ID) of the workspace icon to retrieve.

  • <CommonParameters>
    Supports common parameters:
    Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable.

    More info: about_CommonParameters.

OUTPUTS​

Returns detailed information about the requested workspace icon, including the icon encoded as a base64 string.

EXAMPLES​

Example 1: Retrieve an icon and save it to disk​

# Retrieve icon data
$icon = Get-AtriaWorkSpaceIcon -IconId 789

# Decode base64 string and save to a file
[System.IO.File]::WriteAllBytes("C:\\Icons\\$($icon.data.filename)", [Convert]::FromBase64String($icon.data.iconBase64String))

This example retrieves the workspace icon with ID 789 and saves it to the specified location (C:\Icons\adobeAcrobat.png).

NOTES​

Ensure you've authenticated using Connect-AtriaApi before invoking this function.