ARM peer vnet pair

POST

/

v2

/

api

/

arm_peer_vnet_pair

cURL

curl -sk -X POST "https://<controller>/v2/api/arm_peer_vnet_pair" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/arm_peer_vnet_pair"
headers = {"Authorization": "cid <CID>"}

response = requests.post(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://<controller>/v2/api/arm_peer_vnet_pair", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

Body

application/json

acc_account_name

string

required

Account name created from setup_account_profile.

acc_region

string

required

The region of an existing vpc you wish to connect.

acc_vpc_id

string

required

A unique VNet ID.

req_account_name

string

required

Account name created from setup_account_profile.

req_region

string

required

The region of an existing vpc you wish to connect.

req_vpc_id

string

required

A unique VNet ID.

CID

string

The opaque session ID token. Required for 7.2 controllers only.

action

string

The API action to perform. Required for 7.2 controllers only.

allow_forwarded_traffic_1

boolean

Allow forwarded traffic for VNet 1.

allow_forwarded_traffic_2

boolean

Allow forwarded traffic for VNet 2.

allow_gateway_transit_1

boolean

Allow gateway transit for VNet 1.

allow_gateway_transit_2

boolean

Allow gateway transit for VNet 2.

use_remote_gateways_1

boolean

Use remote gateways for VNet 1.

use_remote_gateways_2

boolean

Use remote gateways for VNet 2.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype

string

Error type if the API failed.

reason

string

Failure reason if the API failed.

results

API response data

return

boolean

Whether the API returned successfully

⌘I

cURL

curl -sk -X POST "https://<controller>/v2/api/arm_peer_vnet_pair" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/arm_peer_vnet_pair"
headers = {"Authorization": "cid <CID>"}

response = requests.post(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://<controller>/v2/api/arm_peer_vnet_pair", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}