Citrix Virtual Apps and Desktops SDK


Returns the list of pending image(s) to be deleted


Get-ProvImagesPendingDelete [[-ImageId] <String>] [-HostingUnitUid <Guid>] [-StorageId <String>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]


Detailed Description

Returns a list for each pending image which needs to be deleted. This check is done without regard for scoping of existing provisioning schemes, and hosting connection.


Name Description Required? Pipeline Input Default Value
ImageId The identifiers of the image(s)/ to be tested. false false  
HostingUnitUid The identifiers of the hosting units(s) to be tested. false false  
StorageId The identifier for the storage location on which the virtual image is located. 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_Prov_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_Prov_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  
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 The address of a Citrix Virtual Apps and Desktops 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


Filter pending image for delete by hosting unit identifer.


Filter pending image for delete by image identifer.

Return Values


The object has the following properties: Id <Int> The unique image record id

  • HostingUnitUid <Guid> The unique identifier of the hostingunit.

  • ImageId <string> The unique identifier of the image to be deleted.

  • InProgress <bool> Indicates whether the operation is in progress.

  • StorageId <string> The storage location on the hypervisor where the image resides.

  • TimeAdded <DateTime> The date and time when the operation was last queued for action.

  • PendingState <string> The state of the pending images to be deleted.

  • Reason <string> The reason why the image is in the pending state for deletion.


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

PartialData Only a subset of the available data was returned.
CouldNotQueryDatabase The query required to get the database was not defined.
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
CommunicationError An error occurred while communicating with the service.
DatabaseNotConfigured The operation could not be completed because the database for the service is not configured.
InvalidFilter A filtering expression was supplied that could not be interpreted for this cmdlet.
ExceptionThrown An unexpected error occurred. For more details, see the Windows event logs on the controller being used or Citrix Virtual Apps and Desktops logs.


Example 1

C:\PS>Get-ProvPendingImageDelete -HostingUnitUid "f68c0712-4643-496e-bf94-14b95b2e5c47"

                    HostingUnitUid : f68c0712-4643-496e-bf94-14b95b2e5c47

                    Id             : 1

                    ImageId        : 2cf68213-bd35-4adc-9c69-5de723cba469

                    InProgress     : True

                    PendingState   : DiskInUse

                    Reason         : Begin Delete threw an exception

                    StorageId      : 693fa4ab-1d67-478f-98a2-c4766d63d7eb

                    TimeAdded      : 8/25/2022 4:04:39 AM



Gets the operation ‘f68c0712-4643-496e-bf94-14b95b2e5c47’.