terraform-azurerm-avm-tlogic_workflow

This module creates a Logic App workflow with the Consumption SKU.

Requirements

The following requirements are needed by this module:

terraform (~> 1.5)
azapi (~> 1.13)
azurerm (~> 3.71)
modtm (~> 0.3)
random (~> 3.5)

Resources

The following resources are used by this module:

azapi_resource.this (resource)
azurerm_management_lock.this (resource)
azurerm_monitor_diagnostic_setting.this (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:

location

Description: Azure region where the resource should be deployed.

Type: string

name

Description: The name of the this resource.

Type: string

resource_group_id

Description: The resource group ID where the resources will be deployed.

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):

Description: "Optional. The access control configuration for the workflow." Refer https://learn.microsoft.com/en-us/azure/templates/microsoft.logic/workflows?pivots=deployment-language-terraform for schema reference. This variable is left untyped, so that adhoc openAuthenticationPolicies can be specified. A basic example is available in the waf-aligned example.

Type: map

Default: {}

customer_managed_key

Description: A map describing customer-managed keys to associate with the resource. This includes the following properties:

key_vault_resource_id - The resource ID of the Key Vault where the key is stored.
key_name - The name of the key.
key_version - (Optional) The version of the key. If not specified, the latest version is used.
user_assigned_identity - (Optional) An object representing a user-assigned identity with the following properties:
- resource_id - The resource ID of the user-assigned identity.

Type:

object({
    key_vault_resource_id = string
    key_name              = string
    key_version           = optional(string, null)
    user_assigned_identity = optional(object({
      resource_id = string
    }), null)
  })

Default: null

diagnostic_settings

Description: A map of diagnostic settings to create on the Key Vault. 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

endpoints_configuration

Description: Optional. The endpoints configuration: Access endpoint and outgoing IP addresses for the connector and workflow. Refer https://learn.microsoft.com/en-us/azure/templates/microsoft.logic/workflows?pivots=deployment-language-terraform for schema reference. This variable is untyped; refer waf-aligned example for usage guidance.

Type: map

Default: {}

integration_account_id

Description: Optional. The Integration Account ID.

Type: string

Default: ""

integration_service_environment_id

Description: Optional. The integration service environment id.

Type: string

Default: ""

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 the kind value. Changing this forces the creation of a new resource.

Type:

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

Default: null

logic_app_definition

Description: This variable contains the actual Logic App workflow definition. In practice, Logic app workflows are usually created using Azure Portal or VS Code extensions. Pre-existing workflows can be exported into their JSON representation, which is added as input to this deployment through this variable It is to be noted that only the Logic app definition is included here; For example, if a Logic App uses any API connections, that resource has to be provisioned separately.

Type: map

Default:

{
  "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
  "actions": {},
  "contentVersion": "1.0.0.0",
  "outputs": {},
  "parameters": {},
  "triggers": {}
}

managed_identities

Description: Controls the Managed Identity configuration on this resource. The following properties can be specified:

system_assigned - (Optional) Specifies if the System Assigned Managed Identity should be enabled.
user_assigned_resource_ids - (Optional) Specifies a list of User Assigned Managed Identity resource IDs to be assigned to this resource.

Type:

object({
    system_assigned            = optional(bool, false)
    user_assigned_resource_ids = optional(set(string), [])
  })

Default: {}

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_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)
    principal_type                         = optional(string, null)
  }))

Default: {}

state

Description: Optional. The state. - NotSpecified, Completed, Enabled, Disabled, Deleted, Suspended.

Type: string

Default: "Enabled"

Outputs

The following outputs are exported:

resource

Description: This is the full output for the resource.

resource_id

Description: Resource ID of logic app

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.