Set-BrokerAutoTagRule
Introduced in: Citrix Virtual Apps and Desktop 7 2109
Changes an existing AutoTagRule.
Syntax
Set-BrokerAutoTagRule
[-InputObject] <AutoTagRule[]>
[-PassThru]
[-Description <String>]
[-ObjectType <String>]
[-RuleText <String>]
[-TagUid <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-BrokerAutoTagRule
[-Name] <String>
[-PassThru]
[-Description <String>]
[-ObjectType <String>]
[-RuleText <String>]
[-TagUid <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Changes the specified properties of an existing AutoTagRule.
Examples
EXAMPLE 1
Sets RandomAllocatedCatalogs' tag to MyExample2.
$tag = New-BrokerTag -Name MyExample2
Set-BrokerAutoTagRule -Name RandomAllocatedCatalogs -TagUid $tag.Uid
Parameters
-InputObject
Specifies the AutoTagRule object to change.
| Type: | AutoTagRule[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Name
The name of the AutoTagRule to change.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-PassThru
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
New Description that will be set.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ObjectType
New ObjectType that will be set.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RuleText
New RuleText that will be set.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TagUid
New TagUid that will be set.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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
Citrix.Broker.Admin.SDK.AutoTagRule
AutoTagRule may be specified through pipeline input.
Outputs
None
By default, this cmdlet returns no output.