Skip to content

Commit ef3edbc

Browse files
committed
Update documentation
1 parent 77a4fab commit ef3edbc

File tree

2 files changed

+52
-118
lines changed

2 files changed

+52
-118
lines changed

README.md

Lines changed: 0 additions & 118 deletions
This file was deleted.

dns-zone/README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
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 = "devwithkrishna"
17+
dns_zone_name = ""
18+
environment = "DEV"
19+
location = ""
20+
resource_group_name = ""
21+
temporary = "TRUE"
22+
}
23+
```
24+
25+
## Resources
26+
27+
| Name | Type |
28+
|------|------|
29+
| [azurerm_dns_zone.dns](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/dns_zone) | resource |
30+
| [azurerm_resource_group.dns_rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
31+
32+
## Inputs
33+
34+
| Name | Description | Type | Required |
35+
|------|-------------|------|:--------:|
36+
| <a name="input_application_name"></a> [application_name](#input_application_name) | Azure application name tag | `string` | no |
37+
| <a name="input_dns_zone_name"></a> [dns_zone_name](#input_dns_zone_name) | Azure DNS Zone name | `string` | no |
38+
| <a name="input_environment"></a> [environment](#input_environment) | Environment tag value in Azure | `string` | no |
39+
| <a name="input_location"></a> [location](#input_location) | Azure DNS RG location | `string` | no |
40+
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure DNS Zone Rg | `string` | no |
41+
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |
42+
43+
## Outputs
44+
45+
| Name | Description |
46+
|------|-------------|
47+
| <a name="output_dns_zone_id"></a> [dns_zone_id](#output_dns_zone_id) | DNS zone ID |
48+
| <a name="output_dns_zone_name"></a> [dns_zone_name](#output_dns_zone_name) | Azure DNS zone name |
49+
| <a name="output_name_servers"></a> [name_servers](#output_name_servers) | Name servers for the DNS zone |
50+
| <a name="output_resource_group"></a> [resource_group](#output_resource_group) | Azure DNS Zone resource group name |
51+
| <a name="output_resource_group_location"></a> [resource_group_location](#output_resource_group_location) | Azure resource group location |
52+
<!-- END_AUTOMATED_TF_DOCS_BLOCK -->

0 commit comments

Comments
 (0)