Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Aris van Ommeren committed Dec 15, 2022
1 parent 2a2d5a5 commit e8545a4
Showing 1 changed file with 64 additions and 0 deletions.
64 changes: 64 additions & 0 deletions website/docs/d/lb_outbound_rule.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
subcategory: "Load Balancer"
layout: "azurerm"
page_title: "Azure Resource Manager: Data Source: azurerm_lb_outbound_rule"
description: |-
Gets information about an existing Load Balancer Outbound Rule.
---

# Data Source: azurerm_lb_outbound_rule

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

## Example Usage

```hcl
data "azurerm_lb_outbound_rule" "example" {
name = "existing_lb_outbound_rule"
loadbalancer_id = "existing_load_balancer_id"
}
output "id" {
value = data.azurerm_lb_outbound_rule.example.id
}
```

## Arguments Reference

The following arguments are supported:

* `name` - (Required) The name of this Load Balancer Outbound Rule.

* `loadbalancer_id` - (Required) The ID of the Load Balancer in which the Outbound Rule exists.

## Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:

* `id` - The ID of the Load Balancer Outbound Rule.

* `allocated_outbound_ports` - The number of outbound ports used for NAT.

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

* `frontend_ip_configuration` - A `frontend_ip_configuration` block as defined below.

* `idle_timeout_in_minutes` - The timeout for the TCP idle connection.

* `protocol` - The transport protocol for the external endpoint.

* `tcp_reset_enabled` - Is the bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination enabled? This value is useful when the protocol is set to TCP.

---

A `frontend_ip_configuration` block exports the following:

* `id` - The ID of the Frontend IP Configuration.

* `name` - The name of the Frontend IP Configuration.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `read` - (Defaults to 5 minutes) Used when retrieving the Load Balancer Outbound Rule.

0 comments on commit e8545a4

Please sign in to comment.