Citrix Virtual Apps and Desktops SDK

New-BrokerUniversalClaim

A claim can be an arbitrary string up to 450 characters in length. Each Claim is mapped to a Virtual SID. Virtual SIDs are generated by either taking a SHA256 hash of the claim, and storing the hash bytes in a SID format, or in the case of a SID string being used as a Claim, the SID is copied to the VirtualSid.

Syntax


New-BrokerUniversalClaim [-VirtualSid] <String> -Claim <String> [-DirectoryContext] <String> [-UniversalClaimsTenantContext <String>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Creates a new UniversalClaim object.

Parameters

Name Description Required? Pipeline Input Default Value
VirtualSid The VirtualSid for this UniversalClaim mapping. true true (ByPropertyName)  
Claim The Claim for this UniversalClaim mapping. true true (ByPropertyName)  
DirectoryContext The DirectoryContext associated with this UniversalClaim mapping. true true (ByPropertyName)  
UniversalClaimsTenantContext The UnivesalClaimsTenantContext for this UniversalClaim mapping. false true (ByPropertyName)  
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. false false  
AdminAddress Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken Specifies the bearer token assigned to the calling user false false  
AdminClientIP Internal use only. false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  

Input Type

None

Input cannot be piped to this cmdlet.

Return Values

Citrix.Broker.Admin.Sdk.Universalclaim

Get-BrokerUniversalClaim returns an object for each matching broker UniversalClaim mapping.

Examples

Example 1


C:\PS> New-BrokerUniversalClaim -Claim AD:... -VirtualSid S-1-...1234 -DirectoryContext {..}

<!--NeedCopy-->

Description

Creates a new UniversalClaim mapping

New-BrokerUniversalClaim