DomainModel
Details about a domain.
Properties
Name | Description | Additional information |
---|---|---|
Href | See Hypermedia. |
Type: String |
RelatedActions | See Hypermedia. |
Type: Array of RelationModel |
Id | ID of the domain. |
Type: String |
ChangeId |
Type: String |
|
DeleteState | See Deleting Objects. |
Type: ObjectDeleteState |
Name | Name. |
Type: String |
Type | Type of domain. |
Type: DomainType |
IsPasswordProtected | If true, a password must be provided in order for a tenant to be associated with this domain. |
Type: Boolean |
OrchestrationServiceUserName | A user account name with permission to read and modify items in the domain, under the App Orchestration Organizational Unit. |
Type: String |
IsInUse | True if any tenants are using the domain. |
Type: Boolean |
ProductInstallUserName | A user account name with permission to install software on machines in the domain. |
Type: String |
HealthSummary | Summary of health notifications associated with the domain |
Type: HealthSummaryModel |
Tags |
Type: Array of String |
|
CustomProperties |
Type: Array of CustomPropertyModel |
|
NumTenants | Number of tenants using the domain. |
Type: Number |
Sample
application/json
{ "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]", "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760", "ChangeId": "7", "DeleteState": "NotDeleted", "Name": "domain1.local", "Type": "Both", "IsPasswordProtected": true, "OrchestrationServiceUserName": "DOMAIN\\orch", "IsInUse": true, "ProductInstallUserName": "DOMAIN\\install", "HealthSummary": { "InfoCount": 1, "Messages": [ { "Text": "Attempting to reach desired capacity", "IsActive": true, "Type": "Allocation" } ] }, "Tags": [ "tag" ], "CustomProperties": [ { "Name": "myProperty", "Value": "myValue" } ], "NumTenants": 1 }