terraform-azure-mcaf-virtualmachine

Terraform module to deploy virtual machines

This module's defaults are optimized and set to default to be used with gen2 images!

Generation 2 pros.

• UEFI
• SCSI / NVMe docs
• Secure Boot
• vTPM
• Trusted Launch docs

Generation 2 cons.

• not all vm sizes are supported list
• not all vm images are supported list

Usage

How to find the right SKU

Partialy search to speed up, it can take some time if you search for all SKU's.

• --size D4s
• --size _v6
• --zone to list only availabity zone enabled sku's

az vm list-skus --location germanywestcentral --query '[?resourceType==`virtualMachines` && restrictions == `[]`]' --output table --size D4
#
az vm list-skus --location germanywestcentral --query '[?resourceType==`virtualMachines` && restrictions == `[]`]' --output table --size _v6

how to find the right image definition. (Publisher, Offer, SKU)

Partialy search to speed up, it can take some time if you search for all images.

• --sku gen2
• --sku 22_04
• --sku 2025

Add --all if you want to to list all available.

# Windows
az vm image list --location germanywestcentral --publisher MicrosoftWindowsServer --sku hotpatch --output table --query "[].{Publisher:publisher, Offer:offer, Sku:sku, Version:version}" --all


#Ubuntu
az vm image list --location germanywestcentral --publisher Canonical --output table --query "[].{Publisher:publisher, Offer:offer, Sku:sku, Version:version}"

Requirements

Name	Version
terraform	>= 1.8
azapi	>= 2.0, < 3.0
azurerm	>= 4.5, < 5.0
random	>= 3.0
time	>= 0.12

Providers

Name	Version
azapi	>= 2.0, < 3.0
azurerm	>= 4.5, < 5.0
random	>= 3.0
terraform	n/a
time	>= 0.12

Modules

No modules.

Resources

Name	Type
azapi_update_resource.linux_os_disk	resource
azapi_update_resource.windows_os_disk	resource
azurerm_dev_test_global_vm_shutdown_schedule.this	resource
azurerm_key_vault_secret.admin_password	resource
azurerm_linux_virtual_machine.this	resource
azurerm_managed_disk.this	resource
azurerm_network_interface.virtualmachine_network_interfaces	resource
azurerm_network_interface_application_gateway_backend_address_pool_association.this	resource
azurerm_network_interface_application_security_group_association.this	resource
azurerm_network_interface_backend_address_pool_association.this	resource
azurerm_network_interface_nat_rule_association.this	resource
azurerm_network_interface_security_group_association.this	resource
azurerm_public_ip.virtualmachine_public_ips	resource
azurerm_role_assignment.system_managed_identity	resource
azurerm_role_assignment.this_virtual_machine	resource
azurerm_virtual_machine_data_disk_attachment.this_linux	resource
azurerm_virtual_machine_data_disk_attachment.this_windows	resource
azurerm_virtual_machine_extension.this_extension	resource
azurerm_windows_virtual_machine.this	resource
random_password.admin_password	resource
terraform_data.password_timestamp	resource
time_static.password_timestamp	resource
azurerm_resource_group.this	data source

Inputs

