CloudAccount

CloudAccount
CloudAccount

State object representing a cloud account.

A cloud account identifies a cloud account type and an account-specific deployment region or data center where the associated cloud account resources are hosted.
HATEOAS links:
associated-cloud-accounts - array[CloudAccount] - Cloud accounts associated to this cloud account. For example an NSX endpoint linked to a vSphere cloud account.
regions - array[Region] - List of regions that are enabled for this cloud account.
self - CloudAccount - Self link to this cloud account

JSON Example
{
    "id": "9.0E49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "ownerType": "ad_group",
    "orgId": "42413b31-1716-477e-9a88-9dc1c3cb1cdf",
    "_links": {
        "empty": false
    },
    "name": "my-name",
    "description": "my-description",
    "cloudAccountType": "vsphere, aws, azure, nsxv, nsxt",
    "cloudAccountProperties": {
        "hostName": "vcenter.mycompany.com"
    },
    "enabledRegions": [
        {
            "id": "9.0E49",
            "createdAt": "2012-09-27",
            "updatedAt": "2012-09-27",
            "owner": "[email protected]",
            "ownerType": "ad_group",
            "orgId": "42413b31-1716-477e-9a88-9dc1c3cb1cdf",
            "_links": {
                "empty": false
            },
            "externalRegionId": "us-west",
            "name": "us-west",
            "cloudAccountId": "9.0E49"
        }
    ],
    "customProperties": {
        "isExternal": "false"
    },
    "associatedMobilityCloudAccountIds": {
        "42f3e0d199d134755684cd935435a": "BIDIRECTIONAL"
    },
    "tags": [
        {
            "key": "env",
            "value": "dev"
        }
    ],
    "healthy": false,
    "inMaintenanceMode": false
}
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user or display name of the group that owns the entity.

string
ownerType
Optional

Type of a owner(user/ad_group) that owns the entity.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Required

HATEOAS of the entity

string
name
Optional

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

string
cloudAccountType
Required

Cloud account type

object
cloudAccountProperties
Required

Cloud account specific properties

array of Region
enabledRegions
Optional

A list of regions that are enabled for provisioning on this cloud account

object
customProperties
Optional

Additional properties that may be used to extend the base type.

object
associatedMobilityCloudAccountIds
Optional

Workload mobility associations to other vSphere cloud accounts. ID refers to an associated cloud account, and directionality can be unidirectional or bidirectional. Only supported on vSphere Cloud Accounts.

array of Tag
tags
Optional

A set of tag keys and optional values that were set on the Cloud Account

boolean
healthy
Optional

Indicates the health of the cloud account. If false, this means there is no connectivity to the cloud provider or the credentials are invalid.

boolean
inMaintenanceMode
Optional

Indicates if the cloud account is undergoing maintenance. If true, it can't be used for provisioning and scheduled enumeration is not triggered.

Property Of
Returned By