ARM Spoke Attachment

POST

api

attach_arm_native_spoke_to_transit

cURL

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

import requests

url = "https://<controller>/v2/api/attach_arm_native_spoke_to_transit"
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/attach_arm_native_spoke_to_transit", 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

account_name

string

required

Account name created from setup_account_profile.

region

string

required

VNet region.

transit_gateway_name

string

required

Transit gateway name.

vpc_id

string

required

VNet name (+ resource group).

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.

details

boolean

Set flag to return native spoke with region detail.

spoke_name

string

Spoke Name.

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/attach_arm_native_spoke_to_transit" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/attach_arm_native_spoke_to_transit"
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/attach_arm_native_spoke_to_transit", 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
}

Concepts & Architecture

Guides

Reference

Attach ARM Native Spoke to Transit

Body

Response