OutboundRule

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.

Create a OutboundRule Resource

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

def OutboundRule(resource_name, opts=None, allocated_outbound_ports=None, backend_address_pool_id=None, enable_tcp_reset=None, frontend_ip_configurations=None, idle_timeout_in_minutes=None, loadbalancer_id=None, name=None, protocol=None, resource_group_name=None, __props__=None);

func NewOutboundRule(ctx *Context, name string, args OutboundRuleArgs, opts ...ResourceOption) (*OutboundRule, error)

public OutboundRule(string name, OutboundRuleArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args OutboundRuleArgs: 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 OutboundRuleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

OutboundRule Resource Properties

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

Inputs

The OutboundRule resource accepts the following input properties:

BackendAddressPoolId string: The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
LoadbalancerId string: The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
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. Changing this forces a new resource to be created.
AllocatedOutboundPorts int: The number of outbound ports to be used for NAT.
EnableTcpReset bool: 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.
FrontendIpConfigurations List<OutboundRuleFrontendIpConfigurationArgs>: One or more frontend_ip_configuration blocks as defined below.
IdleTimeoutInMinutes int: The timeout for the TCP idle connection
Name string: Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.

BackendAddressPoolId string: The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
LoadbalancerId string: The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
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. Changing this forces a new resource to be created.
AllocatedOutboundPorts int: The number of outbound ports to be used for NAT.
EnableTcpReset bool: 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.
FrontendIpConfigurations []OutboundRuleFrontendIpConfiguration: One or more frontend_ip_configuration blocks as defined below.
IdleTimeoutInMinutes int: The timeout for the TCP idle connection
Name string: Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.

backendAddressPoolId string: The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
loadbalancerId string: The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
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. Changing this forces a new resource to be created.
allocatedOutboundPorts number: The number of outbound ports to be used for NAT.
enableTcpReset 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.
frontendIpConfigurations OutboundRuleFrontendIpConfiguration[]: One or more frontend_ip_configuration blocks as defined below.
idleTimeoutInMinutes number: The timeout for the TCP idle connection
name string: Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.

backend_address_pool_id str: The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
loadbalancer_id str: The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
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. Changing this forces a new resource to be created.
allocated_outbound_ports float: The number of outbound ports to be used for NAT.
enable_tcp_reset bool: 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.
frontend_ip_configurations List[OutboundRuleFrontendIpConfiguration]: One or more frontend_ip_configuration blocks as defined below.
idle_timeout_in_minutes float: The timeout for the TCP idle connection
name str: Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.

Outputs

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

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

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

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

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

Look up an Existing OutboundRule Resource

Get an existing OutboundRule 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?: OutboundRuleState, opts?: CustomResourceOptions): OutboundRule

static get(resource_name, id, opts=None, allocated_outbound_ports=None, backend_address_pool_id=None, enable_tcp_reset=None, frontend_ip_configurations=None, idle_timeout_in_minutes=None, loadbalancer_id=None, name=None, protocol=None, resource_group_name=None, __props__=None);

func GetOutboundRule(ctx *Context, name string, id IDInput, state *OutboundRuleState, opts ...ResourceOption) (*OutboundRule, error)

public static OutboundRule Get(string name, Input<string> id, OutboundRuleState? 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:

AllocatedOutboundPorts int: The number of outbound ports to be used for NAT.
BackendAddressPoolId string: The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
EnableTcpReset bool: 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.
FrontendIpConfigurations List<OutboundRuleFrontendIpConfigurationArgs>: One or more frontend_ip_configuration blocks as defined below.
IdleTimeoutInMinutes int: The timeout for the TCP idle connection
LoadbalancerId string: The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
Name string: Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
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. Changing this forces a new resource to be created.

AllocatedOutboundPorts int: The number of outbound ports to be used for NAT.
BackendAddressPoolId string: The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
EnableTcpReset bool: 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.
FrontendIpConfigurations []OutboundRuleFrontendIpConfiguration: One or more frontend_ip_configuration blocks as defined below.
IdleTimeoutInMinutes int: The timeout for the TCP idle connection
LoadbalancerId string: The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
Name string: Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
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. Changing this forces a new resource to be created.

allocatedOutboundPorts number: The number of outbound ports to be used for NAT.
backendAddressPoolId string: The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
enableTcpReset 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.
frontendIpConfigurations OutboundRuleFrontendIpConfiguration[]: One or more frontend_ip_configuration blocks as defined below.
idleTimeoutInMinutes number: The timeout for the TCP idle connection
loadbalancerId string: The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
name string: Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
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. Changing this forces a new resource to be created.

allocated_outbound_ports float: The number of outbound ports to be used for NAT.
backend_address_pool_id str: The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
enable_tcp_reset bool: 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.
frontend_ip_configurations List[OutboundRuleFrontendIpConfiguration]: One or more frontend_ip_configuration blocks as defined below.
idle_timeout_in_minutes float: The timeout for the TCP idle connection
loadbalancer_id str: The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
name str: Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
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. Changing this forces a new resource to be created.

Supporting Types

OutboundRuleFrontendIpConfiguration

See the input and output API doc for this type.

Name string: The name of the Frontend IP Configuration.
Id string: The ID of the Load Balancer Outbound Rule.

Name string: The name of the Frontend IP Configuration.
Id string: The ID of the Load Balancer Outbound Rule.

name string: The name of the Frontend IP Configuration.
id string: The ID of the Load Balancer Outbound Rule.

name str: The name of the Frontend IP Configuration.
id str: The ID of the Load Balancer Outbound Rule.

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