|
| 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 | +## Usage |
| 9 | +Basic usage of this module is as follows: |
| 10 | + ```hcl |
| 11 | + module "example" { |
| 12 | + source = "<module-path>" |
| 13 | + |
| 14 | + # Optional variables |
| 15 | + application_name = "" |
| 16 | + environment = "" |
| 17 | + location = "" |
| 18 | + loganalytics_retention_period = 7 |
| 19 | + loganalytics_sku = "PerGB2018" |
| 20 | + loganalytics_workspace_name = "" |
| 21 | + resource_group_name = "" |
| 22 | + } |
| 23 | + ``` |
| 24 | + |
| 25 | +## Resources |
| 26 | + |
| 27 | +| Name | Type | |
| 28 | +|------|------| |
| 29 | +| [azurerm_log_analytics_workspace.loganalytics_ws](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/log_analytics_workspace) | resource | |
| 30 | +| [azurerm_resource_group.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_environment"></a> [environment](#input_environment) | Environment tag value in Azure | `string` | no | |
| 38 | +| <a name="input_location"></a> [location](#input_location) | Azure location | `string` | no | |
| 39 | +| <a name="input_loganalytics_retention_period"></a> [loganalytics_retention_period](#input_loganalytics_retention_period) | Loganalytics logs retention period | `number` | no | |
| 40 | +| <a name="input_loganalytics_sku"></a> [loganalytics_sku](#input_loganalytics_sku) | Specifies the SKU of the Log Analytics Workspace | `string` | no | |
| 41 | +| <a name="input_loganalytics_workspace_name"></a> [loganalytics_workspace_name](#input_loganalytics_workspace_name) | Loganalytics workspace name | `string` | no | |
| 42 | +| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure resource group name to create log analytics workspace | `string` | no | |
| 43 | + |
| 44 | +## Outputs |
| 45 | + |
| 46 | +| Name | Description | |
| 47 | +|------|-------------| |
| 48 | +| <a name="output_loganalytics_retention_period"></a> [loganalytics_retention_period](#output_loganalytics_retention_period) | Azure loganalytics data retention in days | |
| 49 | +| <a name="output_loganalytics_sku"></a> [loganalytics_sku](#output_loganalytics_sku) | Azure loganalytics SKU | |
| 50 | +| <a name="output_loganalytics_workspace_name"></a> [loganalytics_workspace_name](#output_loganalytics_workspace_name) | Azure Log analytics workspace name | |
| 51 | +| <a name="output_loganalytics_workspace_resource_group"></a> [loganalytics_workspace_resource_group](#output_loganalytics_workspace_resource_group) | Azure Log analytics workspace resource group name | |
| 52 | +<!-- END_AUTOMATED_TF_DOCS_BLOCK --> |
0 commit comments