1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. lb

Module lb

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Functions

Others

Resources

Resource BackendAddressPool

class BackendAddressPool extends CustomResource

Manages a Load Balancer Backend Address Pool.

NOTE: When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration Attached

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
});
const exampleLoadBalancer = new azure.lb.LoadBalancer("exampleLoadBalancer", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    frontend_ip_configuration: [{
        name: "PublicIPAddress",
        publicIpAddressId: examplePublicIp.id,
    }],
});
const exampleBackendAddressPool = new azure.lb.BackendAddressPool("exampleBackendAddressPool", {
    resourceGroupName: exampleResourceGroup.name,
    loadbalancerId: exampleLoadBalancer.id,
});

constructor

new BackendAddressPool(name: string, args: BackendAddressPoolArgs, opts?: pulumi.CustomResourceOptions)

Create a BackendAddressPool resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BackendAddressPoolState, opts?: pulumi.CustomResourceOptions): BackendAddressPool

Get an existing BackendAddressPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is BackendAddressPool

Returns true if the given object is an instance of BackendAddressPool. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property backendIpConfigurations

public backendIpConfigurations: pulumi.Output<string[]>;

The Backend IP Configurations associated with this Backend Address Pool.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property loadBalancingRules

public loadBalancingRules: pulumi.Output<string[]>;

The Load Balancing Rules associated with this Backend Address Pool.

property loadbalancerId

public loadbalancerId: pulumi.Output<string>;

The ID of the Load Balancer in which to create the Backend Address Pool.

property name

public name: pulumi.Output<string>;

Specifies the name of the Backend Address Pool.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource LoadBalancer

class LoadBalancer extends CustomResource

Manages a Load Balancer Resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
});
const exampleLoadBalancer = new azure.lb.LoadBalancer("exampleLoadBalancer", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    frontend_ip_configuration: [{
        name: "PublicIPAddress",
        publicIpAddressId: examplePublicIp.id,
    }],
});

constructor

new LoadBalancer(name: string, args: LoadBalancerArgs, opts?: pulumi.CustomResourceOptions)

Create a LoadBalancer resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: LoadBalancerState, opts?: pulumi.CustomResourceOptions): LoadBalancer

Get an existing LoadBalancer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is LoadBalancer

Returns true if the given object is an instance of LoadBalancer. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property frontendIpConfigurations

public frontendIpConfigurations: pulumi.Output<LoadBalancerFrontendIpConfiguration[] | undefined>;

One or multiple frontendIpConfiguration blocks as documented below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure Region where the Load Balancer should be created.

property name

public name: pulumi.Output<string>;

Specifies the name of the Load Balancer.

property privateIpAddress

public privateIpAddress: pulumi.Output<string>;

Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.

property privateIpAddresses

public privateIpAddresses: pulumi.Output<string[]>;

The list of private IP address assigned to the load balancer in frontendIpConfiguration blocks, if any.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the Resource Group in which to create the Load Balancer.

property sku

public sku: pulumi.Output<string | undefined>;

The SKU of the Azure Load Balancer. Accepted values are Basic and Standard. Defaults to Basic.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NatPool

class NatPool extends CustomResource

Manages a Load Balancer NAT pool.

NOTE: This resource cannot be used with with virtual machines, instead use the azure.lb.NatRule resource.

NOTE When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration Attached

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
});
const exampleLoadBalancer = new azure.lb.LoadBalancer("exampleLoadBalancer", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    frontend_ip_configuration: [{
        name: "PublicIPAddress",
        publicIpAddressId: examplePublicIp.id,
    }],
});
const exampleNatPool = new azure.lb.NatPool("exampleNatPool", {
    resourceGroupName: exampleResourceGroup.name,
    loadbalancerId: exampleLoadBalancer.id,
    protocol: "Tcp",
    frontendPortStart: 80,
    frontendPortEnd: 81,
    backendPort: 8080,
    frontendIpConfigurationName: "PublicIPAddress",
});

constructor

