terraform-azurerm-avm-ptn-azuremonitorwindowsagent
MIT License
terraform-azurerm-avm-ptn-azuremonitorwindowsagent
This is a module to provision AzureStachHCI extension azuremonitorwindowsagent.
Requirements
The following requirements are needed by this module:
Resources
The following resources are used by this module:
- azapi_resource.monitor_agent (resource)
- azurerm_log_analytics_workspace.workspace (resource)
- azurerm_management_lock.this (resource)
- azurerm_monitor_data_collection_endpoint.dce (resource)
- azurerm_monitor_data_collection_rule.dcr (resource)
- azurerm_monitor_data_collection_rule_association.association (resource)
- azurerm_role_assignment.this (resource)
- modtm_telemetry.telemetry (resource)
- random_uuid.telemetry (resource)
- azurerm_client_config.telemetry (data source)
- modtm_module_source.telemetry (data source)
Required Inputs
The following input variables are required:
arc_server_ids
Description: The resource IDs of the Azure Arc servers. Key is the server name and value is the resource ID.
Type: map(string)
arc_setting_id
Description: The resource ID for the Azure Arc setting.
Type: string
resource_group_name
Description: The resource group where the resources will be deployed.
Type: string
Optional Inputs
The following input variables are optional (have default values):
azurerm_monitor_data_collection_rule_association_name
Description: The name of the Azure Monitor Data Collection Rule Association.
Type: string
Default: ""
cmk_for_query_forced
Description: (Optional) Is Customer Managed Storage mandatory for query management?
Type: bool
Default: false
counter_specifiers
Description: A list of performance counter specifiers.
Type: list(string)
Default:
[
"\\Memory\\Available Bytes",
"\\Network Interface(*)\\Bytes Total/sec",
"\\Processor(_Total)\\% Processor Time",
"\\RDMA Activity(*)\\RDMA Inbound Bytes/sec",
"\\RDMA Activity(*)\\RDMA Outbound Bytes/sec"
]
create_data_collection_resources
Description: Whether to create the data collection resources.
Type: bool
Default: false
data_collection_endpoint_name
Description: The name of the Azure Log Analytics data collection endpoint.
Type: string
Default: null
data_collection_endpoint_tags
Description: A mapping of tags to assign to th data collection endpoint.
Type: map(string)
Default: {}
data_collection_resources_location
Description: The location of the data collection resources.
Type: string
Default: ""
data_collection_rule_destination_id
Description: The id of data collection rule destination id.
Type: string
Default: "2-90d1-e814dab6067e"
data_collection_rule_name
Description: The name of the Azure Log Analytics data collection rule.
Type: string
Default: null
data_collection_rule_resource_id
Description: The id of the Azure Log Analytics data collection rule.
Type: string
Default: null
data_collection_rule_tags
Description: A mapping of tags to assign to th data collection rule.
Type: map(string)
Default: {}
enable_telemetry
Description: This variable controls whether or not telemetry is enabled for the module. For more information see https://aka.ms/avm/telemetryinfo. If it is set to false, then no telemetry will be collected.
Type: bool
Default: true
immediate_data_purge_on_30_days_enabled
Description: (Optional) Whether to remove the data in the Log Analytics Workspace immediately after 30 days.
Type: bool
Default: false
lock
Description: Controls the Resource Lock configuration for this resource. The following properties can be specified:
-
kind- (Required) The type of lock. Possible values are\"CanNotDelete\"and\"ReadOnly\". -
name- (Optional) The name of the lock. If not specified, a name will be generated based on thekindvalue. Changing this forces the creation of a new resource.
Type:
object({
kind = string
name = optional(string, null)
})
Default: null
name
Description: The name of the this resource.
Type: string
Default: "AzureMonitorWindowsAgent"
retention_in_days
Description: (Optional) The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730.
Type: number
Default: 30
role_assignments
Description: A map of role assignments to create on this resource. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
-
role_definition_id_or_name- The ID or name of the role definition to assign to the principal. -
principal_id- The ID of the principal to assign the role to. -
description- The description of the role assignment. -
skip_service_principal_aad_check- If set to true, skips the Azure Active Directory check for the service principal in the tenant. Defaults to false. -
condition- The condition which will be used to scope the role assignment. -
condition_version- The version of the condition syntax. Valid values are '2.0'.
Note: only set
skip_service_principal_aad_checkto true if you are assigning a role to a service principal.
Type:
map(object({
role_definition_id_or_name = string
principal_id = string
description = optional(string, null)
skip_service_principal_aad_check = optional(bool, false)
condition = optional(string, null)
condition_version = optional(string, null)
delegated_managed_identity_resource_id = optional(string, null)
principal_type = optional(string, null)
}))
Default: {}
sku
Description: (Optional) Specifies the SKU of the Log Analytics Workspace.
Type: string
Default: "PerGB2018"
workspace_name
Description: The name of the Azure Log Analytics workspace.
Type: string
Default: null
workspace_tags
Description: A mapping of tags to assign to the Azure Log Analytics workspace.
Type: map(string)
Default: {}
x_path_queries
Description: A list of XPath queries for event logs.
Type: list(string)
Default:
[
"Microsoft-Windows-SDDC-Management/Operational!*[System[(EventID=3000 or EventID=3001 or EventID=3002 or EventID=3003 or EventID=3004)]]",
"microsoft-windows-health/operational!*"
]
Outputs
The following outputs are exported:
resource_id
Description: This is the full output for the resource.
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 https://go.microsoft.com/fwlink/?LinkID=824704. 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.