Help Page Home

# UpdateTenantModel

Updated details for a tenant.

### Properties

Name | Description | Additional information
--- | --- | ---
Name | New name. | 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
StoreFrontIsolationMode | StoreFront isolation mode. Note that changing this property may cause a temporary outage in user connectivity while new StoreFront server groups are allocated and configured for the tenant's users. After the change completes, either redirect the original StoreFront URL to the new StoreFront server group load balancer address, or change the address that users enter into Receiver for accessing their applications. | Type: StoreFrontIsolationMode
LocationUserGroups | Location user groups for the tenant. Any new user groups that were not already specified for the tenant are added. Any user groups that were configured before for the tenant, and are not specified, will be deleted. This will have a cascading delete effect. Use the GET Tenants({id})/LocationUserGroup({lugId})/DeleteCascade API to determine the impact of this change before committing the update. Any user groups that were configured before for the tenant, and are specified in the update, but with a different backup datacenter, may cause a cascading delete effect for delivery groups in the former backup datacenter. Use the GET Tenants({id})/LocationUserGroup({lugId})/DeleteCascade API to determine the impact of this change before committing the update. It is not supported to modify the primary datacenter for any existing location user group configuration in-place. | Type: Array of UpdateLocationUserGroupModel
NetScalerGatewayIsolationMode | NetScaler Gateway isolation mode. Note that changing this property may cause a temporary outage in user connectivity while the tenant's StoreFront site is reconfigured. After the change completes, change the address that users enter into Receiver for accessing their applications from outside of the network. | Type: NetScalerGatewayIsolationMode
TenantDataCenters | Per-datacenter settings for private equipment (such as NetScaler Gateways) allocated to the tenant in each datacenter. | Type: Array of UpdateTenantDataCenterModel
IsAacEnabled | If true, the tenant has the Advanced Access Control feature enabled. Only applies when StoreFrontIsolationMode is not SharedSite, and NetScalerGatewayIsolationMode is Private. | Type: Boolean
AacFarmName | Advanced Access Control farm name used by the tenant. Only applies when StoreFrontIsolationMode is not SharedSite, NetScalerGatewayIsolationMode is Private, and IsAacEnabled is true. | Type: String
UsePrivateNetwork | If true, session machines, delivery controllers, and StoreFront servers allocated exclusively to the tenant must be attached to the tenant's private management network. Note: this setting will not affect any existing allocations, but will affect future allocations for the tenant. Only applies if network isolation is enabled globally. | Type: Boolean
PrivateManagementNetwork | The name of the tenant's private management network. Only applies if network isolation is enabled globally, and UsePrivateNetwork is true. Note: this setting will not affect any existing allocations, but will affect future allocations for the tenant. | Type: String
OtherPrivateDeliveryGroupNetworks | Other networks to attach to all automatically provisioned session machines that are privately allocated to the tenant, when using integrated provisioning. Note: this setting will not affect any existing provisioned machines, but will affect future provisioned machines for the tenant. | Type: Array of String

### Sample

#### application/json

Sample:

    {
      "Name": "tenant 1",
      "Description": "my first tenant",
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ],
      "StoreFrontIsolationMode": "PrivateServerGroup",
      "LocationUserGroups": [
        {
          "UserGroupName": "DOMAIN\\tenant1 datacenter1 users",
          "PrimaryDataCenterId": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
        }
      ],
      "NetScalerGatewayIsolationMode": "Private",
      "TenantDataCenters": [
        {
          "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a",
          "NetScalerGatewayAddress": "https://ag.tenant1.datacenter1.mydomain.com"
        }
      ],
      "IsAacEnabled": true,
      "AacFarmName": "tenant 1",
      "UsePrivateNetwork": true,
      "PrivateManagementNetwork": "tenant 1 network"
    }