[{"label":"Latest (v1.1)","version":"latest"}]
vmc

Post Compatible Subnets Async

Description

Sets which subnet to use to link accounts and finishes the linking process via a task

Request

Request

URL

URL


post
https://vmc.vmware.com/vmc/api/orgs/{org}/account-link/compatible-subnets-async
Copy

Path Parameters

Path Parameters

string
org Required

Organization identifier


Request Body

Request Body

AwsSubnet of type(s) application/json Required

The subnet chosen by the customer

{
	"availability_zone": "string",
	"connected_account_id": "string",
	"is_compatible": false,
	"name": "string",
	"region_name": "string",
	"subnet_cidr_block": "string",
	"subnet_id": "string",
	"vpc_cidr_block": "string",
	"vpc_id": "string"
}
string
availability_zone Optional

The availability zone this subnet is in, which should be the region name plus one extra letter (ex. us-west-2a).


string
connected_account_id Optional

The connected account ID this subnet is accessible through. This is an internal ID formatted as a UUID specific to Skyscraper.


boolean
is_compatible Optional

Flag indicating whether this subnet is compatible. If true, this is a valid choice for the customer to deploy a SDDC in.


string
name Optional

Optional field (may not be provided by AWS), indicates the found name tag for the subnet.


string
region_name Optional

The region this subnet is in, usually in the form of country code, general location, and a number (ex. us-west-2).


string
subnet_cidr_block Optional

The CIDR block of the subnet, in the form of ‘#.#.#.#/#’.


string
subnet_id Optional

The subnet ID in AWS, provided in the form ‘subnet-######’.


string
vpc_cidr_block Optional

The CIDR block of the VPC, in the form of ‘#.#.#.#/#’.


string
vpc_id Optional

The VPC ID the subnet resides in within AWS. Tends to be ‘vpc-#######’.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns Task of type(s) application/json
This response body class contains all of the following: AbstractEntity, InlineTask1
Errors

Errors

401

Unauthorized


403

Forbidden

Code Samples

Code Samples

PowerCLI Client SDK Example

$AwsSubnet = Initialize-AwsSubnet -ConnectedAccountId "MyConnectedAccountId" -RegionName "MyRegionName" -AvailabilityZone "MyAvailabilityZone" -SubnetId "MySubnetId" -SubnetCidrBlock "MySubnetCidrBlock" -IsCompatible $false -VpcId "MyVpcId" -VpcCidrBlock "MyVpcCidrBlock" -Name "MyName"
Invoke-OrgsOrgAccountLinkCompatibleSubnetsAsyncPost -Org "MyOrg" -AwsSubnet $AwsSubnet

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"availability_zone":"string","connected_account_id":"string","is_compatible":false,"name":"string","region_name":"string","subnet_cidr_block":"string","subnet_id":"string","vpc_cidr_block":"string","vpc_id":"string"}' https://vmc.vmware.com/vmc/api/orgs/{org}/account-link/compatible-subnets-async
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmc-ui-servicename: compatible-subnets-async
x-vmw-vapi-methodname: post


Feedback

Was this page helpful?