Load Balancers - Create Or Update

Service:

Load balancer

API Version:

2021-08-01

Membuat atau memperbarui load balancer.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}?api-version=2021-08-01

Parameter URI

Name	In	Required	Type	Description
loadBalancerName	path	True	string	Nama load balancer.
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	Info masuk langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi API klien.

Isi Permintaan

Name	Type	Description
extendedLocation	ExtendedLocation	Lokasi penyeimbang beban yang diperluas.
id	string	ID Sumber Daya.
location	string	Lokasi sumber daya.
properties.backendAddressPools	BackendAddressPool[]	Kumpulan kumpulan alamat backend yang digunakan oleh load balancer.
properties.frontendIPConfigurations	FrontendIPConfiguration[]	Objek yang mewakili IP frontend yang akan digunakan untuk load balancer.
properties.inboundNatPools	InboundNatPool[]	Menentukan rentang port eksternal untuk NAT masuk ke satu port backend pada NIC yang terkait dengan load balancer. Aturan NAT masuk dibuat secara otomatis untuk setiap NIC yang terkait dengan Load Balancer menggunakan port eksternal dari rentang ini. Menentukan kumpulan NAT Masuk pada Load Balancer Anda saling eksklusif dengan menentukan aturan NAT masuk. Kumpulan NAT masuk dirujuk dari set skala komputer virtual. NIC yang terkait dengan komputer virtual individual tidak dapat mereferensikan kumpulan NAT masuk. Mereka harus mereferensikan aturan NAT masuk individu.
properties.inboundNatRules	InboundNatRule[]	Kumpulan Aturan NAT masuk yang digunakan oleh load balancer. Menentukan aturan NAT masuk pada load balancer Anda saling eksklusif dengan menentukan kumpulan NAT masuk. Kumpulan NAT masuk dirujuk dari set skala komputer virtual. NIC yang terkait dengan komputer virtual individual tidak dapat mereferensikan kumpulan NAT Masuk. Mereka harus mereferensikan aturan NAT masuk individu.
properties.loadBalancingRules	LoadBalancingRule[]	Koleksi objek yang mewakili aturan penyeimbangan beban Mendapatkan provisi.
properties.outboundRules	OutboundRule[]	Aturan keluar.
properties.probes	Probe[]	Kumpulan objek pemeriksaan yang digunakan dalam load balancer.
sku	LoadBalancerSku	SKU load balancer.
tags	object	Tag sumber daya.

Respons

Name	Type	Description
200 OK	LoadBalancer	Pembaruan berhasil. Operasi mengembalikan sumber daya LoadBalancer yang dihasilkan.
201 Created	LoadBalancer	Buat keberhasilan. Operasi mengembalikan sumber daya LoadBalancer yang dihasilkan.
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

Create load balancer

Create load balancer with Frontend IP in Zone 1

Create load balancer with Gateway Load Balancer Consumer configured

Create load balancer with Gateway Load Balancer Provider configured with one Backend Pool

Create load balancer with Gateway Load Balancer Provider configured with two Backend Pool

Create load balancer with Global Tier and one regional load balancer in its backend pool

Create load balancer with inbound nat pool

Create load balancer with outbound rules

Create load balancer with Standard SKU

Create load balancer

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb?api-version=2021-08-01

{
  "location": "eastus",
  "properties": {
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "properties": {
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          }
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "properties": {}
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "enableTcpReset": false,
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          }
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "properties": {
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "enableTcpReset": false
        }
      }
    ],
    "inboundNatPools": []
  }
}

Java

import com.azure.core.management.SubResource;
import com.azure.core.util.Context;
import com.azure.resourcemanager.network.fluent.models.BackendAddressPoolInner;
import com.azure.resourcemanager.network.fluent.models.FrontendIpConfigurationInner;
import com.azure.resourcemanager.network.fluent.models.InboundNatRuleInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancerInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancingRuleInner;
import com.azure.resourcemanager.network.fluent.models.ProbeInner;
import com.azure.resourcemanager.network.fluent.models.SubnetInner;
import com.azure.resourcemanager.network.models.LoadDistribution;
import com.azure.resourcemanager.network.models.ProbeProtocol;
import com.azure.resourcemanager.network.models.TransportProtocol;
import java.util.Arrays;

/** Samples for LoadBalancers CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreate.json
     */
    /**
     * Sample code: Create load balancer.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createLoadBalancer(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .networks()
            .manager()
            .serviceClient()
            .getLoadBalancers()
            .createOrUpdate(
                "rg1",
                "lb",
                new LoadBalancerInner()
                    .withLocation("eastus")
                    .withFrontendIpConfigurations(
                        Arrays
                            .asList(
                                new FrontendIpConfigurationInner()
                                    .withName("fe-lb")
                                    .withSubnet(
                                        new SubnetInner()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"))))
                    .withBackendAddressPools(Arrays.asList(new BackendAddressPoolInner().withName("be-lb")))
                    .withLoadBalancingRules(
                        Arrays
                            .asList(
                                new LoadBalancingRuleInner()
                                    .withName("rulelb")
                                    .withFrontendIpConfiguration(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"))
                                    .withBackendAddressPool(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"))
                                    .withProbe(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"))
                                    .withProtocol(TransportProtocol.TCP)
                                    .withLoadDistribution(LoadDistribution.DEFAULT)
                                    .withFrontendPort(80)
                                    .withBackendPort(80)
                                    .withIdleTimeoutInMinutes(15)
                                    .withEnableFloatingIp(true)
                                    .withEnableTcpReset(false)))
                    .withProbes(
                        Arrays
                            .asList(
                                new ProbeInner()
                                    .withName("probe-lb")
                                    .withProtocol(ProbeProtocol.HTTP)
                                    .withPort(80)
                                    .withIntervalInSeconds(15)
                                    .withNumberOfProbes(2)
                                    .withRequestPath("healthcheck.aspx")))
                    .withInboundNatRules(
                        Arrays
                            .asList(
                                new InboundNatRuleInner()
                                    .withName("in-nat-rule")
                                    .withFrontendIpConfiguration(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"))
                                    .withProtocol(TransportProtocol.TCP)
                                    .withFrontendPort(3389)
                                    .withBackendPort(3389)
                                    .withIdleTimeoutInMinutes(15)
                                    .withEnableFloatingIp(true)
                                    .withEnableTcpReset(false)))
                    .withInboundNatPools(Arrays.asList()),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreate.json
func ExampleLoadBalancersClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"lb",
		armnetwork.LoadBalancer{
			Location: to.Ptr("eastus"),
			Properties: &armnetwork.LoadBalancerPropertiesFormat{
				BackendAddressPools: []*armnetwork.BackendAddressPool{
					{
						Name:       to.Ptr("be-lb"),
						Properties: &armnetwork.BackendAddressPoolPropertiesFormat{},
					}},
				FrontendIPConfigurations: []*armnetwork.FrontendIPConfiguration{
					{
						Name: to.Ptr("fe-lb"),
						Properties: &armnetwork.FrontendIPConfigurationPropertiesFormat{
							Subnet: &armnetwork.Subnet{
								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"),
							},
						},
					}},
				InboundNatPools: []*armnetwork.InboundNatPool{},
				InboundNatRules: []*armnetwork.InboundNatRule{
					{
						Name: to.Ptr("in-nat-rule"),
						Properties: &armnetwork.InboundNatRulePropertiesFormat{
							BackendPort:      to.Ptr[int32](3389),
							EnableFloatingIP: to.Ptr(true),
							EnableTCPReset:   to.Ptr(false),
							FrontendIPConfiguration: &armnetwork.SubResource{
								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
							},
							FrontendPort:         to.Ptr[int32](3389),
							IdleTimeoutInMinutes: to.Ptr[int32](15),
							Protocol:             to.Ptr(armnetwork.TransportProtocolTCP),
						},
					}},
				LoadBalancingRules: []*armnetwork.LoadBalancingRule{
					{
						Name: to.Ptr("rulelb"),
						Properties: &armnetwork.LoadBalancingRulePropertiesFormat{
							BackendAddressPool: &armnetwork.SubResource{
								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"),
							},
							BackendPort:      to.Ptr[int32](80),
							EnableFloatingIP: to.Ptr(true),
							EnableTCPReset:   to.Ptr(false),
							FrontendIPConfiguration: &armnetwork.SubResource{
								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
							},
							FrontendPort:         to.Ptr[int32](80),
							IdleTimeoutInMinutes: to.Ptr[int32](15),
							LoadDistribution:     to.Ptr(armnetwork.LoadDistributionDefault),
							Probe: &armnetwork.SubResource{
								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"),
							},
							Protocol: to.Ptr(armnetwork.TransportProtocolTCP),
						},
					}},
				Probes: []*armnetwork.Probe{
					{
						Name: to.Ptr("probe-lb"),
						Properties: &armnetwork.ProbePropertiesFormat{
							IntervalInSeconds: to.Ptr[int32](15),
							NumberOfProbes:    to.Ptr[int32](2),
							Port:              to.Ptr[int32](80),
							RequestPath:       to.Ptr("healthcheck.aspx"),
							Protocol:          to.Ptr(armnetwork.ProbeProtocolHTTP),
						},
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a load balancer.
 *
 * @summary Creates or updates a load balancer.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreate.json
 */
async function createLoadBalancer() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const loadBalancerName = "lb";
  const parameters = {
    backendAddressPools: [{ name: "be-lb" }],
    frontendIPConfigurations: [
      {
        name: "fe-lb",
        subnet: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb",
        },
      },
    ],
    inboundNatPools: [],
    inboundNatRules: [
      {
        name: "in-nat-rule",
        backendPort: 3389,
        enableFloatingIP: true,
        enableTcpReset: false,
        frontendIPConfiguration: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        },
        frontendPort: 3389,
        idleTimeoutInMinutes: 15,
        protocol: "Tcp",
      },
    ],
    loadBalancingRules: [
      {
        name: "rulelb",
        backendAddressPool: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        },
        backendPort: 80,
        enableFloatingIP: true,
        enableTcpReset: false,
        frontendIPConfiguration: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        },
        frontendPort: 80,
        idleTimeoutInMinutes: 15,
        loadDistribution: "Default",
        probe: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        },
        protocol: "Tcp",
      },
    ],
    location: "eastus",
    probes: [
      {
        name: "probe-lb",
        intervalInSeconds: 15,
        numberOfProbes: 2,
        port: 80,
        requestPath: "healthcheck.aspx",
        protocol: "Http",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.loadBalancers.beginCreateOrUpdateAndWait(
    resourceGroupName,
    loadBalancerName,
    parameters
  );
  console.log(result);
}

createLoadBalancer().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Basic"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ]
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "enableTcpReset": false,
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule",
        "type": "Microsoft.Network/loadBalancers/inboundNatRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "enableTcpReset": false
        }
      }
    ],
    "inboundNatPools": []
  }
}

Status code:

201

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Basic"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ]
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "enableTcpReset": false,
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule",
        "type": "Microsoft.Network/loadBalancers/inboundNatRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "enableTcpReset": false
        }
      }
    ],
    "inboundNatPools": []
  }
}

Create load balancer with Frontend IP in Zone 1

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb?api-version=2021-08-01

{
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "properties": {
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          }
        },
        "zones": [
          "1"
        ]
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "properties": {}
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          }
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "properties": {
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp"
        }
      }
    ],
    "inboundNatPools": [],
    "outboundRules": []
  }
}

Java

import com.azure.core.management.SubResource;
import com.azure.core.util.Context;
import com.azure.resourcemanager.network.fluent.models.BackendAddressPoolInner;
import com.azure.resourcemanager.network.fluent.models.FrontendIpConfigurationInner;
import com.azure.resourcemanager.network.fluent.models.InboundNatRuleInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancerInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancingRuleInner;
import com.azure.resourcemanager.network.fluent.models.ProbeInner;
import com.azure.resourcemanager.network.fluent.models.SubnetInner;
import com.azure.resourcemanager.network.models.LoadBalancerSku;
import com.azure.resourcemanager.network.models.LoadBalancerSkuName;
import com.azure.resourcemanager.network.models.LoadDistribution;
import com.azure.resourcemanager.network.models.ProbeProtocol;
import com.azure.resourcemanager.network.models.TransportProtocol;
import java.util.Arrays;

/** Samples for LoadBalancers CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateWithZones.json
     */
    /**
     * Sample code: Create load balancer with Frontend IP in Zone 1.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createLoadBalancerWithFrontendIPInZone1(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .networks()
            .manager()
            .serviceClient()
            .getLoadBalancers()
            .createOrUpdate(
                "rg1",
                "lb",
                new LoadBalancerInner()
                    .withLocation("eastus")
                    .withSku(new LoadBalancerSku().withName(LoadBalancerSkuName.STANDARD))
                    .withFrontendIpConfigurations(
                        Arrays
                            .asList(
                                new FrontendIpConfigurationInner()
                                    .withName("fe-lb")
                                    .withZones(Arrays.asList("1"))
                                    .withSubnet(
                                        new SubnetInner()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"))))
                    .withBackendAddressPools(Arrays.asList(new BackendAddressPoolInner().withName("be-lb")))
                    .withLoadBalancingRules(
                        Arrays
                            .asList(
                                new LoadBalancingRuleInner()
                                    .withName("rulelb")
                                    .withFrontendIpConfiguration(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"))
                                    .withBackendAddressPool(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"))
                                    .withProbe(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"))
                                    .withProtocol(TransportProtocol.TCP)
                                    .withLoadDistribution(LoadDistribution.DEFAULT)
                                    .withFrontendPort(80)
                                    .withBackendPort(80)
                                    .withIdleTimeoutInMinutes(15)
                                    .withEnableFloatingIp(true)))
                    .withProbes(
                        Arrays
                            .asList(
                                new ProbeInner()
                                    .withName("probe-lb")
                                    .withProtocol(ProbeProtocol.HTTP)
                                    .withPort(80)
                                    .withIntervalInSeconds(15)
                                    .withNumberOfProbes(2)
                                    .withRequestPath("healthcheck.aspx")))
                    .withInboundNatRules(
                        Arrays
                            .asList(
                                new InboundNatRuleInner()
                                    .withName("in-nat-rule")
                                    .withFrontendIpConfiguration(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"))
                                    .withProtocol(TransportProtocol.TCP)
                                    .withFrontendPort(3389)
                                    .withBackendPort(3389)
                                    .withIdleTimeoutInMinutes(15)
                                    .withEnableFloatingIp(true)))
                    .withInboundNatPools(Arrays.asList())
                    .withOutboundRules(Arrays.asList()),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a load balancer.
 *
 * @summary Creates or updates a load balancer.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateWithZones.json
 */
async function createLoadBalancerWithFrontendIPInZone1() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const loadBalancerName = "lb";
  const parameters = {
    backendAddressPools: [{ name: "be-lb" }],
    frontendIPConfigurations: [
      {
        name: "fe-lb",
        subnet: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb",
        },
        zones: ["1"],
      },
    ],
    inboundNatPools: [],
    inboundNatRules: [
      {
        name: "in-nat-rule",
        backendPort: 3389,
        enableFloatingIP: true,
        frontendIPConfiguration: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        },
        frontendPort: 3389,
        idleTimeoutInMinutes: 15,
        protocol: "Tcp",
      },
    ],
    loadBalancingRules: [
      {
        name: "rulelb",
        backendAddressPool: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        },
        backendPort: 80,
        enableFloatingIP: true,
        frontendIPConfiguration: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        },
        frontendPort: 80,
        idleTimeoutInMinutes: 15,
        loadDistribution: "Default",
        probe: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        },
        protocol: "Tcp",
      },
    ],
    location: "eastus",
    outboundRules: [],
    probes: [
      {
        name: "probe-lb",
        intervalInSeconds: 15,
        numberOfProbes: 2,
        port: 80,
        requestPath: "healthcheck.aspx",
        protocol: "Http",
      },
    ],
    sku: { name: "Standard" },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.loadBalancers.beginCreateOrUpdateAndWait(
    resourceGroupName,
    loadBalancerName,
    parameters
  );
  console.log(result);
}