new NatPool(name: string, args: NatPoolArgs, opts?: pulumi.CustomResourceOptions)

Create a NatPool resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NatPoolState, opts?: pulumi.CustomResourceOptions): NatPool

Get an existing NatPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NatPool

Returns true if the given object is an instance of NatPool. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property backendPort

public backendPort: pulumi.Output<number>;

The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.

property frontendIpConfigurationId

public frontendIpConfigurationId: pulumi.Output<string>;

property frontendIpConfigurationName

public frontendIpConfigurationName: pulumi.Output<string>;

The name of the frontend IP configuration exposing this rule.

property frontendPortEnd

public frontendPortEnd: pulumi.Output<number>;

The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.

property frontendPortStart

public frontendPortStart: pulumi.Output<number>;

The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property loadbalancerId

public loadbalancerId: pulumi.Output<string>;

The ID of the Load Balancer in which to create the NAT pool.

property name

public name: pulumi.Output<string>;

Specifies the name of the NAT pool.

property protocol

public protocol: pulumi.Output<string>;

The transport protocol for the external endpoint. Possible values are Udp or Tcp.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NatRule

class NatRule extends CustomResource

Manages a Load Balancer NAT Rule.

NOTE: This resource cannot be used with with virtual machine scale sets, instead use the azure.lb.NatPool resource.

NOTE When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration Attached

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
});
const exampleLoadBalancer = new azure.lb.LoadBalancer("exampleLoadBalancer", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    frontend_ip_configuration: [{
        name: "PublicIPAddress",
        publicIpAddressId: examplePublicIp.id,
    }],
});
const exampleNatRule = new azure.lb.NatRule("exampleNatRule", {
    resourceGroupName: exampleResourceGroup.name,
    loadbalancerId: exampleLoadBalancer.id,
    protocol: "Tcp",
    frontendPort: 3389,
    backendPort: 3389,
    frontendIpConfigurationName: "PublicIPAddress",
});

constructor

new NatRule(name: string, args: NatRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a NatRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NatRuleState, opts?: pulumi.CustomResourceOptions): NatRule

Get an existing NatRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NatRule

Returns true if the given object is an instance of NatRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property backendIpConfigurationId

public backendIpConfigurationId: pulumi.Output<string>;

property backendPort

public backendPort: pulumi.Output<number>;

The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive.

property enableFloatingIp

public enableFloatingIp: pulumi.Output<boolean>;

Are the Floating IPs enabled for this Load Balncer Rule? A “floating” IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. Defaults to false.

property enableTcpReset

public enableTcpReset: pulumi.Output<boolean | undefined>;

Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.

property frontendIpConfigurationId

public frontendIpConfigurationId: pulumi.Output<string>;

property frontendIpConfigurationName

public frontendIpConfigurationName: pulumi.Output<string>;

The name of the frontend IP configuration exposing this rule.

property frontendPort

public frontendPort: pulumi.Output<number>;

The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Possible values range between 1 and 65534, inclusive.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property idleTimeoutInMinutes

public idleTimeoutInMinutes: pulumi.Output<number>;

Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.

property loadbalancerId

public loadbalancerId: pulumi.Output<string>;

The ID of the Load Balancer in which to create the NAT Rule.

property name

public name: pulumi.Output<string>;

Specifies the name of the NAT Rule.

property protocol

public protocol: pulumi.Output<string>;

The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource OutboundRule

class OutboundRule extends CustomResource

Manages a Load Balancer Outbound Rule.

NOTE When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration and a Backend Address Pool Attached.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
});
const exampleLoadBalancer = new azure.lb.LoadBalancer("exampleLoadBalancer", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    frontend_ip_configuration: [{
        name: "PublicIPAddress",
        publicIpAddressId: examplePublicIp.id,
    }],
});
const exampleBackendAddressPool = new azure.lb.BackendAddressPool("exampleBackendAddressPool", {
    resourceGroupName: exampleResourceGroup.name,
    loadbalancerId: exampleLoadBalancer.id,
});
const exampleOutboundRule = new azure.lb.OutboundRule("exampleOutboundRule", {
    resourceGroupName: exampleResourceGroup.name,
    loadbalancerId: exampleLoadBalancer.id,
    protocol: "Tcp",
    backendAddressPoolId: exampleBackendAddressPool.id,
    frontend_ip_configuration: [{
        name: "PublicIPAddress",
    }],
});

