ImportTenantModel
Details for importing a tenant.
Properties
Name | Description | Additional information |
---|---|---|
Name | Name. Must be unique. Required. |
Type: String |
ShortName | See Short Names. |
Type: String |
Description | Description. |
Type: String |
Tags |
Type: Array of String |
|
CustomProperties |
Type: Array of CustomPropertyModel |
|
ResourceDomainId | ID of the domain for tenant resources. Private session machines, delivery controllers, and StoreFront servers allocated to the tenant will belong to this domain. If not specified, defaults to the global SharedResourceDomain. |
Type: String |
UserDomainId | ID of the domain for tenant users. The location user groups and subscription user groups for the tenant must belong to this domain. If not specified, defaults to the global DefaultUserDomain. |
Type: String |
ResourceDomainPasswordBase64 | The password required to use the resource domain. Ignored if not required by the domain definition. Must be Base64 encoded. |
Type: String |
UserDomainPasswordBase64 | The password required to use the user domain. Ignored if not required by the domain definition. Must be Base64 encoded. |
Type: String |
LocationUserGroups | Location user groups for the tenant. All of the tenant's subscribed user groups must be a member of exactly one location user group. At least one location user group is required. |
Type: Array of ImportLocationUserGroupModel |
TenantDataCenters | Per-datacenter settings for private equipment (such as NetScaler Gateways) allocated to the tenant in each datacenter. |
Type: Array of ImportTenantDataCenterModel |
StoreFrontIsolationMode | StoreFront isolation mode used by the tenant. If not specified, defaults to PrivateSite. |
Type: StoreFrontIsolationMode |
NetScalerGatewayIsolationMode | NetScaler Gateway isolation mode used by the tenant. Only used if the StoreFrontIsolationMode is not SharedSite. If not specified, defaults to Shared if NetScaler Gateway is enabled globally, or None otherwise. |
|
IsAacEnabled | If true, the tenant has the Advanced Access Control feature enabled. Only applies when StoreFrontIsolationMode is not SharedSite, and NetScalerGatewayIsolationMode is Private. If not specified, defaults to true. |
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. If not specified, defaults to the tenant's ShortName. |
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. If not specified, defaults to true. 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. If not specified, default to the tenant's Name. |
Type: String |
OtherPrivateDeliveryGroupNetworks | Other networks to attach to all automatically provisioned session machines that are privately allocated to the tenant, when using integrated provisioning. |
Type: Array of String |
Sample
application/json
{ "Name": "tenant 1", "ShortName": "tenant1", "Description": "my first tenant", "Tags": [ "tag" ], "CustomProperties": [ { "Name": "myProperty", "Value": "myValue" } ], "ResourceDomainId": "241b45cc-261d-47d0-81d7-a0a41c54c760", "UserDomainId": "241b45cc-261d-47d0-81d7-a0a41c54c760", "ResourceDomainPasswordBase64": "cGFzc3dvcmQ=", "UserDomainPasswordBase64": "cGFzc3dvcmQ=", "LocationUserGroups": [ { "UserGroupName": "DOMAIN\\tenant1 datacenter1 users", "PrimaryDataCenterId": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a" } ], "TenantDataCenters": [ { "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a", "NetScalerGatewayAddress": "https://ag.tenant1.datacenter1.mydomain.com" } ], "StoreFrontIsolationMode": "PrivateServerGroup", "NetScalerGatewayIsolationMode": "Private", "IsAacEnabled": true, "AacFarmName": "tenant 1", "PrivateManagementNetwork": "tenant 1 network" }