NatRule

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

Create a NatRule Resource

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

def NatRule(resource_name, opts=None, backend_port=None, enable_floating_ip=None, enable_tcp_reset=None, frontend_ip_configuration_name=None, frontend_port=None, idle_timeout_in_minutes=None, loadbalancer_id=None, name=None, protocol=None, resource_group_name=None, __props__=None);

func NewNatRule(ctx *Context, name string, args NatRuleArgs, opts ...ResourceOption) (*NatRule, error)

public NatRule(string name, NatRuleArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args NatRuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args NatRuleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NatRuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

NatRule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The NatRule resource accepts the following input properties:

BackendPort int: The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive.
FrontendIpConfigurationName string: The name of the frontend IP configuration exposing this rule.
FrontendPort int: 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.
LoadbalancerId string: The ID of the Load Balancer in which to create the NAT Rule.
Protocol string: The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
ResourceGroupName string: The name of the resource group in which to create the resource.
EnableFloatingIp bool: 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.
EnableTcpReset bool: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
IdleTimeoutInMinutes int: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
Name string: Specifies the name of the NAT Rule.

BackendPort int: The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive.
FrontendIpConfigurationName string: The name of the frontend IP configuration exposing this rule.
FrontendPort int: 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.
LoadbalancerId string: The ID of the Load Balancer in which to create the NAT Rule.
Protocol string: The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
ResourceGroupName string: The name of the resource group in which to create the resource.
EnableFloatingIp bool: 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.
EnableTcpReset bool: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
IdleTimeoutInMinutes int: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
Name string: Specifies the name of the NAT Rule.

backendPort number: The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive.
frontendIpConfigurationName string: The name of the frontend IP configuration exposing this rule.
frontendPort 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.
loadbalancerId string: The ID of the Load Balancer in which to create the NAT Rule.
protocol string: The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
resourceGroupName string: The name of the resource group in which to create the resource.
enableFloatingIp 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.
enableTcpReset boolean: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
idleTimeoutInMinutes number: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
name string: Specifies the name of the NAT Rule.

backend_port float: The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive.
frontend_ip_configuration_name str: The name of the frontend IP configuration exposing this rule.
frontend_port float: 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.
loadbalancer_id str: The ID of the Load Balancer in which to create the NAT Rule.
protocol str: The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
resource_group_name str: The name of the resource group in which to create the resource.
enable_floating_ip bool: 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.
enable_tcp_reset bool: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
idle_timeout_in_minutes float: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
name str: Specifies the name of the NAT Rule.

Outputs

All input properties are implicitly available as output properties. Additionally, the NatRule resource produces the following output properties:

BackendIpConfigurationId string
FrontendIpConfigurationId string
Id string: The provider-assigned unique ID for this managed resource.

BackendIpConfigurationId string
FrontendIpConfigurationId string
Id string: The provider-assigned unique ID for this managed resource.

backendIpConfigurationId string
frontendIpConfigurationId string
id string: The provider-assigned unique ID for this managed resource.

backend_ip_configuration_id str
frontend_ip_configuration_id str
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing NatRule Resource

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

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

static get(resource_name, id, opts=None, backend_ip_configuration_id=None, backend_port=None, enable_floating_ip=None, enable_tcp_reset=None, frontend_ip_configuration_id=None, frontend_ip_configuration_name=None, frontend_port=None, idle_timeout_in_minutes=None, loadbalancer_id=None, name=None, protocol=None, resource_group_name=None, __props__=None);

func GetNatRule(ctx *Context, name string, id IDInput, state *NatRuleState, opts ...ResourceOption) (*NatRule, error)

public static NatRule Get(string name, Input<string> id, NatRuleState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

BackendIpConfigurationId string
BackendPort int: The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive.
EnableFloatingIp bool: 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.
EnableTcpReset bool: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
FrontendIpConfigurationId string
FrontendIpConfigurationName string: The name of the frontend IP configuration exposing this rule.
FrontendPort int: 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.
IdleTimeoutInMinutes int: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
LoadbalancerId string: The ID of the Load Balancer in which to create the NAT Rule.
Name string: Specifies the name of the NAT Rule.
Protocol string: The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
ResourceGroupName string: The name of the resource group in which to create the resource.

BackendIpConfigurationId string
BackendPort int: The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive.
EnableFloatingIp bool: 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.
EnableTcpReset bool: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
FrontendIpConfigurationId string
FrontendIpConfigurationName string: The name of the frontend IP configuration exposing this rule.
FrontendPort int: 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.
IdleTimeoutInMinutes int: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
LoadbalancerId string: The ID of the Load Balancer in which to create the NAT Rule.
Name string: Specifies the name of the NAT Rule.
Protocol string: The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
ResourceGroupName string: The name of the resource group in which to create the resource.

backendIpConfigurationId string
backendPort number: The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive.
enableFloatingIp 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.
enableTcpReset boolean: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
frontendIpConfigurationId string
frontendIpConfigurationName string: The name of the frontend IP configuration exposing this rule.
frontendPort 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.
idleTimeoutInMinutes number: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
loadbalancerId string: The ID of the Load Balancer in which to create the NAT Rule.
name string: Specifies the name of the NAT Rule.
protocol string: The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
resourceGroupName string: The name of the resource group in which to create the resource.

backend_ip_configuration_id str
backend_port float: The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive.
enable_floating_ip bool: 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.
enable_tcp_reset bool: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
frontend_ip_configuration_id str
frontend_ip_configuration_name str: The name of the frontend IP configuration exposing this rule.
frontend_port float: 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.
idle_timeout_in_minutes float: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
loadbalancer_id str: The ID of the Load Balancer in which to create the NAT Rule.
name str: Specifies the name of the NAT Rule.
protocol str: The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
resource_group_name str: The name of the resource group in which to create the resource.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud