Update Cloud Account Async

Update Cloud Account Async

Update a single CloudAccount

Request
URI
PATCH
https://vra-interop-222-139.lvn.broadcom.net/iaas/api/cloud-accounts/{id}
COPY
Path Parameters
string
id
Required

The ID of the cloudAccount

Query Parameters
string
apiVersion
Required

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


Request Body

Cloud account details to be updated

UpdateCloudAccountSpecification of type(s) application/json
Required

Show optional properties

{
    "name": "string",
    "cloudAccountProperties": {},
    "regions": [
        {
            "name": "East Asia",
            "externalRegionId": "eastasia"
        }
    ]
}
{
    "name": "string",
    "description": "string",
    "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
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 object
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 object
tags
Optional

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

object
certificateInfo
Optional

Specification for certificate for a cloud account.

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns RequestTracker of type(s) application/json
"RequestTracker Object"
integer As int32 As int32
progress
Required

Progress of the request as percentage.

string
message
Optional

Status message of the request.

string
status
Required

Status of the request.

Possible values are : FINISHED, INPROGRESS, FAILED,
array of string
resources
Optional

Collection of resources.

string
name
Optional

Name of the operation.

string
id
Required

ID of this request.

string
selfLink
Required

Self link of this request.

string
deploymentId
Optional

ID of the deployment, this request is connected to.


403

Forbidden

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


404

Not Found

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"cloudAccountProperties:"object","name:"string","regions":["object"]}'
                
Cloud Account Operations
POST
Enumerate Private Images
POST
Run Endpoint Health Check
POST
Enumerate Regions Async
POST
Enumerate Private Images V Sphere
POST
Enumerate V Sphere Regions Async
GET
Get V Sphere Cloud Accounts
POST
Create V Sphere Cloud Account Async
POST
Enumerate Private Images VMC
POST
Enumerate Vmc Regions Async
GET
Get Vmc Cloud Accounts
POST
Create Vmc Cloud Account Async
POST
Enumerate Private Images VCF
POST
Enumerate Vcf Regions Async
GET
Get Vcf Cloud Accounts
POST
Create Vcf Cloud Account Async
GET
Get Nsx T Cloud Accounts
POST
Create Nsx T Cloud Account Async
POST
Enumerate Private Images Gcp
POST
Enumerate Gcp Regions Async
GET
Get Gcp Cloud Accounts
POST
Create Gcp Cloud Account Async
POST
Enumerate Private Images Azure
POST
Enumerate Azure Regions Async
GET
Get Azure Cloud Accounts
POST
Create Azure Cloud Account Async
POST
Enumerate Private Images AWS
POST
Enumerate Aws Regions Async
GET
Get Aws Cloud Accounts
POST
Create Aws Cloud Account Async
GET
Get Cloud Accounts
POST
Create Cloud Account Async
GET
Get Cloud Account
DELETE
Delete Cloud Account
PATCH
Update Cloud Account Async
GET
Get V Sphere Cloud Account
DELETE
Delete V Sphere Cloud Account
PATCH
Update V Sphere Cloud Account Async
GET
Get Vmc Cloud Account
DELETE
Delete Vmc Cloud Account
PATCH
Update VMC Cloud Account Async
GET
Get Vcf Cloud Account
DELETE
Delete Vcf Cloud Account
PATCH
Update Vcf Cloud Account Async
GET
Get Nsx T Cloud Account
DELETE
Delete Cloud Account Nsx T
PATCH
Update Nsx T Cloud Account Async
GET
Get Gcp Cloud Account
DELETE
Delete Gcp Cloud Account
PATCH
Update Gcp Cloud Account Async
GET
Get Azure Cloud Account
DELETE
Delete Azure Cloud Account
PATCH
Update Azure Cloud Account Async
GET
Get Aws Cloud Account
DELETE
Delete Aws Cloud Account
PATCH
Update AWS Cloud Account Async
GET
Get Region Enumeration Result