constructor

new OutboundRule(name: string, args: OutboundRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a OutboundRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: OutboundRuleState, opts?: pulumi.CustomResourceOptions): OutboundRule

Get an existing OutboundRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is OutboundRule

Returns true if the given object is an instance of OutboundRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allocatedOutboundPorts

public allocatedOutboundPorts: pulumi.Output<number | undefined>;

The number of outbound ports to be used for NAT.

property backendAddressPoolId

public backendAddressPoolId: pulumi.Output<string>;

The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.

property enableTcpReset

public enableTcpReset: pulumi.Output<boolean | undefined>;

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

property frontendIpConfigurations

public frontendIpConfigurations: pulumi.Output<OutboundRuleFrontendIpConfiguration[] | undefined>;

One or more frontendIpConfiguration blocks as defined below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property idleTimeoutInMinutes

public idleTimeoutInMinutes: pulumi.Output<number | undefined>;

The timeout for the TCP idle connection

property loadbalancerId

public loadbalancerId: pulumi.Output<string>;

The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.

property protocol

public protocol: pulumi.Output<string>;

The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the resource. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Probe

class Probe extends CustomResource

Manages a LoadBalancer Probe Resource.

NOTE When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration Attached

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
});
const exampleLoadBalancer = new azure.lb.LoadBalancer("exampleLoadBalancer", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    frontend_ip_configuration: [{
        name: "PublicIPAddress",
        publicIpAddressId: examplePublicIp.id,
    }],
});
const exampleProbe = new azure.lb.Probe("exampleProbe", {
    resourceGroupName: exampleResourceGroup.name,
    loadbalancerId: exampleLoadBalancer.id,
    port: 22,
});

constructor

new Probe(name: string, args: ProbeArgs, opts?: pulumi.CustomResourceOptions)

Create a Probe resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProbeState, opts?: pulumi.CustomResourceOptions): Probe

Get an existing Probe resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Probe

Returns true if the given object is an instance of Probe. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property intervalInSeconds

public intervalInSeconds: pulumi.Output<number | undefined>;

The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.

property loadBalancerRules

public loadBalancerRules: pulumi.Output<string[]>;

property loadbalancerId

public loadbalancerId: pulumi.Output<string>;

The ID of the LoadBalancer in which to create the NAT Rule.

property name

public name: pulumi.Output<string>;

Specifies the name of the Probe.

property numberOfProbes

public numberOfProbes: pulumi.Output<number | undefined>;

The number of failed probe attempts after which the backend endpoint is removed from rotation. The default value is 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.

property port

public port: pulumi.Output<number>;

Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.

property protocol

public protocol: pulumi.Output<string>;

Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If Tcp is specified, a received ACK is required for the probe to be successful. If Http is specified, a 200 OK response from the specified URI is required for the probe to be successful.

property requestPath

public requestPath: pulumi.Output<string | undefined>;

The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. Otherwise, it is not allowed.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Rule

class Rule extends CustomResource

Manages a Load Balancer Rule.

NOTE When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration Attached

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
});
const exampleLoadBalancer = new azure.lb.LoadBalancer("exampleLoadBalancer", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    frontend_ip_configuration: [{
        name: "PublicIPAddress",
        publicIpAddressId: examplePublicIp.id,
    }],
});
const exampleRule = new azure.lb.Rule("exampleRule", {
    resourceGroupName: exampleResourceGroup.name,
    loadbalancerId: exampleLoadBalancer.id,
    protocol: "Tcp",
    frontendPort: 3389,
    backendPort: 3389,
    frontendIpConfigurationName: "PublicIPAddress",
});

constructor

