Citrix Virtual Apps and Desktops SDK

Get-TrustServiceKey

Gets register ServiceKey configured for this site.

Syntax

Get-TrustServiceKey
   [[-Uid] <Int32>]
   [-InstanceId <String>]
   [-InstanceName <String>]
   [-IsTrustService <Boolean>]
   [-LastUpdated <DateTime>]
   [-RotationNeeded <Boolean>]
   [-ServiceName <String>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Retrieves registered ServiceKey matching the specified criteria. If no parameters are specified, all registered ServicesKey will be returned.

Examples

EXAMPLE 1

Gets all service keys.

Get-TrustServiceKey
<!--NeedCopy-->

EXAMPLE 2

Gets all service keys for a Trust Service.

Get-TrustServiceKey -IsTrustService $true
<!--NeedCopy-->

EXAMPLE 3

Mark all the service keys whose public key were last updated before October 20, 2015 to rotate their public keys.

Get-TrustServiceKey -Filter "LastUpdated -lt '10-20-2015'" | Set-TrustServiceKeyRotation
<!--NeedCopy-->

EXAMPLE 4

Revoke the previous public key of all service keys that were updated after October 20, 2016.

Get-TrustServiceKey -Filter "LastUpdated -gt '10-20-2016'" | Revoke-TrustPreviousServiceKey
<!--NeedCopy-->

Parameters

-InstanceId

Get ServiceKey with the specified instance identifier.

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

-InstanceName

Get ServiceKey with the specified instance name

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

-IsTrustService

Get ServiceKey with the specified value of the IsTrustService flag.

If true, only Service Keys for the Trust Service will be returned.

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

-LastUpdated

Get ServiceKey where the public key was last updated at the specified time.

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

-RotationNeeded

Get ServiceKey with the specified value of the RotationNeeded flag.

If true, only ServiceKey that need to be rotated will be returned.

If false, only ServiceKey where key rotation is not pending will be returned.

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

-ServiceName

Get ServiceKey with the specified service name.

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

-Property

Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.

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

-ReturnTotalRecordCount

When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Trust_Filtering for details.

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

-MaxRecordCount

Specifies the maximum number of records to return.

Type: Int32
Position: Named
Default value: 250
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

Type: String
Position: Named
Default value: The default sort order is by name or unique identifier.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Gets records that match a PowerShell-style filter expression. See about_Trust_Filtering for details.

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

-FilterScope

Gets only results allowed by the specified scope id.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2106

-Uid

Get ServiceKey with the specified Unique Identifier.

Type: Int32
Position: 2
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName, ByValue)
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

You cannot pipe input into this cmdlet.

Outputs

Citrix.Trust.Sdk.ServiceKey

Get-TrustServiceKey returns an object for each matching registered Service Key.

Get-TrustServiceKey