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

{
    "name": "string",
    "description": "string",
    "cloudAccountType": "vsphere, aws, azure, nsxt, vmc",
    "privateKeyId": "ACDC55DB4MFH6ADG75KK",
    "privateKey": "gfsScK345sGGaVdds222dasdfDDSSasdfdsa34fS",
    "associatedCloudAccountIds": [
        "42f3e0d199d134755684cd935435a"
    ],
    "associatedMobilityCloudAccountIds": {
        "42f3e0d199d134755684cd935435a": "BIDIRECTIONAL"
    },
    "cloudAccountProperties": {
        "supportPublicImages": "true",
        "acceptSelfSignedCertificate": "true"
    },
    "customProperties": {
        "sampleadapterProjectId": "projectId"
    },
    "regions": [
        {
            "name": "East Asia",
            "externalRegionId": "eastasia"
        }
    ],
    "createDefaultZones": true,
    "tags": [
        {
            "key": "env",
            "value": "dev"
        }
    ],
    "certificateInfo": {
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIDHjCCAoegAwIBAgIBATANBgkqhkiG9w0BAQsFADCBpjEUMBIGA1UEChMLVk13\nYXJlIEluYAAc1pw18GT3iAqQRPx0PrjzJhgjIJMla\n/1Kg4byY4FPSacNiRgY/FG2bPCqZk1yRfzmkFYCW/vU+Dg==\n-----END CERTIFICATE-----\n-"
    }
}

string

name

Required

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

string

privateKeyId

Optional

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

string

privateKey

Optional

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

array of string

associatedCloudAccountIds

Optional

Cloud accounts to associate with this cloud account

object

associatedMobilityCloudAccountIds

Optional

Cloud Account IDs and directionalities create associations to other vSphere cloud accounts that can be used for workload mobility. ID refers to an associated cloud account, and directionality can be unidirectional or bidirectional. Only supported on vSphere cloud accounts.

object

cloudAccountProperties

Required

Cloud Account specific properties supplied in as name value pairs

object

customProperties

Optional

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

array of RegionSpecification

regions

Required

A set of regions to enable provisioning on.Refer to /iaas/api/cloud-accounts/region-enumeration. 'regionInfos' is a required parameter for AWS, AZURE, GCP, VSPHERE, VMC, VCF cloud account types.

boolean

createDefaultZones

Optional

Create default cloud zones for the enabled regions.

array of Tag