Citrix Daas SDK

New-BrokerTag

August 9, 2024

Contributed by:

C C

Creates a new tag.

Syntax

New-BrokerTag
   [-Description <String>]
   [-Name] <String>
   [-Scope <String[]>]
   [-UUID <Guid>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Creates a tag that can be associated with other objects using Add-BrokerTag.

Examples

EXAMPLE 1

Creates a new tag with name ‘Tag1’.

New-BrokerTag -Name 'Tag1'
<!--NeedCopy-->

EXAMPLE 2

Creates a new tag with name ‘Tag2’ and associates it with machine DOMAIN\Machine.

New-BrokerTag 'Tag2' | Add-BrokerTag -Machine DOMAIN\Machine
<!--NeedCopy-->

Parameters

-Name

Specifies a name for the new tag.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-Description

A description for the tag.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-Scope

Specifies the name of the delegated administration scope to which the tag should belong.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-UUID

Specifies a UUID for the new tag. When not specified, a UUID is automatically assigned.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Input cannot be piped to this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.Tag

Outputs the generated tag.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

New-BrokerTag

August 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

New-BrokerTag

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-Name

-Description

-Scope

-UUID

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Broker.Admin.SDK.Tag

Related Links

In this article