CloudAccountSpecification

Specification for a generic 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.

JSON Example

{
    "privateKey": "gfsScK345sGGaVdds222dasdfDDSSasdfdsa34fS",
    "associatedCloudAccountIds": [
        "string"
    ],
    "createDefaultZones": true,
    "cloudAccountType": "vsphere, aws, azure, nsxv, nsxt",
    "name": "string",
    "description": "string",
    "regionIds": [
        "string"
    ],
    "privateKeyId": "ACDC55DB4MFH6ADG75KK",
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ]
}

object

cloudAccountProperties

Required

Cloud Account specific properties supplied in as name value pairs

string

privateKey

Required

Secret access key or password to be used to authenticate with the cloud account

array of string

associatedCloudAccountIds

Optional

Cloud account to link with this cloud account

boolean

createDefaultZones

Optional

Create default cloud zones for the enabled regions.

object

customProperties

Optional

Additional custom properties that may be used to extend the Cloud Account.

string

cloudAccountType

Required

Cloud account type

string

name

Required

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

string

description

Optional

A human-friendly description.

array of string

regionIds

Required

A set of Region names to enable provisioning on.Refer to /iaas/cloud-accounts/region-enumeration.

string

privateKeyId

Required

Access key id or username to be used to authenticate with the cloud account

array of Tag