Skip to main content

New-AtriaWorkSpaceItem

SYNOPSIS​

Creates a new Shared (Public) WorkSpace Item.

SYNTAX​

New-AtriaWorkSpaceItem -displayName <String> [-description <String>] [-environmentId <Int>] [-locationId <Int>] [-iconReference <String>] [-iconId <Int>] [-sku <String>] [-configuration <String>] [-isDefaultSelect] [-tags <String[]>] [-itemTypeId <Int> | -itemTypeName <String>] [-isCreateGroupItem <Boolean>] [-isCustomerOnlyItem <Boolean>] [-dirResName <String>] [-dirUserGroupName <String>] [<CommonParameters>]

DESCRIPTION​

Creates a new workspace item that is not specific to a customer. This function allows detailed configuration and supports specifying either the itemTypeId or the itemTypeName. It also provides control over directory group linkage, scope, and behavior.

PARAMETERS​

  • displayName <String> (Required)
    The display name for the workspace item.

  • description <String> (Optional)
    A description of the item.

  • environmentId <Int> (Optional)
    Environment ID where the item will be used.

  • locationId <Int> (Optional)
    Location ID related to the item.

  • iconReference <String> (Optional)
    Icon reference string.

  • iconId <Int> (Optional)
    Numeric ID of a predefined icon.

  • sku <String> (Optional)
    SKU (Stock Keeping Unit) identifier.

  • configuration <String> (Optional)
    Configuration data as a JSON-formatted string.

  • isDefaultSelect (Optional)
    Indicates whether the item should be default selected.

  • tags <String[]> (Optional)
    Tags for categorization.

  • itemTypeId <Int> (Required if using ByTypeId)
    Numeric identifier of the item type.

  • itemTypeName <String> (Required if using ByTypeName)
    Name of the item type.

  • isCreateGroupItem <Boolean> (Optional)
    Specifies whether the item should create a directory resource group. Defaults to true.

  • isCustomerOnlyItem <Boolean> (Optional)
    If true, the item is customer-specific only. Defaults to false.

  • dirResName <String> (Conditionally Required)
    Name of the directory resource group. Required if isCreateGroupItem is true.

  • dirUserGroupName <String> (Conditionally Required)
    Name of the user group. Required if isCreateGroupItem is true and isCustomerOnlyItem is false.

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

OUTPUTS​

Returns the newly created workspace item object.

EXAMPLES​

Example 1 (By Type ID)​

New-AtriaWorkSpaceItem -displayName "Shared App" -itemTypeId 1001 -dirResName "SharedGroup" -dirUserGroupName "UserGroupA"

Creates a shared workspace item with the given parameters using item type ID.

Example 2 (By Type Name, with Description)​

New-AtriaWorkSpaceItem -displayName "Custom App" -itemTypeName "CustomType" -dirResName "CustomGroup" -dirUserGroupName "UserGroupB" -description "Custom app for special cases."

Creates a workspace item using the item type name, with description and directory group settings.

NOTES​

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