new Rule(name: string, args: RuleArgs, opts?: pulumi.CustomResourceOptions)

Create a Rule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RuleState, opts?: pulumi.CustomResourceOptions): Rule

Get an existing Rule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Rule

Returns true if the given object is an instance of Rule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property backendAddressPoolId

public backendAddressPoolId: pulumi.Output<string>;

A reference to a Backend Address Pool over which this Load Balancing Rule operates.

property backendPort

public backendPort: pulumi.Output<number>;

The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.

property disableOutboundSnat

public disableOutboundSnat: pulumi.Output<boolean | undefined>;

Is snat enabled for this Load Balancer Rule? Default false.

property enableFloatingIp

public enableFloatingIp: pulumi.Output<boolean | undefined>;

Are the Floating IPs enabled for this Load Balncer Rule? A “floating” IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. Defaults to false.

property enableTcpReset

public enableTcpReset: pulumi.Output<boolean | undefined>;

Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.

property frontendIpConfigurationId

public frontendIpConfigurationId: pulumi.Output<string>;

property frontendIpConfigurationName

public frontendIpConfigurationName: pulumi.Output<string>;

The name of the frontend IP configuration to which the rule is associated.

property frontendPort

public frontendPort: pulumi.Output<number>;

The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Possible values range between 0 and 65534, inclusive.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property idleTimeoutInMinutes

public idleTimeoutInMinutes: pulumi.Output<number>;

Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.

property loadDistribution

public loadDistribution: pulumi.Output<string>;

Specifies the load balancing distribution type to be used by the Load Balancer. Possible values are: Default – The load balancer is configured to use a 5 tuple hash to map traffic to available servers. SourceIP – The load balancer is configured to use a 2 tuple hash to map traffic to available servers. SourceIPProtocol – The load balancer is configured to use a 3 tuple hash to map traffic to available servers. Also known as Session Persistence, where the options are called None, Client IP and Client IP and Protocol respectively.

property loadbalancerId

public loadbalancerId: pulumi.Output<string>;

The ID of the Load Balancer in which to create the Rule.

property name

public name: pulumi.Output<string>;

Specifies the name of the LB Rule.

property probeId

public probeId: pulumi.Output<string>;

A reference to a Probe used by this Load Balancing Rule.

property protocol

public protocol: pulumi.Output<string>;

The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getBackendAddressPool

getBackendAddressPool(args: GetBackendAddressPoolArgs, opts?: pulumi.InvokeOptions): Promise<GetBackendAddressPoolResult>

Use this data source to access information about an existing Load Balancer’s Backend Address Pool.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleLB = azure.lb.getLB({
    name: "example-lb",
    resourceGroupName: "example-resources",
});
const exampleBackendAddressPool = exampleLB.then(exampleLB => azure.lb.getBackendAddressPool({
    name: "first",
    loadbalancerId: exampleLB.id,
}));
export const backendAddressPoolId = exampleBackendAddressPool.then(exampleBackendAddressPool => exampleBackendAddressPool.id);
export const backendIpConfigurationIds = data.azurerm_lb_backend_address_pool.beap.backend_ip_configurations.map(__item => __item.id);

Function getLB

getLB(args: GetLBArgs, opts?: pulumi.InvokeOptions): Promise<GetLBResult>

Use this data source to access information about an existing Load Balancer

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.lb.getLB({
    name: "example-lb",
    resourceGroupName: "example-resources",
});
export const loadbalancerId = example.then(example => example.id);

Others

interface BackendAddressPoolArgs

interface BackendAddressPoolArgs

The set of arguments for constructing a BackendAddressPool resource.

property loadbalancerId

loadbalancerId: pulumi.Input<string>;

The ID of the Load Balancer in which to create the Backend Address Pool.

property name

name?: pulumi.Input<string>;

Specifies the name of the Backend Address Pool.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the resource.

interface BackendAddressPoolState

interface BackendAddressPoolState

Input properties used for looking up and filtering BackendAddressPool resources.

property backendIpConfigurations

backendIpConfigurations?: pulumi.Input<pulumi.Input<string>[]>;