createLoadBalancerWithFrontendIPInZone1().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "zones": [
          "1"
        ],
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ]
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule",
        "type": "Microsoft.Network/loadBalancers/inboundNatRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp"
        }
      }
    ],
    "outboundRules": [],
    "inboundNatPools": []
  }
}

Status code:

201

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "zones": [
          "1"
        ],
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ]
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule",
        "type": "Microsoft.Network/loadBalancers/inboundNatRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp"
        }
      }
    ],
    "outboundRules": [],
    "inboundNatPools": []
  }
}

Create load balancer with Gateway Load Balancer Consumer configured

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb?api-version=2021-08-01

{
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "properties": {
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "gatewayLoadBalancer": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider"
          }
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "properties": {}
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          }
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "properties": {
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp"
        }
      }
    ],
    "inboundNatPools": [],
    "outboundRules": []
  }
}

Java

import com.azure.core.management.SubResource;
import com.azure.core.util.Context;
import com.azure.resourcemanager.network.fluent.models.BackendAddressPoolInner;
import com.azure.resourcemanager.network.fluent.models.FrontendIpConfigurationInner;
import com.azure.resourcemanager.network.fluent.models.InboundNatRuleInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancerInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancingRuleInner;
import com.azure.resourcemanager.network.fluent.models.ProbeInner;
import com.azure.resourcemanager.network.fluent.models.SubnetInner;
import com.azure.resourcemanager.network.models.LoadBalancerSku;
import com.azure.resourcemanager.network.models.LoadBalancerSkuName;
import com.azure.resourcemanager.network.models.LoadDistribution;
import com.azure.resourcemanager.network.models.ProbeProtocol;
import com.azure.resourcemanager.network.models.TransportProtocol;
import java.util.Arrays;

/** Samples for LoadBalancers CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateGatewayLoadBalancerConsumer.json
     */
    /**
     * Sample code: Create load balancer with Gateway Load Balancer Consumer configured.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createLoadBalancerWithGatewayLoadBalancerConsumerConfigured(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .networks()
            .manager()
            .serviceClient()
            .getLoadBalancers()
            .createOrUpdate(
                "rg1",
                "lb",
                new LoadBalancerInner()
                    .withLocation("eastus")
                    .withSku(new LoadBalancerSku().withName(LoadBalancerSkuName.STANDARD))
                    .withFrontendIpConfigurations(
                        Arrays
                            .asList(
                                new FrontendIpConfigurationInner()
                                    .withName("fe-lb")
                                    .withSubnet(
                                        new SubnetInner()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"))
                                    .withGatewayLoadBalancer(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider"))))
                    .withBackendAddressPools(Arrays.asList(new BackendAddressPoolInner().withName("be-lb")))
                    .withLoadBalancingRules(
                        Arrays
                            .asList(
                                new LoadBalancingRuleInner()
                                    .withName("rulelb")
                                    .withFrontendIpConfiguration(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"))
                                    .withBackendAddressPool(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"))
                                    .withProbe(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"))
                                    .withProtocol(TransportProtocol.TCP)
                                    .withLoadDistribution(LoadDistribution.DEFAULT)
                                    .withFrontendPort(80)
                                    .withBackendPort(80)
                                    .withIdleTimeoutInMinutes(15)
                                    .withEnableFloatingIp(true)))
                    .withProbes(
                        Arrays
                            .asList(
                                new ProbeInner()
                                    .withName("probe-lb")
                                    .withProtocol(ProbeProtocol.HTTP)
                                    .withPort(80)
                                    .withIntervalInSeconds(15)
                                    .withNumberOfProbes(2)
                                    .withRequestPath("healthcheck.aspx")))
                    .withInboundNatRules(
                        Arrays
                            .asList(
                                new InboundNatRuleInner()
                                    .withName("in-nat-rule")
                                    .withFrontendIpConfiguration(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"))
                                    .withProtocol(TransportProtocol.TCP)
                                    .withFrontendPort(3389)
                                    .withBackendPort(3389)
                                    .withIdleTimeoutInMinutes(15)
                                    .withEnableFloatingIp(true)))
                    .withInboundNatPools(Arrays.asList())
                    .withOutboundRules(Arrays.asList()),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a load balancer.
 *
 * @summary Creates or updates a load balancer.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateGatewayLoadBalancerConsumer.json
 */
async function createLoadBalancerWithGatewayLoadBalancerConsumerConfigured() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const loadBalancerName = "lb";
  const parameters = {
    backendAddressPools: [{ name: "be-lb" }],
    frontendIPConfigurations: [
      {
        name: "fe-lb",
        gatewayLoadBalancer: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider",
        },
        subnet: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb",
        },
      },
    ],
    inboundNatPools: [],
    inboundNatRules: [
      {
        name: "in-nat-rule",
        backendPort: 3389,
        enableFloatingIP: true,
        frontendIPConfiguration: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        },
        frontendPort: 3389,
        idleTimeoutInMinutes: 15,
        protocol: "Tcp",
      },
    ],
    loadBalancingRules: [
      {
        name: "rulelb",
        backendAddressPool: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        },
        backendPort: 80,
        enableFloatingIP: true,
        frontendIPConfiguration: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        },
        frontendPort: 80,
        idleTimeoutInMinutes: 15,
        loadDistribution: "Default",
        probe: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        },
        protocol: "Tcp",
      },
    ],
    location: "eastus",
    outboundRules: [],
    probes: [
      {
        name: "probe-lb",
        intervalInSeconds: 15,
        numberOfProbes: 2,
        port: 80,
        requestPath: "healthcheck.aspx",
        protocol: "Http",
      },
    ],
    sku: { name: "Standard" },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.loadBalancers.beginCreateOrUpdateAndWait(
    resourceGroupName,
    loadBalancerName,
    parameters
  );
  console.log(result);
}

createLoadBalancerWithGatewayLoadBalancerConsumerConfigured().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ],
          "gatewayLoadBalancer": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider"
          }
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule",
        "type": "Microsoft.Network/loadBalancers/inboundNatRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp"
        }
      }
    ],
    "outboundRules": [],
    "inboundNatPools": []
  }
}

Status code:

201

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ],
          "gatewayLoadBalancer": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider"
          }
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule",
        "type": "Microsoft.Network/loadBalancers/inboundNatRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp"
        }
      }
    ],
    "outboundRules": [],
    "inboundNatPools": []
  }
}

Create load balancer with Gateway Load Balancer Provider configured with one Backend Pool

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb?api-version=2021-08-01

{
  "location": "eastus",
  "sku": {
    "name": "Premium"
  },
  "properties": {
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "properties": {
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          }
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "properties": {
          "tunnelInterfaces": [
            {
              "port": 15000,
              "identifier": 900,
              "protocol": "VXLAN",
              "type": "Internal"
            },
            {
              "port": 15001,
              "identifier": 901,
              "protocol": "VXLAN",
              "type": "Internal"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 0,
          "backendPort": 0,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "All",
          "loadDistribution": "Default",
          "backendAddressPools": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
            }
          ],
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          }
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "properties": {
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2
        }
      }
    ],
    "inboundNatPools": [],
    "outboundRules": []
  }
}

Java

import com.azure.core.management.SubResource;
import com.azure.core.util.Context;
import com.azure.resourcemanager.network.fluent.models.BackendAddressPoolInner;
import com.azure.resourcemanager.network.fluent.models.FrontendIpConfigurationInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancerInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancingRuleInner;
import com.azure.resourcemanager.network.fluent.models.ProbeInner;
import com.azure.resourcemanager.network.fluent.models.SubnetInner;
import com.azure.resourcemanager.network.models.GatewayLoadBalancerTunnelInterface;
import com.azure.resourcemanager.network.models.GatewayLoadBalancerTunnelInterfaceType;
import com.azure.resourcemanager.network.models.GatewayLoadBalancerTunnelProtocol;
import com.azure.resourcemanager.network.models.LoadBalancerSku;
import com.azure.resourcemanager.network.models.LoadBalancerSkuName;
import com.azure.resourcemanager.network.models.LoadDistribution;
import com.azure.resourcemanager.network.models.ProbeProtocol;
import com.azure.resourcemanager.network.models.TransportProtocol;
import java.util.Arrays;

/** Samples for LoadBalancers CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithOneBackendPool.json
     */
    /**
     * Sample code: Create load balancer with Gateway Load Balancer Provider configured with one Backend Pool.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createLoadBalancerWithGatewayLoadBalancerProviderConfiguredWithOneBackendPool(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .networks()
            .manager()
            .serviceClient()
            .getLoadBalancers()
            .createOrUpdate(
                "rg1",
                "lb",
                new LoadBalancerInner()
                    .withLocation("eastus")
                    .withSku(new LoadBalancerSku().withName(LoadBalancerSkuName.fromString("Premium")))
                    .withFrontendIpConfigurations(
                        Arrays
                            .asList(
                                new FrontendIpConfigurationInner()
                                    .withName("fe-lb")
                                    .withSubnet(
                                        new SubnetInner()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"))))
                    .withBackendAddressPools(
                        Arrays
                            .asList(
                                new BackendAddressPoolInner()
                                    .withName("be-lb")
                                    .withTunnelInterfaces(
                                        Arrays
                                            .asList(
                                                new GatewayLoadBalancerTunnelInterface()
                                                    .withPort(15000)
                                                    .withIdentifier(900)
                                                    .withProtocol(GatewayLoadBalancerTunnelProtocol.VXLAN)
                                                    .withType(GatewayLoadBalancerTunnelInterfaceType.INTERNAL),
                                                new GatewayLoadBalancerTunnelInterface()
                                                    .withPort(15001)
                                                    .withIdentifier(901)
                                                    .withProtocol(GatewayLoadBalancerTunnelProtocol.VXLAN)
                                                    .withType(GatewayLoadBalancerTunnelInterfaceType.INTERNAL)))))
                    .withLoadBalancingRules(
                        Arrays
                            .asList(
                                new LoadBalancingRuleInner()
                                    .withName("rulelb")
                                    .withFrontendIpConfiguration(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"))
                                    .withBackendAddressPools(
                                        Arrays
                                            .asList(
                                                new SubResource()
                                                    .withId(
                                                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb")))
                                    .withProbe(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"))
                                    .withProtocol(TransportProtocol.ALL)
                                    .withLoadDistribution(LoadDistribution.DEFAULT)
                                    .withFrontendPort(0)
                                    .withBackendPort(0)
                                    .withIdleTimeoutInMinutes(15)
                                    .withEnableFloatingIp(true)))
                    .withProbes(
                        Arrays
                            .asList(
                                new ProbeInner()
                                    .withName("probe-lb")
                                    .withProtocol(ProbeProtocol.HTTP)
                                    .withPort(80)
                                    .withIntervalInSeconds(15)
                                    .withNumberOfProbes(2)
                                    .withRequestPath("healthcheck.aspx")))
                    .withInboundNatPools(Arrays.asList())
                    .withOutboundRules(Arrays.asList()),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a load balancer.
 *
 * @summary Creates or updates a load balancer.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithOneBackendPool.json
 */
async function createLoadBalancerWithGatewayLoadBalancerProviderConfiguredWithOneBackendPool() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const loadBalancerName = "lb";
  const parameters = {
    backendAddressPools: [
      {
        name: "be-lb",
        tunnelInterfaces: [
          { type: "Internal", identifier: 900, port: 15000, protocol: "VXLAN" },
          { type: "Internal", identifier: 901, port: 15001, protocol: "VXLAN" },
        ],
      },
    ],
    frontendIPConfigurations: [
      {
        name: "fe-lb",
        subnet: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb",
        },
      },
    ],
    inboundNatPools: [],
    loadBalancingRules: [
      {
        name: "rulelb",
        backendAddressPools: [
          {
            id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
          },
        ],
        backendPort: 0,
        enableFloatingIP: true,
        frontendIPConfiguration: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        },
        frontendPort: 0,
        idleTimeoutInMinutes: 15,
        loadDistribution: "Default",
        probe: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        },
        protocol: "All",
      },
    ],
    location: "eastus",
    outboundRules: [],
    probes: [
      {
        name: "probe-lb",
        intervalInSeconds: 15,
        numberOfProbes: 2,
        port: 80,
        requestPath: "healthcheck.aspx",
        protocol: "Http",
      },
    ],
    sku: { name: "Premium" },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.loadBalancers.beginCreateOrUpdateAndWait(
    resourceGroupName,
    loadBalancerName,
    parameters
  );
  console.log(result);
}

createLoadBalancerWithGatewayLoadBalancerProviderConfiguredWithOneBackendPool().catch(
  console.error
);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ]
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "tunnelInterfaces": [
            {
              "port": 15000,
              "identifier": 900,
              "protocol": "VXLAN",
              "type": "Internal"
            },
            {
              "port": 15001,
              "identifier": 901,
              "protocol": "VXLAN",
              "type": "Internal"
            }
          ],
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPools": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
            }
          ],
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "outboundRules": [],
    "inboundNatPools": []
  }
}

Status code:

201

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "tunnelInterfaces": [
            {
              "port": 15000,
              "identifier": 900,
              "protocol": "VXLAN",
              "type": "Internal"
            },
            {
              "port": 15001,
              "identifier": 901,
              "protocol": "VXLAN",
              "type": "Internal"
            }
          ],
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPools": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
            }
          ],
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "outboundRules": [],
    "inboundNatPools": []
  }
}

Create load balancer with Gateway Load Balancer Provider configured with two Backend Pool

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb?api-version=2021-08-01

{
  "location": "eastus",
  "sku": {
    "name": "Premium"
  },
  "properties": {
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "properties": {
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          }
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb1",
        "properties": {}
      },
      {
        "name": "be-lb2",
        "properties": {}
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 0,
          "backendPort": 0,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "All",
          "loadDistribution": "Default",
          "backendAddressPool": {},
          "backendAddressPools": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1"
            },
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2"
            }
          ],
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          }
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "properties": {
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2
        }
      }
    ],
    "inboundNatPools": [],
    "outboundRules": []
  }
}

Java

import com.azure.core.management.SubResource;
import com.azure.core.util.Context;
import com.azure.resourcemanager.network.fluent.models.BackendAddressPoolInner;
import com.azure.resourcemanager.network.fluent.models.FrontendIpConfigurationInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancerInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancingRuleInner;
import com.azure.resourcemanager.network.fluent.models.ProbeInner;
import com.azure.resourcemanager.network.fluent.models.SubnetInner;
import com.azure.resourcemanager.network.models.LoadBalancerSku;
import com.azure.resourcemanager.network.models.LoadBalancerSkuName;
import com.azure.resourcemanager.network.models.LoadDistribution;
import com.azure.resourcemanager.network.models.ProbeProtocol;
import com.azure.resourcemanager.network.models.TransportProtocol;
import java.util.Arrays;

