NOTE: This module follows the semantic versioning and versions prior to 1.0.0 should be considered pre-release versions.
This is the virtual machine resource module for the Azure Verified Modules library. This module deploys a Windows and/or Linux virtual machine along with common associated resources. It leverages the AzureRM provider and sets a number of initial defaults to minimize the overall inputs for simple configurations.
The following requirements are needed by this module:
The following providers are used by this module:
The following resources are used by this module:
- azurerm_backup_protected_vm.this (resource)
- azurerm_dev_test_global_vm_shutdown_schedule.this (resource)
- azurerm_key_vault_secret.admin_password (resource)
- azurerm_key_vault_secret.admin_ssh_key (resource)
- azurerm_linux_virtual_machine.this (resource)
- azurerm_maintenance_assignment_virtual_machine.this (resource)
- azurerm_managed_disk.this (resource)
- azurerm_management_lock.this_disk (resource)
- azurerm_management_lock.this_linux_virtualmachine (resource)
- azurerm_management_lock.this_nic (resource)
- azurerm_management_lock.this_public_ip (resource)
- azurerm_management_lock.this_windows_virtualmachine (resource)
- azurerm_monitor_diagnostic_setting.this_nic_diags (resource)
- azurerm_monitor_diagnostic_setting.this_vm_diags (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_resource_group_template_deployment.telemetry (resource)
- azurerm_role_assignment.disks (resource)
- azurerm_role_assignment.system_managed_identity (resource)
- azurerm_role_assignment.this_network_interface (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_id.telemetry (resource)
- random_password.admin_password (resource)
- tls_private_key.this (resource)
The following input variables are required:
Description: The Azure region where this and supporting resources should be deployed.
Type: string
Description: The name to use when creating the virtual machine.
Type: string
Description: The resource group name of the resource group where the vm resources will be deployed.
Type: string
Description: The sku value to use for this virtual machine
Type: string
Description: 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.
Type: string
The following input variables are optional (have default values):
Description: 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 areAutoLogonandFirstLogonCommands. Changing this forces a new resource to be created.
Example Inputs:
#Example Reboot
additional_unattend_contents = [
{
content = "<FirstLogonCommands><SynchronousCommand><CommandLine>shutdown /r /t 0 /c \"initial reboot\"</CommandLine><Description>reboot</Description><Order>1</Order></SynchronousCommand></FirstLogonCommands>"
setting = "FirstLogonCommands"
}
]Type:
list(object({
content = string
setting = string
}))Default: []
Description: The Azure resource ID for the key vault that stores admin credential information
Type: string
Default: null
Description: Use this to provide a custom name for the key vault secret when using the generate an admin ssh key option.
Type: string
Default: null
Description: Password to use for the default admin account created for the virtual machine. Passing this as a key vault secret value is recommended.
Type: string
Default: null
Description: The name of the key vault secret which should be used for the auto-generated admin password. This is only used to store auto-generated passwords. Use the admin_password variable and a key vault secret value reference if storing the password value in an external key vault secret.
Type: string
Default: null
Description: 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 inssh-rsaformat. 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:
admin_ssh_keys = [
{
public_key = "<base64 string for the key>"
username = "exampleuser"
},
{
public_key = "<base64 string for the next user key>"
username = "examleuser2"
}
]Type:
list(object({
public_key = string
username = string
}))Default: []
Description: Name to use for the default admin account created for the virtual machine
Type: string
Default: "azureuser"
Description: (Optional) Should Extension Operations be allowed on this Virtual Machine? Defaults to true.
Type: bool
Default: true
Description: (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.
Type: string
Default: null
Description: This object describes the backup configuration to use for this VM instance. Provide the backup details for configuring the backup. It defaults to null.
<map_key>- An arbitrary map key to avoid terraform issues with know before apply challengesresource_group_name- (Optional) - The resource group name for the resource group containing the recovery services vault. If not supplied it will default to the deployment resource group.recovery_vault_name- (Required) - The name of the recovery services vault where the backup will be stored.backup_policy_resource_id- (Optional) - Required during creation, but can be optional when the protection state is notProtectionStopped.exclude_disk_luns- (Optional) - A list of Disk Logical Unit Numbers (LUN) to be excluded from VM Protection.include_disk_luns- (Optional) - A list of Disk Logical Unit Numbers (LUN) to be included for VM Protection.protection_state- (Optional) - Specifies the protection state of the backup. Possible values areInvalid,Protected,ProtectionStopped,ProtectionError, andProtectionPaused.
Example Input:
azure_backup_configurations = {
arbitrary_key = {
resource_group_name = azurerm_recovery_services_vault.test_vault.resource_group_name
recovery_vault_name = azurerm_recovery_services_vault.test_vault.name
backup_policy_resource_id = azurerm_backup_policy_vm.test_policy.id
exclude_disk_luns = [1]
}
}
Type:
map(object({
resource_group_name = optional(string, null)
recovery_vault_name = string
backup_policy_resource_id = optional(string, null)
exclude_disk_luns = optional(list(number), null)
include_disk_luns = optional(list(number), null)
protection_state = optional(string, null)
}))Default: {}
Description: (Optional) Enable or Disable boot diagnostics.
Type: bool
Default: false
Description: (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.
Type: string
Default: null
Description: (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
Type: bool
Default: false
Description: (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
Type: string
Default: null
Description: (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.
Type: string
Default: null
Description: (Optional) The Base64 encoded Custom Data for building this virtual machine. Changing this forces a new resource to be created
Type: string
Default: null
Description: 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 diskcaching(Required) - Specifies the caching requirements for this Data Disk. Possible values include None, ReadOnly and ReadWritelun(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_LRScreate_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 areCanNotDelete, andReadOnly.lock_name(Optional) - The name for the lock on this disklogical_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 machinesecure_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 Importupload_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 machinerole_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_namescope_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 theprincipal_id. Possible values areUser,GroupandServicePrincipal. 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:
#Create a new empty disk and attach it as lun 0
data_disk_managed_disks = {
disk1 = {
name = "testdisk1-win-lun0"
storage_account_type = "StandardSSD_LRS"
lun = 0
caching = "ReadWrite"
disk_size_gb = 32
}
}Type:
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)
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)
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)
})), {})
}))Default: {}
Description: (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)
Type: string
Default: null
Description: (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)
Type: string
Default: null
Description: This map object is used to define the diagnostic settings on the virtual machine. This functionality does not implement the diagnostic settings extension, but instead can be used to configure sending the vm metrics to one of the standard targets.
<map_key>- unique key to define the map elementname= (required) - Name to use for the Diagnostic setting configuration. Changing this creates a new resourcelog_categories_and_groups= (Optional) - List of strings used to define log categories and groups. Currently not valid for the VM resourcemetric_categories= (Optional) - List of strings used to define metric categories. Currently only AllMetrics is validlog_analytics_destination_type= (Optional) - Valid values are null, AzureDiagnostics, and Dedicated. Defaults to nullworkspace_resource_id= (Optional) - The Log Analytics Workspace Azure Resource ID when sending logs or metrics to a Log Analytics Workspacestorage_account_resource_id= (Optional) - The Storage Account Azure Resource ID when sending logs or metrics to a Storage Accountevent_hub_authorization_rule_resource_id= (Optional) - The Event Hub Namespace Authorization Rule Resource ID when sending logs or metrics to an Event Hub Namespaceevent_hub_name= (Optional) - The Event Hub name when sending logs or metrics to an Event Hubmarketplace_partner_resource_id= (Optional) - The marketplace partner solution Azure Resource ID when sending logs or metrics to a partner integration
Example Input:
diagnostic_settings = {
vm_diags = {
name = module.naming.monitor_diagnostic_setting.name_unique
workspace_resource_id = azurerm_log_analytics_workspace.this_workspace.id
metric_categories = ["AllMetrics"]
}
}
Type:
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, "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: If true this value will disallow password authentication on linux vm's. This will require at least one public key to be configured.
Type: bool
Default: true
Description: (Optional) - Specifies the Disk Controller Type used for this Virtual Machine. Possible values are SCSI and NVME.
Type: string
Default: null
Description: (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.
Type: string
Default: null
Description: (Optional) Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true.
Type: bool
Default: true
Description: This variable controls whether or not telemetry is enabled for the module.
For more information see https://aka.ms/avm/telemetry.
If it is set to false, then no telemetry will be collected.
Type: bool
Default: true
Description: (Optional) Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
Type: bool
Default: null
Description: (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
Type: string
Default: null
Description: 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 objectname(Required) - Set a custom name on this value if you want the guest configuration extension to have a custom namepublisher(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 tabletype(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 trueautomatic_upgrade_enabled(Optional) - Set this to false to avoid automatic upgrades for major versions on the extension. Defaults to truefailure_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 withprotected_settingssecret_url(Required) - The Secret URL of a Key Vault Certificate. This can be sourced from thesecret_idfield within theazurerm_key_vault_certificateResource.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:
#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
}
]Type:
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
}))
}))Default: {}
Description: (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).
Type: string
Default: "PT1H30M"
Description: 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 between0and2,147,483,647.tag(Optional) Specifies a passthrough value for more generic context. This field can be any validstringvalue.
Example Inputs:
gallery_applications = {
application_1 = {
version_id = "/subscriptions/{subscriptionId}/resourceGroups/<resource group>/providers/Microsoft.Compute/galleries/{gallery name}/applications/{application name}/versions/{version}"
order = 1
}
}Type:
map(object({
version_id = string
configuration_blob_uri = optional(string)
order = optional(number, 0)
tag = optional(string)
}))Default: {}
Description: Set this value to true if the deployment should create a strong password for the admin user.
Type: bool
Default: true
Description: (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.
Type: bool
Default: false
Description: (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.
Type: string
Default: null
Description: "The lock configuration to apply to this virtual machine and all of it's child resources. The following properties are specified.
kind- (Required) - The type of the lock. Possible values areCanNotDeleteandReadOnly.name- (Optional) - The name of the lock. If not specified, a name will be generated based on thekindvalue. Changing this forces the creation of a new resource.
Example Inputs:
lock = {
name = "lock-{resourcename}" # optional
type = "CanNotDelete"
}Type:
object({
name = optional(string, null)
kind = string
})Default: null
Description: A map of maintenance configuration Id(s) to apply to this virtual machine. Using a map to avoid any issues with known before apply. The key value is arbitrary as it is only used as the index for terraform.
Example Input:
{
config_1 = "<maintenance configuration Azure resource id>"
}Type: map(string)
Default: {}
Description: 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:
#default system managed identity
managed_identities = {
system_assigned = true
}
#user assigned managed identity only
managed_identities = {
user_assigned_resource_ids = ["<azure resource ID of a user assigned managed identity>"]
}
#user assigned and system assigned managed identities
managed_identities = {
system_assigned = true
user_assigned_resource_ids = ["<azure resource ID of a user assigned managed identity>"]
}Type:
object({
system_assigned = optional(bool, false)
user_assigned_resource_ids = optional(set(string), [])
})Default: {}
Description: (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.
Type: number
Default: -1
Description: A map of objects representing each network virtual machine network interface
<map key>- Use a custom map key to define each network interfacename= (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 configurationname= (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 Configurationgateway_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 Staticprivate_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 false. 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_ids= (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 configurationname= (required) - Name to use for the Diagnostic setting configuration. Changing this creates a new resourceevent_hub_authorization_rule_resource_id= (Optional) - The Event Hub Namespace Authorization Rule Resource ID when sending logs or metrics to an Event Hub Namespaceevent_hub_name= (Optional) - The Event Hub name when sending logs or metrics to an Event Hublog_analytics_destination_type= (Optional) - Valid values are null, AzureDiagnostics, and Dedicated. Defaults to nulllog_categories_and_groups= (Optional) - List of strings used to define log categories and groups. Currently not valid for the VM resourcemarketplace_partner_resource_id= (Optional) - The marketplace partner solution Azure Resource ID when sending logs or metrics to a partner integrationmetric_categories= (Optional) - List of strings used to define metric categories. Currently only AllMetrics is validstorage_account_resource_id= (Optional) - The Storage Account Azure Resource ID when sending logs or metrics to a Storage Accountworkspace_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 falselock_level= (Optional) - Set this value to override the resource level lock value. Possible values areNone,CanNotDelete, andReadOnly.lock_name= (Optional) - The name for the lock on this nicnetwork_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 machinerole_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 configurationassign_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_nameskip_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 theprincipal_id. Possible values areUser,GroupandServicePrincipal. 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:
#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"
}
}
}
}Type:
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, false)
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)
}))Default:
{
"ipconfig_1": {
"accelerated_networking_enabled": true,
"dns_servers": null,
"internal_dns_name_label": null,
"ip_configurations": {
"ip_config_1": {
"gateway_load_balancer_frontend_ip_configuration_resource_id": null,
"is_primary_ipconfiguration": true,
"name": "ipv4-ipconfig",
"private_ip_address": null,
"private_ip_address_allocation": "Dynamic",
"private_ip_address_version": "IPv4",
"private_ip_subnet_resource_id": null,
"public_ip_address_resource_id": null
}
},
"ip_forwarding_enabled": false,
"name": "default-ipv4-ipconfig",
"tags": null
}
}Description: 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 areNone,ReadOnly, andReadWrite.storage_account_type= (Required) - The Type of Storage Account which should back this the Internal OS Disk. Possible values areStandard_LRS,StandardSSD_LRS,Premium_LRS,StandardSSD_ZRSandPremium_ZRS. Changing this forces a new resource to be createddisk_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 Vaultdisk_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 areVMGuestStateOnlyandDiskWithVMGuestState. Changing this forces a new resource to be created.vtpm_enabledmust be set to true when security_encryption_type is specified. encryption_at_host_enabled cannot be set totruewhen security_encryption_type is set toDiskWithVMGuestStatewrite_accelerator_enabled= (Optional) - Should Write Accelerator be Enabled for this OS Disk? Defaults tofalse. This requires that the storage_account_type is set toPremium_LRSand that caching is set toNonediff_disk_settings- An optional object defining the diff disk settingsoption= (Required) - Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value isLocal. 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:
#basic example:
os_disk = {
caching = "ReadWrite"
storage_account_type = "StandardSSD_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
}Type:
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)
})Default:
{
"caching": "ReadWrite",
"storage_account_type": "StandardSSD_LRS"
}Description: (Optional) Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault.
Type: string
Default: "ImageDefault"
Description: (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.
Type: string
Default: null
Description: 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:
plan = {
name = "17_04_02-payg-essentials"
product = "cisco-8000v"
publisher = "cisco"
}Type:
object({
name = string
product = string
publisher = string
})Default: null
Description: (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.
Type: number
Default: null
Description: (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.
Type: string
Default: "Regular"
Description: (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.
Type: bool
Default: true
Description: (Optional) The ID of the Proximity Placement Group which the Virtual Machine should be assigned to. Conflicts with capacity_reservation_group_resource_id.
Type: string
Default: null
Description: 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 areNone,CanNotDelete, andReadOnly. -
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:
#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"
}Type:
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)
})Default:
{
"allocation_method": "Static",
"ddos_protection_mode": "VirtualNetworkInherited",
"idle_timeout_in_minutes": 30,
"ip_version": "IPv4",
"sku": "Standard",
"sku_tier": "Regional"
}Description: (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
Type: string
Default: null
Description: 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 machineprincipal_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_namecondition= (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 theprincipal_id. Possible values areUser,GroupandServicePrincipal. 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:
#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"
}
}Type:
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)
}
))Default: {}
Description: 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 machinerole_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_namescope_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 theprincipal_id. Possible values areUser,GroupandServicePrincipal. 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:
#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"
}
}Type:
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)
}
))Default: {}
Description: 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 thesecret_idfield within theazurerm_key_vault_certificateResource.store= (Optional) The certificate store on the Virtual Machine where the certificate should be added. Required when use with Windows Virtual Machine.
Example Inputs:
secrets = [
{
key_vault_id = azurerm_key_vault.example.id
certificate = [
{
url = azurerm_key_vault_certificate.example.secret_id
store = "My"
}
]
}
]Type:
list(object({
key_vault_id = string
certificate = set(object({
url = string
store = optional(string)
}))
}))Default: []
Description: (Optional) Specifies whether secure boot should be enabled on the virtual machine. Changing this forces a new resource to be created.
Type: bool
Default: null
Description: 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 definitiondaily_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:
shutdown_schedules = {
test_schedule = {
daily_recurrence_time = "1700"
enabled = true
timezone = "Pacific Standard Time"
notification_settings = {
enabled = true
email = "example@example.com;example2@example.com"
time_in_minutes = "15"
webhook_url = "https://example-webhook-url.example.com"
}
}
}
Type:
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)
}))Default: {}
Description: 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:
#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"
}Type:
object({
publisher = string
offer = string
sku = string
version = string
})Default: null
Description: 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.
Type: string
Default: null
Description: Map of tags to be assigned to this resource
Type: map(string)
Default: null
Description: optional Termination notification object with the following attributes:
enabled= (Optional) - Should the termination notification be enabled on this Virtual Machine? Defaults to falsetimeout= (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:
termination_notification = {
enabled = true
timeout = "PT5M"
}Type:
object({
enabled = optional(bool, false)
timeout = optional(string, "PT5M")
})Default: null
Description: (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.
Type: string
Default: null
Description: (Optional) The Base64-Encoded User Data which should be used for this Virtual Machine.
Type: string
Default: null
Description: (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.
Type: string
Default: null
Description: The base OS type of the vm to be built. Valid answers are Windows or Linux
Type: string
Default: "Windows"
Description: Object describing virtual machine additional capabilities using the following attributes:
ultra_ssd_enabled= (Optional) Should the capacity to enable Data Disks of theUltraSSD_LRSstorage account type be supported on this Virtual Machine? Defaults tofalse.
Example Inputs:
vm_additional_capabilities = {
ultra_ssd_enabled = true
}Type:
object({
ultra_ssd_enabled = optional(bool, false)
})Default: null
Description: (Optional) Specifies whether vTPM should be enabled on the virtual machine. Changing this forces a new resource to be created.
Type: bool
Default: null
Description: 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 areHttporHttpscertificate_url= (Optional) The Secret URL of a Key Vault Certificate, which must be specified whenprotocolis set toHttps. Changing this forces a new resource to be created.
Example Inputs:
#https example
winrm_listeners = [
{
protocol = "Https"
certificate_url = data.azurerm_keyvault_secret.example.secret_id
}
]
#http example
winrm_listeners = [
{
protocol = "Http"
}
]Type:
set(object({
protocol = string
certificate_url = optional(string)
}))Default: []
The following outputs are exported:
Description: Returns the admin password if installation is configured to use the password. Otherwise returns null
Description: 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.
Description: 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.
Description: The name used for the virtual machines name.
Description: 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.
Description: 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.
Description: The Azure resource id for the deployed virtual machine
Description: The principal id of the system managed identity assigned to the virtual machine
Description: The full object for the deployed virtual machine. This is marked sensitive as it contains specific sensitive values
Description: 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.
No modules.
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.