Cloud.LoadBalancer

Cloud.LoadBalancer

Request schema for provisioning Compute Load Balancer

JSON Example

{
    "address": "string",
    "constraints": [
        {
            "tag": "string"
        }
    ],
    "instances": [
        "string"
    ],
    "internetFacing": false,
    "name": "string",
    "network": "string",
    "resourceGroupName": "string",
    "routes": [
        {
            "healthCheckConfiguration": {
                "healthyThreshold": 0,
                "intervalSeconds": 0,
                "port": "string",
                "protocol": "string",
                "timeoutSeconds": 0,
                "unhealthyThreshold": 0,
                "urlPath": "string"
            },
            "instancePort": "string",
            "instanceProtocol": "string",
            "port": "string",
            "protocol": "string"
        }
    ],
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}

string

address

Optional

The DNS address of the load balancer.

array of object

constraints

Optional

Load balancer constraints

array of string

instances

Required

A list of machines, by ID, to add to the load balancer pool.

boolean

internetFacing

Required

Whether or not the load balancer faces the public Internet.

string

name

Optional

Load balancer machine name.

string

network

Required

The network to attach to the load balancer. The network subnet/security group information determines whether or not the load balancer will be created in a VPC.

string

resourceGroupName

Optional

Name of the existing Azure resource group into which the load balancer will be provisioned.

array of object

routes

Required

Settings for incoming requests to reach the load balancer, for requests to be routed to machines in the pool, and for checking the health of machines in the pool.

array of object

tags

Optional

Resource categorization, in case-sensitive key names, or in key-value pairs.