Contents x
    User Collections
    • 24 Jun 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    User Collections

    • Updated on 24 Jun 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Get-LiquitUserCollection

    Synopsis

    This command displays a list of all user collections from the Liquit Workspace, or you can select a specific user collection.

    Syntax

    Get-LiquitUserCollection 
    [-LiquitContext <LiquitContext>] 
    [<CommonParameters>] 

Get-LiquitUserCollection 
    [-ID] <guid[]> 
    [-LiquitContext <LiquitContext>] 
    [<CommonParameters>] 

Get-LiquitUserCollection 
    [-IdentityRef] <IdentityRef[]> 
    [-LiquitContext <LiquitContext>] 
    [<CommonParameters>] 

Get-LiquitUserCollection 
    [-Search] <string> 
    [-LiquitContext <LiquitContext>] 
    [<CommonParameters>] 

Get-LiquitUserCollection 
    [-Name] <string> 
    [-LiquitContext <LiquitContext>] 
    [<CommonParameters>]

    Examples

    The following command lists all available user collections within Liquit Workspace.

    Get-LiquitUserCollection

    The following command lists a specific user collection.

    Get-LiquitUserCollection -id 00000000-0000-0000-0000-000000000000

    New-LiquitUserCollection

    Synopsis

    This command creates a new user collection.

    Syntax

    New-LiquitUserCollection 
    -Dynamic 
    -Name <string> 
    -Filters <ContextFilters> 
    [-Description <string>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm] 
    [<CommonParameters>] 

 New-LiquitUserCollection 
    -Dynamic 
    -Name <string> 
    -Script <string> 
    [-Description <string>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm] 
    [<CommonParameters>] 
 
New-LiquitUserCollection 
    -Dynamic 
    -Name <string> 
    [-Description <string>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm] 
    [<CommonParameters>] 

New-LiquitUserCollection 
    -Name <string> 
    [-Description <string>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm] 
    [<CommonParameters>]

    Example

    The following command creates a new user collection, named " UserCollection".

    New-LiquitUserCollection 
    -Name " UserCollection"

    Parameters

    NameValueDescriptionRequiredDefault value
    DynamicCreate a dynamic user collection.Yes
    Name<string>Provide a name for the user collection.Yes
    Script<string>The script to use for the user collection.Yes
    Filters<ContextFilters>Filters to use for the user collection.Yes
    Description<string>Provide a description for the user collection.No
    LiquitContext<LiquitContext>Determines the selected zone.NoDefault

    Set-LiquitUserCollection

    Synopsis

    This command updates a user collection.

    Syntax

    Set-LiquitUserCollection 
    [-UserCollection] <UserCollection[]> 
    [-Name <string>] 
    [-Description <string>] 
    [-Filters <ContextFilters>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm] 
    [<CommonParameters>] 

Set-LiquitUserCollection 
     [-UserCollection] <UserCollection[]> 
     [-Name <string>] 
     [-Description <string>] 
     [-Script <string>] 
     [-LiquitContext <LiquitContext>] 
     [-WhatIf] 
     [-Confirm] 
     [<CommonParameters>]

    Example

    The following command updates the name of the user collection to "Updated UserCollection".

    $UserCollection = Get-LiquitUserCollection -id 00000000-0000-0000-0000-000000000000 
Set-LiquitUserCollection -UserCollection $UserCollection -Name "Updated UserCollection"

    Parameters

    NameValueDescriptionRequiredDefault value
    UserCollection<UserCollection[]>The user collection that needs to be updated.Yes
    Name<string>Provide a name for the user collection.Yes
    Script<string>Script to use for the user collection.No
    Filters<ContextFilters>Filters to use for user collection.No
    Description<string>Provide a description for the user collection.No
    LiquitContext<LiquitContext>Determines the selected zone.NoDefault

    Remove-LiquitUserCollection

    Synopsis

    Removes a user collection from the Liquit Workspace.

    Syntax

    Remove-LiquitUserCollection 
[-UserCollection] <UserCollection[]> 
[-LiquitContext <LiquitContext>] 
[-WhatIf] 
[-Confirm] 
[<CommonParameters>]

    Example

    The following command removes the selected device collection from the Liquit Workspace.

    $UserCollection = Get-LiquitUserCollection -id 00000000-0000-0000-0000-000000000000 
Remove-LiquitUserCollection -UserCollection $UserCollection

    Parameters

    NameValueDescriptionRequiredDefault value
    UserCollection<UserCollection[]>The user collection that should be removed.Yes
    LiquitContext<LiquitContext>Determines the selected zone.NoDefault
    Was this article helpful?
    What's Next