Repository files navigation

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.

The module supports theDeveloper,Basic,Standard andPremium SKU's for Azure Bastion.

Here is an example of how you can use this module in your Terraform configuration:

module"azure_bastion" {source="Azure/avm-res-network-bastionhost/azurerm"enable_telemetry=truename=module.naming.bastion_host.name_uniqueresource_group_name=azurerm_resource_group.this.namelocation=azurerm_resource_group.this.locationcopy_paste_enabled=truefile_copy_enabled=falsesku="Standard"ip_configuration={    name="my-ipconfig"    subnet_id= module.virtualnetwork.subnets["AzureBastionSubnet"].resource_id    public_ip_address_id= azurerm_public_ip.example.id  }ip_connect_enabled=truescale_units=4shareable_link_enabled=truetunneling_enabled=truekerberos_enabled=truetags={    environment="production"  }}

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 tohttps://semver.org/

The following requirements are needed by this module:

• terraform (>= 1.9, < 2.0)

• azapi (~> 2.0)

• azurerm (~> 4.10)

• modtm (~> 0.3)

• random (~> 3.5)

The following resources are used by this module:

• azapi_resource.bastion (resource)
• azapi_resource.bastion_developer (resource)
• azurerm_management_lock.pip (resource)
• azurerm_management_lock.this (resource)
• azurerm_monitor_diagnostic_setting.this (resource)
• azurerm_role_assignment.pip (resource)
• azurerm_role_assignment.this (resource)
• modtm_telemetry.telemetry (resource)
• random_uuid.telemetry (resource)
• azurerm_client_config.telemetry (data source)
• azurerm_public_ip.this (data source)
• azurerm_subscription.current (data source)
• modtm_module_source.telemetry (data source)

The following input variables are required:

Description: The location of the Azure Bastion Host and related resources.

Type:string

Description: The name of the Azure Bastion Host.

Type:string

Description: The name of the resource group where the Azure Bastion Host will be deployed.

Type:string

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

Description: Specifies whether copy-paste functionality is enabled for the Azure Bastion Host.

Type:bool

Default:true

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 areDedicated andAzureDiagnostics. Defaults toDedicated.
• 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:{}

Description: This variable controls whether or not telemetry is enabled for the module.
For more information seehttps://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

Description: Specifies whether file copy functionality is enabled for the Azure Bastion Host.

Type:bool

Default:false

Description: The IP configuration for the Azure Bastion Host.

• name - The name of the IP configuration.
• subnet_id - The ID of the subnet where the Azure Bastion Host will be deployed.
• create_public_ip - Specifies whether a public IP address should be created by the module.
• public_ip_tags - A map of tags to apply to the public IP address.
• public_ip_merge_with_module_tags - If set to true, the public IP tags will be merged with the module's tags. If set to false, only thepublic_ip_tags will be applied to the public IP address.
• public_ip_address_name - The Name of the public IP address to create. Will be ignored ifpublic_ip_address_id is set.
• public_ip_address_id - The ID of the public IP address associated with the Azure Bastion Host. If Set, create_public_ip must be set to false.

Type:

object({    name=optional(string)    subnet_id=string    create_public_ip=optional(bool,true)    public_ip_tags=optional(map(string),null)    public_ip_merge_with_module_tags=optional(bool,true)    public_ip_address_name=optional(string,null)    public_ip_address_id=optional(string,null)  })

Default:null

Description: Specifies whether IP connect functionality is enabled for the Azure Bastion Host.

Type:bool

Default:false

Description: Specifies whether Kerberos authentication is enabled for the Azure Bastion Host.

Type:bool

Default:false

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

Type:

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

Default:null

Description: Specifies whether the Azure Bastion Host is configured to be private only. This is a premium SKU feature.

Type:bool

Default:false

Description: A map of role assignments to create on the . 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 - (Optional) The description of the role assignment.
• skip_service_principal_aad_check - (Optional) If set to true, skips the Azure Active Directory check for the service principal in the tenant. Defaults to false.
• condition - (Optional) The condition which will be used to scope the role assignment.
• condition_version - (Optional) The version of the condition syntax. Leave asnull if you are not using a condition, if you are then valid values are '2.0'.
• delegated_managed_identity_resource_id - (Optional) The delegated Azure Resource Id which contains a Managed Identity. Changing this forces a new resource to be created. This field is only used in cross-tenant scenario.
• principal_type - (Optional) The type of theprincipal_id. Possible values areUser,Group andServicePrincipal. It is necessary to explicitly set this attribute when creating role assignments if the principal creating the assignment is constrained by ABAC rules that filters on the PrincipalType attribute.

Note: only setskip_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:{}

Description: The number of scale units for the Azure Bastion Host.

Type:number

Default:2

Description: Specifies whether session recording functionality is enabled for the Azure Bastion Host.

Type:bool

Default:false

Description: Specifies whether shareable link functionality is enabled for the Azure Bastion Host.

Type:bool

Default:false

Description: The SKU of the Azure Bastion Host.
Valid values are 'Basic', 'Standard', 'Developer' or 'Premium'.

Type:string

Default:"Basic"

Description: (Optional) Tags of the resource.

Type:map(string)

Default:null

Description: Specifies whether tunneling functionality is enabled for the Azure Bastion Host. (Native client support for SSH and RDP tunneling)

Type:bool

Default:false

Description: The ID of the virtual the Developer SKU Bastion hosts is attached to. Required for the Developer SKU Only.

Type:string

Default:null

Description: The availability zones where the Azure Bastion Host is deployed.

Type:set(string)

Default:

["1","2","3"]

The following outputs are exported:

Description: The FQDN of the Azure Bastion resource

Description: The name of the Azure Bastion resource

Description: The Azure Bastion resource

Description: The ID of the Azure Bastion resource

The following Modules are called:

Source: Azure/avm-res-network-publicipaddress/azurerm

Version: 0.2.0

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 athttps://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.