/** Samples for LoadBalancers CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithTwoBackendPool.json
     */
    /**
     * Sample code: Create load balancer with Gateway Load Balancer Provider configured with two Backend Pool.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createLoadBalancerWithGatewayLoadBalancerProviderConfiguredWithTwoBackendPool(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .networks()
            .manager()
            .serviceClient()
            .getLoadBalancers()
            .createOrUpdate(
                "rg1",
                "lb",
                new LoadBalancerInner()
                    .withLocation("eastus")
                    .withSku(new LoadBalancerSku().withName(LoadBalancerSkuName.fromString("Premium")))
                    .withFrontendIpConfigurations(
                        Arrays
                            .asList(
                                new FrontendIpConfigurationInner()
                                    .withName("fe-lb")
                                    .withSubnet(
                                        new SubnetInner()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"))))
                    .withBackendAddressPools(
                        Arrays
                            .asList(
                                new BackendAddressPoolInner().withName("be-lb1"),
                                new BackendAddressPoolInner().withName("be-lb2")))
                    .withLoadBalancingRules(
                        Arrays
                            .asList(
                                new LoadBalancingRuleInner()
                                    .withName("rulelb")
                                    .withFrontendIpConfiguration(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"))
                                    .withBackendAddressPool(new SubResource())
                                    .withBackendAddressPools(
                                        Arrays
                                            .asList(
                                                new SubResource()
                                                    .withId(
                                                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1"),
                                                new SubResource()
                                                    .withId(
                                                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2")))
                                    .withProbe(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"))
                                    .withProtocol(TransportProtocol.ALL)
                                    .withLoadDistribution(LoadDistribution.DEFAULT)
                                    .withFrontendPort(0)
                                    .withBackendPort(0)
                                    .withIdleTimeoutInMinutes(15)
                                    .withEnableFloatingIp(true)))
                    .withProbes(
                        Arrays
                            .asList(
                                new ProbeInner()
                                    .withName("probe-lb")
                                    .withProtocol(ProbeProtocol.HTTP)
                                    .withPort(80)
                                    .withIntervalInSeconds(15)
                                    .withNumberOfProbes(2)
                                    .withRequestPath("healthcheck.aspx")))
                    .withInboundNatPools(Arrays.asList())
                    .withOutboundRules(Arrays.asList()),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a load balancer.
 *
 * @summary Creates or updates a load balancer.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithTwoBackendPool.json
 */
async function createLoadBalancerWithGatewayLoadBalancerProviderConfiguredWithTwoBackendPool() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const loadBalancerName = "lb";
  const parameters = {
    backendAddressPools: [{ name: "be-lb1" }, { name: "be-lb2" }],
    frontendIPConfigurations: [
      {
        name: "fe-lb",
        subnet: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb",
        },
      },
    ],
    inboundNatPools: [],
    loadBalancingRules: [
      {
        name: "rulelb",
        backendAddressPool: {},
        backendAddressPools: [
          {
            id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1",
          },
          {
            id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2",
          },
        ],
        backendPort: 0,
        enableFloatingIP: true,
        frontendIPConfiguration: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        },
        frontendPort: 0,
        idleTimeoutInMinutes: 15,
        loadDistribution: "Default",
        probe: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        },
        protocol: "All",
      },
    ],
    location: "eastus",
    outboundRules: [],
    probes: [
      {
        name: "probe-lb",
        intervalInSeconds: 15,
        numberOfProbes: 2,
        port: 80,
        requestPath: "healthcheck.aspx",
        protocol: "Http",
      },
    ],
    sku: { name: "Premium" },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.loadBalancers.beginCreateOrUpdateAndWait(
    resourceGroupName,
    loadBalancerName,
    parameters
  );
  console.log(result);
}

createLoadBalancerWithGatewayLoadBalancerProviderConfiguredWithTwoBackendPool().catch(
  console.error
);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ]
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "tunnelInterfaces": [
            {
              "port": 15000,
              "identifier": 900,
              "protocol": "VXLAN",
              "type": "Internal"
            }
          ],
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      },
      {
        "name": "be-lb2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "tunnelInterfaces": [
            {
              "port": 15001,
              "identifier": 901,
              "protocol": "VXLAN",
              "type": "Internal"
            }
          ],
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 0,
          "backendPort": 0,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPools": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1"
            },
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2"
            }
          ],
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "outboundRules": [],
    "inboundNatPools": []
  }
}

Status code:

201

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "tunnelInterfaces": [
            {
              "port": 15000,
              "identifier": 900,
              "protocol": "VXLAN",
              "type": "Internal"
            }
          ],
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      },
      {
        "name": "be-lb2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "tunnelInterfaces": [
            {
              "port": 15001,
              "identifier": 901,
              "protocol": "VXLAN",
              "type": "Internal"
            }
          ],
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPools": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1"
            },
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2"
            }
          ],
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "outboundRules": [],
    "inboundNatPools": []
  }
}

Create load balancer with Global Tier and one regional load balancer in its backend pool

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb?api-version=2021-08-01

{
  "location": "eastus",
  "sku": {
    "name": "Standard",
    "tier": "Global"
  },
  "properties": {
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "properties": {
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          }
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "properties": {
          "loadBalancerBackendAddresses": [
            {
              "name": "regional-lb1-address",
              "properties": {
                "loadBalancerFrontendIPConfiguration": {
                  "id": "/subscriptions/subid/resourceGroups/regional-lb-rg1/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb"
                }
              }
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": false,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          }
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "properties": {
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2
        }
      }
    ]
  }
}

Java

import com.azure.core.management.SubResource;
import com.azure.core.util.Context;
import com.azure.resourcemanager.network.fluent.models.BackendAddressPoolInner;
import com.azure.resourcemanager.network.fluent.models.FrontendIpConfigurationInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancerInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancingRuleInner;
import com.azure.resourcemanager.network.fluent.models.ProbeInner;
import com.azure.resourcemanager.network.fluent.models.SubnetInner;
import com.azure.resourcemanager.network.models.LoadBalancerBackendAddress;
import com.azure.resourcemanager.network.models.LoadBalancerSku;
import com.azure.resourcemanager.network.models.LoadBalancerSkuName;
import com.azure.resourcemanager.network.models.LoadBalancerSkuTier;
import com.azure.resourcemanager.network.models.LoadDistribution;
import com.azure.resourcemanager.network.models.ProbeProtocol;
import com.azure.resourcemanager.network.models.TransportProtocol;
import java.util.Arrays;

/** Samples for LoadBalancers CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateGlobalTier.json
     */
    /**
     * Sample code: Create load balancer with Global Tier and one regional load balancer in its backend pool.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createLoadBalancerWithGlobalTierAndOneRegionalLoadBalancerInItsBackendPool(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .networks()
            .manager()
            .serviceClient()
            .getLoadBalancers()
            .createOrUpdate(
                "rg1",
                "lb",
                new LoadBalancerInner()
                    .withLocation("eastus")
                    .withSku(
                        new LoadBalancerSku()
                            .withName(LoadBalancerSkuName.STANDARD)
                            .withTier(LoadBalancerSkuTier.GLOBAL))
                    .withFrontendIpConfigurations(
                        Arrays
                            .asList(
                                new FrontendIpConfigurationInner()
                                    .withName("fe-lb")
                                    .withSubnet(
                                        new SubnetInner()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"))))
                    .withBackendAddressPools(
                        Arrays
                            .asList(
                                new BackendAddressPoolInner()
                                    .withName("be-lb")
                                    .withLoadBalancerBackendAddresses(
                                        Arrays
                                            .asList(
                                                new LoadBalancerBackendAddress()
                                                    .withName("regional-lb1-address")
                                                    .withLoadBalancerFrontendIpConfiguration(
                                                        new SubResource()
                                                            .withId(
                                                                "/subscriptions/subid/resourceGroups/regional-lb-rg1/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb"))))))
                    .withLoadBalancingRules(
                        Arrays
                            .asList(
                                new LoadBalancingRuleInner()
                                    .withName("rulelb")
                                    .withFrontendIpConfiguration(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"))
                                    .withBackendAddressPool(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"))
                                    .withProbe(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"))
                                    .withProtocol(TransportProtocol.TCP)
                                    .withLoadDistribution(LoadDistribution.DEFAULT)
                                    .withFrontendPort(80)
                                    .withBackendPort(80)
                                    .withIdleTimeoutInMinutes(15)
                                    .withEnableFloatingIp(false)))
                    .withProbes(
                        Arrays
                            .asList(
                                new ProbeInner()
                                    .withName("probe-lb")
                                    .withProtocol(ProbeProtocol.HTTP)
                                    .withPort(80)
                                    .withIntervalInSeconds(15)
                                    .withNumberOfProbes(2)
                                    .withRequestPath("healthcheck.aspx"))),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a load balancer.
 *
 * @summary Creates or updates a load balancer.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateGlobalTier.json
 */
async function createLoadBalancerWithGlobalTierAndOneRegionalLoadBalancerInItsBackendPool() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const loadBalancerName = "lb";
  const parameters = {
    backendAddressPools: [
      {
        name: "be-lb",
        loadBalancerBackendAddresses: [
          {
            name: "regional-lb1-address",
            loadBalancerFrontendIPConfiguration: {
              id: "/subscriptions/subid/resourceGroups/regional-lb-rg1/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb",
            },
          },
        ],
      },
    ],
    frontendIPConfigurations: [
      {
        name: "fe-lb",
        subnet: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb",
        },
      },
    ],
    loadBalancingRules: [
      {
        name: "rulelb",
        backendAddressPool: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        },
        backendPort: 80,
        enableFloatingIP: false,
        frontendIPConfiguration: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        },
        frontendPort: 80,
        idleTimeoutInMinutes: 15,
        loadDistribution: "Default",
        probe: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        },
        protocol: "Tcp",
      },
    ],
    location: "eastus",
    probes: [
      {
        name: "probe-lb",
        intervalInSeconds: 15,
        numberOfProbes: 2,
        port: 80,
        requestPath: "healthcheck.aspx",
        protocol: "Http",
      },
    ],
    sku: { name: "Standard", tier: "Global" },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.loadBalancers.beginCreateOrUpdateAndWait(
    resourceGroupName,
    loadBalancerName,
    parameters
  );
  console.log(result);
}

createLoadBalancerWithGlobalTierAndOneRegionalLoadBalancerInItsBackendPool().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard",
    "tier": "Global"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ]
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "loadBalancerBackendAddresses": [
            {
              "name": "regional-lb1-address",
              "properties": {
                "loadBalancerFrontendIPConfiguration": {
                  "id": "/subscriptions/subid/resourceGroups/regional-lb-rg1/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb"
                }
              }
            }
          ],
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": false,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ]
  }
}

Status code:

201

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard",
    "tier": "Global"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ]
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "loadBalancerBackendAddresses": [
            {
              "name": "regional-lb1-address",
              "properties": {
                "loadBalancerFrontendIPConfiguration": {
                  "id": "/subscriptions/subid/resourceGroups/regional-lb-rg1/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb"
                }
              }
            }
          ],
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": false,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ]
  }
}

Create load balancer with inbound nat pool

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb?api-version=2021-08-01

{
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "frontendIPConfigurations": [
      {
        "properties": {
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet"
          }
        },
        "name": "test",
        "zones": [],
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test"
      }
    ],
    "backendAddressPools": [],
    "loadBalancingRules": [],
    "probes": [],
    "inboundNatRules": [],
    "outboundRules": [],
    "inboundNatPools": [
      {
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test"
          },
          "protocol": "Tcp",
          "frontendPortRangeStart": 8080,
          "frontendPortRangeEnd": 8085,
          "backendPort": 8888,
          "idleTimeoutInMinutes": 10,
          "enableFloatingIP": true,
          "enableTcpReset": true
        },
        "name": "test",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test"
      }
    ]
  }
}

Java

import com.azure.core.management.SubResource;
import com.azure.core.util.Context;
import com.azure.resourcemanager.network.fluent.models.FrontendIpConfigurationInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancerInner;
import com.azure.resourcemanager.network.fluent.models.SubnetInner;
import com.azure.resourcemanager.network.models.InboundNatPool;
import com.azure.resourcemanager.network.models.IpAllocationMethod;
import com.azure.resourcemanager.network.models.LoadBalancerSku;
import com.azure.resourcemanager.network.models.LoadBalancerSkuName;
import com.azure.resourcemanager.network.models.TransportProtocol;
import java.util.Arrays;

/** Samples for LoadBalancers CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateWithInboundNatPool.json
     */
    /**
     * Sample code: Create load balancer with inbound nat pool.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createLoadBalancerWithInboundNatPool(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .networks()
            .manager()
            .serviceClient()
            .getLoadBalancers()
            .createOrUpdate(
                "rg1",
                "lb",
                new LoadBalancerInner()
                    .withLocation("eastus")
                    .withSku(new LoadBalancerSku().withName(LoadBalancerSkuName.STANDARD))
                    .withFrontendIpConfigurations(
                        Arrays
                            .asList(
                                new FrontendIpConfigurationInner()
                                    .withId(
                                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test")
                                    .withName("test")
                                    .withZones(Arrays.asList())
                                    .withPrivateIpAllocationMethod(IpAllocationMethod.DYNAMIC)
                                    .withSubnet(
                                        new SubnetInner()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet"))))
                    .withBackendAddressPools(Arrays.asList())
                    .withLoadBalancingRules(Arrays.asList())
                    .withProbes(Arrays.asList())
                    .withInboundNatRules(Arrays.asList())
                    .withInboundNatPools(
                        Arrays
                            .asList(
                                new InboundNatPool()
                                    .withId(
                                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test")
                                    .withName("test")
                                    .withFrontendIpConfiguration(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test"))
                                    .withProtocol(TransportProtocol.TCP)
                                    .withFrontendPortRangeStart(8080)
                                    .withFrontendPortRangeEnd(8085)
                                    .withBackendPort(8888)
                                    .withIdleTimeoutInMinutes(10)
                                    .withEnableFloatingIp(true)
                                    .withEnableTcpReset(true)))
                    .withOutboundRules(Arrays.asList()),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a load balancer.
 *
 * @summary Creates or updates a load balancer.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateWithInboundNatPool.json
 */
async function createLoadBalancerWithInboundNatPool() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const loadBalancerName = "lb";
  const parameters = {
    backendAddressPools: [],
    frontendIPConfigurations: [
      {
        name: "test",
        id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test",
        privateIPAllocationMethod: "Dynamic",
        subnet: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet",
        },
        zones: [],
      },
    ],
    inboundNatPools: [
      {
        name: "test",
        backendPort: 8888,
        enableFloatingIP: true,
        enableTcpReset: true,
        frontendIPConfiguration: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test",
        },
        frontendPortRangeEnd: 8085,
        frontendPortRangeStart: 8080,
        id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test",
        idleTimeoutInMinutes: 10,
        protocol: "Tcp",
      },
    ],
    inboundNatRules: [],
    loadBalancingRules: [],
    location: "eastus",
    outboundRules: [],
    probes: [],
    sku: { name: "Standard" },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.loadBalancers.beginCreateOrUpdateAndWait(
    resourceGroupName,
    loadBalancerName,
    parameters
  );
  console.log(result);
}

