Citrix Virtual Apps and Desktops SDK

Get-ProvImageRuntimeEnvironment

Introduced in: Citrix Virtual Apps and Desktop 7 2308

Get image runtime Environment.

Syntax

Get-ProvImageRuntimeEnvironment
   -ImageVersionSpecUid <Guid>
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-ProvImageRuntimeEnvironment
   -ProvisioningSchemeUid <Guid>
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Allow you to extract information from ‘ImageRutimeInfo’ field in provisioning scheme or image version.

Examples

EXAMPLE 1

Get the image runtime environment associated with the given image version.

$res = Get-ProvImageRuntimeEnvironment -ImageVersionSpecUid a80c8338-e7af-48d6-8f08-21d2590b21b6
PS C:\Users\hanw> $res


Capabilities           : {[AzureAdSupported, True], [HybridAzureAdSupported, True], [IntuneSupported, False]}
DeviceEnrollmentStatus : Unknown
IdentityJoinStatus     : NotDomainJoined
OperatingSystem        : Citrix.MachineCreation.Sdk.OperatingSystemInfo
PagingFileSettings     : {Citrix.MachineCreation.Sdk.PagingFileSetting}
VDASessionSupport      : MultiSession



PS C:\Users\hanw> $res.OperatingSystem

FullName                          Type
--------                          ------------------
Windows Server 2019 Datacenter    Windows
<!--NeedCopy-->

EXAMPLE 2

Get the image runtime environment associated with the given provisioning scheme.

$res = Get-ProvImageRuntimeEnvironment -ProvisioningSchemeUid c0c55fa2-3d9f-44ee-8aba-3baec6547525
PS C:\Users\hanw> $res


Capabilities           : {[AzureAdSupported, False], [HybridAzureAdSupported, False], [IntuneSupported, True]}
DeviceEnrollmentStatus : Unknown
IdentityJoinStatus     : NotDomainJoined
OperatingSystem        : Citrix.MachineCreation.Sdk.OperatingSystemInfo
PagingFileSettings     :
VDASessionSupport      : SingleSession



PS C:\Users\hanw> $res.OperatingSystem

FullName       Type
--------       ------------------
Ubuntu 22.04   Linux
<!--NeedCopy-->

Parameters

-ImageVersionSpecUid

The unique identifier of image version spec.

Type: Guid
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2402

-ProvisioningSchemeUid

The unique identifier of provisioning scheme.

Type: Guid
Position: Named
Default value: None
Required: True
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

None

You can’t pipe objects to this cmdlet.

Outputs

Citrix.MachineCreation.Sdk.ImageRuntimeEnvironment

This object provides details of the image runtime environment and contains the following infrmation:

Capabilities <System.Collections.Generic.IDictionary<string, string>>

The capabilities of the image such as ‘AzureAdSupported’.

DeviceEnrollmentStatus <string>

The device enrollment status of the image.

IdentityJoinStatus <string>

The identity join status of the image.

OperatingSystem <Citrix.MachineCreation.Sdk.OperatingSystemInfo>

The operating system information of the image.

PagingFileSettings <Citrix.MachineCreation.Sdk.PagingFileSetting[]>

The page file settings of the image.

VDASessionSupport <string>

Specifies the session support of the VDA on the image. Valid values are: ‘SingleSession’, ‘MultiSession’, ‘Unknown’.

Notes

The Get-ProvImageRuntimeEnvironment cmdlet returns an object containing the following six sub-objects:

  • The image capabilities
  • The device enrollment status
  • The identity join status
  • The operating system information of the image
  • The page file settings of the image
  • The type of VDA installed on the image
Get-ProvImageRuntimeEnvironment