Skip to main content

Add-AtriaWorkSpaceListItem

SYNOPSIS​

Adds a shared workspace item to a specific workspace list.

SYNTAX​

Add-AtriaWorkSpaceListItem -ListId <Int> -ItemId <Int> [-Configuration <String>] [-isDefaultSelect] [-resourceGroupName <String>] [-userGroupName <String>] [<CommonParameters>]

DESCRIPTION​

Creates an association between a specified workspace item and a workspace list by invoking the Atria API. Optional parameters allow for additional configuration, marking the item as default, and associating resource and user groups.

PARAMETERS​

  • ListId <Int> (Required)
    The unique identifier (ID) of the workspace list.

  • ItemId <Int> (Required)
    The unique identifier (ID) of the workspace item to add.

  • Configuration <String> (Optional)
    JSON-formatted configuration settings for the workspace item.

  • isDefaultSelect (Optional)
    Indicates if the workspace item should be marked as the default selection for the list.

  • resourceGroupName <String> (Optional)
    Name of the directory resource group to associate with the item.

  • userGroupName <String> (Optional)
    Name of the directory user group to associate with the item.

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

    More info: about_CommonParameters.

OUTPUTS​

Returns the response object confirming the successful addition of the workspace item to the list.

EXAMPLES​

Example 1​

PS> Add-AtriaWorkSpaceListItem -ListId 101 -ItemId 202

Adds the workspace item with ID 202 to the workspace list with ID 101.

Example 2 (With Configuration and Default Selection)​

PS> Add-AtriaWorkSpaceListItem -ListId 101 -ItemId 202 -isDefaultSelect -Configuration '{"key":"value"}'

Adds the workspace item with ID 202 to the list 101, marks it as default, and applies custom configuration settings.

Example 3 (Associating Resource and User Groups)​

PS> Add-AtriaWorkSpaceListItem -ListId 101 -ItemId 202 -resourceGroupName "ResourceGroup1" -userGroupName "UserGroupA"

Adds the workspace item with ID 202 to the list 101 and associates it with the specified resource and user groups.

NOTES​

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