Azure Verified Module for Azure Bastion

This module provides a generic way to create and manage a Azure Bastion resource.

To use this module in your Terraform configuration, you'll need to provide values for the required variables. Here's a basic example:

module "azure_bastion" {
  source = "./path_to_this_module"

  enable_telemetry     = true
  resource_group_name  = azurerm_resource_group.this.name
  virtual_network_name = azurerm_virtual_network.example.name

  // Define the bastion host configuration
  bastion_host = {
    name                = "my-bastion"
    resource_group_name = azurerm_resource_group.this.name
    location            = "southeastasia"
    copy_paste_enabled  = true
    file_copy_enabled   = false
    sku                 = "Basic"
    ip_configuration = {
      name                 = "my-ipconfig"
      subnet_id            = "subnet_id_resource"
      public_ip_address_id = azurerm_public_ip.example.id
    }
    ip_connect_enabled     = true
    scale_units            = 2
    shareable_link_enabled = true
    tunneling_enabled      = true
  }

AVM Versioning Notice

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:

• terraform (>= 1.0.0)

• azurerm (>= 3.11, < 4.0)

• random (>= 3.5.0)

Providers

The following providers are used by this module:

• azurerm (>= 3.11, < 4.0)

• random (>= 3.5.0)

Resources

The following resources are used by this module:

• azurerm_bastion_host.bastion (resource)
• azurerm_management_lock.this (resource)
• azurerm_monitor_diagnostic_setting.this (resource)
• azurerm_resource_group_template_deployment.telemetry (resource)
• azurerm_role_assignment.this (resource)
• random_id.telem (resource)

Required Inputs

The following input variables are required:

bastion_host

Description: "Configuration for Azure Bastion Host. The variable requires a subnet with the name AzureBastionSubnet, else the deployment will fail"

Example usage:

bastion_host = {
name                = "example-bastion"
resource_group_name = "example-resources"
location            = "West Europe"
copy_paste_enabled  = true
file_copy_enabled   = false // Remember that this is only applicable for Standard SKU
sku                 = "Standard"
ip_configuration = {
  name                 = "example-ipconfig"
  subnet_id            = "subnet-id"
  public_ip_address_id = "public-ip-id"
}
ip_connect_enabled     = false // Only applicable for Standard SKU
scale_units            = 2     // Only changeable for Standard SKU and always 2 for Basic
shareable_link_enabled = false // Only applicable for Standard SKU
tunneling_enabled      = false // Only applicable for Standard SKU

Type:

object({
    name                = string
    resource_group_name = string
    location            = string
    copy_paste_enabled  = bool
    file_copy_enabled   = bool
    sku                 = string
    ip_configuration = object({
      name                 = string
      subnet_id            = string
      public_ip_address_id = string
    })
    ip_connect_enabled     = bool
    scale_units            = number
    shareable_link_enabled = bool
    tunneling_enabled      = bool
  })

resource_group_name

Description: "The name of the resource group in which to create the Azure Bastion."
Example usage:
resource_group_name = "myResourceGroup"

Type: string

virtual_network_name

Description: "The name of the virtual network where Azure Bastion will be deployed."
Example usage:
virtual_network_name = "myVnet"

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 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.

Example usage:

diagnostic_settings = {
setting1 = {
  log_analytics_destination_type = "Dedicated"
  workspace_resource_id = "logAnalyticsWorkspaceResourceId"
}
}

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.

Example usage:
enable_telemetry = false

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.
Example usage:
name = "test-lock"
kind = "ReadOnly"

Type:

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

Default: {}

role_assignments

Description: A map of role assignments to create on the Key Vault. 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.
Example usage:
role_assignments = {
assignment1 = {
role_definition_id_or_name = "Contributor"
principal_id = "servicePrincipalId" } }

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: {}

subnet_name

Description: "The name of the subnet where Azure Bastion will be deployed. The variable requires a subnet with the name AzureBastionSubnet, else the deployment will fail."

Example usage:
subnet_name = "AzureBastionSubnet"

Type: string

Default: "AzureBastionSubnet"

tags

Description: The tags to associate with your network and subnets.
Example usage:
tags = {
environment = "production"
project = "myProject" }

Type: map(string)

Default: {}

Outputs

The following outputs are exported:

bastion_resource

Description: The Azure Bastion 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.