Help Page Home

# ComputeResourceModel

A compute resource represents a hypervisor, hypervisor pool, or other resource that provides the ability to provision machines on-demand.

### Properties

Name | Description | Additional information
--- | --- | ---
Href | See Hypermedia. | Type: String
RelatedActions | See Hypermedia. | Type: Array of RelationModel
Id | ID of the compute resource. | Type: String
ChangeId | See Optimistic Concurrency. | Type: String
Name | Name. | Type: String
ShortName | See Short Names. | Type: String
Description | Description. | Type: String
DeleteState | See Deleting Objects. | Type: ObjectDeleteState
ComputeResourceAllocationState | The allocation state. | Type: ComputeResourceAllocationState
ComputeResourceType | The type of compute resource. | Type: ComputeResourceType
Address | The management address of the compute resource. | Type: String
UserNameOrApiKey | The user name used to communicate with the compute resource. | Type: String
Cluster | The cluster within the compute resource where provisioning will occur. This property only applies to compute resources of type HyperV and VMWare. | Type: ClusterModel
UseLocalStorage | If true, the virtual machines provisioned on the compute resource will have their operating system disk located on the local storage of the hypervisor. If false, the operating system disk will be located on the storage indicated by the VirtualMachineStorage property. | Type: Boolean
VirtualMachineStorage | The hypervisor storage pool(s) where operating system disks will be placed when virtual machines are provisioned on this compute resource. If there are multiple pools, virtual machines will be balanced between these storage pools. This property is only used if UseLocalStorage is false. | Type: Array of String
PersonalVDiskStorage | The hypervisor storage pool(s) where personal virtual disks will be placed when virtual machines are provisioned on this compute resource. If there are multiple pools, virtual machines will be balanced between these storage pools. This property is only used when provisioning virtual machines for session machine catalogs that use personal virtual disks. | Type: Array of String
HaServers | The list of backup management servers to contact in case the primary address is unavailable. This property only applies to compute resources or type XenServer. | Type: Array of String
Tenant | The tenant to whom this compute resource is allocated. If the compute resource is not allocated, or is allocated for shared use, this property will not be set. | Type: ReferenceModel
DataCenter | The datacenter where this compute resource is located. | Type: ReferenceModel
MaxVirtualMachinesToProvision | The maximum number of virtual machines to provision on this compute resource before considering it "Full". | Type: Number
NumVirtualMachinesProvisioned | The number of virtual machines that have been provisioned so far on this compute resource. | Type: Number
IsEnabled | If true, the compute resource will be used to provision additional virtual machines when necessary, as long as it has not yet reached the MaxVirtualMachinesToProvision limit. If false, the virtual machines currently existing on the compute resource continue to function normally, but no additional virtual machines will be provisioned on the compute resource even if it has not yet reached its provisioning limit. | Type: Boolean
IsVMLimitHitMax | If true, the NumVirtualMachinesProvisioned is equal-to or greater-than MaxVirtualMachinesToProvision. | Type: Boolean
Tags | See Tags and Custom Properties. | Type: Array of String
CustomProperties | See Tags and Custom Properties. | Type: Array of CustomPropertyModel

### Sample

#### application/json

Sample:

    {
      "Href": "[api:ComputeResources(ab32f043-4682-4953-8dea-a0489b839f80)]",
      "Id": "ab32f043-4682-4953-8dea-a0489b839f80",
      "ChangeId": "4",
      "Name": "SCVMM",
      "ShortName": "SCVMM",
      "Description": "My SCVMM cluster",
      "DeleteState": "NotDeleted",
      "ComputeResourceAllocationState": "Allocated",
      "ComputeResourceType": "HyperV",
      "Address": "https://10.1.1.10",
      "UserNameOrApiKey": "DOMAIN\\scvmm",
      "Cluster": {
        "Href": "[api:ComputeResources(ab32f043-4682-4953-8dea-a0489b839f80)/ClusterTree",
        "Name": "ClusterRoot",
        "FullPath": "/ClusterRoot",
        "CanBeProvisioningTarget": true,
        "Children": [
          {
            "Name": "Cluster1",
            "FullPath": "/ClusterRoot/Cluster1",
            "CanBeProvisioningTarget": true
          },
          {
            "Name": "Cluster2",
            "FullPath": "/ClusterRoot/Cluster2",
            "CanBeProvisioningTarget": true
          }
        ]
      },
      "UseLocalStorage": true,
      "PersonalVDiskStorage": [
        "PVD Storage"
      ],
      "Tenant": {
        "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
        "Name": "Tenant 1",
        "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
      },
      "DataCenter": {
        "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
        "Name": "datacenter1",
        "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
      },
      "MaxVirtualMachinesToProvision": 100,
      "NumVirtualMachinesProvisioned": 5,
      "IsEnabled": true,
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ]
    }