Skip to main content

New-AtriaWorkSpaceCustomerItem

SYNOPSIS​

Creates a customer-owned WorkSpace item.

SYNTAX​

New-AtriaWorkSpaceCustomerItem -customerId <Int> -displayName <String> -itemTypeId <Int> [-description <String>] [-iconReference <String>] [-iconId <Int>] [-sku <String>] [-configuration <String>] [-isDefaultSelect] [-tags <String[]>] [-isCreateGroupItem <Boolean>] [-isCustomerOnlyItem <Boolean>] [-dirResName <String>] [<CommonParameters>]

New-AtriaWorkSpaceCustomerItem -customerId <Int> -displayName <String> -itemTypeName <String> [-description <String>] [-iconReference <String>] [-iconId <Int>] [-sku <String>] [-configuration <String>] [-isDefaultSelect] [-tags <String[]>] [-isCreateGroupItem <Boolean>] [-isCustomerOnlyItem <Boolean>] [-dirResName <String>] [<CommonParameters>]

DESCRIPTION​

Creates a private WorkSpace item beneath a customer. Identify the item type by either ID or exact name.

When isCreateGroupItem is true—the default—dirResName is required. When it is false, dirResName is not allowed.

PARAMETERS​

  • customerId <Int> (Required) Customer that will own the item.
  • displayName <String> (Required) Customer-facing item name.
  • itemTypeId <Int> (Required in the ByTypeId parameter set) Numeric item-type identifier.
  • itemTypeName <String> (Required in the ByTypeName parameter set) Exact item-type name. The cmdlet resolves it to an ID.
  • description <String> (Optional) Item description.
  • iconReference <String> / iconId <Int> (Optional) Icon reference or numeric icon identifier.
  • sku <String> (Optional) External or billing SKU.
  • configuration <String> (Optional) Configuration payload expected by the selected item type.
  • isDefaultSelect (Optional switch) Marks the item as selected by default.
  • tags <String[]> (Optional) Item tags.
  • isCreateGroupItem <Boolean> (Optional; default true) Whether the item creates or uses a directory resource group.
  • isCustomerOnlyItem <Boolean> (Optional; default false) Whether the item is restricted to this customer.
  • dirResName <String> (Conditional) Required when isCreateGroupItem is true; forbidden when it is false.

EXAMPLES​

Create a group-backed item by type ID​

New-AtriaWorkSpaceCustomerItem `
    -customerId 123 `
    -displayName 'Standard App' `
    -itemTypeId 1001 `
    -dirResName 'Example-Standard-App'

Create a customer-only item without a directory group​

New-AtriaWorkSpaceCustomerItem `
    -customerId 123 `
    -displayName 'Customer Portal' `
    -itemTypeName 'Web Link' `
    -isCreateGroupItem $false `
    -isCustomerOnlyItem $true

OUTPUTS​

Returns the newly created WorkSpace item returned by the API.

NOTES​

Call Connect-AtriaApi first. Resolve the customer and item type in the target environment rather than reusing IDs from another deployment.