The Backend IP Configurations associated with this Backend Address Pool.

property loadBalancingRules

loadBalancingRules?: pulumi.Input<pulumi.Input<string>[]>;

The Load Balancing Rules associated with this Backend Address Pool.

property loadbalancerId

loadbalancerId?: pulumi.Input<string>;

The ID of the Load Balancer in which to create the Backend Address Pool.

property name

name?: pulumi.Input<string>;

Specifies the name of the Backend Address Pool.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the resource.

interface GetBackendAddressPoolArgs

interface GetBackendAddressPoolArgs

A collection of arguments for invoking getBackendAddressPool.

property loadbalancerId

loadbalancerId: string;

The ID of the Load Balancer in which the Backend Address Pool exists.

property name

name: string;

Specifies the name of the Backend Address Pool.

interface GetBackendAddressPoolResult

interface GetBackendAddressPoolResult

A collection of values returned by getBackendAddressPool.

property backendIpConfigurations

backendIpConfigurations: GetBackendAddressPoolBackendIpConfiguration[];

An array of references to IP addresses defined in network interfaces.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property loadbalancerId

loadbalancerId: string;

property name

name: string;

The name of the Backend Address Pool.

interface GetLBArgs

interface GetLBArgs

A collection of arguments for invoking getLB.

property name

name: string;

Specifies the name of the Load Balancer.

property resourceGroupName

resourceGroupName: string;

The name of the Resource Group in which the Load Balancer exists.

interface GetLBResult

interface GetLBResult

A collection of values returned by getLB.

property frontendIpConfigurations

frontendIpConfigurations: GetLBFrontendIpConfiguration[];

(Optional) A frontendIpConfiguration block as documented below.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

The Azure location where the Load Balancer exists.

property name

name: string;

The name of the Frontend IP Configuration.

property privateIpAddress

privateIpAddress: string;

Private IP Address to assign to the Load Balancer.

property privateIpAddresses

privateIpAddresses: string[];

The list of private IP address assigned to the load balancer in frontendIpConfiguration blocks, if any.

property resourceGroupName

resourceGroupName: string;

property sku

sku: string;

The SKU of the Load Balancer.

property tags

tags: {[key: string]: string};

A mapping of tags assigned to the resource.

interface LoadBalancerArgs

interface LoadBalancerArgs

The set of arguments for constructing a LoadBalancer resource.

property frontendIpConfigurations

frontendIpConfigurations?: pulumi.Input<pulumi.Input<LoadBalancerFrontendIpConfiguration>[]>;

One or multiple frontendIpConfiguration blocks as documented below.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure Region where the Load Balancer should be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Load Balancer.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the Resource Group in which to create the Load Balancer.

property sku

sku?: pulumi.Input<string>;

The SKU of the Azure Load Balancer. Accepted values are Basic and Standard. Defaults to Basic.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface LoadBalancerState

interface LoadBalancerState

Input properties used for looking up and filtering LoadBalancer resources.

property frontendIpConfigurations

frontendIpConfigurations?: pulumi.Input<pulumi.Input<LoadBalancerFrontendIpConfiguration>[]>;

One or multiple frontendIpConfiguration blocks as documented below.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure Region where the Load Balancer should be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Load Balancer.

property privateIpAddress

privateIpAddress?: pulumi.Input<string>;

Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.

property privateIpAddresses

privateIpAddresses?: pulumi.Input<pulumi.Input<string>[]>;

The list of private IP address assigned to the load balancer in frontendIpConfiguration blocks, if any.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the Resource Group in which to create the Load Balancer.

property sku

sku?: pulumi.Input<string>;

The SKU of the Azure Load Balancer. Accepted values are Basic and Standard. Defaults to Basic.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface NatPoolArgs

interface NatPoolArgs

The set of arguments for constructing a NatPool resource.

property backendPort

backendPort: pulumi.Input<number>;

The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.

property frontendIpConfigurationName

frontendIpConfigurationName: pulumi.Input<string>;

