Skip to main content

Update-AtriaWorkSpaceCustomerItem

SYNOPSIS​

Updates a customer's WorkSpace list item and can refresh or replace its membership.

SYNTAX​

Update-AtriaWorkSpaceCustomerItem -CustomerId <Int> -ListItemId <Int> [-ItemId <Int>] [-Name <String>] [-Description <String>] [-SKU <String>] [-IconReference <String>] [-Tags <String[]>] [-IsDefault] [-SortOrder <Int>] [-Import] [-Users <String[]>] [-Roles <String[]>] [-TimeoutSec <Int>] [<CommonParameters>]

DESCRIPTION​

Sends an update for a customer's WorkSpace item. ListItemId identifies the customer's assignment instance; ItemId identifies the underlying item. They are different identifiers.

Use Import to refresh membership from the linked directory group, or supply explicit Users and Roles when the item supports those assignments.

PARAMETERS​

  • CustomerId <Int> (Required) — Customer that owns the list item.
  • ListItemId <Int> (Required) — Customer list-item assignment identifier.
  • ItemId <Int> (Optional) — Underlying WorkSpace item identifier.
  • Name, Description, SKU, IconReference (Optional) — Metadata fields to update.
  • Tags <String[]> (Optional) — Replacement tag collection.
  • IsDefault (Optional switch) — Marks the item as the default.
  • SortOrder <Int> (Optional) — Display order hint.
  • Import (Optional switch) — Refreshes membership from the linked directory resource.
  • Users <String[]> (Optional) — User account identifiers to assign.
  • Roles <String[]> (Optional) — WorkSpace role names to assign.
  • TimeoutSec <Int> (Optional; default 60) — HTTP request timeout in seconds.

EXAMPLES​

Update metadata​

Update-AtriaWorkSpaceCustomerItem `
    -CustomerId 123 `
    -ListItemId 456 `
    -ItemId 789 `
    -Name 'Accounts application' `
    -Tags @('finance', 'application')

Refresh directory membership​

Update-AtriaWorkSpaceCustomerItem `
    -CustomerId 123 `
    -ListItemId 456 `
    -Import `
    -TimeoutSec 120

OUTPUTS​

Returns the processed API response.

NOTES​

Call Connect-AtriaApi first. Retrieve the customer's current item records before updating so that ListItemId and ItemId are not confused.