Teams
  • 06 Nov 2024
  • 2 Minutes to read
  • Dark
    Light
  • PDF

Teams

  • Dark
    Light
  • PDF

Article summary

Get-LiquitTeam

Synopsis

This command displays a list of all the teams available within Liquit Workspace. Alternatively, you can select a specific team.

Syntax

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

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

 Get-LiquitTeam 
    [-EntityRef] <EntityRef[]> 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]
    
 Get-LiquitTeam
    [-Search] <string> 
    [-LiquitContext <LiquitContext>]
    [<CommonParameters>]

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

Examples

Example 1: Get-LiquitTeam

 Get-LiquitTeam 

This command displays all the teams defined within Liquit Workspace.

Example 2: Get-LiquitTeam

Get-LiquitTeam -id 00000000-0000-0000-0000-000000000000

This command displays the specified team.

Parameters

NameValueDescriptionRequiredDefault value
Search<string>This parameter serves a similar purpose to the search box found in the teams table from the Liquit Workspace UI. It enables users to search multiple columns within the table, such as Name and Description. When a search term is provided, the parameter filters records by matching values in these indexed columns. However, it's important to note that not all columns in the table are indexed, meaning that searches for values in these non-indexed columns will not return results. Non-indexed columns include for example the ID and columns containing checkboxes.
Name<string>Searches on the team name itself.
LiquitContext<LiquitContext>Determines the selected zone.NoDefault

New-LiquitTeam

Synopsis

This command creates a new team.

Syntax

 New-LiquitTeam 
    [-Name] <string> 
    [-Icon <Content>] 
    [-Description <string>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm]  
    [<CommonParameters>]

Example

 New-LiquitTeam -Name "PowerShell Team"

This command creates a new team named “PowerShell Team”.

Parameters

NameValueDescriptionRequiredDefault value
Name<string>The name of the team to be created.Yes
Icon<Content>The icon of the team.No
Description<string>The description used for the team.No
LiquitContext<LiquitContext>Determines the selected zone.NoDefault

Set-LiquitTeam

Synopsis

This command lets you edit the properties of a team.

Syntax

 Set-LiquitTeam 
    [-Team] <Team[]> 
    [-Name <string>] 
    [-Description <string>] 
    [-Icon <Content>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm]  
    [<CommonParameters>]

Example

 $team = Get-LiquitTeam -ID 00000000-0000-0000-0000-000000000000
 Set-LiquitTeam -Name "Updated PowerShell Team" -Team $team

This command updates the team.

Parameters

NameValueDescriptionRequiredDefault value
Team<Team[]>The team to be updated.Yes
Name<string>The name of the team to be created.No
Icon<Content>The icon of the team.No
Description<string>The description of the team.No
LiquitContext<LiquitContext>Determines the selected zone.NoDefault

Remove-LiquitTeam

Synopsis

This command removes a team.

Syntax

 Remove-LiquitTeam 
    [-Team] <Team[]> 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] [-Confirm]  
    [<CommonParameters>]

Example

 $team = Get-LiquitTeam -ID 00000000-0000-0000-0000-000000000000
 Remove-LiquitTeam -Team $team

This command removes the specified team.

Parameters

NameValueDescriptionRequiredDefault value
Team<Team[]>The team you want to remove.Yes
LiquitContext<LiquitContext>Determines the selected zone.NoDefault

Was this article helpful?