HomeGuidesAPI Reference
API Reference

Deploy Azure Internal Load Balancer

Creates and deploys a new Azure Internal Load Balancer (ILB) configuration. Requires Orchestrator to be registered with the portal and a valid Azure account. Deployment can use an existing subnet or create a new one.

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

Azure load balancer deployment configuration

Azure Internal Load Balancer deployment configuration

string
required

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

string
enum
required

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

Allowed:
string
required
length ≤ 20
^[a-zA-Z0-9_-]{1,20}$

Unique deployment name. Alphanumeric, dash (-), and underscore (_) allowed. Maximum 20 characters.

integer

Number of instances associated with this deployment. Typically managed internally.

string

Optional user comment or description for the deployment.

string
required

Azure resource group name where the load balancer will be deployed.

string
required

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

string
required

Azure Virtual Network name where the load balancer will be deployed.

string

Full Azure resource ID of an existing subnet. Required when deploying in an existing subnet. Mutually exclusive with subnetIpMask for new subnet creation.

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

CIDR block for creating a new subnet (e.g., '10.0.1.0/27'). Must be at least /27 or smaller prefix. Required when creating a new subnet. Mutually exclusive with subnetId.

string

Static private IP address for the load balancer frontend. Required when using an existing subnet (subnetId). Must be a valid IP within the subnet range.

integer
required
1 to 65535

TCP port for ILB health probes. Used to check backend health status.

Responses

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