VirtualMachineListResult

Properties

Required Property Name Type Description
optional _links array of ResourceLink

The server will populate this field when returing the resource. Ignored on PUT and POST.

optional _schema string

Schema for this resource

optional _self SelfResourceLink

Link to this resource

optional cursor string

Opaque cursor to be used for getting next page of records (supplied by current result page)

optional result_count integer

Count of results found (across all pages), set only on first page

optional results array of VirtualMachine

VirtualMachine list results

optional sort_ascending boolean

If true, results are sorted in ascending order

optional sort_by string

Field by which records are sorted

JSON Example

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "cursor": "string",
    "result_count": 0,
    "results": [
        {
            "_last_sync_time": 0,
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "compute_ids": [
                "string"
            ],
            "description": "string",
            "display_name": "string",
            "external_id": "string",
            "guest_info": {
                "computer_name": "string",
                "os_name": "string"
            },
            "host_id": "string",
            "local_id_on_host": "string",
            "power_state": "string",
            "resource_type": "string",
            "source": {
                "is_valid": false,
                "target_display_name": "string",
                "target_id": "string",
                "target_type": "string"
            },
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "type": "string"
        }
    ],
    "sort_ascending": false,
    "sort_by": "string"
}
Feedback

Was this page helpful?