Help Page Home

# GET Offerings({id})/DeliveryGroups

Get the delivery groups used by subscriptions to an offering, or which may be used for future subscriptions to the offering.

## Request Information

### Parameters

Name | Description | Additional information
--- | --- | ---
id | ID of the offering. | Type:
tenantId | ID of the tenant. If the offering isolation mode is 'SharedDeliveryGroup', this should not be specified; otherwise it must be specified. | Type: String
name | See Filtering, Arranging, and Paging. | Type: String
filterBy | See Filtering, Arranging, and Paging. The supported filters are: All: All delivery groups. NotDeleted: All delivery groups that are not currently being deleted. (default) NoDeliverySites: Only delivery groups for which there are no available delivery sites in which to place them. NoSessionMachines: Only delivery groups for which there are no session machines allocated. NotUsed: Only delivery groups that are not hosting any subscriptions. UpdatePending: Only delivery groups that contain session machines that are pending a session machine catalog update. Overallocated: Only delivery groups for which there are not enough session machines available to reach the desired capacity. | 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) TotalItems: Arrange by the total number of session machines in the delivery group. SessionMachineCatalog: Arrange by the session machine catalog associated with the delivery group. Tenant: Arrange by the tenant who the delivery group 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 delivery groups.

### Response type

CollectionResultModel<DeliveryGroupModel>

### Response body formats

#### application/json, text/json

Sample:

    {
      "Href": "[api:Offerings(2f08f456-7ec8-4edc-866d-25037776ef4f)/DeliveryGroups]",
      "Count": 1,
      "TotalMatchingFilter": 1,
      "Items": [
        {
          "Href": "[api:DeliveryGroups(c004375e-a96d-4368-96ba-c80702d7e80f)]",
          "Id": "c004375e-a96d-4368-96ba-c80702d7e80f",
          "ChangeId": "4",
          "DeleteState": "NotDeleted",
          "Name": "dg1",
          "IsolationMode": "PrivateDeliveryGroup",
          "Tags": [
            "tag"
          ],
          "CustomProperties": [
            {
              "Name": "myProperty",
              "Value": "myValue"
            }
          ],
          "DeliveryControllerArchitecture": "FMA",
          "SessionMachineCatalog": {
            "Href": "[api:SessionMachines(77b50020-4252-453c-815b-ce9b9412d543)]",
            "Name": "machine1",
            "Id": "77b50020-4252-453c-815b-ce9b9412d543"
          },
          "SessionMachineCatalogVersion": 4,
          "Tenant": {
            "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
            "Name": "Tenant 1",
            "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
          },
          "NumDesiredMachines": 30,
          "NumDrainingMachines": 2,
          "NumMachinesAwaitingUpdate": 5,
          "NumMachinesAllocated": 30,
          "NumAllocatedMachinesPerSessionMachineCatalogVersion": [
            {
              "SessionMachineCatalogVersion": 3,
              "MachineCount": 20
            }
          ],
          "DataCenter": {
            "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
            "Name": "datacenter1",
            "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
          },
          "IsUsedAsPrimary": true,
          "IsUsedAsBackup": true,
          "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"
              }
            ]
          },
          "Domain": {
            "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]",
            "Name": "domain1.local",
            "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760"
          },
          "Network": "Shared Delivery Group Management Network",
          "NeedsDeliverySite": false,
          "EstimatedUsersPerSessionMachine": 250
        }
      ]
    }