Set-BrokerAccessPolicyRuleMetadata

Last published : Oct 31, 2026
Creates/Updates metadata key-value pairs for AccessPolicyRule
Related information
about_Broker_AccessPolicy

Syntax

Set-BrokerAccessPolicyRuleMetadata
   [-AccessPolicyRuleId] <Int32>
   [-PassThru]
   -Name <String>
   -Value <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Set-BrokerAccessPolicyRuleMetadata
   [-AccessPolicyRuleId] <Int32>
   [-PassThru]
   -Name <String>
   -Value <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Set-BrokerAccessPolicyRuleMetadata
   [-AccessPolicyRuleId] <Int32>
   [-PassThru]
   -Map <PSObject>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Set-BrokerAccessPolicyRuleMetadata
   [-InputObject] <AccessPolicyRule[]>
   [-PassThru]
   -Name <String>
   -Value <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Set-BrokerAccessPolicyRuleMetadata
   [-InputObject] <AccessPolicyRule[]>
   [-PassThru]
   -Map <PSObject>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Set-BrokerAccessPolicyRuleMetadata
   [-AccessPolicyRuleName] <String>
   [-PassThru]
   -Name <String>
   -Value <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Set-BrokerAccessPolicyRuleMetadata
   [-AccessPolicyRuleName] <String>
   [-PassThru]
   -Map <PSObject>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

The Set-BrokerAccessPolicyRuleMetadata cmdlet creates/updates metadata key-value
pairs for AccessPolicyRule. The AccessPolicyRule can be specified by InputObject or piping.

Examples

EXAMPLE 1

This command creates/updates the Metadata "MyMetadataName" key-value pair for the AccessPolicyRule whose instance is pointed by \$obj-Uid
Set-BrokerAccessPolicyRuleMetadata -InputObject $obj-Uid -Name "MyMetadataName" -Value "1234"

EXAMPLE 2

This command creates/updates metadata key "MyMetadataName" with the value "1234" for all the AccessPolicyRule in the site
Get-BrokerAccessPolicyRule | Set-BrokerAccessPolicyRuleMetadata -Name "MyMetadataName" -Value "1234"

EXAMPLE 3

This command creates/updates two metadata keys "name1" and "name2" with the values "value1" and "value2" respectively for the AccessPolicyRule in the site whose name is 'objname'
@{ 'name1' = 'value1'; 'name2' = 'value2' } | Set-BrokerAccessPolicyRuleMetadata 'objname'

Parameters

-AccessPolicyRuleId

Specifies the AccessPolicyRule object whose Metadata is to be created/updated by ID.
Type: Int32
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Type: Int32
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Type: Int32
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-InputObject

Specifies the AccessPolicyRule objects whose Metadata is to be created/updated.
Type: AccessPolicyRule[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-AccessPolicyRuleName

Specifies the AccessPolicyRule object whose Metadata is to be created/updated by name.
Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: True

-Name

Specifies the name of the Metadata member to be created/updated
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-Value

Specifies the value of the Metadata member to be created/updated
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-Map

Specifies a hashtable containing name/value pairs to be used to create or update Metadata members
Type: PSObject
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-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

-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.BrokerAccessPolicyRule

You can pipe the AccessPolicyRule to hold the new or updated metadata.

Outputs

None or Citrix.Broker.Admin.SDK.BrokerAccessPolicyRule

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.BrokerAccessPolicyRule object.