-
Notifications
You must be signed in to change notification settings - Fork 9.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
provider/azurerm: Documentation for the ARM LB resources
- Loading branch information
Showing
3 changed files
with
199 additions
and
0 deletions.
There are no files selected for viewing
62 changes: 62 additions & 0 deletions
62
website/source/docs/providers/azurerm/r/loadbalancer.html.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
--- | ||
layout: "azurerm" | ||
page_title: "Azure Resource Manager: azurerm_lb" | ||
sidebar_current: "docs-azurerm-resource-loadbalancer" | ||
description: |- | ||
Create a LoadBalancer Resource. | ||
--- | ||
|
||
# azurerm\_lb | ||
|
||
Create a LoadBalancer Resource. | ||
|
||
## Example Usage | ||
|
||
``` | ||
resource "azurerm_resource_group" "test" { | ||
name = "LoadBalancerRG" | ||
location = "West US" | ||
} | ||
resource "azurerm_public_ip" "test" { | ||
name = "PublicIPForLB" | ||
location = "West US" | ||
resource_group_name = "${azurerm_resource_group.test.name}" | ||
public_ip_address_allocation = "static" | ||
} | ||
resource "azurerm_lb" "test" { | ||
name = "TestLoadBalancer" | ||
location = "West US" | ||
resource_group_name = "${azurerm_resource_group.test.name}" | ||
frontend_ip_configuration { | ||
name = "PublicIPAddress" | ||
public_ip_address_id = "${azurerm_public_ip.test.id}" | ||
} | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `name` - (Required) Specifies the name of the LoadBalancer. | ||
* `resource_group_name` - (Required) The name of the resource group in which to create the LoadBalancer. | ||
* `location` - (Required) Specifies the supported Azure location where the resource exists. | ||
* `frontend_ip_configuration` - (Optional) A frontend ip configuration block as documented below. | ||
* `tags` - (Optional) A mapping of tags to assign to the resource. | ||
|
||
`frontend_ip_configuration` supports the following: | ||
|
||
* `name` - (Required) Specifies the name of the frontend ip configuration. | ||
* `subnet_id` - (Optional) Reference to subnet associated with the IP Configuration. | ||
* `private_ip_address` - (Optional) 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. | ||
* `public_ip_address_id` - (Optional) Reference to Public IP address to be associated with the Load Balancer. | ||
|
||
## Attributes Reference | ||
|
||
The following attributes are exported: | ||
|
||
* `id` - The LoadBalancer ID. | ||
|
62 changes: 62 additions & 0 deletions
62
...source/docs/providers/azurerm/r/loadbalancer_backend_address_pool.html.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
--- | ||
layout: "azurerm" | ||
page_title: "Azure Resource Manager: azurerm_lb_backend_address_pool" | ||
sidebar_current: "docs-azurerm-resource-loadbalancer-backend-address-pool" | ||
description: |- | ||
Create a LoadBalancer Backend Address Pool. | ||
--- | ||
|
||
# azurerm\_lb\_backend\_address\_pool | ||
|
||
Create a LoadBalancer Backend Address Pool. | ||
|
||
~> **NOTE When using this resource, the LoadBalancer needs to have a FrontEnd IP Configuration Attached | ||
|
||
## Example Usage | ||
|
||
``` | ||
resource "azurerm_resource_group" "test" { | ||
name = "LoadBalancerRG" | ||
location = "West US" | ||
} | ||
resource "azurerm_public_ip" "test" { | ||
name = "PublicIPForLB" | ||
location = "West US" | ||
resource_group_name = "${azurerm_resource_group.test.name}" | ||
public_ip_address_allocation = "static" | ||
} | ||
resource "azurerm_lb" "test" { | ||
name = "TestLoadBalancer" | ||
location = "West US" | ||
resource_group_name = "${azurerm_resource_group.test.name}" | ||
frontend_ip_configuration { | ||
name = "PublicIPAddress" | ||
public_ip_address_id = "${azurerm_public_ip.test.id}" | ||
} | ||
} | ||
resource "azurerm_lb_backend_address_pool" "test" { | ||
location = "West US" | ||
resource_group_name = "${azurerm_resource_group.test.name}" | ||
loadbalancer_id = "${azurerm_lb.test.id}" | ||
name = "BackEndAddressPool" | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `name` - (Required) Specifies the name of the Backend Address Pool. | ||
* `resource_group_name` - (Required) The name of the resource group in which to create the resource. | ||
* `location` - (Required) Specifies the supported Azure location where the resource exists. | ||
* `loadbalancer_id` - (Required) The ID of the LoadBalancer in which to create the Backend Address Pool. | ||
|
||
## Attributes Reference | ||
|
||
The following attributes are exported: | ||
|
||
* `id` - The ID of the LoadBalancer to which the resource is attached. |
75 changes: 75 additions & 0 deletions
75
website/source/docs/providers/azurerm/r/loadbalancer_rule.html.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
--- | ||
layout: "azurerm" | ||
page_title: "Azure Resource Manager: azurerm_lb_rule" | ||
sidebar_current: "docs-azurerm-resource-loadbalancer-rule" | ||
description: |- | ||
Create a LoadBalancer Rule. | ||
--- | ||
|
||
# azurerm\_lb\_rule | ||
|
||
Create a LoadBalancer Rule. | ||
|
||
~> **NOTE When using this resource, the LoadBalancer needs to have a FrontEnd IP Configuration Attached | ||
|
||
## Example Usage | ||
|
||
``` | ||
resource "azurerm_resource_group" "test" { | ||
name = "LoadBalancerRG" | ||
location = "West US" | ||
} | ||
resource "azurerm_public_ip" "test" { | ||
name = "PublicIPForLB" | ||
location = "West US" | ||
resource_group_name = "${azurerm_resource_group.test.name}" | ||
public_ip_address_allocation = "static" | ||
} | ||
resource "azurerm_lb" "test" { | ||
name = "TestLoadBalancer" | ||
location = "West US" | ||
resource_group_name = "${azurerm_resource_group.test.name}" | ||
frontend_ip_configuration { | ||
name = "PublicIPAddress" | ||
public_ip_address_id = "${azurerm_public_ip.test.id}" | ||
} | ||
} | ||
resource "azurerm_lb_rule" "test" { | ||
location = "West US" | ||
resource_group_name = "${azurerm_resource_group.test.name}" | ||
loadbalancer_id = "${azurerm_lb.test.id}" | ||
name = "LB Rule" | ||
protocol = "Tcp" | ||
frontend_port = 3389 | ||
backend_port = 3389 | ||
frontend_ip_configuration_name = "PublicIPAddress" | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `name` - (Required) Specifies the name of the LB Rule. | ||
* `resource_group_name` - (Required) The name of the resource group in which to create the resource. | ||
* `location` - (Required) Specifies the supported Azure location where the resource exists. | ||
* `loadbalancer_id` - (Required) The ID of the LoadBalancer in which to create the Backend Address Pool. | ||
* `frontend_ip_configuration_name` - (Required) The name of the frontend IP configuration to which the rule is associated. | ||
* `protocol` - (Required) The transport protocol for the external endpoint. Possible values are `Udp` or `Tcp`. | ||
* `frontend_port` - (Required) 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. | ||
* `backend_port` - (Required) The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive. | ||
* `backend_address_pool_id` - (Optional) A reference to a Backend Address Pool over which this Load Balancing Rule operates. | ||
* `probe_id` - (Optional) A reference to a Probe used by this Load Balancing Rule. | ||
* `enable_floating_ip` - (Optional) 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. | ||
* `idle_timeout_in_minutes` - (Optional) 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. | ||
* `load_distribution` - (Optional) 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. | ||
|
||
## Attributes Reference | ||
|
||
The following attributes are exported: | ||
|
||
* `id` - The ID of the LoadBalancer to which the resource is attached. |