/terraform-azurerm-avm-res-operationalinsights-workspace

Azure Log Analytics Workspace AVM Module

Primary LanguageHCLMIT LicenseMIT

terraform-azurerm-avm-res-operationalinsights-workspace

This repo is to deploy an Log Anayltics Workspace.

Major version Zero (0.y.z) is for initial development. Anything MAY change at any time. The module SHOULD NOT be considered stable till at least it is major version one (1.0.0) or greater. Changes will always be via new versions being published and no changes will be made to existing published versions. For more details please go to https://semver.org/

Requirements

The following requirements are needed by this module:

Providers

The following providers are used by this module:

Resources

The following resources are used by this module:

Required Inputs

The following input variables are required:

location

Description: (Required) Specifies the suppored Azure location where the Log Anayltics Workspace should exist. Changing this forces a new resource to be created

Type: string

name

Description: Specifies the name of the Log Analytics Workspace. Changing this forces a new resource to be created.

Type: string

resource_group_name

Description: (Required) Specifies the name of the Resource Group in which the Log Analytics Workspace should exist. Changing this forces a new resource to be created

Type: string

Optional Inputs

The following input variables are optional (have default values):

diagnostic_settings

Description: A map of diagnostic settings to create on the Workspace. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.

  • name - (Optional) The name of the diagnostic setting. One will be generated if not set, however this will not be unique if you want to create multiple diagnostic setting resources.
  • log_categories - (Optional) A set of log categories to send to the log analytics workspace. Defaults to [].
  • log_groups - (Optional) A set of log groups to send to the log analytics workspace. Defaults to ["allLogs"].
  • metric_categories - (Optional) A set of metric categories to send to the log analytics workspace. Defaults to ["AllMetrics"].
  • log_analytics_destination_type - (Optional) The destination type for the diagnostic setting. Possible values are Dedicated and AzureDiagnostics. Defaults to Dedicated.
  • workspace_resource_id - (Optional) The resource ID of the log analytics workspace to send logs and metrics to.
  • storage_account_resource_id - (Optional) The resource ID of the storage account to send logs and metrics to.
  • event_hub_authorization_rule_resource_id - (Optional) The resource ID of the event hub authorization rule to send logs and metrics to.
  • event_hub_name - (Optional) The name of the event hub. If none is specified, the default event hub will be selected.
  • marketplace_partner_resource_id - (Optional) The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic LogsLogs.

Type:

map(object({
    name                                     = optional(string, null)
    log_categories                           = optional(set(string), [])
    log_groups                               = optional(set(string), ["allLogs"])
    metric_categories                        = optional(set(string), ["AllMetrics"])
    log_analytics_destination_type           = optional(string, "Dedicated")
    workspace_resource_id                    = optional(string, null)
    storage_account_resource_id              = optional(string, null)
    event_hub_authorization_rule_resource_id = optional(string, null)
    event_hub_name                           = optional(string, null)
    marketplace_partner_resource_id          = optional(string, null)
  }))

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

lock

Description: The lock level to apply to the Virtual Network. Default is None. Possible values are None, CanNotDelete, and ReadOnly.

Type:

object({
    name = optional(string, null)
    kind = optional(string, "None")
  })

Default: {}

log_analytics_workspace_allow_resource_only_permissions

Description: (Optional) Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to true.

Type: bool

Default: null

log_analytics_workspace_cmk_for_query_forced

Description: (Optional) Is Customer Managed Storage mandatory for query management?

Type: bool

Default: null

log_analytics_workspace_daily_quota_gb

Description: (Optional) The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited) if omitted.

Type: number

Default: null

log_analytics_workspace_identity

Description: - identity_ids - (Optional) Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

  • type - (Required) Specifies the identity type of the Log Analytics Workspace. Possible values are SystemAssigned (where Azure will generate a Service Principal for you) and UserAssigned where you can specify the Service Principal IDs in the identity_ids field.

Type:

object({
    identity_ids = optional(set(string))
    type         = string
  })

Default: null

log_analytics_workspace_internet_ingestion_enabled

Description: (Optional) Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to true.

Type: bool

Default: null

log_analytics_workspace_internet_query_enabled

Description: (Optional) Should the Log Analytics Workspace support querying over the Public Internet? Defaults to true.

Type: bool

Default: null

log_analytics_workspace_local_authentication_disabled

Description: (Optional) Specifies if the log Analytics workspace should enforce authentication using Azure AD. Defaults to false.

Type: bool

Default: null

log_analytics_workspace_reservation_capacity_in_gb_per_day

Description: (Optional) The capacity reservation level in GB for this workspace. Possible values are 100, 200, 300, 400, 500, 1000, 2000 and 5000.

Type: number

Default: null

log_analytics_workspace_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: null

log_analytics_workspace_sku

Description: (Optional) Specifies the SKU of the Log Analytics Workspace. Possible values are Free, PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, and PerGB2018 (new SKU as of 2018-04-03). Defaults to PerGB2018.

Type: string

Default: null

log_analytics_workspace_timeouts

Description: - create - (Defaults to 30 minutes) Used when creating the Log Analytics Workspace.

  • delete - (Defaults to 30 minutes) Used when deleting the Log Analytics Workspace.
  • read - (Defaults to 5 minutes) Used when retrieving the Log Analytics Workspace.
  • update - (Defaults to 30 minutes) Used when updating the Log Analytics Workspace.

Type:

object({
    create = optional(string)
    delete = optional(string)
    read   = optional(string)
    update = optional(string)
  })

Default: null

role_assignments

Description: A map of role assignments to create on the Workspace. 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. Leave as null if you are not using a condition, if you are then valid values are '2.0'.

Note: only set skip_service_principal_aad_check to 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)
  }))

Default: {}

tags

Description: The tags to associate with your network and subnets.

Type: map(any)

Default: {}

Outputs

The following outputs are exported:

name

Description: The Name of the Log Analytics Workspace.

resource

Description: The Log Analytics Workspace resource

workspace_id

Description: The Resource ID of the Log Analytics Workspace.

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.