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

Deploy Cloud Hub(s) in Azure

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

Initiates deployment of one or more EdgeConnect Cloud Hub appliances in Microsoft Azure. Requires Orchestrator to be registered with Cloud Portal. Validates deployment configuration and queues the deployment task.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Azure deployment configuration containing subscription details, network settings, and instance specifications

Configuration object for Azure Cloud Hub deployment. Contains Azure subscription details, network configuration, and instance specifications.

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

Unique deployment name. Only alphanumeric characters and hyphens allowed, max 20 characters.

string
required

ID of registered Azure subscription in Orchestrator. Must be pre-configured via Azure accounts management.

string
enum

Cloud provider identifier. Must be 'azure' for this endpoint.

Allowed:
string
required

Expected WAN bandwidth in Mbps or 'Unlimited'. Determines appliance sizing and licensing.

boolean
Defaults to false

Enable WAN Optimization (Boost) capability on deployed appliances.

integer
required
≥ 1

Number of appliances to deploy. Must match the length of the instances array.

string
required

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

string
required

Azure VM size for the appliance (e.g., 'Standard_D4s_v3', 'Standard_D8s_v3').

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

CIDR block for Azure Virtual Network. Must be a valid IPv4 or IPv6 CIDR notation.

boolean
Defaults to false

When true, deploys into an existing VNet instead of creating new. Requires existingVirtualNetworkName and existingSubnets.

string

Name of existing Azure VNet. Required when useExistingVirtualNetworkCidr is true.

existingSubnets
object

Existing subnet names for network interfaces. Required when useExistingVirtualNetworkCidr is true.

string
required

SSH public key in OpenSSH format for appliance access. Must be single-line without line breaks.

string

Azure resource group name for deploying all resources. Created if it does not exist.

instances
array of objects
required
length ≥ 1

Array of per-appliance configurations. Array length must equal numInstances.

instances*

Per-appliance configuration including availability zone and network interface details.

string

Azure availability zone for appliance placement (e.g., '1', '2', '3'). Required when availabilityOption is 'availability zone'.

string
length ≤ 25
^[a-zA-Z0-9-]+$

Unique appliance identifier tag. Only alphanumeric characters and hyphens allowed, max 25 characters.

int64

Instance-specific bandwidth in Kbps. Used for appliance sizing.

string
^([^=,]+=[^=,]+)(,[^=,]+=[^=,]+)*$

Azure resource tags as comma-separated key=value pairs. Optional for resource organization.

string

Availability configuration type. Use 'availability zone' for zone-based deployment.

string

Optional deployment description or notes.

uri

Private Azure VHD blob URL for custom appliance image. Optional, uses default image if not specified.

string
length between 3 and 24
^[a-z0-9]+$

Azure storage account name. Must be globally unique, 3-24 lowercase alphanumeric characters only.

imageInfo
object

Azure Marketplace image information for deployment.

Responses

Updated about 14 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 14 hours ago

Did this page help you?