GET Offerings({id})/SubscriptionsInSameScope

Get the subscriptions in the same scope as the specified offering. Subscriptions in the same scope share delivery groups.

For 'SharedDeliveryGroup' offerings, a scope is defined as:

  • The same session machine catalog.
  • The same isolation level.

For 'PrivateDeliveryGroup' and 'PrivateDeliverySite' offerings, a scope is defined as:

  • The same session machine catalog.
  • The same isolation level.
  • The same tenant.

Request Information

Parameters

NameDescriptionAdditional information
id

ID of the offering that defines the scope.

Type:

tenantId

ID of the tenant. This must be specified when the scope is defined by an offering with 'PrivateDeliveryGroup' or 'PrivateDeliverySite' isolation mode, and should not be specified when the scope is defined by an offering with 'SharedDeliverySite' isolation mode.

Type: String

name

See Filtering, Arranging, and Paging.

Type: String

filterBy

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

  • All: All subscriptions.
  • NotDeleted: All subscriptions which are not currently being deleted. (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)
  • Tenant: Arrange by tenant.
  • 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 subscriptions.

Response type

CollectionResultModel<SubscriptionModel>

Response body formats

application/json, text/json

Sample:
{
  "Href": "[api:Offerings(2f08f456-7ec8-4edc-866d-25037776ef4f)/SubscriptionsInSameScope]",
  "Count": 1,
  "TotalMatchingFilter": 1,
  "Items": [
    {
      "Href": "[api:Subscriptions(df13665a-533d-451a-a43a-d1faf29af13b)]",
      "Id": "df13665a-533d-451a-a43a-d1faf29af13b",
      "ChangeId": "9",
      "Name": "tenant1 subscription to Application",
      "Description": "my subscription",
      "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"
      },
      "Offering": {
        "Href": "[api:Offerings(2f08f456-7ec8-4edc-866d-25037776ef4f)]",
        "Name": "Application",
        "Id": "2f08f456-7ec8-4edc-866d-25037776ef4f"
      },
      "Tenant": {
        "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
        "Name": "Tenant 1",
        "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
      },
      "Groups": [
        {
          "Name": "DOMAIN\\group",
          "Sid": "S-1-5-21-1180699209-877415012-3182924384-1004",
          "PrimaryDeliveryGroup": {
            "Href": "[api:DeliveryGroups(c004375e-a96d-4368-96ba-c80702d7e80f)]",
            "Name": "dg1",
            "Id": "c004375e-a96d-4368-96ba-c80702d7e80f"
          }
        }
      ],
      "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"
          }
        ]
      }
    }
  ]
}