Developer Documentation
Citrix Daas SDK

Get-ProvImagesPendingDelete

November 28, 2023
Contributed by: 
C C

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

Syntax

Get-ProvImagesPendingDelete
   [-HostingUnitUid <Guid>]
   [[-ImageId] <String>]
   [-StorageId <String>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

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

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
<!--NeedCopy-->

Parameters

-ImageId

The identifiers of the image(s)/ to be tested.

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

-HostingUnitUid

The identifiers of the hosting units(s) to be tested.

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

-StorageId

The identifier for the storage location on which the virtual image is located.

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

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

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

-MaxRecordCount

Specifies the maximum number of records to return.

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

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

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

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

Type: String
Position: Named
Default value: The default sort order is by name or unique identifier.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Gets records that match a PowerShell-style filter expression. 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

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

Citrix.Host.Sdk.HostingUnit

Filter pending image for delete by hosting unit identifer.

Citrix.Host.Sdk.ImageId

Filter pending image for delete by image identifer.

Outputs

Citrix.MachineCreation.Sdk.PendingImageDelete

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.

Notes

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

Error Codes

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.

Get-ProvImagesPendingDelete
November 28, 2023
Contributed by: 
C C
November 28, 2023
Contributed by: 
C C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.