Citrix Virtual Apps and Desktops SDK

Get-ProvOrphanedResource

March 11, 2024

Contributed by:

Gets the list of orphaned resources created while schemes provisioning.

Syntax

Get-ProvOrphanedResource -HypervisorConnectionUid <Guid[]> [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Let you retrieve the list of orphaned provisioning resources, such as disks, snapshots, galleries, virtual machines and network interfaces etc.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
HypervisorConnectionUid	Connection Uids group to specific hypervisor.	true	true (ByPropertyName)
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminClientIP	Specifies the Client IP of 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

Return Values

Citrix.Machinecreation.Sdk.Hypresource

This object provides details of hypervisor orphaned resource.

Id <string> An Id of hypervisor orphaned resource.
ResourceType <string> Resource type of hypervisor orphaned resource.
ProvisioningSchemeId <string> ProvisioningSchemeId of hypervisor orphaned resource.
Metadata <Citrix.MachineCreation.Sdk.ProvisionedResourceMetadata[]> Hypervisor resource orphaned metadata key/value.

Notes

The Get-ProvOrphanedResource cmdlet returns an object containing three sub-objects: o The Id of hypervisor orphaned resource. o The ProvisioningSchemeId of hypervisor orphaned resource. o The resource type of hypervisor orphaned resource. o The hypervisor orphaned resource metadata.

Examples

Example 1

C:\PS> $pluginId = 'AzureRmFactory'

                    C:\PS> $connections = Get-ChildItem xdhyp:\connections | where { $_.PluginId -eq $pluginId }

                    C:\PS> $result = Get-ProvOrphanedResource -HypervisorConnectionUid $connections.HypervisorConnectionUid

                    C:\PS> $result

                    resourceId                                                                                                                                                                            ResourceType               ProvisioningSchemeId                    Metadata

                    -----------------                                                                                                                                                                     ------------               --------                                --------

                    {/subscriptions/3fd5967f-7152-46c4-b061-2bd5d0cad70c/resourceGroups/citrix-xd-66575601-158f-48f1-a013-9c85e5f10c21-9peif/providers/Microsoft.Compute/snapshots/AZMC01-baseDisk-vy3ov} microsoft.compute/disks    d5a53d4e-dc8b-416a-80ce-8eef5eb2256f

<!--NeedCopy-->

Description

Returns the orphaned resource objects

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-ProvOrphanedResource

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Get-ProvOrphanedResource

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Machinecreation.Sdk.Hypresource

Notes

Examples

Example 1

Description

In this article