HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. azureCloudDeployment

Deploy EdgeConnect appliances in Azure Virtual WAN hub

post
http://127.0.0.1:8080/cloudDeployment/azure-nva/edgeconnects

Initiates deployment of EdgeConnect NVA instances in an Azure Virtual WAN hub. Requires Orchestrator to be registered with the cloud portal. Validates configuration including ASN range (64512-65534, excluding Azure reserved ASNs) and scale unit availability.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false

Flag to trigger deployment. When true, deployment is queued for execution.

Body Params

Azure NVA deployment configuration containing account, region, virtual hub, and appliance settings.

Azure NVA deployment configuration for EdgeConnect appliances in Virtual WAN hub.

string
enum
required

Cloud provider identifier. Must be 'azure_nva' for Azure Virtual WAN NVA deployments.

Allowed:
string
required
length ≤ 20
^[a-zA-Z0-9_-]+$

Unique deployment name. Alphanumeric, dash, and underscore allowed, max 20 characters.

string
required

ID of the configured Azure cloud account in Orchestrator.

string
required

Azure resource group name where the Virtual WAN hub resides.

string
required

Azure region code where the Virtual WAN hub is deployed.

string
required

Full Azure resource ID of the Virtual WAN hub for appliance deployment.

string

Virtual network CIDR assigned to the Virtual WAN hub.

string
required

EdgeConnect software release version to deploy.

integer
required

Azure NVA scale unit determining appliance capacity. Must be a valid scale unit from the portal metadata.

integer
required
64512 to 65534

BGP Autonomous System Number for EdgeConnect. Must be 64512-65534, excluding Azure reserved ASNs (65515, 65517-65520) and ASNs already in use.

string
required

SSH public key for appliance access. Must be a single line without newline characters.

integer

Number of EdgeConnect instances in the deployment.

string

User-defined comment or description for the deployment.

instances
array of objects

List of deployed EdgeConnect instance configurations and network details.

instances
Responses

Updated about 12 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 12 hours ago

Did this page help you?