Skip to content

Commit e6dc58c

Browse files
committed
Update documentation
1 parent e99c4d5 commit e6dc58c

File tree

2 files changed

+55
-103
lines changed

2 files changed

+55
-103
lines changed

README.md

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

data-factory/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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+
data_factory_name = ""
18+
environment = "DEV"
19+
location = ""
20+
managed_virtual_network_enabled = "true"
21+
public_network_enabled = "true"
22+
resource_group_name = ""
23+
temporary = "TRUE"
24+
}
25+
```
26+
27+
## Resources
28+
29+
| Name | Type |
30+
|------|------|
31+
| [azurerm_data_factory.data_factory](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/data_factory) | resource |
32+
| [azurerm_resource_group.data_factory_rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
33+
34+
## Inputs
35+
36+
| Name | Description | Type | Required |
37+
|------|-------------|------|:--------:|
38+
| <a name="input_application_name"></a> [application_name](#input_application_name) | Azure application name tag | `string` | no |
39+
| <a name="input_data_factory_name"></a> [data_factory_name](#input_data_factory_name) | Azure Data factory name | `string` | no |
40+
| <a name="input_environment"></a> [environment](#input_environment) | Environment tag value in Azure | `string` | no |
41+
| <a name="input_location"></a> [location](#input_location) | Azure Data factory location | `string` | no |
42+
| <a name="input_managed_virtual_network_enabled"></a> [managed_virtual_network_enabled](#input_managed_virtual_network_enabled) | Is Managed Virtual Network enabled | `string` | no |
43+
| <a name="input_public_network_enabled"></a> [public_network_enabled](#input_public_network_enabled) | Is Public Network enabled | `string` | no |
44+
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure Datafactory Rg | `string` | no |
45+
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |
46+
47+
## Outputs
48+
49+
| Name | Description |
50+
|------|-------------|
51+
| <a name="output_data_factory_location"></a> [data_factory_location](#output_data_factory_location) | Azure data factory location |
52+
| <a name="output_data_factory_name"></a> [data_factory_name](#output_data_factory_name) | Azure Data Factory name |
53+
| <a name="output_public_access_enabled"></a> [public_access_enabled](#output_public_access_enabled) | Azure datafactory enabled public access or not |
54+
| <a name="output_resource_group"></a> [resource_group](#output_resource_group) | Azure data factory resource group name |
55+
<!-- END_AUTOMATED_TF_DOCS_BLOCK -->

0 commit comments

Comments
 (0)