createLoadBalancerWithInboundNatPool().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "test",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet"
          },
          "inboundNatPools": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test"
            }
          ]
        }
      }
    ],
    "backendAddressPools": [],
    "loadBalancingRules": [],
    "probes": [],
    "inboundNatRules": [],
    "outboundRules": [],
    "inboundNatPools": [
      {
        "name": "test",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test",
        "type": "Microsoft.Network/loadBalancers/inboundNatPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendPortRangeStart": 8080,
          "frontendPortRangeEnd": 8085,
          "backendPort": 8888,
          "idleTimeoutInMinutes": 10,
          "enableFloatingIP": true,
          "protocol": "Tcp",
          "enableTcpReset": true,
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test"
          }
        }
      }
    ]
  }
}

Status code:

201

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "test",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet"
          },
          "inboundNatPools": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test"
            }
          ]
        }
      }
    ],
    "backendAddressPools": [],
    "loadBalancingRules": [],
    "probes": [],
    "inboundNatRules": [],
    "outboundRules": [],
    "inboundNatPools": [
      {
        "name": "test",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test",
        "type": "Microsoft.Network/loadBalancers/inboundNatPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendPortRangeStart": 8080,
          "frontendPortRangeEnd": 8085,
          "backendPort": 8888,
          "idleTimeoutInMinutes": 10,
          "enableFloatingIP": true,
          "protocol": "Tcp",
          "enableTcpReset": true,
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test"
          }
        }
      }
    ]
  }
}

Create load balancer with outbound rules

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb?api-version=2021-08-01

{
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "properties": {
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip"
          }
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "properties": {}
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "frontendPort": 80,
          "backendPort": 80,
          "idleTimeoutInMinutes": 15,
          "enableFloatingIP": true,
          "disableOutboundSnat": true
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "properties": {
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp"
        }
      }
    ],
    "inboundNatPools": [],
    "outboundRules": [
      {
        "name": "rule1",
        "properties": {
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "frontendIPConfigurations": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
            }
          ],
          "protocol": "All"
        }
      }
    ]
  }
}

Java

import com.azure.core.management.SubResource;
import com.azure.core.util.Context;
import com.azure.resourcemanager.network.fluent.models.BackendAddressPoolInner;
import com.azure.resourcemanager.network.fluent.models.FrontendIpConfigurationInner;
import com.azure.resourcemanager.network.fluent.models.InboundNatRuleInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancerInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancingRuleInner;
import com.azure.resourcemanager.network.fluent.models.OutboundRuleInner;
import com.azure.resourcemanager.network.fluent.models.ProbeInner;
import com.azure.resourcemanager.network.fluent.models.PublicIpAddressInner;
import com.azure.resourcemanager.network.models.LoadBalancerOutboundRuleProtocol;
import com.azure.resourcemanager.network.models.LoadBalancerSku;
import com.azure.resourcemanager.network.models.LoadBalancerSkuName;
import com.azure.resourcemanager.network.models.LoadDistribution;
import com.azure.resourcemanager.network.models.ProbeProtocol;
import com.azure.resourcemanager.network.models.TransportProtocol;
import java.util.Arrays;

/** Samples for LoadBalancers CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateWithOutboundRules.json
     */
    /**
     * Sample code: Create load balancer with outbound rules.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createLoadBalancerWithOutboundRules(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .networks()
            .manager()
            .serviceClient()
            .getLoadBalancers()
            .createOrUpdate(
                "rg1",
                "lb",
                new LoadBalancerInner()
                    .withLocation("eastus")
                    .withSku(new LoadBalancerSku().withName(LoadBalancerSkuName.STANDARD))
                    .withFrontendIpConfigurations(
                        Arrays
                            .asList(
                                new FrontendIpConfigurationInner()
                                    .withName("fe-lb")
                                    .withPublicIpAddress(
                                        new PublicIpAddressInner()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip"))))
                    .withBackendAddressPools(Arrays.asList(new BackendAddressPoolInner().withName("be-lb")))
                    .withLoadBalancingRules(
                        Arrays
                            .asList(
                                new LoadBalancingRuleInner()
                                    .withName("rulelb")
                                    .withFrontendIpConfiguration(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"))
                                    .withBackendAddressPool(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"))
                                    .withProbe(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"))
                                    .withProtocol(TransportProtocol.TCP)
                                    .withLoadDistribution(LoadDistribution.DEFAULT)
                                    .withFrontendPort(80)
                                    .withBackendPort(80)
                                    .withIdleTimeoutInMinutes(15)
                                    .withEnableFloatingIp(true)
                                    .withDisableOutboundSnat(true)))
                    .withProbes(
                        Arrays
                            .asList(
                                new ProbeInner()
                                    .withName("probe-lb")
                                    .withProtocol(ProbeProtocol.HTTP)
                                    .withPort(80)
                                    .withIntervalInSeconds(15)
                                    .withNumberOfProbes(2)
                                    .withRequestPath("healthcheck.aspx")))
                    .withInboundNatRules(
                        Arrays
                            .asList(
                                new InboundNatRuleInner()
                                    .withName("in-nat-rule")
                                    .withFrontendIpConfiguration(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"))
                                    .withProtocol(TransportProtocol.TCP)
                                    .withFrontendPort(3389)
                                    .withBackendPort(3389)
                                    .withIdleTimeoutInMinutes(15)
                                    .withEnableFloatingIp(true)))
                    .withInboundNatPools(Arrays.asList())
                    .withOutboundRules(
                        Arrays
                            .asList(
                                new OutboundRuleInner()
                                    .withName("rule1")
                                    .withFrontendIpConfigurations(
                                        Arrays
                                            .asList(
                                                new SubResource()
                                                    .withId(
                                                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb")))
                                    .withBackendAddressPool(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"))
                                    .withProtocol(LoadBalancerOutboundRuleProtocol.ALL))),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a load balancer.
 *
 * @summary Creates or updates a load balancer.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateWithOutboundRules.json
 */
async function createLoadBalancerWithOutboundRules() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const loadBalancerName = "lb";
  const parameters = {
    backendAddressPools: [{ name: "be-lb" }],
    frontendIPConfigurations: [
      {
        name: "fe-lb",
        publicIPAddress: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip",
        },
      },
    ],
    inboundNatPools: [],
    inboundNatRules: [
      {
        name: "in-nat-rule",
        backendPort: 3389,
        enableFloatingIP: true,
        frontendIPConfiguration: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        },
        frontendPort: 3389,
        idleTimeoutInMinutes: 15,
        protocol: "Tcp",
      },
    ],
    loadBalancingRules: [
      {
        name: "rulelb",
        backendAddressPool: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        },
        backendPort: 80,
        disableOutboundSnat: true,
        enableFloatingIP: true,
        frontendIPConfiguration: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        },
        frontendPort: 80,
        idleTimeoutInMinutes: 15,
        loadDistribution: "Default",
        probe: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        },
        protocol: "Tcp",
      },
    ],
    location: "eastus",
    outboundRules: [
      {
        name: "rule1",
        backendAddressPool: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        },
        frontendIPConfigurations: [
          {
            id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
          },
        ],
        protocol: "All",
      },
    ],
    probes: [
      {
        name: "probe-lb",
        intervalInSeconds: 15,
        numberOfProbes: 2,
        port: 80,
        requestPath: "healthcheck.aspx",
        protocol: "Http",
      },
    ],
    sku: { name: "Standard" },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.loadBalancers.beginCreateOrUpdateAndWait(
    resourceGroupName,
    loadBalancerName,
    parameters
  );
  console.log(result);
}

createLoadBalancerWithOutboundRules().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Dynamic",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ],
          "outboundRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1"
            }
          ],
          "privateIPAddressVersion": "IPv4"
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "outboundRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1"
            }
          ],
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "enableTcpReset": false,
          "loadDistribution": "Default",
          "disableOutboundSnat": true,
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          }
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule",
        "type": "Microsoft.Network/loadBalancers/inboundNatRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "enableTcpReset": false
        }
      }
    ],
    "outboundRules": [
      {
        "name": "rule1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1",
        "type": "Microsoft.Network/loadBalancers/outboundRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "allocatedOutboundPorts": 1024,
          "protocol": "All",
          "enableTcpReset": false,
          "idleTimeoutInMinutes": 4,
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "frontendIPConfigurations": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
            }
          ]
        }
      }
    ],
    "inboundNatPools": []
  }
}

Status code:

201

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Dynamic",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ],
          "outboundRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1"
            }
          ],
          "privateIPAddressVersion": "IPv4"
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "outboundRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1"
            }
          ],
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "enableTcpReset": false,
          "loadDistribution": "Default",
          "disableOutboundSnat": true,
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          }
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule",
        "type": "Microsoft.Network/loadBalancers/inboundNatRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "enableTcpReset": false
        }
      }
    ],
    "outboundRules": [
      {
        "name": "rule1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1",
        "type": "Microsoft.Network/loadBalancers/outboundRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "allocatedOutboundPorts": 1024,
          "protocol": "All",
          "enableTcpReset": false,
          "idleTimeoutInMinutes": 4,
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "frontendIPConfigurations": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
            }
          ]
        }
      }
    ],
    "inboundNatPools": []
  }
}

Create load balancer with Standard SKU

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb?api-version=2021-08-01

{
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "properties": {
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          }
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "properties": {}
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          }
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "properties": {
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp"
        }
      }
    ],
    "inboundNatPools": [],
    "outboundRules": []
  }
}

Java

import com.azure.core.management.SubResource;
import com.azure.core.util.Context;
import com.azure.resourcemanager.network.fluent.models.BackendAddressPoolInner;
import com.azure.resourcemanager.network.fluent.models.FrontendIpConfigurationInner;
import com.azure.resourcemanager.network.fluent.models.InboundNatRuleInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancerInner;
import com.azure.resourcemanager.network.fluent.models.LoadBalancingRuleInner;
import com.azure.resourcemanager.network.fluent.models.ProbeInner;
import com.azure.resourcemanager.network.fluent.models.SubnetInner;
import com.azure.resourcemanager.network.models.LoadBalancerSku;
import com.azure.resourcemanager.network.models.LoadBalancerSkuName;
import com.azure.resourcemanager.network.models.LoadDistribution;
import com.azure.resourcemanager.network.models.ProbeProtocol;
import com.azure.resourcemanager.network.models.TransportProtocol;
import java.util.Arrays;

/** Samples for LoadBalancers CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateStandardSku.json
     */
    /**
     * Sample code: Create load balancer with Standard SKU.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createLoadBalancerWithStandardSKU(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .networks()
            .manager()
            .serviceClient()
            .getLoadBalancers()
            .createOrUpdate(
                "rg1",
                "lb",
                new LoadBalancerInner()
                    .withLocation("eastus")
                    .withSku(new LoadBalancerSku().withName(LoadBalancerSkuName.STANDARD))
                    .withFrontendIpConfigurations(
                        Arrays
                            .asList(
                                new FrontendIpConfigurationInner()
                                    .withName("fe-lb")
                                    .withSubnet(
                                        new SubnetInner()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"))))
                    .withBackendAddressPools(Arrays.asList(new BackendAddressPoolInner().withName("be-lb")))
                    .withLoadBalancingRules(
                        Arrays
                            .asList(
                                new LoadBalancingRuleInner()
                                    .withName("rulelb")
                                    .withFrontendIpConfiguration(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"))
                                    .withBackendAddressPool(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"))
                                    .withProbe(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"))
                                    .withProtocol(TransportProtocol.TCP)
                                    .withLoadDistribution(LoadDistribution.DEFAULT)
                                    .withFrontendPort(80)
                                    .withBackendPort(80)
                                    .withIdleTimeoutInMinutes(15)
                                    .withEnableFloatingIp(true)))
                    .withProbes(
                        Arrays
                            .asList(
                                new ProbeInner()
                                    .withName("probe-lb")
                                    .withProtocol(ProbeProtocol.HTTP)
                                    .withPort(80)
                                    .withIntervalInSeconds(15)
                                    .withNumberOfProbes(2)
                                    .withRequestPath("healthcheck.aspx")))
                    .withInboundNatRules(
                        Arrays
                            .asList(
                                new InboundNatRuleInner()
                                    .withName("in-nat-rule")
                                    .withFrontendIpConfiguration(
                                        new SubResource()
                                            .withId(
                                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"))
                                    .withProtocol(TransportProtocol.TCP)
                                    .withFrontendPort(3389)
                                    .withBackendPort(3389)
                                    .withIdleTimeoutInMinutes(15)
                                    .withEnableFloatingIp(true)))
                    .withInboundNatPools(Arrays.asList())
                    .withOutboundRules(Arrays.asList()),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a load balancer.
 *
 * @summary Creates or updates a load balancer.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/LoadBalancerCreateStandardSku.json
 */
async function createLoadBalancerWithStandardSku() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const loadBalancerName = "lb";
  const parameters = {
    backendAddressPools: [{ name: "be-lb" }],
    frontendIPConfigurations: [
      {
        name: "fe-lb",
        subnet: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb",
        },
      },
    ],
    inboundNatPools: [],
    inboundNatRules: [
      {
        name: "in-nat-rule",
        backendPort: 3389,
        enableFloatingIP: true,
        frontendIPConfiguration: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        },
        frontendPort: 3389,
        idleTimeoutInMinutes: 15,
        protocol: "Tcp",
      },
    ],
    loadBalancingRules: [
      {
        name: "rulelb",
        backendAddressPool: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        },
        backendPort: 80,
        enableFloatingIP: true,
        frontendIPConfiguration: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        },
        frontendPort: 80,
        idleTimeoutInMinutes: 15,
        loadDistribution: "Default",
        probe: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        },
        protocol: "Tcp",
      },
    ],
    location: "eastus",
    outboundRules: [],
    probes: [
      {
        name: "probe-lb",
        intervalInSeconds: 15,
        numberOfProbes: 2,
        port: 80,
        requestPath: "healthcheck.aspx",
        protocol: "Http",
      },
    ],
    sku: { name: "Standard" },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.loadBalancers.beginCreateOrUpdateAndWait(
    resourceGroupName,
    loadBalancerName,
    parameters
  );
  console.log(result);
}

createLoadBalancerWithStandardSku().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ]
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule",
        "type": "Microsoft.Network/loadBalancers/inboundNatRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp"
        }
      }
    ],
    "outboundRules": [],
    "inboundNatPools": []
  }
}

Status code:

201

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "eastus",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ]
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "type": "Microsoft.Network/loadBalancers/probes",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule",
        "type": "Microsoft.Network/loadBalancers/inboundNatRules",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp"
        }
      }
    ],
    "outboundRules": [],
    "inboundNatPools": []
  }
}

Definisi

