Information
# Azure Landing Zones Management Resources AVM Module
This module deploys the management resource for Azure Landings Zones.
## Features
- Deployment of Log Analytics Workspace.
- Opitional deployment of Azure Automation Account.
- Optional deployment of Azure Resource Group.
- Customizable Log Analytics Solutions.
- Optional deployment of Data Collections Rules.
- Optional deployment of User Assigned Managed Identity.
## Example
\`\`\`hcl
module "avm-ptn-alz-management" \{
source = "Azure/avm-ptn-alz-management/azurerm"
version = "" # change this to your desired version, https://www.terraform.io/language/expressions/version-constraints
automation_account_name = "aa-prod-eus-001"
location = "eastus"
log_analytics_workspace_name = "law-prod-eus-001"
resource_group_name = "rg-management-eus-001"
\}
\`\`\`
## Requirements
The following requirements are needed by this module:
- [terraform](#requirement\_terraform) (>= 1.9, < 2.0)
- [azapi](#requirement\_azapi) (~> 2.4)
- [azurerm](#requirement\_azurerm) (~> 4.35)
- [modtm](#requirement\_modtm) (~> 0.3)
- [random](#requirement\_random) (~> 3.6)
## Resources
The following resources are used by this module:
- [azapi_resource.data_collection_rule](https://registry.terraform.io/providers/Azure/azapi/latest/docs/resources/resource) (resource)
- [azapi_resource.sentinel_onboarding](https://registry.terraform.io/providers/Azure/azapi/latest/docs/resources/resource) (resource)
- [azurerm_automation_account.management](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/automation_account) (resource)
- [azurerm_log_analytics_linked_service.management](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/log_analytics_linked_service) (resource)
- [azurerm_log_analytics_solution.management](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/log_analytics_solution) (resource)
- [azurerm_log_analytics_workspace.management](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/log_analytics_workspace) (resource)
- [azurerm_resource_group.management](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) (resource)
- [azurerm_user_assigned_identity.management](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/user_assigned_identity) (resource)
- [modtm_telemetry.telemetry](https://registry.terraform.io/providers/azure/modtm/latest/docs/resources/telemetry) (resource)
- [random_uuid.telemetry](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/uuid) (resource)
- [azapi_client_config.current](https://registry.terraform.io/providers/Azure/azapi/latest/docs/data-sources/client_config) (data source)
- [azapi_client_config.telemetry](https://registry.terraform.io/providers/Azure/azapi/latest/docs/data-sources/client_config) (data source)
- [modtm_module_source.telemetry](https://registry.terraform.io/providers/azure/modtm/latest/docs/data-sources/module_source) (data source)
## Required Inputs
The following input variables are required:
### [automation\_account\_name](#input\_automation\_account\_name)
Description: The name of the Azure Automation Account to create.
Type: \`string\`
### [location](#input\_location)
Description: The Azure region where the resources will be deployed.
Type: \`string\`
### [resource\_group\_name](#input\_resource\_group\_name)
Description: The name of the Azure Resource Group where the resources will be created.
Type: \`string\`
## Optional Inputs
The following input variables are optional (have default values):
### [automation\_account\_encryption](#input\_automation\_account\_encryption)
Description: The encryption configuration for the Azure Automation Account.
Type:
\`\`\`hcl
object(\{
key_vault_key_id = string
user_assigned_identity_id = optional(string, null)
\})
\`\`\`
Default: \`null\`
### [automation\_account\_identity](#input\_automation\_account\_identity)
Description: The identity to assign to the Azure Automation Account.
Type:
\`\`\`hcl
object(\{
type = string
identity_ids = optional(set(string), null)
\})
\`\`\`
Default: \`null\`
### [automation\_account\_local\_authentication\_enabled](#input\_automation\_account\_local\_authentication\_enabled)
Description: Whether or not local authentication is enabled for the Azure Automation Account.
Type: \`bool\`
Default: \`true\`
### [automation\_account\_location](#input\_automation\_account\_location)
Description: The Azure region of the Azure Automation Account to deploy. This supports overriding the location variable in specific cases.
Type: \`string\`
Default: \`null\`
### [automation\_account\_public\_network\_access\_enabled](#input\_automation\_account\_public\_network\_access\_enabled)
Description: Whether or not public network access is enabled for the Azure Automation Account.
Type: \`bool\`
Default: \`true\`
### [automation\_account\_sku\_name](#input\_automation\_account\_sku\_name)
Description: The name of the SKU for the Azure Automation Account to create.
Type: \`string\`
Default: \`"Basic"\`
### [data\_collection\_rules](#input\_data\_collection\_rules)
Description: Enables customisation of the data collection rules for Azure Monitor.
This is an object with attributes pertaining to the three DCRs that are created by this module.
Each object has the following attributes:
- enabled (Optional) - Whether or not to create the data collection rule. Defaults to \`true\`.
- name (Required) - The name of the data collection rule. For the default values, see the default variable value.
- location (Optional) - The Azure region of the data collection rule. Defaults to the value of the location variable.
- tags (Optional) - A map of tags to apply to the data collection rule. Defaults to \`null\`.
The defender\_sql object has an additional attribute:
- enable\_collection\_of\_sql\_queries\_for\_security\_research (Optional) - Whether or not to enable collection of SQL queries for security research. Defaults to \`false\`.
Type:
\`\`\`hcl
object(\{
change_tracking = object(\{
enabled = optional(bool, true)
name = string
location = optional(string, null)
tags = optional(map(string), null)
\})
vm_insights = object(\{
enabled = optional(bool, true)
name = string
location = optional(string, null)
tags = optional(map(string), null)
\})
defender_sql = object(\{
enabled = optional(bool, true)
name = string
location = optional(string, null)
tags = optional(map(string), null)
enable_collection_of_sql_queries_for_security_research = optional(bool, false)
\})
\})
\`\`\`
Default:
\`\`\`json
\{
"change_tracking": \{
"name": "dcr-change-tracking"
\},
"defender_sql": \{
"name": "dcr-defender-sql"
\},
"vm_insights": \{
"name": "dcr-vm-insights"
\}
\}
\`\`\`
### [enable\_telemetry](#input\_enable\_telemetry)
Description: This variable controls whether or not telemetry is enabled for the module.
For more information see .
If it is set to false, then no telemetry will be collected.
Type: \`bool\`
Default: \`true\`
### [linked\_automation\_account\_creation\_enabled](#input\_linked\_automation\_account\_creation\_enabled)
Description: A boolean flag to determine whether to deploy the Azure Automation Account linked to the Log Analytics Workspace or not.
Type: \`bool\`
Default: \`false\`
### [log\_analytics\_solution\_plans](#input\_log\_analytics\_solution\_plans)
Description: The Log Analytics Solution Plans to create.
Do not add the SecurityInsights solution plan here, this deployment method is deprecated. Instead refer to \`sentinel_onboarding\` variable.
The value of this variable is a list of objects with the following attributes:
- product (Required) - The product name of the solution plan, e.g. \`OMSGallery/ContainerInsights\`.
- publisher (Optional) - The publisher name of the solution plan, e.g. \`Microsoft\`. Defaults to \`Microsoft\`.
Type:
\`\`\`hcl
list(object(\{
product = string
publisher = optional(string, "Microsoft")
\}))
\`\`\`
Default:
\`\`\`json
[
\{
"product": "OMSGallery/ContainerInsights",
"publisher": "Microsoft"
\},
\{
"product": "OMSGallery/VMInsights",
"publisher": "Microsoft"
\}
]
\`\`\`
### [log\_analytics\_workspace\_allow\_resource\_only\_permissions](#input\_log\_analytics\_workspace\_allow\_resource\_only\_permissions)
Description: Whether or not to allow resource-only permissions for the Log Analytics Workspace.
Type: \`bool\`
Default: \`true\`
### [log\_analytics\_workspace\_cmk\_for\_query\_forced](#input\_log\_analytics\_workspace\_cmk\_for\_query\_forced)
Description: Whether or not to force the use of customer-managed keys for query in the Log Analytics Workspace.
Type: \`bool\`
Default: \`null\`
### [log\_analytics\_workspace\_creation\_enabled](#input\_log\_analytics\_workspace\_creation\_enabled)
Description: Whether or not to create a Log Analytics Workspace.
Type: \`bool\`
Default: \`true\`
### [log\_analytics\_workspace\_daily\_quota\_gb](#input\_log\_analytics\_workspace\_daily\_quota\_gb)
Description: The daily ingestion quota in GB for the Log Analytics Workspace.
Type: \`number\`
Default: \`null\`
### [log\_analytics\_workspace\_id](#input\_log\_analytics\_workspace\_id)
Description: The ID of the pre-existing Log Analytics Workspace to use. Required if \`log_analytics_workspace_creation_enabled\` is \`false\`.
Type: \`string\`
Default: \`null\`
### [log\_analytics\_workspace\_internet\_ingestion\_enabled](#input\_log\_analytics\_workspace\_internet\_ingestion\_enabled)
Description: Whether or not internet ingestion is enabled for the Log Analytics Workspace.
Type: \`bool\`
Default: \`true\`
### [log\_analytics\_workspace\_internet\_query\_enabled](#input\_log\_analytics\_workspace\_internet\_query\_enabled)
Description: Whether or not internet query is enabled for the Log Analytics Workspace.
Type: \`bool\`
Default: \`true\`
### [log\_analytics\_workspace\_local\_authentication\_enabled](#input\_log\_analytics\_workspace\_local\_authentication\_enabled)
Description: Whether or not local authentication is enabled for the Log Analytics Workspace.
Type: \`bool\`
Default: \`true\`
### [log\_analytics\_workspace\_name](#input\_log\_analytics\_workspace\_name)
Description: The name of the Log Analytics Workspace to create.
Type: \`string\`
Default: \`null\`
### [log\_analytics\_workspace\_reservation\_capacity\_in\_gb\_per\_day](#input\_log\_analytics\_workspace\_reservation\_capacity\_in\_gb\_per\_day)
Description: The reservation capacity in GB per day for the Log Analytics Workspace.
Type: \`number\`
Default: \`null\`
### [log\_analytics\_workspace\_retention\_in\_days](#input\_log\_analytics\_workspace\_retention\_in\_days)
Description: The number of days to retain data for the Log Analytics Workspace.
Type: \`number\`
Default: \`30\`
### [log\_analytics\_workspace\_sku](#input\_log\_analytics\_workspace\_sku)
Description: The SKU to use for the Log Analytics Workspace.
Type: \`string\`
Default: \`"PerGB2018"\`
### [resource\_group\_creation\_enabled](#input\_resource\_group\_creation\_enabled)
Description: A boolean flag to determine whether to deploy the Azure Resource Group or not.
Type: \`bool\`
Default: \`true\`
### [sentinel\_onboarding](#input\_sentinel\_onboarding)
Description: Enables and customizes the Sentinel onboarding. Default is \`null\`, which disables Sentinel onboarding.
Set to empty object \`\{\}\` to enable with default values.
This is an object with the following attributes:
- name (Optional) - The name of the Sentinel onboarding object. Defaults to \`default\`.
- customer\_managed\_key\_enabled (Optional) - Whether or not to enable customer-managed keys for the Sentinel onboarding. Defaults to \`false\`.
Type:
\`\`\`hcl
object(\{
name = optional(string, "default")
customer_managed_key_enabled = optional(bool, false)
\})
\`\`\`
Default: \`null\`
### [tags](#input\_tags)
Description: A map of tags to apply to the resources created.
Type: \`map(string)\`
Default: \`null\`
### [timeouts](#input\_timeouts)
Description: A map of timeouts to apply to the creation and destruction of resources.
If using retry, the maximum elapsed retry time is governed by this value.
The object has attributes for each resource type, with the following optional attributes:
- \`create\` - (Optional) The timeout for creating the resource. Defaults to \`5m\`.
- \`delete\` - (Optional) The timeout for deleting the resource. Defaults to \`5m\` apart from data\_collection\_rule, where this is set to \`10m\`.
- \`update\` - (Optional) The timeout for updating the resource. Defaults to \`5m\`.
- \`read\` - (Optional) The timeout for reading the resource. Defaults to \`5m\`.
Each time duration is parsed using this function: .
Type:
\`\`\`hcl
object(\{
sentinel_onboarding = optional(object(\{
create = optional(string, "5m")
delete = optional(string, "5m")
update = optional(string, "5m")
read = optional(string, "5m")
\}), \{\}
)
data_collection_rule = optional(object(\{
create = optional(string, "5m")
delete = optional(string, "10m")
update = optional(string, "5m")
read = optional(string, "5m")
\}), \{\}
)
\})
\`\`\`
Default: \`\{\}\`
### [user\_assigned\_managed\_identities](#input\_user\_assigned\_managed\_identities)
Description: Enables customisation of the user assigned managed identities.
The value of this variable is an object with the following attributes:
- ama (Required) - The user assigned managed identity for the Azure Monitor Agent.
- enabled (Optional) - Whether or not to create the user assigned managed identity. Defaults to \`true\`.
- name (Required) - The name of the user assigned managed identity, the variable default value is \`uami-ama\`.
- location (Optional) - The Azure region of the user assigned managed identity. Defaults to the value of the location variable.
- tags (Optional) - A map of tags to apply to the user assigned managed identity. Defaults to \`null\`.
Type:
\`\`\`hcl
object(\{
ama = object(\{
enabled = optional(bool, true)
name = string
location = optional(string, null)
tags = optional(map(string), null)
\})
\})
\`\`\`
Default:
\`\`\`json
\{
"ama": \{
"name": "uami-ama"
\}
\}
\`\`\`
## Outputs
The following outputs are exported:
### [automation\_account](#output\_automation\_account)
Description: A curated output of the Azure Automation Account.
### [automation\_account\_dsc\_keys](#output\_automation\_account\_dsc\_keys)
Description: Sensitive values for the Azure Automation Account.
### [data\_collection\_rule\_ids](#output\_data\_collection\_rule\_ids)
Description: Data Collection Rule Resource Ids.
### [log\_analytics\_workspace](#output\_log\_analytics\_workspace)
Description: A curated output of the Log Analytics Workspace.
### [log\_analytics\_workspace\_keys](#output\_log\_analytics\_workspace\_keys)
Description: Sensitive values for the Log Analytics Workspace.
### [resource\_group](#output\_resource\_group)
Description: A curated output of the Azure Resource Group.
### [resource\_id](#output\_resource\_id)
Description: The resource ID of the Log Analytics Workspace.
### [user\_assigned\_identity\_ids](#output\_user\_assigned\_identity\_ids)
Description: User assigned identity IDs.
## Modules
No modules.
## Data Collection
The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at . You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.