Deploy Azure Route Server

post

http://127.0.0.1:8080/cloudDeployment/azure/route-server

Initiates deployment of an Azure Route Server in the specified virtual network. Requires Orchestrator to be registered to the portal. The route server can be deployed in an existing subnet or a new subnet will be created.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

deploy

boolean

Defaults to false

Flag to trigger deployment. When true, initiates the deployment process.

Body Params

Azure Route Server deployment configuration

Configuration for Azure Route Server deployment

accountId

string

required

ID of the configured Azure account in Orchestrator. Must reference an existing Azure cloud account.

name

string

required

length between 1 and 20

^[a-zA-Z0-9_-]+$

Unique deployment name. Must be alphanumeric with dashes/underscores allowed, max 20 characters.

comment

string

User-defined comment or description for the deployment.

resourceGroup

string

required

Azure resource group name where the route server will be deployed. Must exist in the Azure subscription.

region

string

required

Azure region code for deployment location (e.g., eastus, westus2, westeurope).

subnetId

string

Full Azure resource ID of an existing subnet for route server deployment. If provided, subnetIpMask is not required. The subnet must be named 'RouteServerSubnet'.

vnetName

string

required

Azure Virtual Network name where the route server will be deployed.

subnetIpMask

string

^([0-9]{1,3}\.){3}[0-9]{1,3}/([0-9]|[1-2][0-9]|26)$

CIDR block for creating a new 'RouteServerSubnet'. Required if subnetId is not provided. Must be a valid IPv4 CIDR with mask /26 or larger.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Deployment initiated successfully. Returns the deployment ID.

400Bad Request - Invalid configuration or validation failure

500Internal Server Error - Deployment failed