Citrix Virtual Apps and Desktops SDK

Get-ProvImageVersion

Introduced in: Citrix Virtual Apps and Desktop 7 2303

Get a list of image versions.

Syntax

Get-ProvImageVersion
   [-ImageVersionUid <Guid>]
   [[-ImageVersionNumber] <Int32>]
   [-ImageDefinitionUid <Guid>]
   [-ImageDefinitionName <String>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Allows you to retrieve the list of defined image versions.

Examples

EXAMPLE 1

Returns all of the available image versions.

Get-ProvImageVersion

  ImageVersionNumber      : 1
  ImageVersionUid         : b1c7602c-b080-4a63-846b-9d2429d54bd1
  ImageDefinitionName     : myImage
  ImageDefinitionUid      : 42bd09f5-3fac-44a6-8b1c-7c09f1079cc0
  CreationTime            : 4/2/2022 2:57:21 AM
  Metadata                : {}
  Description             : version 1
  ImageVersionSpecsCount  : 0
<!--NeedCopy-->

EXAMPLE 2

Returns all of the available image versions for image definition “myImage”.

Get-ProvImageVersion -ImageDefinitionName myImage

  ImageVersionNumber      : 1
  ImageVersionUid         : b1c7602c-b080-4a63-846b-9d2429d54bd1
  ImageDefinitionName     : myImage
  ImageDefinitionUid      : 42bd09f5-3fac-44a6-8b1c-7c09f1079cc0
  CreationTime            : 4/2/2022 2:57:21 AM
  Metadata                : {}
  Description             : version 1
  ImageVersionSpecsCount  : 0
<!--NeedCopy-->

Parameters

-ImageVersionUid

The image version identifier to retrieve.

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 2402

-ImageDefinitionUid

The identifier of image definition where image versions are contained.

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 2402

-ImageDefinitionName

The name of image definition where image versions are contained.

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

-ReturnTotalRecordCount

See about_Prov_Filtering for details.

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

-MaxRecordCount

See about_Prov_Filtering for details.

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

-Skip

See about_Prov_Filtering for details.

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

-SortBy

See about_Prov_Filtering for details.

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

-Filter

See about_Prov_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

-ImageVersionNumber

The image version number to retrieve.

Type: Int32
Position: 2
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2402

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.ImageVersion

This object provides details of the image version and contains the following information:

CreationTime <DateTime>

The date and time when the image version was created.

Description <string>

The description for this image version.

ImageDefinitionName <string>

The name of the image Definition the created image version belongs to.

ImageDefinitionUid <Guid>

The unique identifier of the image Definition the created image version belongs to.

ImageVersionUid <int>

The unique identifier for this image version.

ImageVersionNumber <int>

The version number fot this image version.

ImageVersionSpecsCount <int>

The total image version specs count in this image version.

Metadata <System.Collections.Generic.Dictionary[string, string];>

The metadata to apply to the image version, if specified.

Notes

In the case of failure, the following errors can result.

Error Codes


DatabaseError

An error occurred in the service while attempting a database operation.

DatabaseNotConfigured

The operation could not be completed because the database for the service is not configured.

ServiceStatusInvalidDb

An error occurred in the service while attempting a database operation - communication with the database failed for

for various reasons.

CommunicationError

An error occurred while communicating with the service.

PermissionDenied

The user does not have administrative rights to perform this operation.

ConfigurationLoggingError

The operation could not be performed because of a configuration logging error.

ExceptionThrown

An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.

UnsupportedByServer

The requested operation is not supported by this version of the service.

Get-ProvImageVersion