ApplicationGatewayBackendAddress	Alamat backend gateway aplikasi.
ApplicationGatewayBackendAddressPool	Kumpulan Alamat Backend gateway aplikasi.
ApplicationGatewayIPConfiguration	Konfigurasi IP gateway aplikasi. Saat ini 1 konfigurasi IP publik dan 1 privat diizinkan.
ApplicationSecurityGroup	Grup keamanan aplikasi dalam grup sumber daya.
AutoApproval	Daftar persetujuan otomatis layanan tautan privat.
BackendAddressPool	Kumpulan alamat IP backend.
CloudError	Respons kesalahan dari layanan.
CloudErrorBody	Respons kesalahan dari layanan.
CustomDnsConfigPropertiesFormat	Berisi konfigurasi resolusi Dns kustom dari pelanggan.
DdosSettings	Berisi pengaturan perlindungan DDoS DARI IP publik.
DdosSettingsProtectionCoverage	Penyesuaian kebijakan perlindungan DDoS dari IP publik. Hanya cakupan standar yang akan memiliki kemampuan untuk disesuaikan.
Delegation	Merinci layanan tempat subnet didelegasikan.
DeleteOptions	Tentukan apa yang terjadi pada alamat IP publik saat VM menggunakannya dihapus
ExtendedLocation	Jenis kompleks ExtendedLocation.
ExtendedLocationTypes	Jenis lokasi yang diperluas.
FlowLog	Sumber daya log alur.
FlowLogFormatParameters	Parameter yang menentukan format log alur.
FlowLogFormatType	Jenis file log alur.
FrontendIPConfiguration	Alamat IP frontend dari load balancer.
GatewayLoadBalancerTunnelInterface	Antarmuka terowongan load balancer gateway dari kumpulan alamat backend load balancer.
GatewayLoadBalancerTunnelInterfaceType	Jenis lalu lintas antarmuka terowongan load balancer gateway.
GatewayLoadBalancerTunnelProtocol	Protokol antarmuka terowongan load balancer gateway.
InboundNatPool	Kumpulan NAT masuk dari load balancer.
InboundNatRule	Aturan NAT masuk dari load balancer.
IPAllocationMethod	Metode alokasi alamat IP.
IPConfiguration	Konfigurasi IP.
IPConfigurationProfile	Sumber daya anak profil konfigurasi IP.
IpTag	Berisi IpTag yang terkait dengan objek .
IPVersion	Versi alamat IP.
LoadBalancer	Sumber daya LoadBalancer.
LoadBalancerBackendAddress	Alamat backend load balancer.
LoadBalancerBackendAddressAdminState	Daftar status administratif yang setelah diatur dapat mengambil alih pemeriksaan kesehatan sehingga Load Balancer akan selalu meneruskan koneksi baru ke backend, atau menolak koneksi baru dan mengatur ulang koneksi yang ada.
LoadBalancerOutboundRuleProtocol	Protokol untuk aturan keluar di load balancer.
LoadBalancerSku	SKU load balancer.
LoadBalancerSkuName	Nama SKU load balancer.
LoadBalancerSkuTier	Tingkat SKU load balancer.
LoadBalancingRule	Aturan penyeimbangan beban untuk load balancer.
LoadDistribution	Kebijakan distribusi beban untuk aturan ini.
NatGateway	Sumber daya Nat Gateway.
NatGatewaySku	SKU gateway nat.
NatGatewaySkuName	Nama SKU Nat Gateway.
NatRulePortMapping	Pemetaan port individual untuk aturan NAT masuk yang dibuat untuk kumpulan backend.
NetworkInterface	Antarmuka jaringan dalam grup sumber daya.
NetworkInterfaceAuxiliaryMode	Mode tambahan sumber daya Antarmuka Jaringan.
NetworkInterfaceDnsSettings	Pengaturan DNS antarmuka jaringan.
NetworkInterfaceIPConfiguration	IPConfiguration dalam antarmuka jaringan.
NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties	Properti PrivateLinkConnection untuk antarmuka jaringan.
NetworkInterfaceMigrationPhase	Fase migrasi sumber daya Antarmuka Jaringan.
NetworkInterfaceNicType	Jenis sumber daya Antarmuka Jaringan.
NetworkInterfaceTapConfiguration	Ketuk konfigurasi di Antarmuka Jaringan.
NetworkSecurityGroup	Sumber daya NetworkSecurityGroup.
OutboundRule	Aturan keluar dari load balancer.
PrivateEndpoint	Sumber daya titik akhir privat.
PrivateEndpointConnection	Sumber daya PrivateEndpointConnection.
PrivateEndpointIPConfiguration	Konfigurasi IP titik akhir privat.
PrivateLinkService	Sumber daya layanan tautan privat.
PrivateLinkServiceConnection	Sumber daya PrivateLinkServiceConnection.
PrivateLinkServiceConnectionState	Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.
PrivateLinkServiceIpConfiguration	Konfigurasi ip layanan tautan privat.
Probe	Pemeriksaan load balancer.
ProbeProtocol	Protokol titik akhir. Jika 'Tcp' ditentukan, ACK yang diterima diperlukan agar pemeriksaan berhasil. Jika 'Http' atau 'Https' ditentukan, respons 200 OK dari URI yang ditentukan diperlukan agar pemeriksaan berhasil.
ProvisioningState	Status penyediaan saat ini.
PublicIPAddress	Sumber daya alamat IP publik.
PublicIPAddressDnsSettings	Berisi FQDN dari catatan DNS yang terkait dengan alamat IP publik.
PublicIPAddressMigrationPhase	Fase migrasi Alamat IP Publik.
PublicIPAddressSku	SKU alamat IP publik.
PublicIPAddressSkuName	Nama SKU alamat IP publik.
PublicIPAddressSkuTier	Tingkat SKU alamat IP publik.
ResourceNavigationLink	Sumber daya ResourceNavigationLink.
RetentionPolicyParameters	Parameter yang menentukan kebijakan penyimpanan untuk log alur.
Route	Rutekan sumber daya.
RouteNextHopType	Jenis hop Azure tempat paket harus dikirim.
RouteTable	Sumber daya tabel rute.
SecurityRule	Aturan keamanan jaringan.
SecurityRuleAccess	Apakah lalu lintas jaringan diizinkan atau ditolak.
SecurityRuleDirection	Arah aturan. Arah menentukan apakah aturan akan dievaluasi pada lalu lintas masuk atau keluar.
SecurityRuleProtocol	Protokol jaringan yang berlaku untuk aturan ini.
ServiceAssociationLink	Sumber daya ServiceAssociationLink.
ServiceEndpointPolicy	Sumber daya kebijakan titik Akhir Layanan.
ServiceEndpointPolicyDefinition	Definisi kebijakan Titik Akhir Layanan.
ServiceEndpointPropertiesFormat	Properti titik akhir layanan.
Subnet	Subnet dalam sumber daya jaringan virtual.
SubResource	Referensi ke subsumber daya lain.
TrafficAnalyticsConfigurationProperties	Parameter yang menentukan konfigurasi analitik lalu lintas.
TrafficAnalyticsProperties	Parameter yang menentukan konfigurasi analitik lalu lintas.
TransportProtocol	Protokol transportasi untuk titik akhir.
VirtualNetworkPrivateEndpointNetworkPolicies	Aktifkan atau Nonaktifkan terapkan kebijakan jaringan pada titik akhir privat di subnet.
VirtualNetworkPrivateLinkServiceNetworkPolicies	Aktifkan atau Nonaktifkan penerapan kebijakan jaringan pada layanan tautan privat di subnet.
VirtualNetworkTap	Virtual Network Ketuk sumber daya.
Visibility	Daftar visibilitas layanan tautan privat.

ApplicationGatewayBackendAddress

Alamat backend gateway aplikasi.

Name	Type	Description
fqdn	string	Nama domain yang sepenuhnya memenuhi syarat (FQDN).
ipAddress	string	Alamat IP.

ApplicationGatewayBackendAddressPool

Kumpulan Alamat Backend gateway aplikasi.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama kumpulan alamat backend yang unik dalam Application Gateway.
properties.backendAddresses	ApplicationGatewayBackendAddress[]	Alamat backend.
properties.backendIPConfigurations	NetworkInterfaceIPConfiguration[]	Kumpulan referensi ke IP yang ditentukan dalam antarmuka jaringan.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya kumpulan alamat backend.
type	string	Jenis sumber daya.

ApplicationGatewayIPConfiguration

Konfigurasi IP gateway aplikasi. Saat ini 1 konfigurasi IP publik dan 1 privat diizinkan.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama konfigurasi IP yang unik dalam Application Gateway.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya konfigurasi IP gateway aplikasi.
properties.subnet	SubResource	Referensi ke sumber daya subnet. Subnet dari mana gateway aplikasi mendapatkan alamat privatnya.
type	string	Jenis sumber daya.

ApplicationSecurityGroup

Grup keamanan aplikasi dalam grup sumber daya.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya grup keamanan aplikasi.
properties.resourceGuid	string	Properti GUID sumber daya dari sumber daya grup keamanan aplikasi. Ini secara unik mengidentifikasi sumber daya, bahkan jika pengguna mengubah namanya atau memigrasikan sumber daya di seluruh langganan atau grup sumber daya.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

AutoApproval

Daftar persetujuan otomatis layanan tautan privat.

Name	Type	Description
subscriptions	string[]	Daftar langganan.

BackendAddressPool

Kumpulan alamat IP backend.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam kumpulan kumpulan alamat backend yang digunakan oleh load balancer. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.backendIPConfigurations	NetworkInterfaceIPConfiguration[]	Array referensi ke alamat IP yang ditentukan dalam antarmuka jaringan.
properties.drainPeriodInSeconds	integer	Jumlah detik Load Balancer menunggu sebelum mengirim RESET ke alamat klien dan backend.
properties.inboundNatRules	SubResource[]	Array referensi ke aturan NAT masuk yang menggunakan kumpulan alamat backend ini.
properties.loadBalancerBackendAddresses	LoadBalancerBackendAddress[]	Array alamat backend.
properties.loadBalancingRules	SubResource[]	Array referensi untuk aturan penyeimbangan beban yang menggunakan kumpulan alamat backend ini.
properties.location	string	Lokasi kumpulan alamat backend.
properties.outboundRule	SubResource	Referensi ke aturan keluar yang menggunakan kumpulan alamat backend ini.
properties.outboundRules	SubResource[]	Array referensi ke aturan keluar yang menggunakan kumpulan alamat backend ini.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya kumpulan alamat backend.
properties.tunnelInterfaces	GatewayLoadBalancerTunnelInterface[]	Array antarmuka terowongan load balancer gateway.
type	string	Jenis sumber daya.

CloudError

Respons kesalahan dari layanan.

Name	Type	Description
error	CloudErrorBody	Isi kesalahan cloud.

CloudErrorBody

Respons kesalahan dari layanan.

Name	Type	Description
code	string	Pengidentifikasi untuk kesalahan. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.
details	CloudErrorBody[]	Daftar detail tambahan tentang kesalahan.
message	string	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
target	string	Target kesalahan tertentu. Misalnya, nama properti dalam kesalahan.

CustomDnsConfigPropertiesFormat

Berisi konfigurasi resolusi Dns kustom dari pelanggan.

Name	Type	Description
fqdn	string	Fqdn yang diselesaikan ke alamat ip titik akhir privat.
ipAddresses	string[]	Daftar alamat IP privat titik akhir privat.

DdosSettings

Berisi pengaturan perlindungan DDoS DARI IP publik.

Name	Type	Description
ddosCustomPolicy	SubResource	Kebijakan kustom DDoS yang terkait dengan IP publik.
protectedIP	boolean	Mengaktifkan perlindungan DDoS pada IP publik.
protectionCoverage	DdosSettingsProtectionCoverage	Penyesuaian kebijakan perlindungan DDoS dari IP publik. Hanya cakupan standar yang akan memiliki kemampuan untuk disesuaikan.

DdosSettingsProtectionCoverage

Penyesuaian kebijakan perlindungan DDoS dari IP publik. Hanya cakupan standar yang akan memiliki kemampuan untuk disesuaikan.

Name	Type	Description
Basic	string
Standard	string

Delegation

Merinci layanan tempat subnet didelegasikan.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam subnet. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.actions	string[]	Tindakan yang diizinkan untuk layanan saat delegasi.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya delegasi layanan.
properties.serviceName	string	Nama layanan yang subnetnya harus didelegasikan (misalnya Microsoft.Sql/servers).
type	string	Jenis sumber daya

DeleteOptions

Tentukan apa yang terjadi pada alamat IP publik saat VM menggunakannya dihapus

Name	Type	Description
Delete	string
Detach	string

ExtendedLocation

Jenis kompleks ExtendedLocation.

Name	Type	Description
name	string	Nama lokasi yang diperluas.
type	ExtendedLocationTypes	Jenis lokasi yang diperluas.

ExtendedLocationTypes

Jenis lokasi yang diperluas.

Name	Type	Description
EdgeZone	string

FlowLog

Sumber daya log alur.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.enabled	boolean	Bendera untuk mengaktifkan/menonaktifkan pengelogan alur.
properties.flowAnalyticsConfiguration	TrafficAnalyticsProperties	Parameter yang menentukan konfigurasi analitik lalu lintas.
properties.format	FlowLogFormatParameters	Parameter yang menentukan format log alur.
properties.provisioningState	ProvisioningState	Status penyediaan log alur.
properties.retentionPolicy	RetentionPolicyParameters	Parameter yang menentukan kebijakan penyimpanan untuk log alur.
properties.storageId	string	ID akun penyimpanan yang digunakan untuk menyimpan log alur.
properties.targetResourceGuid	string	Guid kelompok keamanan jaringan tempat log alur akan diterapkan.
properties.targetResourceId	string	ID grup keamanan jaringan tempat log alur akan diterapkan.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

FlowLogFormatParameters

Parameter yang menentukan format log alur.

Name	Type	Default Value	Description
type	FlowLogFormatType		Jenis file log alur.
version	integer	0	Versi (revisi) log alur.

FlowLogFormatType

Jenis file log alur.

Name	Type	Description
JSON	string

FrontendIPConfiguration

Alamat IP frontend dari load balancer.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam kumpulan konfigurasi IP frontend yang digunakan oleh load balancer. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.gatewayLoadBalancer	SubResource	Referensi ke IP frontend load balancer gateway.
properties.inboundNatPools	SubResource[]	Array referensi ke kumpulan masuk yang menggunakan IP frontend ini.
properties.inboundNatRules	SubResource[]	Array referensi ke aturan masuk yang menggunakan IP frontend ini.
properties.loadBalancingRules	SubResource[]	Array referensi untuk aturan penyeimbangan beban yang menggunakan IP frontend ini.
properties.outboundRules	SubResource[]	Array referensi ke aturan keluar yang menggunakan IP frontend ini.
properties.privateIPAddress	string	Alamat IP privat konfigurasi IP.
properties.privateIPAddressVersion	IPVersion	Apakah ipconfiguration tertentu adalah IPv4 atau IPv6. Default diambil sebagai IPv4.
properties.privateIPAllocationMethod	IPAllocationMethod	Metode alokasi IP Privat.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya konfigurasi IP frontend.
properties.publicIPAddress	PublicIPAddress	Referensi ke sumber daya IP Publik.
properties.publicIPPrefix	SubResource	Referensi ke sumber daya Prefiks IP Publik.
properties.subnet	Subnet	Referensi ke sumber daya subnet.
type	string	Jenis sumber daya.
zones	string[]	Daftar zona ketersediaan yang menunjukkan IP yang dialokasikan untuk kebutuhan sumber daya.

GatewayLoadBalancerTunnelInterface

Antarmuka terowongan load balancer gateway dari kumpulan alamat backend load balancer.

Name	Type	Description
identifier	integer	Pengidentifikasi antarmuka terowongan load balancer gateway.
port	integer	Port antarmuka terowongan load balancer gateway.
protocol	GatewayLoadBalancerTunnelProtocol	Protokol antarmuka terowongan load balancer gateway.
type	GatewayLoadBalancerTunnelInterfaceType	Jenis lalu lintas antarmuka terowongan load balancer gateway.

GatewayLoadBalancerTunnelInterfaceType

