Manage Administrative (Admin) State in Azure Load Balancer

• Access to the Azure portal using [https://preview.portal.azure.com].
• An Azure account with an active subscription. Create an account for free
• Self-registration of the feature name SLBAllowAdminStateChangeForConnectionDraining in your subscription. For information on registering the feature in your subscription, see Register preview feature doc.
• An existing resource group for all resources.
• Two or more existing Virtual Machines.
• An existing standard load balancer in the same subscription and virtual network as the virtual machines.
  • The load balancer should have a backend pool with health probes and load balancing rules attached.

• Access to the Azure portal.
• An Azure account with an active subscription. Create an account for free
• Self-registration of the feature name SLBAllowAdminStateChangeForConnectionDraining in your subscription. For information on registering the feature in your subscription, see Register preview feature doc.
• An existing resource group for all resources.
• Existing Virtual Machines.
• An existing standard load balancer in the same subscription and virtual network as the virtual machine.
  • The load balancer should have a backend pool with health probes and load balancing rules attached.

• Access to the Azure portal.
• An Azure account with an active subscription. Create an account for free
• Self-registration of the feature name SLBAllowAdminStateChangeForConnectionDraining in your subscription. For information on registering the feature in your subscription, see Register preview feature doc.
• An existing resource group for all resources.
• Existing Virtual Machines.
• An existing standard load balancer in the same subscription and virtual network as the virtual machine.
  • The load balancer should have a backend pool with health probes and load balancing rules attached.

• Use the Bash environment in Azure Cloud Shell. For more information, see Quickstart for Bash in Azure Cloud Shell.

  

• If you prefer to run CLI reference commands locally, install the Azure CLI. If you're running on Windows or macOS, consider running Azure CLI in a Docker container. For more information, see How to run the Azure CLI in a Docker container.

  • If you're using a local installation, sign in to the Azure CLI by using the az login command. To finish the authentication process, follow the steps displayed in your terminal. For other sign-in options, see Sign in with the Azure CLI.

  • When you're prompted, install the Azure CLI extension on first use. For more information about extensions, see Use extensions with the Azure CLI.

  • Run az version to find the version and dependent libraries that are installed. To upgrade to the latest version, run az upgrade.

1. Sign in to the Azure portal.
2. In the search box at the top of the portal, enter Load balancer. Select Load balancers in the search results.
3. Select your load balancer from the list.
4. In your load balancer's page, select Backend pools under Settings.
5. Select + Add in Backend pools to add a new backend pool.
6. In the Add backend pool window, enter or select the following information:

7. Select Save.

8. In your Backend pools page, select the corresponding Admin State value of your recently added backend pool instance.

   

9. In your Admin state details window, select Down from the dropdown menu.

   

10. Select Save.

1. Connect to your Azure subscription with Azure PowerShell.

2. Create a new backend pool with a backend pool instance while setting the admin state value to UP or DOWN with New-AzLoadBalancerBackendAddressConfig. Replace the values in brackets with the names of the resources in your configuration.

   $rsg = <resource-group>
   $vnt = <virtual-network-name>
   $lbn = <load-balancer-name>
   $bep = <backend-pool-name>
   $ip = <ip-address>
   $ben = <backend-address-name>
   
   $vnet = Get-AzVirtualNetwork -Name $vnt -ResourceGroupName $rsg
   $lb = Get-AzLoadBalancer -ResourceGroupName $rsg -Name $lbn
   $ip1 = New-AzLoadBalancerBackendAddressConfig -IpAddress $ip -Name $ben -VirtualNetworkId $vnet.Id -AdminState “DOWN”
   $lb | New-AzLoadBalancerBackendAddressPool -LoadBalancerBackendAddress $ip1 -Name $bep
   

This example sets a new backend pool instance admin state to DOWN with the following defined values:

$rsg = "MyResourceGroup"
$vnt = "MyVnet"
$lbn = "MyLB"
$bep = "MyAddressPool"
$ip = "10.0.2.4"
$ben = "MyBackend"

$vnet = Get-AzVirtualNetwork -Name $vnt -ResourceGroupName $rsg
$lb = Get-AzLoadBalancer -ResourceGroupName $rsg -Name $lbn
$ip1 = New-AzLoadBalancerBackendAddressConfig -IpAddress $ip -Name $ben -VirtualNetworkId $vnet.Id -AdminState “DOWN”
$lb | New-AzLoadBalancerBackendAddressPool -LoadBalancerBackendAddress $ip1 -Name $bep

1. Connect to your Azure subscription with Azure CLI.

2. Create a new backend pool with a backend pool instance while setting admin state value to UP or DOWN with az network lb address-pool create. Replace the values in brackets with the names of the resources in your configuration.

   az network lb address-pool create \
       -g <resource-group> \
       --lb-name <lb-name> \
       -n <lb-backend-pool-name> \
       --vnet <virtual-network-name> \
       --backend-address “{name: <new-lb-backend-pool-address-name>,ip-address:<new-lb-backend-pool-address>}” \
       --admin-state <admin-state-value>
   

3. This example updates a backend pool instance admin state to DOWN with the following defined values:

az network lb address-pool create \
    -g MyResourceGroup \
    --lb-name MyLb \
    -n MyAddressPool \
    --vnet MyVnet \
    --backend-address “{name: MyBackend,ip-address:10.0.2.4}” \
    --admin-state DOWN

1. Sign in to the Azure portal.

2. In the search box at the top of the portal, enter Load balancer and select Load balancers in the search results.

3. On the load balancer's Overview page, select your load balancer from the list.

4. In your load balancer's page, select Backend pools under Settings.

5. Select your backend pool.

6. In your backend pool's page, select + Add under IP configurations.

   Note

   This step is assuming your backend pool is NIC-based.

7. Select the virtual machine you want to add to the backend pool.

8. Select Add and Save.

9. In your Backend pools page, select the corresponding Admin State value of your recently added backend pool instance.

10. In your Admin state details window, select Up from the dropdown menu.

    

11. Select Save.

1. Connect to your Azure subscription with Azure PowerShell.

2. Add a new backend pool instance with the admin state value configured to UP or DOWN with New-AzLoadBalancerBackendAddressConfig. Replace the values in brackets with the names of the resources in your configuration.

   $rsg = <resource-group>
   $vnt = <virtual-network-name>
   $lbn = <load-balancer-name>
   $bep = <backend-pool-name>
   $ip = <ip-address>
   $ben = <backend-address-name>
   
   $vnet = Get-AzVirtualNetwork -Name $vnt -ResourceGroupName $rsg
   $lb = Get-AzLoadBalancer -ResourceGroupName $rsg -Name $lbn
   $ip1 = New-AzLoadBalancerBackendAddressConfig -IpAddress $ip -Name $ben -VirtualNetworkId $vnet.Id -AdminState “UP”
   $lb | Set-AzLoadBalancerBackendAddressPool -LoadBalancerBackendAddress $ip1 -Name $bep
   

3. This example sets a new backend pool instance admin state to UP with the following defined values:

# Set the values for the variables
$rsg = "MyResourceGroup"
$vnt = "MyVnet"
$lbn = "MyLB"
$bep = "MyAddressPool"
$ip = "10.0.2.4"
$ben = "MyBackend"

$vnet = Get-AzVirtualNetwork -Name $vnt -ResourceGroupName $rsg
$lb = Get-AzLoadBalancer -ResourceGroupName $rsg -Name $lbn
$ip1 = New-AzLoadBalancerBackendAddressConfig -IpAddress $ip -Name $ben -VirtualNetworkId $vnet.Id -AdminState “UP”
$lb | Set-AzLoadBalancerBackendAddressPool -LoadBalancerBackendAddress $ip1 -Name $bep

1. Connect to your Azure subscription with Azure CLI.

2. Add a new backend pool instance with the admin state value is configured. The value can be set to UP or DOWN with az network lb address-pool update . Replace the values in brackets with the names of the resources in your configuration.

   az network lb address-pool update \
       -g <resource-group> \
       --lb-name <lb-name> \
       -n <lb-backend-pool-name> \
       --vnet <virtual-network-name> \
       --backend-address “{name: <new-lb-backend-pool-address-name>,ip-address:<new-lb-backend-pool-address>}” |
       --admin-state <admin-state-value>
   

3. This example sets a new backend pool instance admin state to UP with the following defined values:

az network lb address-pool update \
    -g MyResourceGroup \
    --lb-name MyLb \
    -n MyAddressPool \
    --vnet MyVnet \
    --backend-address “{name: MyBackend,ip-address:10.0.2.4}” |
    --admin-state UP

1. Sign in to the Azure portal.

2. In the search box at the top of the portal, enter Load balancer and select Load balancers in the search results.

3. Select your load balancer from the list.

4. In your load balancer's page, select Backend pools under Settings.

5. In your Backend pools page, select the corresponding Admin State value of your recently added backend pool instance.

6. In your Admin state details window, select Up from the dropdown menu.

   

7. Select Save.

1. Connect to your Azure subscription with Azure PowerShell.

2. Update an existing backend pool instance with the admin state value configured to UP or DOWN with New-AzLoadBalancerBackendAddressConfig.. Replace the values in brackets with the names of the resources in your configuration.

   
   # Set the values for the variables
   $rsg = <resource-group>
   $vnt = <virtual-network-name>
   $lbn = <load-balancer-name>
   $bep = <backend-pool-name>
   $ip = <ip-address>
   $ben = <backend-address-name>
   
   $vnet = Get-AzVirtualNetwork -Name $vnt -ResourceGroupName $rsg
   $lb = Get-AzLoadBalancer -ResourceGroupName $rsg -Name $lbn
   $ip1 = New-AzLoadBalancerBackendAddressConfig -IpAddress $ip -Name $ben -VirtualNetworkId $vnet.Id -AdminState “DOWN”
   $lb | Set-AzLoadBalancerBackendAddressPool -LoadBalancerBackendAddress $ip1 -Name $bep
   
   

3. This example sets an existing backend pool instance admin state to DOWN with the following defined values:

$rsg = "MyResourceGroup"
$vnt = "MyVnet"
$lbn = "MyLB"
$bep = "MyAddressPool"
$ip = "10.0.2.4"
$ben = "MyBackend"

$vnet = Get-AzVirtualNetwork -Name $vnt -ResourceGroupName $rsg
$lb = Get-AzLoadBalancer -ResourceGroupName $rsg -Name $lbn
$ip1 = New-AzLoadBalancerBackendAddressConfig -IpAddress $ip -Name $ben -VirtualNetworkId $vnet.Id -AdminState “DOWN”
$lb | Set-AzLoadBalancerBackendAddressPool -LoadBalancerBackendAddress $ip1 -Name $bep

1. Connect to your Azure subscription with Azure CLI.

2. Update an existing backend pool instance, and configure the admin state value to UP or DOWN with az network lb address-pool update. Replace the values in brackets with the names of the resources in your configuration.

   
   az network lb address-pool update \
       -g <resource-group> \
       --lb-name <lb-name> \
       -n <lb-backend-pool-name> \
       --backend-address “{name: <lb-backend-pool-address-name>,ip-address:<lb-backend-pool-address>}” |
       --admin-state <admin-state-value>
   
   

3. This example updates an existing backend pool instance admin state to DOWN with the following defined values:

    az network lb address-pool update \
        -g MyResourceGroup \
        --lb-name MyLb \
        -n MyAddressPool \
        --backend-address “{name: MyBackend,ip-address:10.0.2.4}” |
        --admin-state DOWN
    

1. Sign in to the Azure portal.

2. In the search box at the top of the portal, enter Load balancer and select Load balancers in the search results.

3. Select your load balancer from the list.

4. In your load balancer's page, select Backend pools under Settings.

5. Select the corresponding Admin State value of your backend pool instance that you would like to remove.

6. In your admin state’s window, select None from the dropdown menu.

   

7. Select Save.

1. Connect to your Azure subscription with Azure PowerShell.

2. Remove an existing backend pool instance. This is done by setting the admin state value to NONE with New-AzLoadBlancerBackendAddressConfig. Replace the values in brackets with the names of the resources in your configuration.

   
   # Set the values for the variables
   $rsg = <resource-group>
   $vnt = <virtual-network-name>
   $lbn = <load-balancer-name>
   $bep = <backend-pool-name>
   $ip = <ip-address>
   $ben = <backend-address-name>
   
   # Remove the admin state from the backend pool instance
   $vnet = Get-AzVirtualNetwork -Name $vnt -ResourceGroupName $rsg
   $lb = Get-AzLoadBalancer -ResourceGroupName $rsg -Name $lbn
   $ip1 = New-AzLoadBalancerBackendAddressConfig -IpAddress $ip -Name $ben -VirtualNetworkId $vnet.Id -AdminState “NONE”
   $lb | Set-AzLoadBalancerBackendAddressPool -LoadBalancerBackendAddress $ip1 -Name $bep
   
   

3. This example removes an existing backend pool instance admin state with the following defined values:

# Set the values for the variables
$rsg = "MyResourceGroup"
$vnt = "MyVnet"
$lbn = "MyLB"
$bep = "MyAddressPool"
$ip = “10.0.2.4"

# Remove the admin state from the backend pool instance
$vnet = Get-AzVirtualNetwork -Name $vnt -ResourceGroupName $rsg
$lb = Get-AzLoadBalancer -ResourceGroupName $rsg -Name $lbn
$ip1 = New-AzLoadBalancerBackendAddressConfig -IpAddress $ip -Name $ben -VirtualNetworkId $vnet.Id -AdminState “NONE”
$lb | Set-AzLoadBalancerBackendAddressPool -LoadBalancerBackendAddress $ip1 -Name $bep

1. Connect to your Azure subscription with Azure CLI.
2. Remove an existing backend pool instance by setting the admin state value to None with az network lb address-pool update. Replace the values in brackets with the names of the resources in your configuration.

# Remove the admin state from the backend pool instance
az network lb address-pool update \
    -g <resource-group> \
    --lb-name <lb-name> \
    -n <lb-backend-pool-name> \
    --backend-address “{name: <lb-backend-pool-address-name>,ip-address:<lb-backend-pool-address>}” |
    --admin-state <admin-state-value>

1. This example removes an existing backend pool instance admin state with the following defined values:

az network lb address-pool update \
    -g MyResourceGroup \
    --lb-name MyLb \
    -n MyAddressPool \
    --backend-address "{name: MyBackend,ip-address:10.0.2.4}" \
    --admin-state NONE