Skip to content
API Enriched

Configure Azure VNet Site Information.

POST
/api/config/namespaces/{namespace}/azure_vnet_site/{name}/set_cloud_site_info
curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/azure_vnet_site/example/set_cloud_site_info \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "azure_vnet_info": { "express_route_info": { "route_server_asn": 1, "route_server_ips": [ "example" ] }, "node_info": [ { "node_id": "example", "node_instance_name": "example" } ], "private_ips": [ "example" ], "public_ips": [ "example" ], "spoke_vnet_prefix_info": [ { "prefixes": [ "example" ], "vnet": { "f5_orchestrated_routing": {}, "manual_routing": {}, "resource_group": "example", "vnet_name": "example" } } ], "vnet": { "resource_id": "example", "vnet_name": "example" } }, "name": "example", "namespace": "example" }'

Configure Azure VNet Site Information like public, private ips, subnet IDs and others.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace Namespace for the object to be configured.

name
required
string

Name Name of the object to be configured.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
Request to configure Cloud Site Information

Request to configure Cloud Site Information.

object
azure_vnet_info
object
express_route_info
object
route_server_asn
Route Server ASN

Route Server ASN.

integer format: int64
route_server_ips
Route Server IPs

Route Server IPs.

Array<string>
node_info
Azure Node Name

Azure Node Name.

Array<object>
Node Instance Name

Node Instance Name.

object
node_id
Node ID

Node ID Information Required: YES.

string
>= 1 characters <= 64 characters
node_instance_name
Node Instance Name

Node Instance Name used by dataplane.

string
>= 1 characters <= 64 characters
private_ips
Azure VM Private IPs

Azure VM Private IPs used by the nodes Required: YES.

Array<string>
public_ips
Azure VM Public IPs

Azure VM Public IPs used by the nodes Required: YES.

Array<string>
spoke_vnet_prefix_info
Azure Spoke VNet Prefix Information

Azure Spoke VNet Prefix Information.

Array<object>
<= 500 items
Azure VNet IP prefixes Info

Azure VNet IP prefixes Info.

object
prefixes
VNet prefixes

An unordered list of IP prefixes. Required: YES.

Array<string>
>= 1 items <= 1024 items
vnet
object
f5_orchestrated_routing
object
manual_routing
object
resource_group
Existing Vnet Resource Group

Resource group of existing VNet Required: YES.

string
>= 1 characters <= 64 characters
vnet_name
Existing Vnet Name

Name of existing VNet Required: YES.

string
>= 1 characters <= 64 characters
vnet
object
resource_id
VNET Resource ID

VNet Resource ID.

string
<= 1024 characters
vnet_name
VNET Name

VNet Name

string
<= 1024 characters
name
Name

Name of the object to be configured.

string
>= 6 characters <= 1024 characters
namespace
Namespace

Namespace for the object to be configured.

string
>= 6 characters <= 1024 characters
Examplegenerated
{
  "azure_vnet_info": {
    "express_route_info": {
      "route_server_asn": 1,
      "route_server_ips": [
        "example"
      ]
    },
    "node_info": [
      {
        "node_id": "example",
        "node_instance_name": "example"
      }
    ],
    "private_ips": [
      "example"
    ],
    "public_ips": [
      "example"
    ],
    "spoke_vnet_prefix_info": [
      {
        "prefixes": [
          "example"
        ],
        "vnet": {
          "f5_orchestrated_routing": {},
          "manual_routing": {},
          "resource_group": "example",
          "vnet_name": "example"
        }
      }
    ],
    "vnet": {
      "resource_id": "example",
      "vnet_name": "example"
    }
  },
  "name": "example",
  "namespace": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
Response to configure Cloud Site Information

Response to configure configure Cloud Site Information.

object
Examplegenerated
{}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example