Update V Sphere Cloud Account

Update V Sphere Cloud Account

Update vSphere cloud account

Request
URI
PATCH
https://api.mgmt.cloud.vmware.com//iaas/api/cloud-accounts-vsphere/{id}
COPY
Path Parameters
string
id
Required

Cloud account id

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about


Request Body

VSphere cloud account details to be updated

UpdateCloudAccountVsphereSpecification of type(s) application/json
Required
{
    "createDefaultZones": true,
    "name": "string",
    "description": "string",
    "regionIds": [
        "string"
    ],
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ]
}
boolean
createDefaultZones
Optional

Create default cloud zones for the enabled regions.

string
name
Optional

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
Optional

A set of Region names to enable provisioning on.

array of Tag
tags
Optional

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

Responses
200

successful operation

Returns CloudAccountVsphere of type(s) application/json
{
    "owner": "[email protected]",
    "hostName": "vc1.vmware.com",
    "enabledRegionIds": [
        "string"
    ],
    "description": "my-description",
    "orgId": "9e49",
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "organizationId": "deprecated",
    "createdAt": "2012-09-27",
    "dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
    "name": "my-name",
    "id": "9e49",
    "updatedAt": "2012-09-27",
    "username": "[email protected]"
}
string
owner
Optional

Email of the user that owns the entity.

string
hostName
Required

Host name for the vSphere cloud account

array of string
enabledRegionIds
Optional

A set of region names that are enabled for this cloud account.

object
_links
Required

HATEOAS of the entity

string
description
Optional

A human-friendly description.

string
orgId
Optional

The id of the organization this entity belongs to.

array of Tag
tags
Optional

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

string
organizationId
Optional

This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.

string
createdAt
Optional

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

object
customProperties
Optional

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

string
dcid
Optional

Identifier of a data collector vm deployed in the on premise infrastructure.

string
name
Optional

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

string
id
Required

The id of this resource instance

string
updatedAt
Optional

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

string
username
Required

Username to authenticate with the cloud account


403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

Cloud Account Operations
POST
Create Aws Cloud Account
POST
Create Azure Cloud Account
POST
Create Cloud Account
POST
Create Gcp Cloud Account
POST
Create Nsx T Cloud Account
POST
Create Nsx V Cloud Account
POST
Create Vmc Cloud Account
POST
Create V Sphere Cloud Account
DELETE
Delete Aws Cloud Account
DELETE
Delete Azure Cloud Account
DELETE
Delete Cloud Account
DELETE
Delete Cloud Account Nsx T
DELETE
Delete Cloud Account Nsx V
DELETE
Delete Gcp Cloud Account
DELETE
Delete Vmc Cloud Account
DELETE
Delete V Sphere Cloud Account
POST
Enumerate Aws Regions
POST
Enumerate Azure Regions
POST
Enumerate Gcp Regions
POST
Enumerate Private Images
POST
Enumerate Private Images AWS
POST
Enumerate Private Images Azure
POST
Enumerate Private Images Gcp
POST
Enumerate Private Images VMC
POST
Enumerate Private Images V Sphere
POST
Enumerate Regions
POST
Enumerate Vmc Regions
POST
Enumerate V Sphere Regions
GET
Get Aws Cloud Account
GET
Get Aws Cloud Accounts
GET
Get Azure Cloud Account
GET
Get Azure Cloud Accounts
GET
Get Cloud Account
GET
Get Cloud Accounts
GET
Get Gcp Cloud Account
GET
Get Gcp Cloud Accounts
GET
Get Nsx T Cloud Account
GET
Get Nsx T Cloud Accounts
GET
Get Nsx V Cloud Account
GET
Get Nsx V Cloud Accounts
GET
Get Vmc Cloud Account
GET
Get Vmc Cloud Accounts
GET
Get V Sphere Cloud Account
GET
Get V Sphere Cloud Accounts
PATCH
Update Aws Cloud Account
PATCH
Update Azure Cloud Account
PATCH
Update Cloud Account
PATCH
Update Gcp Cloud Account
PATCH
Update Nsx T Cloud Account
PATCH
Update Nsx V Cloud Account
PATCH
Update Vmc Cloud Account
PATCH
Update V Sphere Cloud Account