From 0d765b06c08868a10e962b83c1b52cdb15f82052 Mon Sep 17 00:00:00 2001 From: github-actions Date: Sat, 21 Sep 2024 10:18:13 +0000 Subject: [PATCH] Update documentation --- log-analytics-workspace/README.md | 52 +++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 log-analytics-workspace/README.md diff --git a/log-analytics-workspace/README.md b/log-analytics-workspace/README.md new file mode 100644 index 0000000..e4d0670 --- /dev/null +++ b/log-analytics-workspace/README.md @@ -0,0 +1,52 @@ + +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement_terraform) | ~> 1.3 | +| [azurerm](#requirement_azurerm) | <= 4.0 | +## Usage +Basic usage of this module is as follows: + ```hcl + module "example" { + source = "" + + # Optional variables + application_name = "" + environment = "" + location = "" + loganalytics_retention_period = 7 + loganalytics_sku = "PerGB2018" + loganalytics_workspace_name = "" + resource_group_name = "" + } + ``` + +## Resources + +| Name | Type | +|------|------| +| [azurerm_log_analytics_workspace.loganalytics_ws](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/log_analytics_workspace) | resource | +| [azurerm_resource_group.rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource | + +## Inputs + +| Name | Description | Type | Required | +|------|-------------|------|:--------:| +| [application_name](#input_application_name) | Azure application name tag | `string` | no | +| [environment](#input_environment) | Environment tag value in Azure | `string` | no | +| [location](#input_location) | Azure location | `string` | no | +| [loganalytics_retention_period](#input_loganalytics_retention_period) | Loganalytics logs retention period | `number` | no | +| [loganalytics_sku](#input_loganalytics_sku) | Specifies the SKU of the Log Analytics Workspace | `string` | no | +| [loganalytics_workspace_name](#input_loganalytics_workspace_name) | Loganalytics workspace name | `string` | no | +| [resource_group_name](#input_resource_group_name) | Azure resource group name to create log analytics workspace | `string` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| [loganalytics_retention_period](#output_loganalytics_retention_period) | Azure loganalytics data retention in days | +| [loganalytics_sku](#output_loganalytics_sku) | Azure loganalytics SKU | +| [loganalytics_workspace_name](#output_loganalytics_workspace_name) | Azure Log analytics workspace name | +| [loganalytics_workspace_resource_group](#output_loganalytics_workspace_resource_group) | Azure Log analytics workspace resource group name | + \ No newline at end of file