GET DeliveryGroups({id})/Offerings

Get offerings associated with a delivery group. An offering is considered to be associated with a delivery group if the offering IsolationMode is SharedDeliveryGroup, and the delivery group is compatible with the offering. This means that all current and future tenants who subscribe to the offering will have their user sessions hosted on the delivery group.

Note: if all you need are offering references, the GET DeliveryGroups({id})/OfferingReferences API will perform much better.

Request Information

Parameters

NameDescriptionAdditional information
id

ID of the delivery group.

Type:

name

See Filtering, Arranging, and Paging.

Type: String

filterBy

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

  • All: All offerings.
  • NotDeleted: All offerings which are not currently being deleted. (default)
  • NotUsed: All offerings which have no subscriptions.

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)
  • SessionMachineCatalog: Arrange by session machine catalog.

Type: String

skip

See Filtering, Arranging, and Paging.

Type: Number

take

See Filtering, Arranging, and Paging.

Type: Number

Response Information

A list of offerings.

Response type

CollectionResultModel<OfferingModel>

Response body formats

application/json, text/json

Sample:
{
  "Href": "[api:DeliveryGroups(c004375e-a96d-4368-96ba-c80702d7e80f)/Offerings]",
  "Count": 1,
  "TotalMatchingFilter": 1,
  "Items": [
    {
      "Href": "[api:Offerings(2f08f456-7ec8-4edc-866d-25037776ef4f)]",
      "Id": "2f08f456-7ec8-4edc-866d-25037776ef4f",
      "Name": "Application",
      "ShortName": "myapp",
      "ChangeId": "12",
      "DisplayName": "Best App",
      "Comment": "The best app",
      "Description": "My app",
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ],
      "DeleteState": "NotDeleted",
      "IsolationMode": "PrivateDeliveryGroup",
      "Icon": {
        "Href": "[api:Icons(00000000-0000-0000-0000-000000000002)]",
        "RelatedTo": "2f08f456-7ec8-4edc-866d-25037776ef4f",
        "Id": "00000000-0000-0000-0000-000000000002"
      },
      "DeliveryControllerArchitecture": "FMA",
      "SessionMachineCatalog": {
        "Href": "[api:SessionMachineCatalogs(628fa898-0c36-4024-8fe4-d7e9a9bfbcfa)]",
        "Name": "catalog 1",
        "Id": "628fa898-0c36-4024-8fe4-d7e9a9bfbcfa"
      },
      "Arguments": "",
      "ClientFolder": "MyApps",
      "CpuPriorityLevel": "Normal",
      "EnableState": "Enabled",
      "Executable": "C:\\Program Files\\MyApp\\myapp.exe",
      "OfferingType": "ServerInstalled",
      "ShortcutAddedToDesktop": true,
      "ShortcutAddedToStartMenu": true,
      "StartMenuFolder": "Programs/MyApps",
      "WaitForPrinterCreation": false,
      "WorkingDirectory": "C:\\Program Files\\MyApp",
      "HealthSummary": {
        "ActiveCount": 0,
        "ErrorCount": 0,
        "WarningCount": 0,
        "InfoCount": 1,
        "Messages": [
          {
            "Text": "Attempting to reach desired capacity",
            "IsError": false,
            "IsWarning": false,
            "IsInfo": false,
            "IsActive": true,
            "Type": "Allocation"
          }
        ]
      },
      "IsInLatestVersion": true,
      "IsInAllVersions": true,
      "NumSubscriptions": 1
    }
  ]
}