Jenis lalu lintas antarmuka terowongan load balancer gateway.

Name	Type	Description
External	string
Internal	string
None	string

GatewayLoadBalancerTunnelProtocol

Protokol antarmuka terowongan load balancer gateway.

Name	Type	Description
Native	string
None	string
VXLAN	string

InboundNatPool

Kumpulan NAT masuk dari load balancer.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam kumpulan NAT masuk yang digunakan oleh load balancer. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.backendPort	integer	Port yang digunakan untuk koneksi internal pada titik akhir. Nilai yang dapat diterima adalah antara 1 dan 65535.
properties.enableFloatingIP	boolean	Mengonfigurasi titik akhir komputer virtual untuk kemampuan IP mengambang yang diperlukan untuk mengonfigurasi Grup Ketersediaan SQL AlwaysOn. Pengaturan ini diperlukan saat menggunakan Grup Ketersediaan SQL AlwaysOn di server SQL. Pengaturan ini tidak dapat diubah setelah Anda membuat titik akhir.
properties.enableTcpReset	boolean	Terima Pengaturan Ulang TCP dua arah pada batas waktu diam aliran TCP atau penghentian koneksi yang tidak terduga. Elemen ini hanya digunakan ketika protokol diatur ke TCP.
properties.frontendIPConfiguration	SubResource	Referensi ke alamat IP frontend.
properties.frontendPortRangeEnd	integer	Nomor port terakhir dalam rentang port eksternal yang akan digunakan untuk menyediakan Nat Masuk ke NIC yang terkait dengan load balancer. Rentang nilai yang dapat diterima antara 1 dan 65535.
properties.frontendPortRangeStart	integer	Nomor port pertama dalam rentang port eksternal yang akan digunakan untuk menyediakan Nat Masuk ke NIC yang terkait dengan load balancer. Rentang nilai yang dapat diterima antara 1 dan 65534.
properties.idleTimeoutInMinutes	integer	Batas waktu untuk koneksi diam TCP. Nilainya dapat diatur antara 4 dan 30 menit. Nilai defaultnya adalah 4 menit. Elemen ini hanya digunakan ketika protokol diatur ke TCP.
properties.protocol	TransportProtocol	Referensi ke protokol transportasi yang digunakan oleh kumpulan NAT masuk.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya kumpulan NAT masuk.
type	string	Jenis sumber daya.

InboundNatRule

Aturan NAT masuk dari load balancer.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam kumpulan aturan NAT masuk yang digunakan oleh load balancer. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.backendAddressPool	SubResource	Referensi ke sumber daya backendAddressPool.
properties.backendIPConfiguration	NetworkInterfaceIPConfiguration	Referensi ke alamat IP privat yang ditentukan pada antarmuka jaringan VM. Lalu lintas yang dikirim ke port frontend masing-masing konfigurasi IP frontend diteruskan ke IP backend.
properties.backendPort	integer	Port yang digunakan untuk titik akhir internal. Nilai yang dapat diterima berkisar antara 1 hingga 65535.
properties.enableFloatingIP	boolean	Mengonfigurasi titik akhir komputer virtual untuk kemampuan IP mengambang yang diperlukan untuk mengonfigurasi Grup Ketersediaan SQL AlwaysOn. Pengaturan ini diperlukan saat menggunakan Grup Ketersediaan SQL AlwaysOn di server SQL. Pengaturan ini tidak dapat diubah setelah Anda membuat titik akhir.
properties.enableTcpReset	boolean	Terima Pengaturan Ulang TCP dua arah pada batas waktu diam aliran TCP atau penghentian koneksi yang tidak terduga. Elemen ini hanya digunakan ketika protokol diatur ke TCP.
properties.frontendIPConfiguration	SubResource	Referensi ke alamat IP frontend.
properties.frontendPort	integer	Port untuk titik akhir eksternal. Nomor port untuk setiap aturan harus unik dalam Load Balancer. Nilai yang dapat diterima berkisar antara 1 hingga 65534.
properties.frontendPortRangeEnd	integer	Rentang port berakhir untuk titik akhir eksternal. Properti ini digunakan bersama dengan BackendAddressPool dan FrontendPortRangeStart. Pemetaan port aturan NAT masuk individu akan dibuat untuk setiap alamat backend dari BackendAddressPool. Nilai yang dapat diterima berkisar antara 1 hingga 65534.
properties.frontendPortRangeStart	integer	Rentang port dimulai untuk titik akhir eksternal. Properti ini digunakan bersama dengan BackendAddressPool dan FrontendPortRangeEnd. Pemetaan port aturan NAT masuk individu akan dibuat untuk setiap alamat backend dari BackendAddressPool. Nilai yang dapat diterima berkisar antara 1 hingga 65534.
properties.idleTimeoutInMinutes	integer	Batas waktu untuk koneksi diam TCP. Nilainya dapat diatur antara 4 dan 30 menit. Nilai defaultnya adalah 4 menit. Elemen ini hanya digunakan ketika protokol diatur ke TCP.
properties.protocol	TransportProtocol	Referensi ke protokol transportasi yang digunakan oleh aturan penyeimbangan beban.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya aturan NAT masuk.
type	string	Jenis sumber daya.

IPAllocationMethod

Metode alokasi alamat IP.

Name	Type	Description
Dynamic	string
Static	string

IPConfiguration

Konfigurasi IP.

Name	Type	Default Value	Description
etag	string		String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string		ID Sumber Daya.
name	string		Nama sumber daya yang unik dalam grup sumber daya. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.privateIPAddress	string		Alamat IP privat konfigurasi IP.
properties.privateIPAllocationMethod	IPAllocationMethod	Dynamic	Metode alokasi alamat IP privat.
properties.provisioningState	ProvisioningState		Status penyediaan sumber daya konfigurasi IP.
properties.publicIPAddress	PublicIPAddress		Referensi ke sumber daya IP publik.
properties.subnet	Subnet		Referensi ke sumber daya subnet.

IPConfigurationProfile

Sumber daya anak profil konfigurasi IP.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya profil konfigurasi IP.
properties.subnet	Subnet	Referensi ke sumber daya subnet untuk membuat konfigurasi ip antarmuka jaringan kontainer.
type	string	Jenis Sub Sumber Daya.

IpTag

Berisi IpTag yang terkait dengan objek .

Name	Type	Description
ipTagType	string	Jenis tag IP. Contoh: FirstPartyUsage.
tag	string	Nilai tag IP yang terkait dengan IP publik. Contoh: SQL.

IPVersion

Versi alamat IP.

Name	Type	Description
IPv4	string
IPv6	string

LoadBalancer

Sumber daya LoadBalancer.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
extendedLocation	ExtendedLocation	Lokasi penyeimbang beban yang diperluas.
id	string	ID Sumber Daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.backendAddressPools	BackendAddressPool[]	Kumpulan kumpulan alamat backend yang digunakan oleh load balancer.
properties.frontendIPConfigurations	FrontendIPConfiguration[]	Objek yang mewakili IP frontend yang akan digunakan untuk load balancer.
properties.inboundNatPools	InboundNatPool[]	Menentukan rentang port eksternal untuk NAT masuk ke satu port backend pada NIC yang terkait dengan load balancer. Aturan NAT masuk dibuat secara otomatis untuk setiap NIC yang terkait dengan Load Balancer menggunakan port eksternal dari rentang ini. Menentukan kumpulan NAT Masuk pada Load Balancer Anda saling eksklusif dengan menentukan aturan NAT masuk. Kumpulan NAT masuk dirujuk dari set skala komputer virtual. NIC yang terkait dengan komputer virtual individual tidak dapat mereferensikan kumpulan NAT masuk. Mereka harus mereferensikan aturan NAT masuk individu.
properties.inboundNatRules	InboundNatRule[]	Kumpulan Aturan NAT masuk yang digunakan oleh load balancer. Menentukan aturan NAT masuk pada load balancer Anda saling eksklusif dengan menentukan kumpulan NAT masuk. Kumpulan NAT masuk dirujuk dari set skala komputer virtual. NIC yang terkait dengan komputer virtual individual tidak dapat mereferensikan kumpulan NAT Masuk. Mereka harus mereferensikan aturan NAT masuk individu.
properties.loadBalancingRules	LoadBalancingRule[]	Koleksi objek yang mewakili aturan penyeimbangan beban Mendapatkan provisi.
properties.outboundRules	OutboundRule[]	Aturan keluar.
properties.probes	Probe[]	Kumpulan objek pemeriksaan yang digunakan dalam load balancer.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya load balancer.
properties.resourceGuid	string	Properti GUID sumber daya dari sumber daya load balancer.
sku	LoadBalancerSku	SKU load balancer.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

LoadBalancerBackendAddress

Alamat backend load balancer.

Name	Type	Description
name	string	Nama alamat backend.
properties.adminState	LoadBalancerBackendAddressAdminState	Daftar status administratif yang setelah diatur dapat menimpa pemeriksaan kesehatan sehingga Load Balancer akan selalu meneruskan koneksi baru ke backend, atau menolak koneksi baru dan mengatur ulang koneksi yang ada.
properties.inboundNatRulesPortMapping	NatRulePortMapping[]	Kumpulan pemetaan port aturan NAT masuk.
properties.ipAddress	string	Alamat IP milik jaringan virtual yang dirujuk.
properties.loadBalancerFrontendIPConfiguration	SubResource	Referensi ke konfigurasi alamat ip frontend yang ditentukan dalam loadbalancer regional.
properties.networkInterfaceIPConfiguration	SubResource	Referensi ke alamat IP yang ditentukan dalam antarmuka jaringan.
properties.subnet	SubResource	Referensi ke subnet yang ada.
properties.virtualNetwork	SubResource	Referensi ke jaringan virtual yang ada.

LoadBalancerBackendAddressAdminState

Daftar status administratif yang setelah diatur dapat mengambil alih pemeriksaan kesehatan sehingga Load Balancer akan selalu meneruskan koneksi baru ke backend, atau menolak koneksi baru dan mengatur ulang koneksi yang ada.

Name	Type	Description
Down	string
Drain	string
None	string
Up	string

LoadBalancerOutboundRuleProtocol

Protokol untuk aturan keluar di load balancer.

Name	Type	Description
All	string
Tcp	string
Udp	string

LoadBalancerSku

SKU load balancer.

Name	Type	Description
name	LoadBalancerSkuName	Nama SKU load balancer.
tier	LoadBalancerSkuTier	Tingkat SKU load balancer.

LoadBalancerSkuName

Nama SKU load balancer.

Name	Type	Description
Basic	string
Gateway	string
Standard	string

LoadBalancerSkuTier

Tingkat SKU load balancer.

Name	Type	Description
Global	string
Regional	string

LoadBalancingRule

Aturan penyeimbangan beban untuk load balancer.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam sekumpulan aturan penyeimbangan beban yang digunakan oleh load balancer. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.backendAddressPool	SubResource	Referensi ke kumpulan DIP. Lalu lintas masuk secara acak dimuat seimbang di seluruh IP di IP backend.
properties.backendAddressPools	SubResource[]	Array referensi ke kumpulan DIP.
properties.backendPort	integer	Port yang digunakan untuk koneksi internal pada titik akhir. Nilai yang dapat diterima adalah antara 0 dan 65535. Perhatikan bahwa nilai 0 memungkinkan "Port Apa Pun".
properties.disableOutboundSnat	boolean	Mengonfigurasi SNAT untuk VM di kumpulan backend untuk menggunakan alamat publicIP yang ditentukan di frontend aturan penyeimbangan beban.
properties.enableFloatingIP	boolean	Mengonfigurasi titik akhir komputer virtual untuk kemampuan IP mengambang yang diperlukan untuk mengonfigurasi SQL Grup Ketersediaan AlwaysOn. Pengaturan ini diperlukan saat menggunakan Grup Ketersediaan SQL AlwaysOn di server SQL. Pengaturan ini tidak dapat diubah setelah Anda membuat titik akhir.
properties.enableTcpReset	boolean	Terima Pengaturan Ulang TCP dua arah pada batas waktu diam aliran TCP atau penghentian koneksi yang tidak terduga. Elemen ini hanya digunakan ketika protokol diatur ke TCP.
properties.frontendIPConfiguration	SubResource	Referensi ke alamat IP frontend.
properties.frontendPort	integer	Port untuk titik akhir eksternal. Nomor port untuk setiap aturan harus unik dalam Load Balancer. Nilai yang dapat diterima adalah antara 0 dan 65534. Perhatikan bahwa nilai 0 memungkinkan "Port Apa Pun".
properties.idleTimeoutInMinutes	integer	Batas waktu untuk koneksi diam TCP. Nilainya dapat diatur antara 4 dan 30 menit. Nilai defaultnya adalah 4 menit. Elemen ini hanya digunakan ketika protokol diatur ke TCP.
properties.loadDistribution	LoadDistribution	Kebijakan distribusi beban untuk aturan ini.
properties.probe	SubResource	Referensi ke pemeriksaan load balancer yang digunakan oleh aturan penyeimbangan beban.
properties.protocol	TransportProtocol	Referensi ke protokol transportasi yang digunakan oleh aturan penyeimbangan beban.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya aturan penyeimbangan beban.
type	string	Jenis sumber daya.

LoadDistribution

Kebijakan distribusi beban untuk aturan ini.

Name	Type	Description
Default	string
SourceIP	string
SourceIPProtocol	string

NatGateway

Sumber daya Nat Gateway.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.idleTimeoutInMinutes	integer	Batas waktu menganggur gateway nat.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya gateway NAT.
properties.publicIpAddresses	SubResource[]	Array alamat IP publik yang terkait dengan sumber daya gateway nat.
properties.publicIpPrefixes	SubResource[]	Array prefiks ip publik yang terkait dengan sumber daya gateway nat.
properties.resourceGuid	string	Properti GUID sumber daya dari sumber daya gateway NAT.
properties.subnets	SubResource[]	Array referensi ke subnet menggunakan sumber daya gateway nat ini.
sku	NatGatewaySku	SKU gateway nat.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya
zones	string[]	Daftar zona ketersediaan yang menunjukkan zona tempat Nat Gateway harus disebarkan.

NatGatewaySku

SKU gateway nat.

Name	Type	Description
name	NatGatewaySkuName	Nama SKU Nat Gateway.

NatGatewaySkuName

Nama SKU Nat Gateway.

Name	Type	Description
Standard	string

NatRulePortMapping

Pemetaan port individual untuk aturan NAT masuk yang dibuat untuk kumpulan backend.

Name	Type	Description
backendPort	integer	Port backend.
frontendPort	integer	Port ujung depan.
inboundNatRuleName	string	Nama aturan NAT masuk.

NetworkInterface

