Citrix Virtual Apps and Desktops SDK


Enumerates the regions of a hypervisor connection that are based on cloud technology.


Get-HypConnectionRegion [-LiteralPath] <String> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Use this command to enumerate the available regions within a public or private cloud, when making hypervisor connections to cloud services. Sometimes, regions need to be selected and applied before the cloud connection can be used in a meaningful way. This cmdlet allows the supported regions to be listed so that one may be selected.

Once a region has been chosen, use the standard Set-Item provider cmdlet to select it. See the examples for further details.

This cmdlet may return no output, in which case the cloud connection can be considered “regionless” (or, implicitly, all within a single region). In such cases, there is no need to select a region, and the hypervisor connection can be used as is.


Name Description Required? Pipeline Input Default Value
LiteralPath Specifies the path to the hypervisor connection whose regions are being examined. This cmdlet is valid only for hypervisor connections that have the UsesCloudInfrastructure flag set to true. The path must be in one of the following formats: :\Connections\ or :\Connections{} true true (ByValue)  
BearerToken Specifies the bearer token assigned to 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 use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress Specifies the address of a XenDesktop controller to which the PowerShell snap-in connects. You can provide a host name or an IP address. false false LocalHost. When a value is provided by any cmdlet, this value becomes the default.

Input Type


You Can Pipe A String That Contains A Path To Get-Hypconnectionregion (Literalpath Parameter).

Return Values


Get-HypConnectionRegion returns zero or more instances of the HypervisorConnectionRegion object, each of which contain the following properties:
Name <string> Specifies the unique name of the region. Endpoint <string> Specifies the URL endpoint that is specific to the region, if relevant. This may be an empty string, and is returned only for information purposes.
A full list of the hypervisor networks that are exposed for use in the hosting unit.


In the case of failure, the following errors can be produced.
Error Codes

The path provided is not to an item in the Connections subdirectory of the host service provider.
The path provided could not be resolved to an existing hypervisor connection. The name or GUID is invalid.
The hypervisor for the connection is in maintenance mode.
The hypervisor connection is not associated with cloud infrastructure, making it invalid to enumerate regions.
An error occurred in the service while attempting a database operation.
The operation could not be completed because the database for the service is not configured.
An error occurred in the service while attempting a database operation. Communication with the database failed for
various reasons.
An error occurred while communicating with the service.
The user does not have administrative rights to perform this operation.
An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used, or examine the XenDesktop logs.


Example 1

c:\PS>Get-HypConnectionRegions -LiteralPath XDHyp:\Connections\AWS

          RegionName           : us-east-1

          Endpoint             :

          RegionName           : us-west-1

          Endpoint             :

          RegionName           : eu-west-1

          Endpoint             :


          c:\PS>Set-Item -Path XDHyp:\Connections\AWS -Region "us-east-1"


This sequence of commands enumerates the available regions of an Amazon AWS cloud connection, and then selects one of them for use in the connection.