Help Page Home

# GET SessionMachines({id})/Tenants

Get the list of all tenants whose users may use a session machine. Note: if the session machine is statically allocated to a user, this API may not reflect the actual availability of the machine, as only the original user may access the machine regardless of whether the delivery group is shared or private.

Note: if all you need are tenant references, the GET SessionMachines({id})/TenantReferences API will perform much better.

## Request Information

### Parameters

Name | Description | Additional information
--- | --- | ---
id | ID of the session machine. | Type:
name | See Filtering, Arranging, and Paging. | Type: String
filterBy | See Filtering, Arranging, and Paging. The supported filters are: All: All tenants. NotDeleted: All tenants which are not currently being deleted. (default) NotUsed: All tenants who do not have any subscriptions that are not deleted. | 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

A list of tenants.

### Response type

CollectionResultModel<TenantModel>

### Response body formats

#### application/json, text/json

Sample:

    {
      "Href": "[api:SessionMachines(77b50020-4252-453c-815b-ce9b9412d543)/Tenants]",
      "Count": 1,
      "TotalMatchingFilter": 1,
      "Items": [
        {
          "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
          "Id": "91ade655-feb5-47d3-9585-a5827ad50132",
          "ChangeId": "3",
          "Name": "tenant 1",
          "ShortName": "tenant1",
          "Description": "my first tenant",
          "Tags": [
            "tag"
          ],
          "CustomProperties": [
            {
              "Name": "myProperty",
              "Value": "myValue"
            }
          ],
          "DeleteState": "NotDeleted",
          "StoreFrontIsolationMode": "PrivateServerGroup",
          "ResourceDomain": {
            "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]",
            "Name": "domain1.local",
            "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760"
          },
          "UserDomain": {
            "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]",
            "Name": "domain1.local",
            "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760"
          },
          "LocationUserGroups": [
            {
              "Id": "66382416-9f1c-46dd-b732-e9566f8cd831",
              "UserGroupName": "DOMAIN\\Tenant1Datacenter1Users",
              "PrimaryDataCenter": {
                "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
                "Name": "datacenter1",
                "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
              },
              "DeleteState": "NotDeleted"
            }
          ],
          "TenantDataCenters": [
            {
              "DataCenter": {
                "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
                "Name": "datacenter1",
                "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
              },
              "NetScalerGatewayAddress": "https://ag.tenant1.datacenter1.csp.com"
            }
          ],
          "NetScalerGatewayIsolationMode": "Private",
          "IsAacEnabled": true,
          "AacFarmName": "tenant 1",
          "UsePrivateNetwork": true,
          "PrivateManagementNetwork": "tenant 1 network",
          "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"
              }
            ]
          },
          "InternalStoreFrontSites": [
            "https://sf1.datacenter1.csp.com/StoreFront/tenant1"
          ],
          "ExternalStoreFrontSites": [
            "https://ag.tenant1.datacenter1.csp.com/StoreFront/tenant1"
          ],
          "NumSubscriptions": 12
        }
      ]
    }