Help Page Home

# TenantModel

Details of a tenant in App Orchestration.

### Properties

Name | Description | Additional information
--- | --- | ---
Href | See Hypermedia. | Type: String
RelatedActions | See Hypermedia. | Type: Array of RelationModel
Id | ID of the tenant. | Type: String
ChangeId | See Optimistic Concurrency. | Type: String
Name | Name. | Type: String
ShortName | See Short Names. | Type: String
Description | Description. | Type: String
Tags | See Tags and Custom Properties. | Type: Array of String
CustomProperties | See Tags and Custom Properties. | Type: Array of CustomPropertyModel
DeleteState | See Deleting Objects. | Type: ObjectDeleteState
StoreFrontIsolationMode | StoreFront isolation mode used by the tenant. | Type: StoreFrontIsolationMode
ResourceDomain | Resource domain used by the tenant. | Type: ReferenceModel
UserDomain | User domain used by the tenant. | Type: ReferenceModel
LocationUserGroups | List of location user groups containing the tenant's users. | Type: Array of LocationUserGroupModel
TenantDataCenters | List of datacenters used by the tenant. | Type: Array of TenantDataCenterModel
NetScalerGatewayIsolationMode | NetScaler Gateway isolation mode. Only used if the StoreFrontIsolationMode is not SharedSite. | Type: NetScalerGatewayIsolationMode
IsAacEnabled | True if the tenant uses Advanced Access Control on a private NetScaler Gateway. Only used if the StoreFrontIsolationMode is not SharedSite and NetScalerGatewayIsolationMode is Private. | Type: Boolean
AacFarmName | Tenant's Advanced Access Control farm name. Only used if IsAacEnabled is true. | Type: String
UsePrivateNetwork | True if the tenant uses a private management network for all privately-allocated machines (session machines, delivery controllers, and StoreFront servers). | Type: Boolean
PrivateManagementNetwork | The private management network used for the tenant's privately-allocated machines. Only used if UsePrivateNetwork is true. | Type: String
OtherPrivateDeliveryGroupNetworks | Additional networks that should be attached to all privately-allocated machines that are provisioned using integrated provisioning, for this tenant. | Type: Array of String
HealthSummary | Summary of health notifications associated with this tenant. | Type: HealthSummaryModel
InternalStoreFrontSites | List of internal StoreFront sites available for the tenant's users. | Type: Array of String
ExternalStoreFrontSites | List of external StoreFront sites available for the tenant's users. | Type: Array of String
NumSubscriptions | Number of subscriptions that exist for the tenant's users. Note that each offering used by the tenant's users counts as one subscription, regardless of how many of the tenant's users have access to it. | Type: Number

### Sample

#### application/json

Sample:

    {
      "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": {
        "InfoCount": 1,
        "Messages": [
          {
            "Text": "Attempting to reach desired capacity",
            "IsActive": true,
            "Type": "Allocation"
          }
        ]
      },
      "InternalStoreFrontSites": [
        "https://sf1.datacenter1.csp.com/StoreFront/tenant1"
      ],
      "ExternalStoreFrontSites": [
        "https://ag.tenant1.datacenter1.csp.com/StoreFront/tenant1"
      ],
      "NumSubscriptions": 12
    }