BackendAddressPool

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-load-balancer/json-schema/microsoft-azure-load-balancer-backend-address-pool-schema.json",
  "title": "BackendAddressPool",
  "description": "Pool of backend IP addresses.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-load-balancer-load-balancers-api-openapi.yml#/components/schemas/BackendAddressPool",
  "type": "object",
  "properties": {
    "properties": {
      "$ref": "#/$defs/BackendAddressPoolPropertiesFormat",
      "description": "Properties of load balancer backend address pool.",
      "x-ms-client-flatten": true
    },
    "etag": {
      "type": "string",
      "description": "A unique read-only string that changes whenever the resource is updated.",
      "readOnly": true
    }
  },
  "allOf": [
    {
      "$ref": "#/$defs/SubResourceModel"
    }
  ],
  "$defs": {
    "BackendAddressPoolPropertiesFormat": {
      "type": "object",
      "description": "Properties of the backend address pool.",
      "properties": {
        "location": {
          "type": "string",
          "description": "The location of the backend address pool."
        },
        "tunnelInterfaces": {
          "type": "array",
          "description": "An array of gateway load balancer tunnel interfaces.",
          "items": {
            "$ref": "#/$defs/GatewayLoadBalancerTunnelInterface"
          }
        },
        "loadBalancerBackendAddresses": {
          "type": "array",
          "description": "An array of backend addresses.",
          "items": {
            "$ref": "#/$defs/LoadBalancerBackendAddress"
          }
        },
        "backendIPConfigurations": {
          "type": "array",
          "description": "An array of references to IP addresses defined in network interfaces.",
          "items": {
            "$ref": "#/$defs/NetworkInterfaceIPConfiguration"
          },
          "readOnly": true
        },
        "loadBalancingRules": {
          "type": "array",
          "description": "An array of references to load balancing rules that use this backend address pool.",
          "items": {
            "$ref": "#/$defs/SubResource"
          },
          "readOnly": true
        },
        "outboundRule": {
          "$ref": "#/$defs/SubResource",
          "description": "A reference to an outbound rule that uses this backend address pool.",
          "readOnly": true
        },
        "outboundRules": {
          "type": "array",
          "description": "An array of references to outbound rules that use this backend address pool.",
          "items": {
            "$ref": "#/$defs/SubResource"
          },
          "readOnly": true
        },
        "inboundNatRules": {
          "type": "array",
          "description": "An array of references to inbound NAT rules that use this backend address pool.",
          "items": {
            "$ref": "#/$defs/SubResource"
          },
          "readOnly": true
        },
        "provisioningState": {
          "$ref": "#/$defs/ProvisioningState",
          "description": "The provisioning state of the backend address pool resource.",
          "readOnly": true
        },
        "drainPeriodInSeconds": {
          "type": "integer",
          "format": "int32",
          "description": "Amount of seconds Load Balancer waits for before sending RESET to client and backend address."
        },
        "virtualNetwork": {
          "$ref": "#/$defs/SubResource",
          "description": "A reference to a virtual network."
        },
        "syncMode": {
          "$ref": "#/$defs/SyncMode",
          "description": "Backend address synchronous mode for the backend pool"
        }
      }
    },
    "GatewayLoadBalancerTunnelInterface": {
      "type": "object",
      "description": "Gateway load balancer tunnel interface of a load balancer backend address pool.",
      "properties": {
        "port": {
          "type": "integer",
          "format": "int32",
          "description": "Port of gateway load balancer tunnel interface."
        },
        "identifier": {
          "type": "integer",
          "format": "int32",
          "description": "Identifier of gateway load balancer tunnel interface."
        },
        "protocol": {
          "$ref": "#/$defs/GatewayLoadBalancerTunnelProtocol",
          "description": "Protocol of gateway load balancer tunnel interface."
        },
        "type": {
          "$ref": "#/$defs/GatewayLoadBalancerTunnelInterfaceType",
          "description": "Traffic type of gateway load balancer tunnel interface."
        }
      }
    },
    "GatewayLoadBalancerTunnelInterfaceType": {
      "type": "string",
      "description": "Traffic type of gateway load balancer tunnel interface.",
      "enum": [
        "None",
        "Internal",
        "External"
      ],
      "x-ms-enum": {
        "name": "GatewayLoadBalancerTunnelInterfaceType",
        "modelAsString": true,
        "values": [
          {
            "name": "None",
            "value": "None",
            "description": "None"
          },
          {
            "name": "Internal",
            "value": "Internal",
            "description": "Internal"
          },
          {
            "name": "External",
            "value": "External",
            "description": "External"
          }
        ]
      }
    },
    "GatewayLoadBalancerTunnelProtocol": {
      "type": "string",
      "description": "Protocol of gateway load balancer tunnel interface.",
      "enum": [
        "None",
        "Native",
        "VXLAN"
      ],
      "x-ms-enum": {
        "name": "GatewayLoadBalancerTunnelProtocol",
        "modelAsString": true,
        "values": [
          {
            "name": "None",
            "value": "None",
            "description": "None"
          },
          {
            "name": "Native",
            "value": "Native",
            "description": "Native"
          },
          {
            "name": "VXLAN",
            "value": "VXLAN",
            "description": "VXLAN"
          }
        ]
      }
    },
    "LoadBalancerBackendAddress": {
      "type": "object",
      "description": "Load balancer backend addresses.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/LoadBalancerBackendAddressPropertiesFormat",
          "description": "Properties of load balancer backend address pool.",
          "x-ms-client-flatten": true
        },
        "name": {
          "type": "string",
          "description": "Name of the backend address."
        }
      }
    },
    "LoadBalancerBackendAddressAdminState": {
      "type": "string",
      "description": "A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections.",
      "enum": [
        "None",
        "Up",
        "Down"
      ],
      "x-ms-enum": {
        "name": "LoadBalancerBackendAddressAdminState",
        "modelAsString": true,
        "values": [
          {
            "name": "None",
            "value": "None",
            "description": "None"
          },
          {
            "name": "Up",
            "value": "Up",
            "description": "Up"
          },
          {
            "name": "Down",
            "value": "Down",
            "description": "Down"
          }
        ]
      }
    },
    "LoadBalancerBackendAddressPropertiesFormat": {
      "type": "object",
      "description": "Properties of the load balancer backend addresses.",
      "properties": {
        "virtualNetwork": {
          "$ref": "#/$defs/SubResource",
          "description": "Reference to an existing virtual network."
        },
        "subnet": {
          "$ref": "#/$defs/SubResource",
          "description": "Reference to an existing subnet."
        },
        "ipAddress": {
          "type": "string",
          "description": "IP Address belonging to the referenced virtual network."
        },
        "networkInterfaceIPConfiguration": {
          "$ref": "#/$defs/SubResource",
          "description": "Reference to IP address defined in network interfaces.",
          "readOnly": true
        },
        "loadBalancerFrontendIPConfiguration": {
          "$ref": "#/$defs/SubResource",
          "description": "Reference to the frontend ip address configuration defined in regional loadbalancer."
        },
        "inboundNatRulesPortMapping": {
          "type": "array",
          "description": "Collection of inbound NAT rule port mappings.",
          "items": {
            "$ref": "#/$defs/NatRulePortMapping"
          },
          "readOnly": true
        },
        "adminState": {
          "$ref": "#/$defs/LoadBalancerBackendAddressAdminState",
          "description": "A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections."
        }
      }
    },
    "NatRulePortMapping": {
      "type": "object",
      "description": "Individual port mappings for inbound NAT rule created for backend pool.",
      "properties": {
        "inboundNatRuleName": {
          "type": "string",
          "description": "Name of inbound NAT rule."
        },
        "frontendPort": {
          "type": "integer",
          "format": "int32",
          "description": "Frontend port."
        },
        "backendPort": {
          "type": "integer",
          "format": "int32",
          "description": "Backend port."
        }
      }
    },
    "NetworkInterfaceIPConfiguration": {
      "type": "object",
      "description": "IPConfiguration in a network interface.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/NetworkInterfaceIPConfigurationPropertiesFormat",
          "description": "Network interface IP configuration properties.",
          "x-ms-client-flatten": true
        },
        "etag": {
          "type": "string",
          "description": "A unique read-only string that changes whenever the resource is updated.",
          "readOnly": true
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/SubResourceModel"
        }
      ]
    },
    "ProvisioningState": {
      "type": "string",
      "description": "Provisioning states of a resource.",
      "enum": [
        "Failed",
        "Succeeded",
        "Canceled",
        "Creating",
        "Updating",
        "Deleting"
      ],
      "x-ms-enum": {
        "name": "ProvisioningState",
        "modelAsString": true,
        "values": [
          {
            "name": "Failed",
            "value": "Failed",
            "description": "Failed"
          },
          {
            "name": "Succeeded",
            "value": "Succeeded",
            "description": "Succeeded"
          },
          {
            "name": "Canceled",
            "value": "Canceled",
            "description": "Canceled"
          },
          {
            "name": "Creating",
            "value": "Creating",
            "description": "Creating"
          },
          {
            "name": "Updating",
            "value": "Updating",
            "description": "Updating"
          },
          {
            "name": "Deleting",
            "value": "Deleting",
            "description": "Deleting"
          }
        ]
      }
    },
    "SubResource": {
      "type": "object",
      "description": "Reference to another subresource.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Resource ID."
        }
      }
    },
    "SubResourceModel": {
      "type": "object",
      "description": "Reference to another subresource.",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the resource."
        },
        "type": {
          "type": "string",
          "description": "Resource type.",
          "readOnly": true
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/SubResource"
        }
      ],
      "x-ms-azure-resource": true
    },
    "SyncMode": {
      "type": "string",
      "description": "Backend address synchronous mode for the backend pool",
      "enum": [
        "Automatic",
        "Manual"
      ],
      "x-ms-enum": {
        "name": "SyncMode",
        "modelAsString": true,
        "values": [
          {
            "name": "Automatic",
            "value": "Automatic",
            "description": "Automatic"
          },
          {
            "name": "Manual",
            "value": "Manual",
            "description": "Manual"
          }
        ]
      }
    }
  }
}