The name of the frontend IP configuration exposing this rule.

property frontendPortEnd

frontendPortEnd: pulumi.Input<number>;

The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.

property frontendPortStart

frontendPortStart: pulumi.Input<number>;

The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.

property loadbalancerId

loadbalancerId: pulumi.Input<string>;

The ID of the Load Balancer in which to create the NAT pool.

property name

name?: pulumi.Input<string>;

Specifies the name of the NAT pool.

property protocol

protocol: pulumi.Input<string>;

The transport protocol for the external endpoint. Possible values are Udp or Tcp.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the resource.

interface NatPoolState

interface NatPoolState

Input properties used for looking up and filtering NatPool resources.

property backendPort

backendPort?: pulumi.Input<number>;

The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.

property frontendIpConfigurationId

frontendIpConfigurationId?: pulumi.Input<string>;

property frontendIpConfigurationName

frontendIpConfigurationName?: pulumi.Input<string>;

The name of the frontend IP configuration exposing this rule.

property frontendPortEnd

frontendPortEnd?: pulumi.Input<number>;

The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.

property frontendPortStart

frontendPortStart?: pulumi.Input<number>;

The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.

property loadbalancerId

loadbalancerId?: pulumi.Input<string>;

The ID of the Load Balancer in which to create the NAT pool.

property name

name?: pulumi.Input<string>;

Specifies the name of the NAT pool.

property protocol

protocol?: pulumi.Input<string>;

The transport protocol for the external endpoint. Possible values are Udp or Tcp.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the resource.

interface NatRuleArgs

interface NatRuleArgs

The set of arguments for constructing a NatRule resource.

property backendPort

backendPort: pulumi.Input<number>;

The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive.

property enableFloatingIp

enableFloatingIp?: pulumi.Input<boolean>;

Are the Floating IPs enabled for this Load Balncer Rule? A “floating” IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. Defaults to false.

property enableTcpReset

enableTcpReset?: pulumi.Input<boolean>;

Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.

property frontendIpConfigurationName

frontendIpConfigurationName: pulumi.Input<string>;

The name of the frontend IP configuration exposing this rule.

property frontendPort

frontendPort: pulumi.Input<number>;

The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Possible values range between 1 and 65534, inclusive.

property idleTimeoutInMinutes

idleTimeoutInMinutes?: pulumi.Input<number>;

Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.

property loadbalancerId

loadbalancerId: pulumi.Input<string>;

The ID of the Load Balancer in which to create the NAT Rule.

property name

name?: pulumi.Input<string>;

Specifies the name of the NAT Rule.

property protocol

protocol: pulumi.Input<string>;

The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the resource.

interface NatRuleState

interface NatRuleState

Input properties used for looking up and filtering NatRule resources.

property backendIpConfigurationId

backendIpConfigurationId?: pulumi.Input<string>;

property backendPort

backendPort?: pulumi.Input<number>;

The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive.

property enableFloatingIp

enableFloatingIp?: pulumi.Input<boolean>;

Are the Floating IPs enabled for this Load Balncer Rule? A “floating” IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. Defaults to false.

property enableTcpReset

enableTcpReset?: pulumi.Input<boolean>;

Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.

property frontendIpConfigurationId

frontendIpConfigurationId?: pulumi.Input<string>;

property frontendIpConfigurationName

frontendIpConfigurationName?: pulumi.Input<string>;

The name of the frontend IP configuration exposing this rule.

property frontendPort

frontendPort?: pulumi.Input<number>;

The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Possible values range between 1 and 65534, inclusive.

property idleTimeoutInMinutes

idleTimeoutInMinutes?: pulumi.Input<number>;

Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.

property loadbalancerId

loadbalancerId?: pulumi.Input<string>;

The ID of the Load Balancer in which to create the NAT Rule.

property name

name?: pulumi.Input<string>;

Specifies the name of the NAT Rule.

property protocol

protocol?: pulumi.Input<string>;

The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the resource.

interface OutboundRuleArgs

interface OutboundRuleArgs

