Tags

Updated on 06 Nov 2024
2 Minutes to read

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get-LiquitTag

Synopsis

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

Syntax

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

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

 Get-LiquitTag 
	[-EntityRef] <EntityRef[]> 
	[-LiquitContext <LiquitContext>]  
	[<CommonParameters>]

 Get-LiquitTag 
	[-Type] {Workspace | Management} 
	[-LiquitContext <LiquitContext>]  
	[<CommonParameters>]
    
 Get-LiquitTag  
    [-Search] <string> 
    [-LiquitContext <LiquitContext>]
    [<CommonParameters>]

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

Examples

Example 1: Get-LiquitTag

 Get-LiquitTag

This command displays all tags defined within Liquit Workspace.

Example 2: Get-LiquitTag

Get-LiquitSetting -id 00000000-0000-0000-0000-000000000000

This command displays the selected tag.

Parameters

Name	Value	Description	Required	Default value
Type	`{Workspace \| Management}`	The type of the tag Workspace: This tag is visible within the users workspace. Management: This tag is only visible within the management interface for administrators.
Search	`<string>`	This parameter serves a similar purpose to the search box found in the tags table from the Liquit Workspace UI. It enables users to search multiple columns within the table, such as Name and Type. 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 tag name itself.
LiquitContext	`<LiquitContext>`	Determines the selected zone.	No	Default

New-LiquitTag

Synopsis

This command creates a new tag.

Syntax

 New-LiquitTag 
	[-Name] <string> 
	[-Type] {Workspace | Management} 
	[-Color <string>] 
	[-Description <string>] 
	[-Icon <Content>] 
	[-LiquitContext <LiquitContext>] 
	[-WhatIf] 
	[-Confirm]
	[<CommonParameters>]

Example

 New-LiquitTag -Name "PowerShell Tag"  -Type "Workspace"

This creates a new tag named “PowerShell Tag”, of the “Workspace” type.

Parameters

Name	Value	Description	Required	Default value
Name	`<string>`	The name of the tag to be created.	Yes
Type	`{Workspace \| Management}`	The type of the tag Workspace: This tag is visible within the users workspace. Management: This tag is only visible within the management interface for administrators.	Yes
Color	`<string>`	The color used for the tag. The value should be a hex value (e.g. 15a4fa).	no
Description	`<string>`	The description of the tag.	no
Icon	`<Content>`	The icon of the tag.	no
LiquitContext	`<LiquitContext>`	Determines the selected zone.	No	Default

Set-LiquitTag

Synopsis

This command lets you edit the properties of a tag.

Syntax

 Set-LiquitTag 
	[-Tag] <Tag[]> 
	[-Name <string>] 
	[-Type {Workspace | Management}] 
	[-Color <string>] 
	[-Description <string>] 
	[-Icon <Content>] 
	[-LiquitContext <LiquitContext>]
	[-WhatIf] 
	[-Confirm]  
	[<CommonParameters>]

Example

 $tag = Get-LiquitTag -id 00000000-0000-0000-0000-000000000000
 Set-LiquitTag -Name "Updated PowerShell Tag" -Color "15a4fa" -Tag $tag

This command updates the tag.

Parameters

Name	Value	Description	Required	Default value
Tag	`<Tag[]>`	The tag to be updated.	Yes
Name	`<string>`	The name of the tag to be created.	No
Type	`{Workspace \| Management}`	The type of the tag Workspace: This tag is visible within the users workspace. Management: This tag is only visible within the management interface for administrators.	No
Color	`<string>`	The color used for the tag. The value should be a hex value (e.g. 15a4fa).	no
Description	`<string>`	The description of the tag.	no
Icon	`<Content>`	The icon of the tag	no
LiquitContext	`<LiquitContext>`	Determines the selected zone.	No	Default

Remove-LiquitTag

Synopsis

This command removes a tag.

Syntax

 Remove-LiquitTag 
	[-Tag] <Tag[]> 
	[-LiquitContext <LiquitContext>] 
	[-WhatIf] 
	[-Confirm]  
	[<CommonParameters>]

Example

 $tag  = Get-LiquitTag -ID 00000000-0000-0000-0000-000000000000
 Remove-LiquitTag -Tag $tag

This command removes the specified tag.

Parameters

Name	Value	Description	Required	Default value
Tag	`<Tag[]>`	The tag you want to remove.	Yes
LiquitContext	`<LiquitContext>`	Determines the selected zone.	No	Default

Was this article helpful?

What's Next

Tasks

Table of contents

Get-LiquitTag
New-LiquitTag
Set-LiquitTag
Remove-LiquitTag