Help Page Home

# GET ComputeResources

Get all compute resources.

## Request Information

### Parameters

Name | Description | Additional information
--- | --- | ---
name | See Filtering, Arranging, and Paging. | Type: String
filterBy | See Filtering, Arranging, and Paging. The supported filters are: All: All compute resources. NotDeleted: All compute resources that are not currently being deleted. (default) Allocated: Only compute resources that are allocated either for shared use, or to a single tenant. Empty: Only compute resources that have not provisioned any machines. NotUsed: Only compute resources that have not been allocated. Note that a compute resource may be allocated yet have no provisioned machines, and will not be returned by this filter. | Type: Filter
filterProp | See Filtering, Arranging, and Paging. | Type: String
arrangeBy | See Filtering, Arranging, and Paging. The supported arrangers are: Name: Arrange by name. (default) FreeItems: Arrange by the number of machines which can still be provisioned on the compute resource, according to its limits. TotalItems: Arrange by the number of machines which have been provisioned on the compute resource. Tenant: Arrange by tenant who the compute resource is allocated to. | Type: String
skip | See Filtering, Arranging, and Paging. | Type: Number
take | See Filtering, Arranging, and Paging. | Type: Number

## Response Information

A list of compute resources.

### Response type

CollectionResultModel<ComputeResourceModel>

### Response body formats

#### application/json, text/json

Sample:

    {
      "Href": "[api:ComputeResources]",
      "Count": 1,
      "TotalMatchingFilter": 1,
      "Items": [
        {
          "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,
          "IsVMLimitHitMax": false,
          "Tags": [
            "tag"
          ],
          "CustomProperties": [
            {
              "Name": "myProperty",
              "Value": "myValue"
            }
          ]
        }
      ]
    }