CollectionResultModel<DomainModel>

A collection of items.

Properties

NameDescription Additional information
Href

See Hypermedia.

Type: String

RelatedActions

See Hypermedia.

Type: Array of RelationModel

Count

Number of items in the returned collection. See Object Counts.

Type: Number

TotalMatchingFilter

The total number of items that matched the specified filter. This may be larger than the number of items returned, if the caller specified "take" and/or "skip" parameters. See Object Counts.

Type: Number

Items

The items.

Type: Array of DomainModel

Sample

application/json

Sample:
{
  "Count": 1,
  "TotalMatchingFilter": 1,
  "Items": [
    {
      "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
    }
  ]
}