Citrix Virtual Apps and Desktops SDK

Get-TrustServiceKey

March 11, 2024

Contributed by:

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>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

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

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Uid	Get ServiceKey with the specified Unique Identifier.	false	true (ByValue, ByPropertyName)
InstanceId	Get ServiceKey with the specified instance identifier.	false	false
InstanceName	Get ServiceKey with the specified instance name	false	false
IsTrustService	Get ServiceKey with the specified value of the IsTrustService flag. If true, only Service Keys for the Trust Service will be returned.	false	false
LastUpdated	Get ServiceKey where the public key was last updated at the specified time.	false	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.	false	false
ServiceName	Get ServiceKey with the specified service name.	false	false
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.	false	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.	false	false	False
MaxRecordCount	Specifies the maximum number of records to return.	false	false	250
Skip	Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.	false	false	0
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.	false	false	The default sort order is by name or unique identifier.
Filter	Gets records that match a PowerShell-style filter expression. See about_Trust_Filtering for details.	false	false
FilterScope	Gets only results allowed by the specified scope id.	false	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminClientIP	Specifies the Client IP of the calling user	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 user	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

None

You cannot pipe input into this cmdlet.

Return Values

Citrix.Trust.Sdk.Servicekey

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

Examples

Example 1

Get-TrustServiceKey

<!--NeedCopy-->

Description

Gets all service keys.

Example 2

Get-TrustServiceKey -IsTrustService $true

<!--NeedCopy-->

Description

Gets all service keys for a Trust Service.

Example 3

Get-TrustServiceKey -Filter "LastUpdated -lt '10-20-2015'" | Set-TrustServiceKeyRotation

<!--NeedCopy-->

Description

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

Example 4

Get-TrustServiceKey -Filter "LastUpdated -gt '10-20-2016'" | Revoke-TrustPreviousServiceKey

<!--NeedCopy-->

Description

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

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

Get-TrustServiceKey

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Get-TrustServiceKey

Syntax

Detailed Description

Related Commands

Parameters

Input Type

None

Return Values

Citrix.Trust.Sdk.Servicekey

Examples

Example 1

Description

Example 2

Description

Example 3

Description

Example 4

Description

In this article