Antarmuka jaringan dalam grup sumber daya.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
extendedLocation	ExtendedLocation	Lokasi antarmuka jaringan yang diperluas.
id	string	ID Sumber Daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	Mode tambahan sumber daya Antarmuka Jaringan.
properties.dnsSettings	NetworkInterfaceDnsSettings	Pengaturan DNS di antarmuka jaringan.
properties.dscpConfiguration	SubResource	Referensi ke konfigurasi dscp tempat antarmuka jaringan ditautkan.
properties.enableAcceleratedNetworking	boolean	Jika antarmuka jaringan diaktifkan jaringan yang dipercepat.
properties.enableIPForwarding	boolean	Menunjukkan apakah penerusan IP diaktifkan pada antarmuka jaringan ini.
properties.hostedWorkloads	string[]	Daftar referensi ke sumber daya BareMetal tertaut.
properties.ipConfigurations	NetworkInterfaceIPConfiguration[]	Daftar IPConfigurations antarmuka jaringan.
properties.macAddress	string	Alamat MAC antarmuka jaringan.
properties.migrationPhase	NetworkInterfaceMigrationPhase	Fase migrasi sumber daya Antarmuka Jaringan.
properties.networkSecurityGroup	NetworkSecurityGroup	Referensi ke sumber daya NetworkSecurityGroup.
properties.nicType	NetworkInterfaceNicType	Jenis sumber daya Antarmuka Jaringan.
properties.primary	boolean	Apakah ini adalah antarmuka jaringan utama pada komputer virtual.
properties.privateEndpoint	PrivateEndpoint	Referensi ke titik akhir privat tempat antarmuka jaringan ditautkan.
properties.privateLinkService	PrivateLinkService	Privatelinkservice sumber daya antarmuka jaringan.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya antarmuka jaringan.
properties.resourceGuid	string	Properti GUID sumber daya dari sumber daya antarmuka jaringan.
properties.tapConfigurations	NetworkInterfaceTapConfiguration[]	Daftar TapConfigurations antarmuka jaringan.
properties.virtualMachine	SubResource	Referensi ke komputer virtual.
properties.vnetEncryptionSupported	boolean	Apakah komputer virtual nic ini dilampirkan untuk mendukung enkripsi.
properties.workloadType	string	WorkloadType dari NetworkInterface untuk sumber daya BareMetal
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

NetworkInterfaceAuxiliaryMode

Mode tambahan sumber daya Antarmuka Jaringan.

Name	Type	Description
Floating	string
MaxConnections	string
None	string

NetworkInterfaceDnsSettings

Pengaturan DNS antarmuka jaringan.

Name	Type	Description
appliedDnsServers	string[]	Jika VM yang menggunakan NIC ini adalah bagian dari Set Ketersediaan, maka daftar ini akan memiliki penyatuan semua server DNS dari semua NIC yang merupakan bagian dari Set Ketersediaan. Properti ini adalah apa yang dikonfigurasi pada masing-masing VM tersebut.
dnsServers	string[]	Daftar alamat IP server DNS. Gunakan 'AzureProvidedDNS' untuk beralih ke resolusi DNS yang disediakan Azure. Nilai 'AzureProvidedDNS' tidak dapat digabungkan dengan IP lain, itu harus menjadi satu-satunya nilai dalam koleksi dnsServers.
internalDnsNameLabel	string	Nama DNS relatif untuk NIC ini digunakan untuk komunikasi internal antara VM dalam jaringan virtual yang sama.
internalDomainNameSuffix	string	Bahkan jika internalDnsNameLabel tidak ditentukan, entri DNS dibuat untuk NIC utama VM. Nama DNS ini dapat dibuat dengan menggabungkan nama VM dengan nilai internalDomainNameSuffix.
internalFqdn	string	Nama DNS yang sepenuhnya memenuhi syarat mendukung komunikasi internal antara VM di jaringan virtual yang sama.

NetworkInterfaceIPConfiguration

IPConfiguration dalam antarmuka jaringan.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam grup sumber daya. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.applicationGatewayBackendAddressPools	ApplicationGatewayBackendAddressPool[]	Referensi ke sumber daya ApplicationGatewayBackendAddressPool.
properties.applicationSecurityGroups	ApplicationSecurityGroup[]	Grup keamanan aplikasi tempat konfigurasi IP disertakan.
properties.gatewayLoadBalancer	SubResource	Referensi ke IP frontend load balancer gateway.
properties.loadBalancerBackendAddressPools	BackendAddressPool[]	Referensi ke sumber daya LoadBalancerBackendAddressPool.
properties.loadBalancerInboundNatRules	InboundNatRule[]	Daftar referensi LoadBalancerInboundNatRules.
properties.primary	boolean	Apakah ini adalah alamat pelanggan utama pada antarmuka jaringan.
properties.privateIPAddress	string	Alamat IP privat konfigurasi IP.
properties.privateIPAddressVersion	IPVersion	Apakah konfigurasi IP tertentu adalah IPv4 atau IPv6. Defaultnya adalah IPv4.
properties.privateIPAllocationMethod	IPAllocationMethod	Metode alokasi alamat IP privat.
properties.privateLinkConnectionProperties	NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties	Properti PrivateLinkConnection untuk antarmuka jaringan.
properties.provisioningState	ProvisioningState	Status penyediaan konfigurasi IP antarmuka jaringan.
properties.publicIPAddress	PublicIPAddress	Alamat IP publik terikat ke konfigurasi IP.
properties.subnet	Subnet	Subnet terikat ke konfigurasi IP.
properties.virtualNetworkTaps	VirtualNetworkTap[]	Referensi ke ketuk Virtual Network.
type	string	Jenis sumber daya

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties

Properti PrivateLinkConnection untuk antarmuka jaringan.

Name	Type	Description
fqdns	string[]	Daftar FQDN untuk koneksi tautan privat saat ini.
groupId	string	ID grup untuk koneksi tautan privat saat ini.
requiredMemberName	string	Nama anggota yang diperlukan untuk koneksi tautan privat saat ini.

NetworkInterfaceMigrationPhase

Fase migrasi sumber daya Antarmuka Jaringan.

Name	Type	Description
Abort	string
Commit	string
Committed	string
None	string
Prepare	string

NetworkInterfaceNicType

Jenis sumber daya Antarmuka Jaringan.

Name	Type	Description
Elastic	string
Standard	string

NetworkInterfaceTapConfiguration

Ketuk konfigurasi di Antarmuka Jaringan.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam grup sumber daya. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.provisioningState	ProvisioningState	Status provisi sumber daya konfigurasi ketuk antarmuka jaringan.
properties.virtualNetworkTap	VirtualNetworkTap	Referensi ke sumber daya Virtual Network Tap.
type	string	Jenis Sub Sumber Daya.

NetworkSecurityGroup

Sumber daya NetworkSecurityGroup.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.defaultSecurityRules	SecurityRule[]	Aturan keamanan default grup keamanan jaringan.
properties.flowLogs	FlowLog[]	Kumpulan referensi untuk mengalirkan sumber daya log.
properties.networkInterfaces	NetworkInterface[]	Kumpulan referensi ke antarmuka jaringan.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya grup keamanan jaringan.
properties.resourceGuid	string	Properti GUID sumber daya dari sumber daya grup keamanan jaringan.
properties.securityRules	SecurityRule[]	Kumpulan aturan keamanan kelompok keamanan jaringan.
properties.subnets	Subnet[]	Kumpulan referensi ke subnet.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

OutboundRule

Aturan keluar dari load balancer.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam kumpulan aturan keluar yang digunakan oleh load balancer. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.allocatedOutboundPorts	integer	Jumlah port keluar yang akan digunakan untuk NAT.
properties.backendAddressPool	SubResource	Referensi ke kumpulan DIP. Lalu lintas keluar secara acak dimuat seimbang di seluruh IP di IP backend.
properties.enableTcpReset	boolean	Terima Pengaturan Ulang TCP dua arah pada batas waktu diam aliran TCP atau penghentian koneksi yang tidak terduga. Elemen ini hanya digunakan ketika protokol diatur ke TCP.
properties.frontendIPConfigurations	SubResource[]	Alamat IP Frontend dari load balancer.
properties.idleTimeoutInMinutes	integer	Batas waktu untuk koneksi diam TCP.
properties.protocol	LoadBalancerOutboundRuleProtocol	Protokol untuk aturan keluar di load balancer.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya aturan keluar.
type	string	Jenis sumber daya.

PrivateEndpoint

Sumber daya titik akhir privat.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
extendedLocation	ExtendedLocation	Lokasi penyeimbang beban yang diperluas.
id	string	ID Sumber Daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.applicationSecurityGroups	ApplicationSecurityGroup[]	Grup keamanan aplikasi tempat konfigurasi IP titik akhir privat disertakan.
properties.customDnsConfigs	CustomDnsConfigPropertiesFormat[]	Array konfigurasi dns kustom.
properties.customNetworkInterfaceName	string	Nama kustom antarmuka jaringan yang dilampirkan ke titik akhir privat.
properties.ipConfigurations	PrivateEndpointIPConfiguration[]	Daftar konfigurasi IP titik akhir privat. Ini akan digunakan untuk memetakan ke titik akhir Layanan Pihak Pertama.
properties.manualPrivateLinkServiceConnections	PrivateLinkServiceConnection[]	Pengelompokan informasi tentang koneksi ke sumber daya jarak jauh. Digunakan ketika admin jaringan tidak memiliki akses untuk menyetujui koneksi ke sumber daya jarak jauh.
properties.networkInterfaces	NetworkInterface[]	Array referensi ke antarmuka jaringan yang dibuat untuk titik akhir privat ini.
properties.privateLinkServiceConnections	PrivateLinkServiceConnection[]	Pengelompokan informasi tentang koneksi ke sumber daya jarak jauh.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya titik akhir privat.
properties.subnet	Subnet	ID subnet tempat IP privat akan dialokasikan.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

PrivateEndpointConnection

Sumber daya PrivateEndpointConnection.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam grup sumber daya. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.linkIdentifier	string	Id tautan konsumen.
properties.privateEndpoint	PrivateEndpoint	Sumber daya titik akhir privat.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya koneksi titik akhir privat.
type	string	Jenis sumber daya.

PrivateEndpointIPConfiguration

Konfigurasi IP titik akhir privat.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
name	string	Nama sumber daya yang unik dalam grup sumber daya.
properties.groupId	string	ID grup yang diperoleh dari sumber daya jarak jauh yang harus disambungkan oleh titik akhir privat ini.
properties.memberName	string	Nama anggota grup yang diperoleh dari sumber daya jarak jauh yang harus disambungkan oleh titik akhir privat ini.
properties.privateIPAddress	string	Alamat IP privat yang diperoleh dari subnet titik akhir privat.
type	string	Jenis sumber daya.

PrivateLinkService

Sumber daya layanan tautan privat.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
extendedLocation	ExtendedLocation	Lokasi penyeimbang beban yang diperluas.
id	string	ID Sumber Daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.alias	string	Alias layanan tautan privat.
properties.autoApproval	AutoApproval	Daftar persetujuan otomatis layanan tautan privat.
properties.enableProxyProtocol	boolean	Apakah layanan tautan privat diaktifkan untuk protokol proksi atau tidak.
properties.fqdns	string[]	Daftar Fqdn.
properties.ipConfigurations	PrivateLinkServiceIpConfiguration[]	Array konfigurasi IP layanan tautan privat.
properties.loadBalancerFrontendIpConfigurations	FrontendIPConfiguration[]	Array referensi ke konfigurasi IP load balancer.
properties.networkInterfaces	NetworkInterface[]	Array referensi ke antarmuka jaringan yang dibuat untuk layanan tautan privat ini.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Array daftar tentang koneksi ke titik akhir privat.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya layanan tautan privat.
properties.visibility	Visibility	Daftar visibilitas layanan tautan privat.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

PrivateLinkServiceConnection

Sumber daya PrivateLinkServiceConnection.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam grup sumber daya. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.groupIds	string[]	ID grup yang diperoleh dari sumber daya jarak jauh yang harus disambungkan oleh titik akhir privat ini.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Kumpulan informasi baca-saja tentang status koneksi ke sumber daya jarak jauh.
properties.privateLinkServiceId	string	Id sumber daya layanan tautan privat.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya koneksi layanan tautan privat.
properties.requestMessage	string	Pesan yang diteruskan ke pemilik sumber daya jarak jauh dengan permintaan koneksi ini. Dibatasi hingga 140 karakter.
type	string	Jenis sumber daya.

PrivateLinkServiceConnectionState

Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.

Name	Type	Description
actionsRequired	string	Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.
description	string	Alasan persetujuan/penolakan koneksi.
status	string	Menunjukkan apakah koneksi telah Disetujui/Ditolak/Dihapus oleh pemilik layanan.

PrivateLinkServiceIpConfiguration

Konfigurasi ip layanan tautan privat.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama konfigurasi ip layanan tautan privat.
properties.primary	boolean	Apakah konfigurasi ip adalah primer atau tidak.
properties.privateIPAddress	string	Alamat IP privat konfigurasi IP.
properties.privateIPAddressVersion	IPVersion	Apakah konfigurasi IP tertentu adalah IPv4 atau IPv6. Defaultnya adalah IPv4.
properties.privateIPAllocationMethod	IPAllocationMethod	Metode alokasi alamat IP privat.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya konfigurasi IP layanan tautan privat.
properties.subnet	Subnet	Referensi ke sumber daya subnet.
type	string	Jenis sumber daya.

Probe

Pemeriksaan load balancer.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam kumpulan probe yang digunakan oleh load balancer. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.intervalInSeconds	integer	Interval, dalam detik, untuk seberapa sering menyelidiki status kesehatan titik akhir. Biasanya, interval sedikit kurang dari setengah periode waktu habis yang dialokasikan (dalam detik) yang memungkinkan dua pemeriksaan penuh sebelum mengeluarkan instans dari rotasi. Nilai defaultnya adalah 15, nilai minimumnya adalah 5.
properties.loadBalancingRules	SubResource[]	Aturan load balancer yang menggunakan probe ini.
properties.numberOfProbes	integer	Jumlah pemeriksaan di mana jika tidak ada respons, akan mengakibatkan menghentikan lalu lintas lebih lanjut dikirim ke titik akhir. Nilai ini memungkinkan titik akhir diambil dari rotasi lebih cepat atau lebih lambat dari waktu umum yang digunakan di Azure.
properties.port	integer	Port untuk mengomunikasikan pemeriksaan. Kemungkinan nilainya berkisar dari 1 sampai 65535, secara inklusif.
properties.protocol	ProbeProtocol	Protokol titik akhir. Jika 'Tcp' ditentukan, ACK yang diterima diperlukan agar pemeriksaan berhasil. Jika 'Http' atau 'Https' ditentukan, respons 200 OK dari URI yang ditentukan diperlukan agar pemeriksaan berhasil.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya probe.
properties.requestPath	string	URI yang digunakan untuk meminta status kesehatan dari VM. Jalur diperlukan jika protokol diatur ke http. Jika tidak, hal ini tidak diperbolehkan. Tidak ada nilai default.
type	string	Jenis sumber daya.

ProbeProtocol

Protokol titik akhir. Jika 'Tcp' ditentukan, ACK yang diterima diperlukan agar pemeriksaan berhasil. Jika 'Http' atau 'Https' ditentukan, respons 200 OK dari URI yang ditentukan diperlukan agar pemeriksaan berhasil.

Name	Type	Description
Http	string
Https	string
Tcp	string

ProvisioningState

Status penyediaan saat ini.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

PublicIPAddress