The set of arguments for constructing a OutboundRule resource.

property allocatedOutboundPorts

allocatedOutboundPorts?: pulumi.Input<number>;

The number of outbound ports to be used for NAT.

property backendAddressPoolId

backendAddressPoolId: pulumi.Input<string>;

The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.

property enableTcpReset

enableTcpReset?: pulumi.Input<boolean>;

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

property frontendIpConfigurations

frontendIpConfigurations?: pulumi.Input<pulumi.Input<OutboundRuleFrontendIpConfiguration>[]>;

One or more frontendIpConfiguration blocks as defined below.

property idleTimeoutInMinutes

idleTimeoutInMinutes?: pulumi.Input<number>;

The timeout for the TCP idle connection

property loadbalancerId

loadbalancerId: pulumi.Input<string>;

The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.

property protocol

protocol: pulumi.Input<string>;

The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the resource. Changing this forces a new resource to be created.

interface OutboundRuleState

interface OutboundRuleState

Input properties used for looking up and filtering OutboundRule resources.

property allocatedOutboundPorts

allocatedOutboundPorts?: pulumi.Input<number>;

The number of outbound ports to be used for NAT.

property backendAddressPoolId

backendAddressPoolId?: pulumi.Input<string>;

The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.

property enableTcpReset

enableTcpReset?: pulumi.Input<boolean>;

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

property frontendIpConfigurations

frontendIpConfigurations?: pulumi.Input<pulumi.Input<OutboundRuleFrontendIpConfiguration>[]>;

One or more frontendIpConfiguration blocks as defined below.

property idleTimeoutInMinutes

idleTimeoutInMinutes?: pulumi.Input<number>;

The timeout for the TCP idle connection

property loadbalancerId

loadbalancerId?: pulumi.Input<string>;

The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.

property protocol

protocol?: pulumi.Input<string>;

The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the resource. Changing this forces a new resource to be created.

interface ProbeArgs

interface ProbeArgs

The set of arguments for constructing a Probe resource.

property intervalInSeconds

intervalInSeconds?: pulumi.Input<number>;

The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.

property loadbalancerId

loadbalancerId: pulumi.Input<string>;

The ID of the LoadBalancer in which to create the NAT Rule.

property name

name?: pulumi.Input<string>;

Specifies the name of the Probe.

property numberOfProbes

numberOfProbes?: pulumi.Input<number>;

The number of failed probe attempts after which the backend endpoint is removed from rotation. The default value is 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.

property port

port: pulumi.Input<number>;

Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.

property protocol

protocol?: pulumi.Input<string>;

Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If Tcp is specified, a received ACK is required for the probe to be successful. If Http is specified, a 200 OK response from the specified URI is required for the probe to be successful.

property requestPath

requestPath?: pulumi.Input<string>;

The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. Otherwise, it is not allowed.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the resource.

interface ProbeState

interface ProbeState

Input properties used for looking up and filtering Probe resources.

property intervalInSeconds

intervalInSeconds?: pulumi.Input<number>;

The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.

property loadBalancerRules

loadBalancerRules?: pulumi.Input<pulumi.Input<string>[]>;

property loadbalancerId

loadbalancerId?: pulumi.Input<string>;

The ID of the LoadBalancer in which to create the NAT Rule.

property name

name?: pulumi.Input<string>;

Specifies the name of the Probe.

property numberOfProbes

numberOfProbes?: pulumi.Input<number>;

The number of failed probe attempts after which the backend endpoint is removed from rotation. The default value is 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.

property port

port?: pulumi.Input<number>;

Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.

property protocol

protocol?: pulumi.Input<string>;

Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If Tcp is specified, a received ACK is required for the probe to be successful. If Http is specified, a 200 OK response from the specified URI is required for the probe to be successful.

property requestPath

requestPath?: pulumi.Input<string>;

The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. Otherwise, it is not allowed.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the resource.

interface RuleArgs

interface RuleArgs

The set of arguments for constructing a Rule resource.

property backendAddressPoolId