Name	Description	Type	Default	Required
location	The Azure region where this and supporting resources should be deployed.	string	n/a	yes
name	The name to use when creating the virtual machine.	string	n/a	yes
network_interfaces	A map of objects representing each network virtual machine network interface - <map key> - Use a custom map key to define each network interface - name = (Required) The name of the Network Interface. Changing this forces a new resource to be created. - ip_configurations - A required map of objects defining each interfaces IP configurations - <map key> - Use a custom map key to define each ip configuration - name = (Required) - A name used for this IP Configuration. - app_gateway_backend_pools = (Optional) - A map defining app gateway backend pool(s) this IP configuration should be associated to. - <map key> - Use a custom map key to define each app gateway backend pool association. This is done to handle issues with certain details not being known until after apply. - app_gateway_backend_pool_resource_id = (Required) - An application gateway backend pool Azure Resource ID can be entered to join this ip configuration to the backend pool of an Application Gateway. - create_public_ip_address = (Optional) - Select true here to have the module create the public IP address for this IP Configuration - gateway_load_balancer_frontend_ip_configuration_resource_id = (Optional) - The Frontend IP Configuration Azure Resource ID of a Gateway SKU Load Balancer.) - is_primary_ipconfiguration = (Optional) - Is this the Primary IP Configuration? Must be true for the first ip_configuration when multiple are specified. - load_balancer_backend_pools = (Optional) - A map defining load balancer backend pool(s) this IP configuration should be associated to. - <map key> - Use a custom map key to define each load balancer backend pool association. This is done to handle issues with certain details not being known until after apply. - load_balancer_backend_pool_resource_id = (Required) - A Load Balancer backend pool Azure Resource ID can be entered to join this ip configuration to a load balancer backend pool. - load_balancer_nat_rules = (Optional) - A map defining load balancer NAT rule(s) that this IP Configuration should be associated to. - <map key> - Use a custom map key to define each load balancer NAT Rule association. This is done to handle issues with certain details not being known until after apply. - load_balancer_nat_rule_resource_id = (Optional) - A Load Balancer Nat Rule Azure Resource ID can be entered to associate this ip configuration to a load balancer NAT rule. - private_ip_address = (Optional) - The Static IP Address which should be used. Configured when private_ip_address_allocation is set to Static - private_ip_address_allocation = (Optional) - The allocation method used for the Private IP Address. Possible values are Dynamic and Static. Dynamic means "An IP is automatically assigned during creation of this Network Interface" and is the default; Static means "User supplied IP address will be used" - private_ip_address_version = (Optional) - The IP Version to use. Possible values are IPv4 or IPv6. Defaults to IPv4. - private_ip_subnet_resource_id = (Optional) - The Azure Resource ID of the Subnet where this Network Interface should be located in. - public_ip_address_resource_id = (Optional) - Reference to a Public IP Address resource ID to associate with this NIC - accelerated_networking_enabled = (Optional) - Should Accelerated Networking be enabled? Defaults to true. Only certain Virtual Machine sizes are supported for Accelerated Networking. To use Accelerated Networking in an Availability Set, the Availability Set must be deployed onto an Accelerated Networking enabled cluster. - application_security_groups = (Optional) - A map defining the Application Security Group(s) that this network interface should be a part of. - <map key> - Use a custom map key to define each Application Security Group association. This is done to handle issues with certain details not being known until after apply. - application_security_group_resource_id = (Required) - The Application Security Group (ASG) Azure Resource ID for this Network Interface to be associated to. - diagnostic_settings = (Optional) - A map of objects defining the network interface resource diagnostic settings - <map key> - Use a custom map key to define each diagnostic setting configuration - name = (required) - Name to use for the Diagnostic setting configuration. Changing this creates a new resource - event_hub_authorization_rule_resource_id = (Optional) - The Event Hub Namespace Authorization Rule Resource ID when sending logs or metrics to an Event Hub Namespace - event_hub_name = (Optional) - The Event Hub name when sending logs or metrics to an Event Hub - log_analytics_destination_type = (Optional) - Valid values are null, AzureDiagnostics, and Dedicated. Defaults to null - log_categories_and_groups = (Optional) - List of strings used to define log categories and groups. Currently not valid for the VM resource - marketplace_partner_resource_id = (Optional) - The marketplace partner solution Azure Resource ID when sending logs or metrics to a partner integration - metric_categories = (Optional) - List of strings used to define metric categories. Currently only AllMetrics is valid - storage_account_resource_id = (Optional) - The Storage Account Azure Resource ID when sending logs or metrics to a Storage Account - workspace_resource_id = (Optional) - The Log Analytics Workspace Azure Resource ID when sending logs or metrics to a Log Analytics Workspace - dns_servers = (Optional) - A list of IP Addresses defining the DNS Servers which should be used for this Network Interface. - inherit_tags = (Optional) - Defaults to true. Set this to false if only the tags defined on this resource should be applied. This is potential future functionality and is currently ignored. - internal_dns_name_label = (Optional) - The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network. - ip_forwarding_enabled = (Optional) - Should IP Forwarding be enabled? Defaults to false - lock_level = (Optional) - Set this value to override the resource level lock value. Possible values are None, CanNotDelete, and ReadOnly. - lock_name = (Optional) - The name for the lock on this nic - network_security_groups = (Optional) - A map describing Network Security Group(s) that this Network Interface should be associated to. - <map key> - Use a custom map key to define each network security group association. This is done to handle issues with certain details not being known until after apply. - network_security_group_resource_id = (Optional) - The Network Security Group (NSG) Azure Resource ID used to associate this Network Interface to the NSG. - resource_group_name (Optional) - Specify a resource group name if the network interface should be created in a separate resource group from the virtual machine - role_assignments = An optional map of objects defining role assignments on the individual network configuration resource - <map key> - Use a custom map key to define each role assignment configuration - assign_to_child_public_ip_addresses = (Optional) - Set this to true if the assignment should also apply to any children public IP addresses. - condition = (Optional) - The condition that limits the resources that the role can be assigned to. Changing this forces a new resource to be created. - condition_version = (Optional) - The version of the condition. Possible values are 1.0 or 2.0. Changing this forces a new resource to be created. - 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. - description = (Optional) - The description for this Role Assignment. Changing this forces a new resource to be created. - principal_id = (optional) - The ID of the Principal (User, Group or Service Principal) to assign the Role Definition to. Changing this forces a new resource to be created. - role_definition_id_or_name = (Optional) - The Scoped-ID of the Role Definition or the built-in role name. Changing this forces a new resource to be created. Conflicts with role_definition_name - skip_service_principal_aad_check = (Optional) - If the principal_id is a newly provisioned Service Principal set this value to true to skip the Azure Active Directory check which may fail due to replication lag. This argument is only valid if the principal_id is a Service Principal identity. Defaults to true. - principal_type = (Optional) - The type of the principal_id. Possible values are User, Group and ServicePrincipal. 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. - tags = (Optional) - A mapping of tags to assign to the resource. Example Inputs: hcl #Simple private IP single NIC with IPV4 private address network_interfaces = { network_interface_1 = { name = "testnic1" ip_configurations = { ip_configuration_1 = { name = "testnic1-ipconfig1" private_ip_subnet_resource_id = azurerm_subnet.this_subnet_1.id } } } } #Simple NIC with private and public IP address network_interfaces = { network_interface_1 = { name = "testnic1" ip_configurations = { ip_configuration_1 = { name = "testnic1-ipconfig1" private_ip_subnet_resource_id = azurerm_subnet.this_subnet_1.id create_public_ip_address = true public_ip_address_name = "vm1-testnic1-publicip1" } } } }	map(object({ name = string ip_configurations = map(object({ name = string app_gateway_backend_pools = optional(map(object({ app_gateway_backend_pool_resource_id = string })), {}) create_public_ip_address = optional(bool, false) gateway_load_balancer_frontend_ip_configuration_resource_id = optional(string) is_primary_ipconfiguration = optional(bool, true) load_balancer_backend_pools = optional(map(object({ load_balancer_backend_pool_resource_id = string })), {}) load_balancer_nat_rules = optional(map(object({ load_balancer_nat_rule_resource_id = string })), {}) private_ip_address = optional(string) private_ip_address_allocation = optional(string, "Dynamic") private_ip_address_version = optional(string, "IPv4") private_ip_subnet_resource_id = optional(string) public_ip_address_lock_name = optional(string) public_ip_address_name = optional(string) public_ip_address_resource_id = optional(string) })) accelerated_networking_enabled = optional(bool, true) application_security_groups = optional(map(object({ application_security_group_resource_id = string })), {}) diagnostic_settings = optional(map(object({ name = optional(string, null) log_categories = optional(set(string), []) log_groups = optional(set(string), []) metric_categories = optional(set(string), ["AllMetrics"]) log_analytics_destination_type = optional(string, null) 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) })), {}) dns_servers = optional(list(string)) inherit_tags = optional(bool, true) internal_dns_name_label = optional(string) ip_forwarding_enabled = optional(bool, false) lock_level = optional(string) lock_name = optional(string) network_security_groups = optional(map(object({ network_security_group_resource_id = string })), {}) resource_group_name = optional(string) role_assignments = optional(map(object({ principal_id = string role_definition_id_or_name = string assign_to_child_public_ip_addresses = optional(bool, true) condition = optional(string, null) condition_version = optional(string, null) delegated_managed_identity_resource_id = optional(string, null) description = optional(string, null) skip_service_principal_aad_check = optional(bool, false) principal_type = optional(string, null) })), {}) tags = optional(map(string), null) }))	n/a	yes
resource_group_name	The resource group name of the resource group where the vm resources will be deployed.	string	n/a	yes
zone	The Availability Zone which the Virtual Machine should be allocated in, only one zone would be accepted. If set then this module won't create azurerm_availability_set resource. Changing this forces a new resource to be created. This has been moved to a required value to comply with WAF guidance to intentionally select zones for resources as part of resource architectures. If deploying to a region without zones, set this value to null.	string	n/a	yes
additional_unattend_contents	List of objects representing unattend content settings - content (Required) - The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created. - setting (Required) - The name of the setting to which the content applies. Possible values are AutoLogon and FirstLogonCommands. Changing this forces a new resource to be created. Example Inputs: hcl #Example Reboot additional_unattend_contents = [ { content = "shutdown /r /t 0 /c "initial reboot"reboot1" setting = "FirstLogonCommands" } ]	list(object({ content = string setting = string }))	[]	no
admin_password	Password to use for the default admin account created for the virtual machine. Passing this as a key vault secret value is recommended!, its in the lifecycle, so it will not recreate the vm when its changed.	string	null	no
admin_ssh_keys	A list of objects defining one or more ssh public keys - public_key (Required) - The Public Key which should be used for authentication, which needs to be at least 2048-bit and in ssh-rsa format. Changing this forces a new resource to be created. - username (Required) - The Username for which this Public SSH Key should be configured. Changing this forces a new resource to be created. The Azure VM Agent only allows creating SSH Keys at the path /home/{admin_username}/.ssh/authorized_keys. As such this public key will be written to the authorized keys file. If no username is provided this module will use var.admin_username. Example Input: hcl admin_ssh_keys = [ { public_key = "" username = "exampleuser" }, { public_key = "" username = "examleuser2" } ]	list(object({ public_key = string username = string }))	[]	no
admin_username	Name to use for the default admin account created for the virtual machine	string	"azureuser"	no
allow_extension_operations	(Optional) Should Extension Operations be allowed on this Virtual Machine? Defaults to true.	bool	true	no
availability_set_resource_id	(Optional) Specifies the Azure Resource ID of the Availability Set in which the Virtual Machine should exist. Cannot be used along with new_availability_set, new_capacity_reservation_group, capacity_reservation_group_id, virtual_machine_scale_set_id, zone. Changing this forces a new resource to be created.	string	null	no
boot_diagnostics	(Optional) Enable or Disable boot diagnostics.	bool	false	no
boot_diagnostics_storage_account_uri	(Optional) The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor. Passing a null value will Utilize a managed storage account for diags.	string	null	no
bypass_platform_safety_checks_on_user_schedule_enabled	(Optional) Specifies whether to skip platform scheduled patching when a user schedule is associated with the VM. This value can only be set to true when patch_mode is set to AutomaticByPlatform	bool	false	no
capacity_reservation_group_resource_id	(Optional) Specifies the Azure Resource ID of the Capacity Reservation Group with the Virtual Machine should be allocated to. Cannot be used with availability_set_id or proximity_placement_group_id	string	null	no
computer_name	(Optional) Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the vm_name field. If the value of the vm_name field is not a valid computer_name, then you must specify computer_name. Changing this forces a new resource to be created.	string	null	no
custom_data	(Optional) The Base64 encoded Custom Data for building this virtual machine. Changing this forces a new resource to be created	string	null	no
data_disk_managed_disks	This variable is a map of objects used to define one or more data disks for creation and attachment to the virtual machine. - <map key> - Use a custom map key to define each data disk - caching (Required) - Specifies the caching requirements for this Data Disk. Possible values include None, ReadOnly and ReadWrite - lun (Required) - The Logical Unit Number of the Data Disk, which needs to be unique within the Virtual Machine. Changing this forces a new resource to be created. - name (Required) - Specifies the name of the Managed Disk. Changing this forces a new resource to be created. - storage_account_type (Required) - The type of storage to use for the managed disk. Possible values are Standard_LRS, StandardSSD_ZRS, Premium_LRS, PremiumV2_LRS, Premium_ZRS, StandardSSD_LRS or UltraSSD_LRS - create_option (Optional) - The method to use when creating the managed disk. Changing this forces a new resource to be created. Possible values include: 1. Import - Import a VHD file in to the managed disk (VHD specified with source_uri). 2.ImportSecure - Securely import a VHD file in to the managed disk (VHD specified with source_uri). 3. Empty - Create an empty managed disk. 4. Copy - Copy an existing managed disk or snapshot (specified with source_resource_id). 5. FromImage - Copy a Platform Image (specified with image_reference_id) 6. Restore - Set by Azure Backup or Site Recovery on a restored disk (specified with source_resource_id). 7. Upload - Upload a VHD disk with the help of SAS URL (to be used with upload_size_bytes). - disk_access_resource_id (Optional) - The ID of the disk access resource for using private endpoints on disks. disk_access_resource_id is only supported when network_access_policy is set to AllowPrivate. - disk_attachment_create_option (Optional) - The disk attachment create Option of the Data Disk, such as Empty or Attach. Defaults to Attach. Changing this forces a new resource to be created. - disk_encryption_set_resource_id (Optional) - The resource ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. - disk_iops_read_only (Optional) - The number of IOPS allowed across all VMs mounting the shared disk as read-only; only settable for UltraSSD disks and PremiumV2 disks with shared disk enabled. One operation can transfer between 4k and 256k bytes. - disk_iops_read_write (Optional) - The number of IOPS allowed for this disk; only settable for UltraSSD disks and PremiumV2 disks. One operation can transfer between 4k and 256k bytes. - disk_mbps_read_only (Optional) - The bandwidth allowed across all VMs mounting the shared disk as read-only; only settable for UltraSSD disks and PremiumV2 disks with shared disk enabled. MBps means millions of bytes per second. - disk_mbps_read_write (Optional) - The bandwidth allowed for this disk; only settable for UltraSSD disks and PremiumV2 disks. MBps means millions of bytes per second. - disk_size_gb (Optional) - (Required for a new managed disk) - Specifies the size of the managed disk to create in gigabytes. If create_option is Copy or FromImage, then the value must be equal to or greater than the source's size. The size can only be increased.If No Downtime Resizing is not available, be aware that changing this value is disruptive if the disk is attached to a Virtual Machine. The VM will be shut down and de-allocated as required by Azure to action the change. Terraform will attempt to start the machine again after the update if it was in a running state when the apply was started. When upgrading disk_size_gb from value less than 4095 to a value greater than 4095, the disk will be detached from its associated Virtual Machine as required by Azure to action the change. Terraform will attempt to reattach the disk again after the update. - gallery_image_reference_resource_id (Optional) - ID of a Gallery Image Version to copy when create_option is FromImage. This field cannot be specified if image_reference_id is specified. Changing this forces a new resource to be created. - hyper_v_generation (Optional) - The HyperV Generation of the Disk when the source of an Import or Copy operation targets a source that contains an operating system. Possible values are V1 and V2. For ImportSecure it must be set to V2. Changing this forces a new resource to be created. - image_reference_resource_id (Optional) - ID of an existing platform/marketplace disk image to copy when create_option is FromImage. This field cannot be specified if gallery_image_reference_resource_id is specified. Changing this forces a new resource to be created. - inherit_tags (Optional) - Defaults to true. Set this to false if only the tags defined on this resource should be applied. - lock_level (Optional) - Set this value to override the resource level lock value. Possible values are CanNotDelete, and ReadOnly. - lock_name (Optional) - The name for the lock on this disk - logical_sector_size (Optional) - Logical Sector Size. Possible values are: 512 and 4096. Defaults to 4096. Changing this forces a new resource to be created. Setting logical sector size is supported only with UltraSSD_LRS disks and PremiumV2_LRS disks. - max_shares (Optional) - The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. Premium SSD maxShares limit: P15 and P20 disks: 2. P30,P40,P50 disks: 5. P60,P70,P80 disks: 10. For ultra disks the max_shares minimum value is 1 and the maximum is 5. - network_access_policy (Optional) - Policy for accessing the disk via network. Allowed values are AllowAll, AllowPrivate, and DenyAll. - on_demand_bursting_enabled (Optional) - Specifies if On-Demand Bursting is enabled for the Managed Disk. - optimized_frequent_attach_enabled (Optional) - Specifies whether this Managed Disk should be optimized for frequent disk attachments (where a disk is attached/detached more than 5 times in a day). Defaults to false. Setting optimized_frequent_attach_enabled to true causes the disks to not align with the fault domain of the Virtual Machine, which can have operational implications. - os_type (Optional) - Specify a value when the source of an Import, ImportSecure or Copy operation targets a source that contains an operating system. Valid values are Linux or Windows. - performance_plus_enabled (Optional) - Specifies whether Performance Plus is enabled for this Managed Disk. Defaults to false. Changing this forces a new resource to be created. performance_plus_enabled can only be set to true when using a Managed Disk with an Ultra SSD. - public_network_access_enabled (Optional) - Whether it is allowed to access the disk via public network. Defaults to true. - resource_group_name (Optional) - Specify a resource group name if the data disk should be created in a separate resource group from the virtual machine - secure_vm_disk_encryption_set_resource_id (Optional) - The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created. secure_vm_disk_encryption_set_resource_id can only be specified when security_type is set to ConfidentialVM_DiskEncryptedWithCustomerKey. - security_type (Optional) - Security Type of the Managed Disk when it is used for a Confidential VM. Possible values are ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey, ConfidentialVM_DiskEncryptedWithPlatformKey and ConfidentialVM_DiskEncryptedWithCustomerKey. Changing this forces a new resource to be created. When security_type is set to ConfidentialVM_DiskEncryptedWithCustomerKey the value of create_option must be one of FromImage or ImportSecure. security_type cannot be specified when trusted_launch_enabled is set to true. secure_vm_disk_encryption_set_id must be specified when security_type is set to ConfidentialVM_DiskEncryptedWithCustomerKey. - source_resource_id (Optional) - The ID of an existing Managed Disk or Snapshot to copy when create_option is Copy or the recovery point to restore when create_option is Restore. Changing this forces a new resource to be created. - source_uri (Optional) - URI to a valid VHD file to be used when create_option is Import or ImportSecure. Changing this forces a new resource to be created. - storage_account_resource_id (Optional) - The ID of the Storage Account where the source_uri is located. Required when create_option is set to Import or ImportSecure. Changing this forces a new resource to be created. - tags (Optional) - A mapping of tags to assign to the resource. - tier (Optional) - The disk performance tier to use. Possible values are documented at https://docs.microsoft.com/azure/virtual-machines/disks-change-performance. This feature is currently supported only for premium SSDs.Changing this value is disruptive if the disk is attached to a Virtual Machine. The VM will be shut down and de-allocated as required by Azure to action the change. Terraform will attempt to start the machine again after the update if it was in a running state when the apply was started. - trusted_launch_enabled (Optional) - Specifies if Trusted Launch is enabled for the Managed Disk. Changing this forces a new resource to be created. Trusted Launch can only be enabled when create_option is FromImage or Import - upload_size_bytes (Optional) - Specifies the size of the managed disk to create in bytes. Required when create_option is Upload. The value must be equal to the source disk to be copied in bytes. Source disk size could be calculated with ls -l or wc -c. More information can be found at Copy a managed disk. Changing this forces a new resource to be created. - write_accelerator_enabled (Optional) - Specifies if Write Accelerator is enabled on the disk. This can only be enabled on Premium_LRS managed disks with no caching and M-Series VMs. Defaults to false. - encryption_settings = (Optional) List of encryption objects with the following attributes: - disk_encryption_key_vault_secret_url (Required) - The URL to the Key Vault Secret used as the Disk Encryption Key. This can be found as the id on the azurerm_key_vault_secret resource. - disk_encryption_key_vault_resource_id (Required) - The ID of the source Key Vault. This can be found as the id on the azurerm_key_vault resource. - key_encryption_key_vault_secret_url (Required) - The URL to the Key Vault Key used as the Key Encryption Key. This can be found as the id on the azurerm_key_vault_key resource. - key_encryption_key_vault_resource_id (Required) - The ID of the source Key Vault. This can be found as the id on the azurerm_key_vault resource. - role_assignments = (Optional) - Map of role assignments to assign to this disk - <map key> - Use a custom map key to define each role assignment configuration assigned to the system managed identity of this virtual machine - role_definition_id_or_name = (Required) - The Scoped-ID of the Role Definition or the built-in role name. Changing this forces a new resource to be created. Conflicts with role_definition_name - scope_resource_id = (Required) - The scope at which the System Managed Identity Role Assignment applies to, such as /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333, /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup, or /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM, or /providers/Microsoft.Management/managementGroups/myMG. Changing this forces a new resource to be created. - condition = (Optional) - The condition that limits the resources that the role can be assigned to. Changing this forces a new resource to be created. - condition_version = (Optional) - The version of the condition. Possible values are 1.0 or 2.0. Changing this forces a new resource to be created. - description = (Optional) - The description for this Role Assignment. Changing this forces a new resource to be created. - skip_service_principal_aad_check = (Optional) - If the principal_id is a newly provisioned Service Principal set this value to true to skip the Azure Active Directory check which may fail due to replication lag. This argument is only valid if the principal_id is a Service Principal identity. Defaults to true. - 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. - principal_type = (Optional) - The type of the principal_id. Possible values are User, Group and ServicePrincipal. 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. Example Inputs: hcl #Create a new empty disk and attach it as lun 0 data_disk_managed_disks = { disk1 = { name = "testdisk1-win-lun0" storage_account_type = "Premium_LRS" lun = 0 caching = "ReadWrite" disk_size_gb = 32 } }	map(object({ caching = string lun = number name = string storage_account_type = string create_option = optional(string, "Empty") disk_access_resource_id = optional(string) disk_attachment_create_option = optional(string) disk_encryption_set_resource_id = optional(string) #this is currently a preview feature in the provider disk_iops_read_only = optional(number, null) disk_iops_read_write = optional(number, null) disk_mbps_read_only = optional(number, null) disk_mbps_read_write = optional(number, null) disk_size_gb = optional(number, 128) edge_zone = optional(string, null) gallery_image_reference_resource_id = optional(string) hyper_v_generation = optional(string) image_reference_resource_id = optional(string) inherit_tags = optional(bool, true) lock_level = optional(string, null) lock_name = optional(string, null) logical_sector_size = optional(number, null) max_shares = optional(number) network_access_policy = optional(string) on_demand_bursting_enabled = optional(bool) optimized_frequent_attach_enabled = optional(bool, false) os_type = optional(string) performance_plus_enabled = optional(bool, false) public_network_access_enabled = optional(bool, false) resource_group_name = optional(string) secure_vm_disk_encryption_set_resource_id = optional(string) security_type = optional(string) source_resource_id = optional(string) source_uri = optional(string) storage_account_resource_id = optional(string) tags = optional(map(string), null) tier = optional(string) trusted_launch_enabled = optional(bool) upload_size_bytes = optional(number, null) write_accelerator_enabled = optional(bool) encryption_settings = optional(list(object({ disk_encryption_key_vault_secret_url = optional(string) disk_encryption_key_vault_resource_id = optional(string) key_encryption_key_vault_secret_url = optional(string) key_encryption_key_vault_resource_id = optional(string) })), []) role_assignments = optional(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) })), {}) }))	{}	no
dedicated_host_group_resource_id	(Optional) The Azure Resource ID of the dedicated host group where this virtual machine should run. Conflicts with dedicated_host_resource_id (dedicated_host_group_id on the azurerm provider)	string	null	no
dedicated_host_resource_id	(Optional) The Azure Resource ID of the dedicated host where this virtual machine should run. Conflicts with dedicated_host_group_resource_id (dedicated_host_group_id on the azurerm provider)	string	null	no
disable_password_authentication	If true this value will disallow password authentication on linux vm's. This will require at least one public key to be configured. If using the option to auto generate passwords and keys, setting this value to false will cause a password to be generated an stored instead of an SSH key.	bool	true	no
disk_controller_type	(Optional) - Specifies the Disk Controller Type used for this Virtual Machine. Possible values are SCSI and NVME.	string	null	no
edge_zone	(Optional) Specifies the Edge Zone within the Azure Region where this Virtual Machine should exist. Changing this forces a new Virtual Machine to be created.	string	null	no
enable_automatic_updates	(Optional) Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true.	bool	true	no
encryption_at_host_enabled	(Optional) Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?	bool	true	no
eviction_policy	(Optional) Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate and Delete. Changing this forces a new resource to be created. This value can only be set when priority is set to Spot	string	null	no
extensions	This map of objects is used to create additional azurerm_virtual_machine_extension resources, the argument descriptions could be found at the document. - <map key> - Provide a custom key value to define each extension object - name (Required) - Set a custom name on this value if you want the guest configuration extension to have a custom name - publisher (Required) - Configure the publisher for the extension to be deployed. The Publisher and Type of Virtual Machine Extensions can be found using the Azure CLI, via: az vm extension image list --location westus -o table - type (Required) - Configure the type value for the extension to be deployed. - type_handler_version (Required) - The type handler version for the extension. A common value is 1.0. - auto_upgrade_minor_version (Optional) - Set this to false to avoid automatic upgrades for minor versions on the extension. Defaults to true - automatic_upgrade_enabled (Optional) - Set this to false to avoid automatic upgrades for major versions on the extension. Defaults to true - failure_suppression_enabled (Optional) - Should failures from the extension be suppressed? Possible values are true or false. Defaults to false. Operational failures such as not connecting to the VM will not be suppressed regardless of the failure_suppression_enabled value. - settings (Optional) - The settings passed to the extension, these are specified as a JSON object in a string. Certain VM Extensions require that the keys in the settings block are case sensitive. If you're seeing unhelpful errors, please ensure the keys are consistent with how Azure is expecting them (for instance, for the JsonADDomainExtension extension, the keys are expected to be in TitleCase.) - protected_settings (Optional) - The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string. Certain VM Extensions require that the keys in the protected_settings block are case sensitive. If you're seeing unhelpful errors, please ensure the keys are consistent with how Azure is expecting them (for instance, for the JsonADDomainExtension extension, the keys are expected to be in TitleCase.) - provision_after_extensions (Optional) - list of strings that specifies the collection of extension names after which this extension needs to be provisioned. - protected_settings_from_key_vault (Optional) object for protected settings. Cannot be used with protected_settings - secret_url (Required) - The Secret URL of a Key Vault Certificate. This can be sourced from the secret_id field within the azurerm_key_vault_certificate Resource. - source_vault_id (Required) - the Azure resource ID of the key vault holding the secret - tags (Optional) - A mapping of tags to assign to the extension resource. Example Inputs: hcl #custom script extension example - linux extensions = { { name = "CustomScriptExtension" publisher = "Microsoft.Azure.Extensions" type = "CustomScript" type_handler_version = "2.0" settings = <<SETTINGS { "script": "<base 64 encoded script file>" } SETTINGS } } #custom script extension example - windows extensions = { { name = "CustomScriptExtension" publisher = "Microsoft.Compute" type = "CustomScriptExtension" type_handler_version = "1.10" settings = <<SETTINGS { "timestamp":123456789 } SETTINGS protected_settings = <<PROTECTED_SETTINGS { "commandToExecute": "myExecutionCommand", "storageAccountName": "myStorageAccountName", "storageAccountKey": "myStorageAccountKey", "managedIdentity" : {}, "fileUris": [ "script location" ] } PROTECTED_SETTINGS } }	map(object({ name = string publisher = string type = string type_handler_version = string auto_upgrade_minor_version = optional(bool) automatic_upgrade_enabled = optional(bool) failure_suppression_enabled = optional(bool, false) settings = optional(string) protected_settings = optional(string) provision_after_extensions = optional(list(string), []) tags = optional(map(string), null) protected_settings_from_key_vault = optional(object({ secret_url = string source_vault_id = string })) }))	{}	no
extensions_time_budget	(Optional) Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to 90 minutes (PT1H30M).	string	"PT1H30M"	no
gallery_applications	A list of gallery application objects with the following elements: - <map key> - Used to designate a unique instance for a gallery application. - version_id (Required) Specifies the Gallery Application Version resource ID. - configuration_blob_uri (Optional) Specifies the URI to an Azure Blob that will replace the default configuration for the package if provided. - order (Optional) Specifies the order in which the packages have to be installed. Possible values are between 0 and 2,147,483,647. - tag (Optional) Specifies a passthrough value for more generic context. This field can be any valid string value. Example Inputs: hcl gallery_applications = { application_1 = { version_id = "/subscriptions/{subscriptionId}/resourceGroups//providers/Microsoft.Compute/galleries/{gallery name}/applications/{application name}/versions/{version}" order = 1 } }	map(object({ version_id = string configuration_blob_uri = optional(string) order = optional(number, 0) tag = optional(string) }))	{}	no
generate_admin_password	Set this value to true if the deployment should create a strong password for the admin user.	bool	false	no
generated_secrets_key_vault_secret_config	For simplicity this module provides the option to use an auto-generated admin user password. That password or key is then stored in a key vault provided in the admin_credential_key_vault_resource_id input. This variable allows the user to override the configuration for the key vault secret which stores the generated password or ssh key. The object details are: - name - (Optional) - The name to use for the key vault secret that stores the auto-generated ssh key or password - expiration_date_length_in_days - (Optional) - This value sets the number of days from the installation date to set the key vault expiration value. It defaults to 45 days. This value will not be overridden in subsequent runs. If you need to maintain this virtual machine resource for a long period, generate and/or use your own password or ssh key. - content_type - (Optional) - This value sets the secret content type. Defaults to text/plain - not_before_date - (Optional) - The UTC datetime (Y-m-d'T'H:M:S'Z) date before which this key is not valid. Defaults to null. - tags - (Optional) - Specific tags to assign to this secret resource	object({ key_vault_resource_id = string name = optional(string, null) expiration_date_length_in_days = optional(number, 45) content_type = optional(string, "text/plain") not_before_date = optional(string, null) tags = optional(map(string), {}) })	null	no
hotpatching_enabled	(Optional) Should the VM be patched without requiring a reboot? Possible values are true or false. Defaults to false. For more information about hot patching please see the product documentation. Hotpatching can only be enabled if the patch_mode is set to AutomaticByPlatform, the provision_vm_agent is set to true, your source_image_reference references a hotpatching enabled image, and the VM's size is set to a Azure generation 2 VM. An example of how to correctly configure a Windows Virtual Machine to use the hotpatching_enabled field can be found in the ./examples/virtual-machines/windows/hotpatching-enabled directory within the GitHub Repository.	bool	false	no
license_type	(Optional) For Linux virtual machine specifies the BYOL Type for this Virtual Machine, possible values are RHEL_BYOS and SLES_BYOS. For Windows virtual machine specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine, possible values are None, Windows_Client and Windows_Server.	string	null	no
managed_identities	An object that sets the managed identity configuration for the virtual machine being deployed. Be aware that capabilities such as the Azure Monitor Agent and Role Assignments require that a managed identity has been configured. - system_assigned = (Optional) Specifies whether the System Assigned Managed Identity should be enabled. Defaults to false. - user_assigned_resource_ids = (Optional) Specifies a set of User Assigned Managed Identity IDs to be assigned to this Virtual Machine. Example Inputs: hcl #default system managed identity managed_identities = { system_assigned = true } #user assigned managed identity only managed_identities = { user_assigned_resource_ids = [""] } #user assigned and system assigned managed identities managed_identities = { system_assigned = true user_assigned_resource_ids = [""] }	object({ system_assigned = optional(bool, false) user_assigned_resource_ids = optional(set(string), []) })	{}	no
max_bid_price	(Optional) The maximum price you're willing to pay for this Virtual Machine, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons. This can only be configured when priority is set to Spot.	number	-1	no
os_disk	Required configuration values for the OS disk on the virtual machine. - caching = (Required) - The type of caching which should be used for the internal OS disk. Possible values are None, ReadOnly, and ReadWrite. - storage_account_type = (Required) - The Type of Storage Account which should back this the Internal OS Disk. Possible values are Standard_LRS, Premium_LRS, Premium_LRS, StandardSSD_ZRS and Premium_ZRS. Changing this forces a new resource to be created - disk_encryption_set_id = (Optional) - The Azure Resource ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with secure_vm_disk_encryption_set_id. The Disk Encryption Set must have the Reader Role Assignment scoped on the Key Vault - in addition to an Access Policy to the Key Vault - disk_size_gb = (Optional) - The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from. - name = (Optional) - The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created. - secure_vm_disk_encryption_set_id = (Optional) - The Azure Resource ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created. - security_encryption_type = (Optional) - Encryption Type when the Virtual Machine is a Confidential VM. Possible values are VMGuestStateOnly and DiskWithVMGuestState. Changing this forces a new resource to be created. vtpm_enabled must be set to true when security_encryption_type is specified. encryption_at_host_enabled cannot be set to true when security_encryption_type is set to DiskWithVMGuestState - write_accelerator_enabled = (Optional) - Should Write Accelerator be Enabled for this OS Disk? Defaults to false. This requires that the storage_account_type is set to Premium_LRS and that caching is set to None - diff_disk_settings - An optional object defining the diff disk settings - option = (Required) - Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is Local. Changing this forces a new resource to be created. - placement = (Optional) - Specifies where to store the Ephemeral Disk. Possible values are CacheDisk and ResourceDisk. Defaults to CacheDisk. Changing this forces a new resource to be created. Example Inputs: hcl #basic example: os_disk = { caching = "ReadWrite" storage_account_type = "Premium_LRS" } #increased disk size and write acceleration example os_disk = { name = "sample os disk" caching = "None" storage_account_type = "Premium_LRS" disk_size_gb = 128 write_accelerator_enabled = true }	object({ caching = string storage_account_type = string disk_encryption_set_id = optional(string) disk_size_gb = optional(number) name = optional(string) secure_vm_disk_encryption_set_id = optional(string) security_encryption_type = optional(string) write_accelerator_enabled = optional(bool, false) diff_disk_settings = optional(object({ option = string placement = optional(string, "CacheDisk") }), null) })	{ "caching": "ReadWrite", "storage_account_type": "StandardSSD_ZRS" }	no
os_disk_managed_disk	This variable is an object used to define the managed disk settings for the OS disk of the virtual machine. - network_access_policy (Optional) - Policy for accessing the disk via network. Allowed values are AllowAll, AllowPrivate, and DenyAll. - public_network_access_enabled (Optional) - Whether it is allowed to access the disk via public network. Defaults to Disabled. hcl os_disk_managed_disk = { network_access_policy = "AllowPrivate" public_network_access_enabled = "Enabled" }	object({ network_access_policy = optional(string, "DenyAll") public_network_access_enabled = optional(string, "Disabled") })	{}	no
os_type	The base OS type of the vm to be built. Valid answers are Windows or Linux	string	null	no
patch_assessment_mode	(Optional) Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to AutomaticByPlatform.	string	"AutomaticByPlatform"	no
patch_mode	(Optional) Specifies the mode of in-guest patching to this Linux Virtual Machine. Possible values are AutomaticByPlatform and ImageDefault. Defaults to ImageDefault. For more information on patch modes please see the product documentation.	string	null	no
plan	An object variable that defines the Marketplace image this virtual machine should be created from. If you use the plan block with one of Microsoft's marketplace images (e.g. publisher = "MicrosoftWindowsServer"). This may prevent the purchase of the offer. An example Azure API error: The Offer: 'WindowsServer' cannot be purchased by subscription: '12345678-12234-5678-9012-123456789012' as it is not to be sold in market: 'US'. Please choose a subscription which is associated with a different market. - name = (Required) Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created. - product = (Required) Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created. - publisher = (Required) Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created. Example Input: hcl plan = { name = "17_04_02-payg-essentials" product = "cisco-8000v" publisher = "cisco" }	object({ name = string product = string publisher = string })	null	no
platform_fault_domain	(Optional) Specifies the Platform Fault Domain in which this Virtual Machine should be created. Defaults to null, which means this will be automatically assigned to a fault domain that best maintains balance across the available fault domains. virtual_machine_scale_set_id is required with it. Changing this forces new Virtual Machine to be created.	number	null	no
priority	(Optional) Specifies the priority of this Virtual Machine. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.	string	"Regular"	no
provision_vm_agent	(Optional) Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to true. Changing this forces a new resource to be created. If provision_vm_agent is set to false then allow_extension_operations must also be set to false.	bool	true	no
proximity_placement_group_resource_id	(Optional) The ID of the Proximity Placement Group which the Virtual Machine should be assigned to. Conflicts with capacity_reservation_group_resource_id.	string	null	no
public_ip_configuration_details	This object describes the public IP configuration when creating VM's with a public IP. If creating more than one public IP, then these values will be used for all public IPs. - allocation_method = (Required) - Defines the allocation method for this IP address. Possible values are Static or Dynamic. - ddos_protection_mode = (Optional) - The DDoS protection mode of the public IP. Possible values are Disabled, Enabled, and VirtualNetworkInherited. Defaults to VirtualNetworkInherited. - ddos_protection_plan_id = (Optional) - The ID of DDoS protection plan associated with the public IP. ddos_protection_plan_id can only be set when ddos_protection_mode is Enabled - domain_name_label = (Optional) - Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. - idle_timeout_in_minutes = (Optional) - Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. - inherit_tags = (Optional) - Defaults to false. Set this to false if only the tags defined on this resource should be applied. - Future functionality leaving in. - ip_version = (Optional) - The IP Version to use, IPv6 or IPv4. Changing this forces a new resource to be created. Only static IP address allocation is supported for IPv6. - lock_level = (Optional) - Set this value to override the resource level lock value. Possible values are None, CanNotDelete, and ReadOnly. - sku = (Optional) - The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Standard to support zones by default. Changing this forces a new resource to be created. When sku_tier is set to Global, sku must be set to Standard. - sku_tier = (Optional) - The SKU tier of the Public IP. Accepted values are Global and Regional. Defaults to Regional - tags = (Optional) - A mapping of tags to assign to the resource. Example Inputs: hcl #Standard Regional IPV4 Public IP address configuration public_ip_configuration_details = { allocation_method = "Static" ddos_protection_mode = "VirtualNetworkInherited" idle_timeout_in_minutes = 30 ip_version = "IPv4" sku_tier = "Regional" sku = "Standard" }	object({ allocation_method = optional(string, "Static") ddos_protection_mode = optional(string, "VirtualNetworkInherited") ddos_protection_plan_id = optional(string) domain_name_label = optional(string) idle_timeout_in_minutes = optional(number, 30) inherit_tags = optional(bool, false) ip_version = optional(string, "IPv4") lock_level = optional(string, null) sku = optional(string, "Standard") sku_tier = optional(string, "Regional") tags = optional(map(string), null) })	{ "allocation_method": "Static", "ddos_protection_mode": "VirtualNetworkInherited", "idle_timeout_in_minutes": 30, "ip_version": "IPv4", "sku": "Standard", "sku_tier": "Regional" }	no
reboot_setting	(Optional) Specifies the reboot setting for platform scheduled patching. Possible values are Always, IfRequired and Never. can only be set when patch_mode is set to AutomaticByPlatform	string	null	no
role_assignments	A map of role definitions and scopes to be assigned as part of this resources implementation. Two forms are supported. Assignments against this virtual machine resource scope and assignments to external resource scopes using the system managed identity. - <map key> - Use a custom map key to define each role assignment configuration for this virtual machine - principal_id = (optional) - The ID of the Principal (User, Group or Service Principal) to assign the Role Definition to. Changing this forces a new resource to be created. - role_definition_id_or_name = (Optional) - The Scoped-ID of the Role Definition or the built-in role name. Changing this forces a new resource to be created. Conflicts with role_definition_name - condition = (Optional) - The condition that limits the resources that the role can be assigned to. Changing this forces a new resource to be created. - condition_version = (Optional) - The version of the condition. Possible values are 1.0 or 2.0. Changing this forces a new resource to be created. - description = (Optional) - The description for this Role Assignment. Changing this forces a new resource to be created. - skip_service_principal_aad_check = (Optional) - If the principal_id is a newly provisioned Service Principal set this value to true to skip the Azure Active Directory check which may fail due to replication lag. This argument is only valid if the principal_id is a Service Principal identity. Defaults to false. - 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. - principal_type = (Optional) - The type of the principal_id. Possible values are User, Group and ServicePrincipal. 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. Example Inputs: hcl #typical assignment example. It is also common for the scope resource ID to be a terraform resource reference like azurerm_resource_group.example.id role_assignments = { role_assignment_1 = { #assign a built-in role to the virtual machine role_definition_id_or_name = "Storage Blob Data Contributor" principal_id = data.azuread_client_config.current.object_id description = "Example for assigning a role to an existing principal for the virtual machine scope" } }	map(object({ role_definition_id_or_name = string principal_id = string condition = optional(string, null) condition_version = optional(string, null) delegated_managed_identity_resource_id = optional(string, null) description = optional(string, null) principal_type = optional(string, null) skip_service_principal_aad_check = optional(bool, false) } ))	{}	no
role_assignments_system_managed_identity	A map of role definitions and scopes to be assigned as part of this resources implementation. Two forms are supported. Assignments against this virtual machine resource scope and assignments to external resource scopes using the system managed identity. - <map key> - Use a custom map key to define each role assignment configuration assigned to the system managed identity of this virtual machine - role_definition_id_or_name = (Required) - The Scoped-ID of the Role Definition or the built-in role name. Changing this forces a new resource to be created. Conflicts with role_definition_name - scope_resource_id = (Required) - The scope at which the System Managed Identity Role Assignment applies to, such as /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333, /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup, or /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM, or /providers/Microsoft.Management/managementGroups/myMG. Changing this forces a new resource to be created. - condition = (Optional) - The condition that limits the resources that the role can be assigned to. Changing this forces a new resource to be created. - condition_version = (Optional) - The version of the condition. Possible values are 1.0 or 2.0. Changing this forces a new resource to be created. - description = (Optional) - The description for this Role Assignment. Changing this forces a new resource to be created. - skip_service_principal_aad_check = (Optional) - If the principal_id is a newly provisioned Service Principal set this value to true to skip the Azure Active Directory check which may fail due to replication lag. This argument is only valid if the principal_id is a Service Principal identity. Defaults to false. - 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. - principal_type = (Optional) - The type of the principal_id. Possible values are User, Group and ServicePrincipal. 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. Example Inputs: hcl #typical assignment example. It is also common for the scope resource ID to be a terraform resource reference like azurerm_resource_group.example.id role_assignments_system_managed_identity = { role_assignment_1 = { #assign a built-in role to the system assigned managed identity scope_resource_id = "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/test_resource_group/providers/Microsoft.Storage/storageAccounts/examplestorageacct" role_definition_id_or_name = "Storage Blob Data Contributor" description = "Example for assigning a role to the vm system managed identity" } }	map(object({ role_definition_id_or_name = string scope_resource_id = string condition = optional(string, null) condition_version = optional(string, null) description = optional(string, null) skip_service_principal_aad_check = optional(bool, false) delegated_managed_identity_resource_id = optional(string, null) principal_type = optional(string, null) } ))	{}	no
rotate_admin_state_password	Recreate the password, that have useless password in state, make sure to run it at least once if you generate it. If you want to stop the pipeline from re-generating the password, set it to false! This is a work around to just make sure if you use the generate_admin_password feature, it will no be kept in state preffered is ofcourse to specify the password another way	bool	true	no
secrets	A list of objects defining VM secrets with the following attributes: - key_vault_id = (Required) The ID of the Key Vault from which all Secrets should be sourced. - certificate = A set of object describing the secret certificate using the following attributes: - url = (Required) The Secret URL of a Key Vault Certificate. This can be sourced from the secret_id field within the azurerm_key_vault_certificate Resource. - store = (Optional) The certificate store on the Virtual Machine where the certificate should be added. Required when use with Windows Virtual Machine. Example Inputs: hcl secrets = [ { key_vault_id = azurerm_key_vault.example.id certificate = [ { url = azurerm_key_vault_certificate.example.secret_id store = "My" } ] } ]	list(object({ key_vault_id = string certificate = set(object({ url = string store = optional(string) })) }))	[]	no
secure_boot_enabled	(Optional) Specifies whether secure boot should be enabled on the virtual machine. Changing this forces a new resource to be created, defaults to true.	bool	true	no
shutdown_schedules	This map of objects describes an auto-shutdown schedule for the virtual machine. The default is to not have a shutdown schedule. - <map key> - Use a custom map key for the shutdown schedule definition - daily_recurrence_time = (Required) The time each day when the schedule takes effect. Must match the format HHmm where HH is 00-23 and mm is 00-59 (e.g. 0930, 2300, etc.) - enabled = (Required) Designates whether the shutdown schedule is enabled. Defaults to true when a schedule is configured. - notification_settings = (Required) The notification setting object for this schedule. - enabled = (Required) Whether to enable pre-shutdown notifications. Possible values are true or false. - email = (Optional) = Email address or multiple email addresses separated by a semi-colon where the notification emails will be sent. - time_in_minutes = (Optional) TIme in minutes between 15 and 120 before a shutdown event at which a notification will be sent. Defaults to "30". - webhook_url = (Optional) The webhook URL to which notifications will be sent. - tags = (Optional) - Tags to apply to the shutdown schedules resource. - timezone = (Required) - The time zone ID (e.g. Pacific Standard time). Example Input: hcl shutdown_schedules = { test_schedule = { daily_recurrence_time = "1700" enabled = true timezone = "Pacific Standard Time" notification_settings = { enabled = true email = "[email protected];[email protected]" time_in_minutes = "15" webhook_url = "https://example-webhook-url.example.com" } } }	map(object({ daily_recurrence_time = string notification_settings = optional(object({ enabled = optional(bool, false) email = optional(string, null) time_in_minutes = optional(string, "30") webhook_url = optional(string, null) }), { enabled = false }) timezone = string enabled = optional(bool, true) tags = optional(map(string), null) }))	{}	no
sku_size	The sku value to use for this virtual machine	string	"Standard_D2ds_v5"	no
source_image_reference	The source image to use when building the virtual machine. Either source_image_resource_id or source_image_reference must be set and both can not be null at the same time. - publisher = (Required) Specifies the publisher of the image this virtual machine should be created from. Changing this forces a new virtual machine to be created. - offer = (Required) Specifies the offer of the image used to create this virtual machine. Changing this forces a new virtual machine to be created. - sku = (Required) Specifies the sku of the image used to create this virutal machine. Changing this forces a new virtual machine to be created. - version = (Required) Specifies the version of the image used to create this virutal machine. Changing this forces a new virtual machine to be created. Example Inputs: hcl #Linux example: source_image_reference = { publisher = "Canonical" offer = "0001-com-ubuntu-server-focal" sku = "20_04-lts" version = "latest" } #Windows example: source_image_reference = { publisher = "MicrosoftWindowsServer" offer = "WindowsServer" sku = "2019-Datacenter" version = "latest" }	object({ publisher = string offer = string sku = string version = string })	{ "offer": null, "publisher": null, "sku": null, "version": "latest" }	no
source_image_resource_id	The Azure resource ID of the source image used to create the VM. Either source_image_resource_id or source_image_reference must be set and both can not be null at the same time.	string	null	no
tags	Map of tags to be assigned to this resource	map(string)	null	no
termination_notification	optional Termination notification object with the following attributes: - enabled = (Optional) - Should the termination notification be enabled on this Virtual Machine? Defaults to false - timeout = (Optional) - Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to PT5M. Example Inputs: hcl termination_notification = { enabled = true timeout = "PT5M" }	object({ enabled = optional(bool, false) timeout = optional(string, "PT5M") })	null	no
timezone	(Optional) Specifies the Time Zone which should be used by the Windows Virtual Machine, the possible values are defined here. Changing this forces a new resource to be created.	string	null	no
user_data	(Optional) The Base64-Encoded User Data which should be used for this Virtual Machine.	string	null	no
virtual_machine_scale_set_resource_id	(Optional) Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Conflicts with availability_set_id. Changing this forces a new resource to be created.	string	null	no
vm_additional_capabilities	Object describing virtual machine additional capabilities using the following attributes: - ultra_ssd_enabled = (Optional) Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine? Defaults to false. - hibernation_enabled = (Optional) Whether to enable the hiberation capability or not.<br><br>Example Inputs:<br><br> hcl vm_additional_capabilities = { ultra_ssd_enabled = true }	object({ ultra_ssd_enabled = optional(bool, false) hiberation_enabled = optional(bool, null) })	null	no
vm_agent_platform_updates_enabled	"(Optional) Specifies whether VMAgent Platform Updates is enabled. Defaults to true." Default to true to match the default behavior of the Azure Portal, can only be set to false if you use custom images with the VM Agent installed, otherwise your plan/apply will try to adjust it each run.	bool	true	no
vtpm_enabled	(Optional) Specifies whether vTPM should be enabled on the virtual machine. Changing this forces a new resource to be created, defaults to true.	bool	true	no
winrm_listeners	Set of objects describing the winRM listener configuration for windows VM's using the following attributes: - protocol = (Required) Specifies Specifies the protocol of listener. Possible values are Http or Https - certificate_url = (Optional) The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https. Changing this forces a new resource to be created. Example Inputs: hcl #https example winrm_listeners = [ { protocol = "Https" certificate_url = data.azurerm_keyvault_secret.example.secret_id } ] #http example winrm_listeners = [ { protocol = "Http" } ]	set(object({ protocol = string certificate_url = optional(string) }))	[]	no

Outputs

Name	Description
admin_password	Returns the admin password if installation is configured to use the password. Otherwise returns null
admin_ssh_keys	Returns a list containing all of the provided or generated ssh keys. This is a single key if the generation option is selected and no additional keys are provided.
admin_username	The admin username used when creating this virtual machine.
data_disks	The full ARM object map associated with any deployed data disk(s). Exporting this in the event that a disk property not exposed as part of the azurerm vm export is required.
name	The name used for the virtual machines name.
network_interfaces	The full ARM object map associated with the deployed network interface(s). Exporting this in the event that a nic property not exposed as part of the azurerm vm export is required.
public_ips	The full ARM object map associated with any deployed public ip(s). Exporting this in the event that a public ip property not exposed as part of the azurerm vm export is required.
resource	The full object for the deployed virtual machine. This is marked sensitive as it contains specific sensitive values
resource_id	The Azure resource id for the deployed virtual machine
system_assigned_mi_principal_id	The principal id of the system managed identity assigned to the virtual machine
virtual_machine	The full object for the deployed virtual machine. This is marked sensitive as it contains specific sensitive values. This output has been duplicated to the resource output to comply with the spec and may be deprecated in the future.
virtual_machine_azurerm	The default attributes exported by the azurerm provider. These are defined as a map containing the following attributes id = The Azure resource ID of the deployed virtual machine identity = { #An identity map with the following attributes principal_id = The Principal ID associated with the virtual machine's system assigned managed identity tenant_id = The Tenant ID associated with the virtual machine's system assigned managed identity } private_ip_address = The primary private IP address of the deployed virtual machine private_ip_addresses = A list of Private IP Addresses assigned to this Virtual Machine. public_ip_address = The Primary Public IP Address assigned to this Virtual Machine. public_ip_addresses = A list of the Public IP Addresses assigned to this Virtual Machine. virtual_machine_id = A 128-bit identifier which uniquely identifies this Virtual Machine.

note This module has a lot of items taken from the azure AVM module.

License

Copyright: Schuberg Philis

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.