Fork me on GitHub

Module lb

@pulumi/azure > lb

Index

lb/backendAddressPool.ts lb/loadBalancer.ts lb/natPool.ts lb/natRule.ts lb/probe.ts lb/rule.ts

class BackendAddressPool

Manage a Load Balancer Backend Address Pool.

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

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): 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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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[]>;

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[]>;

property loadbalancerId

public loadbalancerId: pulumi.Output<string>;

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

property location

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

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.

class LoadBalancer

Manage a Load Balancer Resource.

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): 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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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<{ ... }[] | undefined>;

A frontend ip configuration block 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 location where the resource exists.

property name

public name: pulumi.Output<string>;

Specifies the name of the frontend ip configuration.

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 frontend_ip_configuration blocks, if any.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

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<{ ... }>;

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.

class NatPool

Manages a Load Balancer NAT pool.

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

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): 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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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 location

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

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.

class NatRule

Manages a Load Balancer NAT Rule.

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

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): 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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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>;

Enables the Floating IP Capacity, required to configure a SQL AlwaysOn Availability Group.

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 loadbalancerId

public loadbalancerId: pulumi.Output<string>;

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

property location

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

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.

class Probe

Manages a LoadBalancer Probe Resource.

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

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): 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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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 location

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

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.

class Rule

Manages a Load Balancer Rule.

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

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): 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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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 1 and 65535, inclusive.

property enableFloatingIp

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

Floating IP is pertinent to failover scenarios: a “floating” IP is reassigned to a secondary server in case the primary server fails. Floating IP is required for SQL AlwaysOn.

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 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 timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to Tcp.

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 location

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

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.

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 location

location?: pulumi.Input<string>;

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

Input properties used for looking up and filtering BackendAddressPool resources.

property backendIpConfigurations

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

property loadBalancingRules

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

property loadbalancerId

loadbalancerId?: pulumi.Input<string>;

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

property location

location?: pulumi.Input<string>;

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 LoadBalancerArgs

The set of arguments for constructing a LoadBalancer resource.

property frontendIpConfigurations

frontendIpConfigurations?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A frontend ip configuration block as documented below.

property location

location: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists.

property name

name?: pulumi.Input<string>;

Specifies the name of the frontend ip configuration.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

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<{ ... }>;

A mapping of tags to assign to the resource.

interface LoadBalancerState

Input properties used for looking up and filtering LoadBalancer resources.

property frontendIpConfigurations

frontendIpConfigurations?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A frontend ip configuration block as documented below.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists.

property name

name?: pulumi.Input<string>;

Specifies the name of the frontend ip configuration.

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 frontend_ip_configuration blocks, if any.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

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<{ ... }>;

A mapping of tags to assign to the resource.

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 location

location?: pulumi.Input<string>;

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

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 location

location?: pulumi.Input<string>;

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

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>;

Enables the Floating IP Capacity, required to configure a SQL AlwaysOn Availability Group.

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 loadbalancerId

loadbalancerId: pulumi.Input<string>;

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

property location

location?: pulumi.Input<string>;

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

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>;

Enables the Floating IP Capacity, required to configure a SQL AlwaysOn Availability Group.

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 loadbalancerId

loadbalancerId?: pulumi.Input<string>;

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

property location

location?: pulumi.Input<string>;

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 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 location

location?: pulumi.Input<string>;

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

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 location

location?: pulumi.Input<string>;

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

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 1 and 65535, inclusive.

property enableFloatingIp

enableFloatingIp?: pulumi.Input<boolean>;

Floating IP is pertinent to failover scenarios: a “floating” IP is reassigned to a secondary server in case the primary server fails. Floating IP is required for SQL AlwaysOn.

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 1 and 65534, inclusive.

property idleTimeoutInMinutes

idleTimeoutInMinutes?: pulumi.Input<number>;

Specifies the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to Tcp.

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 location

location?: pulumi.Input<string>;

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

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 1 and 65535, inclusive.

property enableFloatingIp

enableFloatingIp?: pulumi.Input<boolean>;

Floating IP is pertinent to failover scenarios: a “floating” IP is reassigned to a secondary server in case the primary server fails. Floating IP is required for SQL AlwaysOn.

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 1 and 65534, inclusive.

property idleTimeoutInMinutes

idleTimeoutInMinutes?: pulumi.Input<number>;

Specifies the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to Tcp.

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 location

location?: pulumi.Input<string>;

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.