Citrix Virtual Apps and Desktops SDK

Get-ProvVMPrices

August 9, 2024

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Gets the list of vitrual machine’s prices.

Syntax

Get-ProvVMPrices
   -HypervisorConnectionUid <Guid>
   -HostedMachineIds <String[]>
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Let you retrieve the list of vitrual machine’s power on and power off prices.

Examples

EXAMPLE 1

Returns the virtual machine’s prices

$vmIds = @('testgroup/vm1', 'testgroup/vm2')
$res = Get-ProvVMPrices -HypervisorConnectionUid $con.HypHypervisorConnectionUid -HostedMachineIds $vmIds
$res
PowerOff                           PowerOn                            VMId
--------                           -------                            ----
Citrix.MachineCreation.Sdk.VMPrice Citrix.MachineCreation.Sdk.VMPrice testgroup/vm1
Citrix.MachineCreation.Sdk.VMPrice Citrix.MachineCreation.Sdk.VMPrice testgroup/vm2
$res[0].PowerOn

DiskPrices                                                                                                                                                                  VmPrice
----------                                                                                                                                                                  -------
{Citrix.MachineCreation.Sdk.ResourcePrice, Citrix.MachineCreation.Sdk.ResourcePrice, Citrix.MachineCreation.Sdk.ResourcePrice, Citrix.MachineCreation.Sdk.ResourcePrice...} Citrix.MachineCreation.Sdk.Re...
$res[0].PowerOff

DiskPrices                                                                           VmPrice
----------                                                                           -------
{Citrix.MachineCreation.Sdk.ResourcePrice, Citrix.MachineCreation.Sdk.ResourcePrice}
$res[0].PowerOn.VmPrice


AdditionalData : {[MeterCategory, Virtual Machines], [MeterSubCategory, Virtual Machines BS Series Windows], [MeterName, B2s], [MeterId, 5fee0fab-eeea-421a-9fab-0dbe6cc780d8]}
EffectivePrice : Citrix.MachineCreation.Sdk.UnitPrice
Location       : eastus
Product        : /subscriptions/3fd5967f-7152-46c4-b061-2bd5d0cad70c/resourceGroups/TESTGROUP/providers/Microsoft.Compute/virtualMachines/vm1
RetailPrice    : Citrix.MachineCreation.Sdk.UnitPrice
SavingsPlans   :
$res[0].PowerOn.VmPrice.EffectivePrice

Currency Price UnitOfMeasure
-------- ----- -------------
USD       2.98 100 Hours
$res[0].PowerOn.VmPrice.RetailPrice

Currency  Price UnitOfMeasure
--------  ----- -------------
USD      0.0496 1 Hour
$res[0].PowerOn.DiskPrices


AdditionalData : {[MeterCategory, Storage], [MeterSubCategory, Premium SSD Managed Disks], [MeterName, P6 LRS Disk], [MeterId, 39edab1a-b691-4088-9bb2-6ffe51d91da4]}
EffectivePrice : Citrix.MachineCreation.Sdk.UnitPrice
Location       : eastus
Product        : /subscriptions/3fd5967f-7152-46c4-b061-2bd5d0cad70c/resourceGroups/TESTGROUP/providers/Microsoft.Compute/disks/vm1-osdisk-kottz
RetailPrice    : Citrix.MachineCreation.Sdk.UnitPrice
SavingsPlans   :

AdditionalData : {[MeterCategory, Storage], [MeterSubCategory, Premium SSD Managed Disks], [MeterName, P6 LRS Disk Mount], [MeterId, 5a9b78c8-ac66-5af8-a877-60cea45ab76f]}
EffectivePrice : Citrix.MachineCreation.Sdk.UnitPrice
Location       : eastus
Product        : /subscriptions/3fd5967f-7152-46c4-b061-2bd5d0cad70c/resourceGroups/TESTGROUP/providers/Microsoft.Compute/disks/vm1-osdisk-kottz
RetailPrice    : Citrix.MachineCreation.Sdk.UnitPrice
SavingsPlans   :
<!--NeedCopy-->

Parameters

-HypervisorConnectionUid

Connection Uids group to specific hypervisor.

Type:	Guid
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-HostedMachineIds

The unique VM Id array within the hosting connection, For Azure it will be ‘{resourcegroupname}/{vm name}’

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	True

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

This object provides details of vitrual machine’s price.

VMId <string> An Id of virtual machine.

PowerOn <Citrix.MachineCreation.Sdk.VMPrice> The price of the VM when it is powered on.

PowerOff <Citrix.MachineCreation.Sdk.VMPrice> The price of the VM when it is powered off.

Notes

The Get-ProvVMPrices cmdlet returns an object containing three sub-objects:

The Id of virtual machine.
The price of the VM when it is powered on.
The price of the VM when it is powered off.

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

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Get-ProvVMPrices

Syntax

Description

Examples

EXAMPLE 1

Parameters

-HypervisorConnectionUid

-HostedMachineIds

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.MachineCreation.Sdk.VirtualMachinePriceResult

Notes

Related Links

In this article