backendAddressPoolId?: pulumi.Input<string>;

A reference to a Backend Address Pool over which this Load Balancing Rule operates.

property backendPort

backendPort: pulumi.Input<number>;

The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.

property disableOutboundSnat

disableOutboundSnat?: pulumi.Input<boolean>;

Is snat enabled for this Load Balancer Rule? Default false.

property enableFloatingIp

enableFloatingIp?: pulumi.Input<boolean>;

Are the Floating IPs enabled for this Load Balncer Rule? A “floating” IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. Defaults to false.

property enableTcpReset

enableTcpReset?: pulumi.Input<boolean>;

Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.

property frontendIpConfigurationName

frontendIpConfigurationName: pulumi.Input<string>;

The name of the frontend IP configuration to which the rule is associated.

property frontendPort

frontendPort: pulumi.Input<number>;

The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Possible values range between 0 and 65534, inclusive.

property idleTimeoutInMinutes

idleTimeoutInMinutes?: pulumi.Input<number>;

Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.

property loadDistribution

loadDistribution?: pulumi.Input<string>;

Specifies the load balancing distribution type to be used by the Load Balancer. Possible values are: Default – The load balancer is configured to use a 5 tuple hash to map traffic to available servers. SourceIP – The load balancer is configured to use a 2 tuple hash to map traffic to available servers. SourceIPProtocol – The load balancer is configured to use a 3 tuple hash to map traffic to available servers. Also known as Session Persistence, where the options are called None, Client IP and Client IP and Protocol respectively.

property loadbalancerId

loadbalancerId: pulumi.Input<string>;

The ID of the Load Balancer in which to create the Rule.

property name

name?: pulumi.Input<string>;

Specifies the name of the LB Rule.

property probeId

probeId?: pulumi.Input<string>;

A reference to a Probe used by this Load Balancing Rule.

property protocol

protocol: pulumi.Input<string>;

The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the resource.

interface RuleState

interface RuleState

Input properties used for looking up and filtering Rule resources.

property backendAddressPoolId

backendAddressPoolId?: pulumi.Input<string>;

A reference to a Backend Address Pool over which this Load Balancing Rule operates.

property backendPort

backendPort?: pulumi.Input<number>;

The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.

property disableOutboundSnat

disableOutboundSnat?: pulumi.Input<boolean>;

Is snat enabled for this Load Balancer Rule? Default false.

property enableFloatingIp

enableFloatingIp?: pulumi.Input<boolean>;

Are the Floating IPs enabled for this Load Balncer Rule? A “floating” IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. Defaults to false.

property enableTcpReset

enableTcpReset?: pulumi.Input<boolean>;

Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.

property frontendIpConfigurationId

frontendIpConfigurationId?: pulumi.Input<string>;

property frontendIpConfigurationName

frontendIpConfigurationName?: pulumi.Input<string>;

The name of the frontend IP configuration to which the rule is associated.

property frontendPort

frontendPort?: pulumi.Input<number>;

The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Possible values range between 0 and 65534, inclusive.

property idleTimeoutInMinutes

idleTimeoutInMinutes?: pulumi.Input<number>;

Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.

property loadDistribution

loadDistribution?: pulumi.Input<string>;

Specifies the load balancing distribution type to be used by the Load Balancer. Possible values are: Default – The load balancer is configured to use a 5 tuple hash to map traffic to available servers. SourceIP – The load balancer is configured to use a 2 tuple hash to map traffic to available servers. SourceIPProtocol – The load balancer is configured to use a 3 tuple hash to map traffic to available servers. Also known as Session Persistence, where the options are called None, Client IP and Client IP and Protocol respectively.

property loadbalancerId

loadbalancerId?: pulumi.Input<string>;

The ID of the Load Balancer in which to create the Rule.

property name

name?: pulumi.Input<string>;

Specifies the name of the LB Rule.

property probeId

probeId?: pulumi.Input<string>;

A reference to a Probe used by this Load Balancing Rule.

property protocol

protocol?: pulumi.Input<string>;

The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the resource.