GET ComputeResources({id})/SessionMachineCatalogCompatibility

Get the list of session machine catalogs using auto-provisioning, along with information about whether the template and service offering configured for each catalog exists on the compute resource.

Request Information

Parameters

NameDescriptionAdditional information
id

ID of the compute resource.

Type:

name

See Filtering, Arranging, and Paging.

Type: String

filterBy

See Filtering, Arranging, and Paging. The supported filters are:

  • All: All session machine catalogs. (default)

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)

Type: String

skip

See Filtering, Arranging, and Paging.

Type: Number

take

See Filtering, Arranging, and Paging.

Type: Number

Response Information

The session machine catalogs, and their compatibility with the compute resource.

Response type

CollectionResultModel<SessionMachineCatalogComputeResourceCompatibilityModel>

Response body formats

application/json, text/json

Sample:
{
  "Href": "[api:ComputeResources(ab32f043-4682-4953-8dea-a0489b839f80)/SessionMachineCatalogCompatibility]",
  "Count": 1,
  "TotalMatchingFilter": 1,
  "Items": [
    {
      "SessionMachineCatalog": {
        "Href": "[api:SessionMachineCatalogs(628fa898-0c36-4024-8fe4-d7e9a9bfbcfa)]",
        "Name": "catalog 1",
        "Id": "628fa898-0c36-4024-8fe4-d7e9a9bfbcfa"
      },
      "BaseVMName": "vm1",
      "BaseVMExistsOnComputeResource": true,
      "VmSpecExistsOnComputeResource": false
    }
  ]
}