Sumber daya alamat IP publik.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
extendedLocation	ExtendedLocation	Lokasi alamat IP publik yang diperluas.
id	string	ID Sumber Daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.ddosSettings	DdosSettings	Kebijakan kustom perlindungan DDoS yang terkait dengan alamat IP publik.
properties.deleteOption	DeleteOptions	Tentukan apa yang terjadi pada alamat IP publik saat VM menggunakannya dihapus
properties.dnsSettings	PublicIPAddressDnsSettings	FQDN rekaman DNS yang terkait dengan alamat IP publik.
properties.idleTimeoutInMinutes	integer	Batas waktu menganggur alamat IP publik.
properties.ipAddress	string	Alamat IP yang terkait dengan sumber daya alamat IP publik.
properties.ipConfiguration	IPConfiguration	Konfigurasi IP yang terkait dengan alamat IP publik.
properties.ipTags	IpTag[]	Daftar tag yang terkait dengan alamat IP publik.
properties.linkedPublicIPAddress	PublicIPAddress	Alamat IP publik tertaut dari sumber daya alamat IP publik.
properties.migrationPhase	PublicIPAddressMigrationPhase	Fase migrasi Alamat IP Publik.
properties.natGateway	NatGateway	NatGateway untuk alamat IP Publik.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya alamat IP publik.
properties.publicIPAddressVersion	IPVersion	Versi alamat IP publik.
properties.publicIPAllocationMethod	IPAllocationMethod	Metode alokasi alamat IP publik.
properties.publicIPPrefix	SubResource	Awalan IP Publik tempat Alamat IP Publik ini harus dialokasikan.
properties.resourceGuid	string	Properti GUID sumber daya dari sumber daya alamat IP publik.
properties.servicePublicIPAddress	PublicIPAddress	Alamat IP publik layanan dari sumber daya alamat IP publik.
sku	PublicIPAddressSku	SKU alamat IP publik.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya
zones	string[]	Daftar zona ketersediaan yang menunjukkan IP yang dialokasikan untuk kebutuhan sumber daya.

PublicIPAddressDnsSettings

Berisi FQDN dari catatan DNS yang terkait dengan alamat IP publik.

Name	Type	Description
domainNameLabel	string	Label nama domain. Perangkaian label nama domain dan zona DNS regional membentuk nama domain yang sepenuhnya memenuhi syarat yang terkait dengan alamat IP publik. Jika label nama domain ditentukan, catatan DNS A dibuat untuk IP publik di sistem DNS Microsoft Azure.
fqdn	string	Nama Domain yang Sepenuhnya Memenuhi Syarat dari catatan DNS yang terkait dengan IP publik. Ini adalah perangkaian domainNameLabel dan zona DNS regional.
reverseFqdn	string	FQDN terbalik. Nama domain yang terlihat dan sepenuhnya memenuhi syarat pengguna yang diselesaikan ke alamat IP publik ini. Jika reverseFqdn ditentukan, maka catatan DNS PTR dibuat menunjuk dari alamat IP di domain in-addr.arpa ke FQDN terbalik.

PublicIPAddressMigrationPhase

Fase migrasi Alamat IP Publik.

Name	Type	Description
Abort	string
Commit	string
Committed	string
None	string
Prepare	string

PublicIPAddressSku

SKU alamat IP publik.

Name	Type	Description
name	PublicIPAddressSkuName	Nama SKU alamat IP publik.
tier	PublicIPAddressSkuTier	Tingkat SKU alamat IP publik.

PublicIPAddressSkuName

Nama SKU alamat IP publik.

Name	Type	Description
Basic	string
Standard	string

PublicIPAddressSkuTier

Tingkat SKU alamat IP publik.

Name	Type	Description
Global	string
Regional	string

ResourceNavigationLink

Sumber daya ResourceNavigationLink.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	Pengidentifikasi tautan navigasi sumber daya.
name	string	Nama sumber daya yang unik dalam grup sumber daya. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.link	string	Tautkan ke sumber daya eksternal.
properties.linkedResourceType	string	Jenis sumber daya dari sumber daya yang ditautkan.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya tautan navigasi sumber daya.
type	string	Jenis sumber daya

RetentionPolicyParameters

Parameter yang menentukan kebijakan penyimpanan untuk log alur.

Name	Type	Default Value	Description
days	integer	0	Jumlah hari untuk menyimpan rekaman log alur.
enabled	boolean	False	Bendera untuk mengaktifkan/menonaktifkan retensi.

Route

Rutekan sumber daya.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam grup sumber daya. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.addressPrefix	string	CIDR tujuan tempat rute berlaku.
properties.hasBgpOverride	boolean	Nilai yang menunjukkan apakah rute ini menimpa rute BGP yang tumpang tindih terlepas dari LPM.
properties.nextHopIpAddress	string	Paket alamat IP harus diteruskan. Nilai hop berikutnya hanya diizinkan dalam rute di mana jenis hop berikutnya adalah VirtualAppliance.
properties.nextHopType	RouteNextHopType	Jenis hop Azure tempat paket harus dikirim.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya rute.
type	string	Jenis sumber daya.

RouteNextHopType

Jenis hop Azure tempat paket harus dikirim.

Name	Type	Description
Internet	string
None	string
VirtualAppliance	string
VirtualNetworkGateway	string
VnetLocal	string

RouteTable

Sumber daya tabel rute.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.disableBgpRoutePropagation	boolean	Apakah akan menonaktifkan rute yang dipelajari oleh BGP pada tabel rute tersebut. Benar berarti menonaktifkan.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya tabel rute.
properties.resourceGuid	string	Properti GUID sumber daya dari tabel rute.
properties.routes	Route[]	Kumpulan rute yang terkandung dalam tabel rute.
properties.subnets	Subnet[]	Kumpulan referensi ke subnet.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

SecurityRule

Aturan keamanan jaringan.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam grup sumber daya. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.access	SecurityRuleAccess	Lalu lintas jaringan diizinkan atau ditolak.
properties.description	string	Deskripsi untuk aturan ini. Dibatasi hingga 140 karakter.
properties.destinationAddressPrefix	string	Awalan alamat tujuan. CIDR atau rentang IP tujuan. Tanda bintang '*' juga dapat digunakan untuk mencocokkan semua IP sumber. Tag default seperti 'VirtualNetwork', 'AzureLoadBalancer' dan 'Internet' juga dapat digunakan.
properties.destinationAddressPrefixes	string[]	Awalan alamat tujuan. CIDR atau rentang IP tujuan.
properties.destinationApplicationSecurityGroups	ApplicationSecurityGroup[]	Kelompok keamanan aplikasi ditentukan sebagai tujuan.
properties.destinationPortRange	string	Port atau rentang tujuan. Bilangan bulat atau rentang antara 0 dan 65535. Tanda bintang '*' juga dapat digunakan untuk mencocokkan semua port.
properties.destinationPortRanges	string[]	Rentang port tujuan.
properties.direction	SecurityRuleDirection	Arah aturan. Arah menentukan apakah aturan akan dievaluasi pada lalu lintas masuk atau keluar.
properties.priority	integer	Prioritas aturan. Nilainya bisa antara 100 dan 4096. Nomor prioritas harus unik untuk setiap aturan dalam koleksi. Semakin rendah jumlah prioritas, semakin tinggi prioritas aturan.
properties.protocol	SecurityRuleProtocol	Protokol jaringan yang berlaku untuk aturan ini.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya aturan keamanan.
properties.sourceAddressPrefix	string	CIDR atau rentang IP sumber. Tanda bintang '*' juga dapat digunakan untuk mencocokkan semua IP sumber. Tag default seperti 'VirtualNetwork', 'AzureLoadBalancer' dan 'Internet' juga dapat digunakan. Jika ini adalah aturan masuk, tentukan dari mana lalu lintas jaringan berasal.
properties.sourceAddressPrefixes	string[]	CIDR atau rentang IP sumber.
properties.sourceApplicationSecurityGroups	ApplicationSecurityGroup[]	Kelompok keamanan aplikasi ditentukan sebagai sumber.
properties.sourcePortRange	string	Port atau rentang sumber. Bilangan bulat atau rentang antara 0 dan 65535. Tanda bintang '*' juga dapat digunakan untuk mencocokkan semua port.
properties.sourcePortRanges	string[]	Rentang port sumber.
type	string	Jenis sumber daya.

SecurityRuleAccess

Apakah lalu lintas jaringan diizinkan atau ditolak.

Name	Type	Description
Allow	string
Deny	string

SecurityRuleDirection

Arah aturan. Arah menentukan apakah aturan akan dievaluasi pada lalu lintas masuk atau keluar.

Name	Type	Description
Inbound	string
Outbound	string

SecurityRuleProtocol

Protokol jaringan yang berlaku untuk aturan ini.

Name	Type	Description
*	string
Ah	string
Esp	string
Icmp	string
Tcp	string
Udp	string

ServiceAssociationLink

Sumber daya ServiceAssociationLink.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam grup sumber daya. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.allowDelete	boolean	Jika true, sumber daya dapat dihapus.
properties.link	string	Tautkan ke sumber daya eksternal.
properties.linkedResourceType	string	Jenis sumber daya dari sumber daya yang ditautkan.
properties.locations	string[]	Daftar lokasi.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya tautan asosiasi layanan.
type	string	Jenis sumber daya

ServiceEndpointPolicy

Sumber daya kebijakan titik Akhir Layanan.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
kind	string	Jenis kebijakan titik akhir layanan. Ini adalah metadata yang digunakan untuk pengalaman portal Azure.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.contextualServiceEndpointPolicies	string[]	Kumpulan kebijakan titik akhir layanan kontekstual.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya kebijakan titik akhir layanan.
properties.resourceGuid	string	Properti GUID sumber daya dari sumber daya kebijakan titik akhir layanan.
properties.serviceAlias	string	Alias yang menunjukkan apakah kebijakan tersebut milik layanan
properties.serviceEndpointPolicyDefinitions	ServiceEndpointPolicyDefinition[]	Kumpulan definisi kebijakan titik akhir layanan dari kebijakan titik akhir layanan.
properties.subnets	Subnet[]	Kumpulan referensi ke subnet.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

ServiceEndpointPolicyDefinition

Definisi kebijakan Titik Akhir Layanan.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya yang unik dalam grup sumber daya. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.description	string	Deskripsi untuk aturan ini. Dibatasi hingga 140 karakter.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya definisi kebijakan titik akhir layanan.
properties.service	string	Nama titik akhir layanan.
properties.serviceResources	string[]	Daftar sumber daya layanan.
type	string	Jenis sumber daya.

ServiceEndpointPropertiesFormat

Properti titik akhir layanan.

Name	Type	Description
locations	string[]	Daftar lokasi.
provisioningState	ProvisioningState	Status penyediaan sumber daya titik akhir layanan.
service	string	Jenis layanan titik akhir.

Subnet

Subnet dalam sumber daya jaringan virtual.

Name	Type	Default Value	Description
etag	string		String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string		ID Sumber Daya.
name	string		Nama sumber daya yang unik dalam grup sumber daya. Nama ini dapat digunakan untuk mengakses sumber daya.
properties.addressPrefix	string		Awalan alamat untuk subnet.
properties.addressPrefixes	string[]		Daftar awalan alamat untuk subnet.
properties.applicationGatewayIpConfigurations	ApplicationGatewayIPConfiguration[]		Konfigurasi IP gateway aplikasi sumber daya jaringan virtual.
properties.delegations	Delegation[]		Array referensi ke delegasi pada subnet.
properties.ipAllocations	SubResource[]		Array IpAllocation yang mereferensikan subnet ini.
properties.ipConfigurationProfiles	IPConfigurationProfile[]		Array profil konfigurasi IP yang mereferensikan subnet ini.
properties.ipConfigurations	IPConfiguration[]		Array referensi ke konfigurasi IP antarmuka jaringan menggunakan subnet.
properties.natGateway	SubResource		Gateway Nat yang terkait dengan subnet ini.
properties.networkSecurityGroup	NetworkSecurityGroup		Referensi ke sumber daya NetworkSecurityGroup.
properties.privateEndpointNetworkPolicies	VirtualNetworkPrivateEndpointNetworkPolicies	Enabled	Mengaktifkan atau Menonaktifkan penerapan kebijakan jaringan pada titik akhir privat di subnet.
properties.privateEndpoints	PrivateEndpoint[]		Array referensi ke titik akhir privat.
properties.privateLinkServiceNetworkPolicies	VirtualNetworkPrivateLinkServiceNetworkPolicies	Enabled	Mengaktifkan atau Menonaktifkan penerapan kebijakan jaringan pada layanan tautan privat di subnet.
properties.provisioningState	ProvisioningState		Status penyediaan sumber daya subnet.
properties.purpose	string		String baca-saja yang mengidentifikasi niat penggunaan untuk subnet ini berdasarkan delegasi dan properti lain yang ditentukan pengguna.
properties.resourceNavigationLinks	ResourceNavigationLink[]		Array referensi ke sumber daya eksternal menggunakan subnet.
properties.routeTable	RouteTable		Referensi ke sumber daya RouteTable.
properties.serviceAssociationLinks	ServiceAssociationLink[]		Array referensi ke layanan yang dimasukkan ke subnet ini.
properties.serviceEndpointPolicies	ServiceEndpointPolicy[]		Array kebijakan titik akhir layanan.
properties.serviceEndpoints	ServiceEndpointPropertiesFormat[]		Array titik akhir layanan.
type	string		Jenis sumber daya

SubResource

Referensi ke subsumber daya lain.

Name	Type	Description
id	string	ID Sumber Daya.

TrafficAnalyticsConfigurationProperties

Parameter yang menentukan konfigurasi analitik lalu lintas.

Name	Type	Description
enabled	boolean	Benderai untuk mengaktifkan/menonaktifkan analitik lalu lintas.
trafficAnalyticsInterval	integer	Interval dalam menit yang akan memutuskan seberapa sering layanan TA harus melakukan analitik alur.
workspaceId	string	Panduan sumber daya ruang kerja yang terlampir.
workspaceRegion	string	Lokasi ruang kerja terlampir.
workspaceResourceId	string	Id sumber daya ruang kerja terlampir.

TrafficAnalyticsProperties

Parameter yang menentukan konfigurasi analitik lalu lintas.

Name	Type	Description
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Parameter yang menentukan konfigurasi analitik lalu lintas.

TransportProtocol

Protokol transportasi untuk titik akhir.

Name	Type	Description
All	string
Tcp	string
Udp	string

VirtualNetworkPrivateEndpointNetworkPolicies

Aktifkan atau Nonaktifkan terapkan kebijakan jaringan pada titik akhir privat di subnet.

Name	Type	Description
Disabled	string
Enabled	string

VirtualNetworkPrivateLinkServiceNetworkPolicies

Aktifkan atau Nonaktifkan penerapan kebijakan jaringan pada layanan tautan privat di subnet.

Name	Type	Description
Disabled	string
Enabled	string

VirtualNetworkTap

Virtual Network Ketuk sumber daya.

Name	Type	Description
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.destinationLoadBalancerFrontEndIPConfiguration	FrontendIPConfiguration	Referensi ke alamat IP privat pada Load Balancer internal yang akan menerima ketukan.
properties.destinationNetworkInterfaceIPConfiguration	NetworkInterfaceIPConfiguration	Referensi ke Alamat IP privat kolektor nic yang akan menerima ketukan.
properties.destinationPort	integer	Port tujuan VXLAN yang akan menerima lalu lintas yang diketuk.
properties.networkInterfaceTapConfigurations	NetworkInterfaceTapConfiguration[]	Menentukan daftar ID sumber daya untuk konfigurasi IP antarmuka jaringan yang perlu diketuk.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya ketuk jaringan virtual.
properties.resourceGuid	string	Properti GUID sumber daya dari sumber daya ketuk jaringan virtual.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

Visibility

Daftar visibilitas layanan tautan privat.

Name	Type	Description
subscriptions	string[]	Daftar langganan.