|
| 1 | +<!-- BEGIN_AUTOMATED_TF_DOCS_BLOCK --> |
| 2 | +## Requirements |
| 3 | + |
| 4 | +| Name | Version | |
| 5 | +|------|---------| |
| 6 | +| <a name="requirement_terraform"></a> [terraform](#requirement_terraform) | ~> 1.3 | |
| 7 | +| <a name="requirement_azurerm"></a> [azurerm](#requirement_azurerm) | <= 4.0 | |
| 8 | +| <a name="requirement_random"></a> [random](#requirement_random) | >= 3.1 | |
| 9 | +## Usage |
| 10 | +Basic usage of this module is as follows: |
| 11 | + ```hcl |
| 12 | + module "example" { |
| 13 | + source = "<module-path>" |
| 14 | + |
| 15 | + # Optional variables |
| 16 | + application_name = "" |
| 17 | + environment = "" |
| 18 | + location = "" |
| 19 | + resource_group_name = "" |
| 20 | + subnet_cidrs = [] |
| 21 | + vnet_address_space = [] |
| 22 | + vnet_name = "" |
| 23 | + } |
| 24 | + ``` |
| 25 | + |
| 26 | +## Resources |
| 27 | + |
| 28 | +| Name | Type | |
| 29 | +|------|------| |
| 30 | +| [azurerm_network_security_group.nsg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_security_group) | resource | |
| 31 | +| [azurerm_network_security_rule.port22](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_security_rule) | resource | |
| 32 | +| [azurerm_network_security_rule.port4243](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_security_rule) | resource | |
| 33 | +| [azurerm_network_security_rule.port80](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_security_rule) | resource | |
| 34 | +| [azurerm_network_security_rule.port8080](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_security_rule) | resource | |
| 35 | +| [azurerm_resource_group.rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource | |
| 36 | +| [azurerm_subnet.subnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/subnet) | resource | |
| 37 | +| [azurerm_subnet_network_security_group_association.subnet2nsg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/subnet_network_security_group_association) | resource | |
| 38 | +| [azurerm_virtual_network.vnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_network) | resource | |
| 39 | + |
| 40 | +## Inputs |
| 41 | + |
| 42 | +| Name | Description | Type | Required | |
| 43 | +|------|-------------|------|:--------:| |
| 44 | +| <a name="input_application_name"></a> [application_name](#input_application_name) | Azure application name tag | `string` | no | |
| 45 | +| <a name="input_environment"></a> [environment](#input_environment) | Environment tag value in Azure | `string` | no | |
| 46 | +| <a name="input_location"></a> [location](#input_location) | Azure location | `string` | no | |
| 47 | +| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure Vnet resource group name | `string` | no | |
| 48 | +| <a name="input_subnet_cidrs"></a> [subnet_cidrs](#input_subnet_cidrs) | Azure Subnet Ip addresses | `list(string)` | no | |
| 49 | +| <a name="input_vnet_address_space"></a> [vnet_address_space](#input_vnet_address_space) | Azure VNET address space | `list(string)` | no | |
| 50 | +| <a name="input_vnet_name"></a> [vnet_name](#input_vnet_name) | Azure Vnet name | `string` | no | |
| 51 | + |
| 52 | +## Outputs |
| 53 | + |
| 54 | +| Name | Description | |
| 55 | +|------|-------------| |
| 56 | +| <a name="output_location"></a> [location](#output_location) | Azure Location | |
| 57 | +| <a name="output_network_security_group_id"></a> [network_security_group_id](#output_network_security_group_id) | Azure NSG ID | |
| 58 | +| <a name="output_resource_group_name"></a> [resource_group_name](#output_resource_group_name) | Azure resource group name | |
| 59 | +| <a name="output_subnet_ids"></a> [subnet_ids](#output_subnet_ids) | List of all subnet IDs | |
| 60 | +| <a name="output_vnet_address_range"></a> [vnet_address_range](#output_vnet_address_range) | Azure Vnet address range | |
| 61 | +| <a name="output_vnet_name"></a> [vnet_name](#output_vnet_name) | Azure Virtual network name | |
| 62 | +<!-- END_AUTOMATED_TF_DOCS_BLOCK --> |
0 commit comments