Edit

AzureNLBManagement@1 - Azure Network Load Balancer v1 task

  • Article

Use this task to connect or disconnect an Azure virtual machine's network interface to a load balancer's back-end address pool.

Note

This task does not support Azure Resource Manager authentication with workflow identity federation.

Syntax

# Azure Network Load Balancer v1
# Connect or disconnect an Azure virtual machine's network interface to a Load Balancer's back end address pool.
- task: AzureNLBManagement@1
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure Subscription. 
    ResourceGroupName: # string. Required. Resource Group. 
    LoadBalancer: # string. Required. Load Balancer Name. 
    Action: # 'Disconnect' | 'Connect'. Required. Action.

# Azure Network Load Balancer v1
# Connect/Disconnect an Azure virtual machine's network interface to a Load Balancer's backend address pool.
- task: AzureNLBManagement@1
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure Subscription. 
    ResourceGroupName: # string. Required. Resource Group. 
    LoadBalancer: # string. Required. Load Balancer Name. 
    Action: # 'Disconnect' | 'Connect'. Required. Action.

Inputs

azureSubscription - Azure Subscription
Input alias: ConnectedServiceName. string. Required.

Specifies the Azure Resource Manager subscription for the deployment.


ResourceGroupName - Resource Group
string. Required.

Specifies the resource group name.


LoadBalancer - Load Balancer Name
string. Required.

Specifies or enters the load balancer's name.


Action - Action
string. Required. Allowed values: Disconnect (Disconnect Primary Network Interface), Connect (Connect Primary Network Interface).

The action you'd like to perform.

Disconnect: Removes the virtual machine’s primary network interface from the load balancer’s back-end pool so it stops receiving network traffic.

Connect: Adds the virtual machine’s primary network interface to load balancer back-end pool so it starts receiving network traffic based on the load balancing rules for the load balancer resource.


Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

None.

Remarks

Use this task to connect or disconnect an Azure virtual machine's network interface to a load balancer's address pool.

Requirements

Requirement Description
Pipeline types YAML, Classic build, Classic release
Runs on DeploymentGroup
Demands None
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions Any
Settable variables Any
Agent version 1.95.0 or greater
Task category Utility