terraform-azurerm-windows-vm

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

terraform-azurerm-windows-vm

(★ 23)

Terraform module composition (feature) for ARM Windows Virtual Machine (VM)

terraform-azurerm-windows-vm Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Azure Windows Virtual Machine
[![Changelog](https://img.shields.io/badge/changelog-release-green.svg)](https://raw.githubusercontent.com/claranet/terraform-azurerm-windows-vm/master/CHANGELOG.md) [![Notice](https://img.shields.io/badge/notice-copyright-blue.svg)](https://raw.githubusercontent.com/claranet/terraform-azurerm-windows-vm/master/NOTICE) [![Apache V2 License](https://img.shields.io/badge/license-Apache%20V2-orange.svg)](https://raw.githubusercontent.com/claranet/terraform-azurerm-windows-vm/master/LICENSE) [![OpenTofu Registry](https://img.shields.io/badge/opentofu-registry-yellow.svg)](https://search.opentofu.org/module/claranet/windows-vm/azurerm/)

This module creates a [Windows Virtual Machine](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/) with
[Windows Remote Management (WinRM)](https://docs.microsoft.com/en-us/windows/desktop/WinRM/portal) activated.

The Windows Virtual Machine comes with:
* [Azure Monitor Agent](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/azure-monitor-agent-overview) activated and configured
* A link to an [Azure Monitor Data Collection Rule](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/data-collection-rule-overview) for logging
* An optional link to a [Load Balancer](https://docs.microsoft.com/en-us/azure/load-balancer/load-balancer-overview) or [Application Gateway](https://docs.microsoft.com/en-us/azure/application-gateway/overview)
* A link to the [Recovery Vault](https://docs.microsoft.com/en-us/azure/backup/backup-azure-recovery-services-vault-overview) and one of its policies to back up the Virtual Machine
* Optional certificates [retrieved from Azure Key Vault](https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/key-vault-windows#extension-schema)

This code is mostly based on [Tom Harvey](https://github.com/tombuildsstuff) work: https://github.com/terraform-providers/terraform-provider-azurerm/tree/master/examples/virtual-machines/provisioners/windows

Following tags are automatically set with default values: `env`, `stack`, `os_family`, `os_distribution`, `os_version`.

## Limitations

* A self-signed certificate is generated and associated

## Requirements

* PowerShell CLI installed with `pwsh` executable available
* [Azure PowerShell module](https://docs.microsoft.com/en-us/powershell/azure/install-az-ps) installed
* The port 5986 must be reachable
* An [Azure Key Vault](https://docs.microsoft.com/en-us/azure/key-vault/) configured with Virtual Machine deployment enabled will be used
* An existing [Azure Monitor Data Collection Rule](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/data-collection-rule-overview) is mandatory for monitoring ang logging management with Azure Monitor Agent

## Ansible usage

The created Virtual Machine can be used with Ansible this way:

```bash
ansible all -i <public_ip_address>, -m win_ping -e ansible_user=<vm_username> -e ansible_password==<vm_password> -e ansible_connection=winrm -e ansible_winrm_server_cert_validation=ignore
```

## Global versioning rule for Claranet Azure modules

| Module version | Terraform version | OpenTofu version | AzureRM version |
| -------------- | ----------------- | ---------------- | --------------- |
| >= 8.x.x | **Unverified** | 1.8.x | >= 4.0 |
| >= 7.x.x | 1.3.x | | >= 3.0 |
| >= 6.x.x | 1.x | | >= 3.0 |
| >= 5.x.x | 0.15.x | | >= 2.0 |
| >= 4.x.x | 0.13.x / 0.14.x | | >= 2.0 |
| >= 3.x.x | 0.12.x | | >= 2.0 |
| >= 2.x.x | 0.12.x | | < 2.0 |
| < 2.x.x | 0.11.x | | < 2.0 |

## Contributing

If you want to contribute to this repository, feel free to use our [pre-commit](https://pre-commit.com/) git hook configuration
which will help you automatically update and format some files for you by enforcing our Terraform code module best-practices.

More details are available in the [CONTRIBUTING.md](./CONTRIBUTING.md#pull-request-process) file.

## Usage

This module is optimized to work with the [Claranet terraform-wrapper](https://github.com/claranet/terraform-wrapper) tool
which set some terraform variables in the environment needed by this module.
More details about variables set by the `terraform-wrapper` available in the [documentation](https://github.com/claranet/terraform-wrapper#environment).

⚠️ Since modules version v8.0.0, we do not maintain/check anymore the compatibility with
[Hashicorp Terraform](https://github.com/hashicorp/terraform/). Instead, we recommend to use [OpenTofu](https://github.com/opentofu/opentofu/).

```hcl
# Retrieve the existing Entra groups to which we want to assign login access on the Windows Virtual Machine
data "azuread_group" "vm_admins_group" {
  display_name = "Virtual Machines Administrators"
}

data "azuread_group" "vm_users_group" {
  display_name = "Virtual Machines Basic Users"
}

resource "azurerm_availability_set" "main" {
  name                = "${var.stack}-${var.client_name}-${module.azure_region.location_short}-${var.environment}-as"
  location            = module.azure_region.location
  resource_group_name = module.rg.name
  managed             = true
}

module "vm" {
  source  = "claranet/windows-vm/azurerm"
  version = "x.x.x"

location       = module.azure_region.location
  location_short = module.azure_region.location_short
  client_name    = var.client_name
  environment    = var.environment
  stack          = var.stack

resource_group_name = module.rg.name

key_vault = {
    id = module.run.key_vault_id
  }

subnet = module.subnet

vm_size        = "Standard_B2als_v2"
  admin_username = var.vm_admin_login
  admin_password = var.vm_admin_password

diagnostics_storage_account_name = module.run.logs_storage_account_name
  azure_monitor_data_collection_rule = {
    id = module.run.data_collection_rule_id
  }

# Set to null to deactivate backup
  backup_policy = {
    id = module.run.vm_backup_policy_id
  }

patch_mode = "AutomaticByPlatform"
  maintenance_configurations_ids = [
    module.run.maintenance_configurations["Donald"].id,
    module.run.maintenance_configurations["Hammer"].id,
  ]

availability_set = azurerm_availability_set.main
  # or use Availability Zone
  # zone_id = 1

vm_image = {
    publisher = "MicrosoftWindowsServer"
    offer     = "WindowsServer"
    sku       = "2019-Datacenter-with-Containers"
    version   = "latest"
  }

# The feature must be activated upstream:
 # az feature register --namespace Microsoft.Compute --name EncryptionAtHost --subscription <subscription_id_or_name>
 encryption_at_host_enabled = true

# Use unmanaged disk if needed
  # If those blocks are not defined, it will use managed_disks
  os_disk_size_gb = "150" # At least 127 Gb
  os_disk_caching = "ReadWrite"

storage_data_disk_config = {
    app = {
      disk_size_gb         = 256
      lun                  = 0
      storage_account_type = "Premium_LRS"
    }
  }

entra_login_enabled = true
  entra_login_user_objects_ids = [
    data.azuread_group.vm_users_group.object_id,
  ]
  entra_login_admin_objects_ids = [
    data.azuread_group.vm_admins_group.object_id,
  ]
}
```

## Providers

| Name | Version |
| ---- | ------- |
| azapi | ~> 2.0 |
| azurecaf | >= 1.2.28 |
| azurerm | ~> 4.31 |
| terraform | n/a |

## Modules

| Name | Source | Version |
| ---- | ------ | ------- |
| azure\_region | claranet/regions/azurerm | >= 7.2.0 |

## Resources

| Name | Type |
| ---- | ---- |
| [azapi_resource_action.main](https://registry.terraform.io/providers/azure/azapi/latest/docs/resources/resource_action) | resource |
| [azurerm_backup_protected_vm.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/backup_protected_vm) | resource |
| [azurerm_key_vault_access_policy.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_access_policy) | resource |
| [azurerm_key_vault_certificate.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_certificate) | resource |
| [azurerm_maintenance_assignment_virtual_machine.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/maintenance_assignment_virtual_machine) | resource |
| [azurerm_managed_disk.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/managed_disk) | resource |
| [azurerm_monitor_data_collection_rule_association.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/monitor_data_collection_rule_association) | resource |
| [azurerm_network_interface.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_interface) | resource |
| [azurerm_network_interface_application_gateway_backend_address_pool_association.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_interface_application_gateway_backend_address_pool_association) | resource |
| [azurerm_network_interface_backend_address_pool_association.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_interface_backend_address_pool_association) | resource |
| [azurerm_public_ip.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/public_ip) | resource |
| [azurerm_role_assignment.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_assignment) | resource |
| [azurerm_role_assignment.rbac_admin_login](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_assignment) | resource |
| [azurerm_role_assignment.rbac_user_login](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_assignment) | resource |
| [azurerm_role_assignment.scopes](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_assignment) | resource |
| [azurerm_virtual_machine_data_disk_attachment.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_machine_data_disk_attachment) | resource |
| [azurerm_virtual_machine_extension.azure_monitor_agent](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_machine_extension) | resource |
| [azurerm_virtual_machine_extension.entra_login](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_machine_extension) | resource |
| [azurerm_virtual_machine_extension.key_vault_certificates](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_machine_extension) | resource |
| [azurerm_windows_virtual_machine.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/windows_virtual_machine) | resource |
| [terraform_data.winrm_connection_test](https://registry.terraform.io/providers/hashicorp/terraform/latest/docs/resources/data) | resource |
| [azurecaf_name.disk](https://registry.terraform.io/providers/claranet/azurecaf/latest/docs/data-sources/name) | data source |
| [azurecaf_name.hostname](https://registry.terraform.io/providers/claranet/azurecaf/latest/docs/data-sources/name) | data source |
| [azurecaf_name.nic](https://registry.terraform.io/providers/claranet/azurecaf/latest/docs/data-sources/name) | data source |
| [azurecaf_name.public_ip](https://registry.terraform.io/providers/claranet/azurecaf/latest/docs/data-sources/name) | data source |
| [azurecaf_name.vm](https://registry.terraform.io/providers/claranet/azurecaf/latest/docs/data-sources/name) | data source |
| [azurerm_client_config.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config) | data source |
| [azurerm_managed_disk.vm_os_disk](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/managed_disk) | data source |

## Inputs

| Name | Description | Type | Default | Required |
| ---- | ----------- | ---- | ------- | :------: |
| admin\_password | Password for the Virtual Machine administrator account. | `string` | n/a | yes |
| admin\_username | Username for the Virtual Machine administrator account. | `string` | n/a | yes |
| application\_gateway\_attachment | ID of the Application Gateway Backend Pool to attach the Virtual Machine to. | <pre>object({ id = string })</pre> | `null` | no |
| automatic\_updates\_enabled | Should automatic updates be enabled for the Virtual Machine? | `bool` | `true` | no |
| availability\_set | ID of the Availability Set in which to locate the Virtual Machine. | <pre>object({ id = string })</pre> | `null` | no |
| azure\_monitor\_agent\_auto\_upgrade\_enabled | Automatically update agent when publisher releases a new version of the agent. | `bool` | `false` | no |
| azure\_monitor\_agent\_user\_assigned\_identity | User Assigned Identity to use with Azure Monitor Agent. | `string` | `null` | no |
| azure\_monitor\_agent\_version | Azure Monitor Agent extension version. See [documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/agents/azure-monitor-agent-extension-versions). | `string` | `"1.13"` | no |
| azure\_monitor\_data\_collection\_rule | Data Collection Rule ID from Azure Monitor for metrics and logs collection. Used with new monitoring agent, set to `null` to disable. | <pre>object({ id = string })</pre> | n/a | yes |
| backup\_policy | Backup policy parameters from the Recovery Vault to attach the Virtual Machine to. Can be `null` to disable backup. | <pre>object({ id = string exclude_disk_luns = optional(list(number), []) })</pre> | n/a | yes |
| certificate\_validity\_in\_months | The created certificate validity in months. | `number` | `48` | no |
| client\_name | Client name/account used in naming. | `string` | n/a | yes |
| computer\_name | Custom name for the Virtual Machine hostname. Based on `var.custom_name` if not set. | `string` | `""` | no |
| custom\_data | The base64-encoded custom data which should be used for this Virtual Machine. Changing this forces a new resource to be created. | `string` | `null` | no |
| custom\_dns\_label | The DNS label to use for public access. Virtual Machine name if not set. DNS label will be `<label>.westeurope.cloudapp.azure.com`. | `string` | `""` | no |
| custom\_name | Custom name for the Virtual Machine. Generated if not set. | `string` | `""` | no |
| dcr\_custom\_name | Custom name for the Data Collection Rule association. | `string` | `null` | no |
| default\_tags\_enabled | Option to enable or disable default tags. | `bool` | `true` | no |
| diagnostics\_storage\_account\_name | Name of the Storage Account in which boot diagnostics are stored. | `string` | n/a | yes |
| disk\_controller\_type | Specifies the Disk Controller Type used for this Virtual Machine. Possible values are `SCSI` and `NVMe`. | `string` | `null` | no |
| disk\_encryption\_set\_id | ID of the disk encryption set to use to encrypt VM disks. | `string` | `null` | no |
| dns\_servers | A list of IP Addresses defining the DNS Servers which should be used for this Network Interface. | `list(string)` | `null` | no |
| encryption\_at\_host\_enabled | Should all disks (including the temporary disk) attached to the Virtual Machine be encrypted by enabling Encryption at Host? See [documentation](https://learn.microsoft.com/en-us/azure/virtual-machines/linux/disks-enable-host-based-encryption-cli#finding-supported-vm-sizes) for more information on compatible Virtual Machine sizes. | `bool` | `true` | no |
| entra\_login\_admin\_objects\_ids | Entra ID (aka AAD) objects IDs allowed to connect as administrator on the Virtual Machine. | `list(string)` | `[]` | no |
| entra\_login\_enabled | Enable login with Entra ID (aka AAD). | `bool` | `false` | no |
| entra\_login\_extension\_version | Virtual Machine extension version for Entra ID (aka AAD) login extension. | `string` | `"1.0"` | no |
| entra\_login\_user\_objects\_ids | Entra ID (aka AAD) objects IDs allowed to connect as standard user on the Virtual Machine. | `list(string)` | `[]` | no |
| environment | Project environment. | `string` | n/a | yes |
| extensions\_extra\_tags | Extra tags to set on Virtual Machine extensions. | `map(string)` | `{}` | no |
| extra\_tags | Extra tags to set on each created resource. | `map(string)` | `{}` | no |
| hotpatching\_enabled | Should the Virtual Machine be patched without requiring a reboot? | `bool` | `false` | no |
| identity | Identity block. See [documentation](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/linux_virtual_machine#identity). | <pre>object({ type = string identity_ids = list(string) })</pre> | <pre>{ "identity_ids": [], "type": "SystemAssigned" }</pre> | no |
| ip\_configuration\_custom\_name | Custom name for the IP configuration of the network interface. Generated if not set. | `string` | `null` | no |
| key\_vault | Key Vault configuration for Virtual Machine access. It also manages WinRM certificate. Set `winrm_certificate_enabled` to `false` to disable WinRM certificate creation. Set `scopes` to assign the `Key Vault Secrets User` role to additional resource scopes. | <pre>object({ id = string rbac_authorization_enabled = optional(bool, true) winrm_certificate_enabled = optional(bool, true) scopes = optional(map(string), {}) })</pre> | n/a | yes |
| key\_vault\_certificates | Key Vault certificates object.<pre>names = List of Key Vault certificates names to install in the Virtual Machine. store_name = Name of the certificate store in which to install the Key Vault certificates. polling_rate = Polling rate (in seconds) for Key Vault certificates retrieval.</pre> | <pre>object({ names = optional(list(string)) store_name = optional(string, "MY") polling_rate = optional(number, 300) })</pre> | `{}` | no |
| license\_type | Specifies the BYOL type for this Virtual Machine. Possible values are `Windows_Client` and `Windows_Server`. | `string` | `null` | no |
| load\_balancer\_attachment | ID of the Load Balancer Backend Pool to attach the Virtual Machine to. | <pre>object({ id = string })</pre> | `null` | no |
| location | Azure location. | `string` | n/a | yes |
| location\_short | Short string for Azure location. | `string` | n/a | yes |
| maintenance\_configurations\_ids | List of maintenance configurations to attach to this Virtual Machine. | `list(string)` | `[]` | no |
| monitoring\_agent\_enabled | `true` to use and deploy the Azure Monitor Agent. | `bool` | `true` | no |
| name\_prefix | Optional prefix for the generated name. | `string` | `""` | no |
| name\_suffix | Optional suffix for the generated name. | `string` | `""` | no |
| nic\_accelerated\_networking\_enabled | Should accelerated networking be enabled? Defaults to `true`. | `bool` | `true` | no |
| nic\_custom\_name | Custom name for the network interface. Generated if not set. | `string` | `null` | no |
| nic\_extra\_tags | Extra tags to set on the network interface. | `map(string)` | `{}` | no |
| os\_disk\_caching | Specifies the caching requirements for the OS disk. | `string` | `"ReadWrite"` | no |
| os\_disk\_custom\_name | Custom name for the OS disk. Generated if not set. | `string` | `null` | no |
| os\_disk\_extra\_tags | Extra tags to set on the OS disk. | `map(string)` | `{}` | no |
| os\_disk\_id | ID of the existing Managed Disk to use as the OS disk for this Virtual Machine. When specifying an existing Managed Disk it is not currently possible to subsequently manage the OS profile properties: `admin_username`, `admin_password`, `bypass_platform_safety_checks_on_user_schedule_enabled`, `computer_name`, `custom_data`, `provision_vm_agent`, `patch_mode`, `patch_assessment_mode`, or `reboot_setting`. | `string` | `null` | no |
| os\_disk\_size\_gb | Specifies the size of the OS disk in gigabytes. | `string` | `null` | no |
| os\_disk\_storage\_account\_type | The type of Storage Account used to store the operating system disk. Possible values are `Standard_LRS`, `StandardSSD_LRS`, `Premium_LRS`, `StandardSSD_ZRS` and `Premium_ZRS`. | `string` | `"Premium_ZRS"` | no |
| os\_disk\_tagging\_enabled | Should OS disk tagging be enabled? Defaults to `true`. | `bool` | `true` | no |
| patch\_mode | Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are `Manual`, `AutomaticByOS` and `AutomaticByPlatform`. | `string` | `"AutomaticByPlatform"` | no |
| patching\_reboot\_setting | Specifies the reboot setting for platform scheduled patching. Possible values are `Always`, `IfRequired` and `Never`. | `string` | `"IfRequired"` | no |
| public\_ip\_custom\_name | Custom name for the Public IP. Generated if not set. | `string` | `null` | no |
| public\_ip\_enabled | Should a Public IP be attached to the Virtual Machine? | `bool` | `false` | no |
| public\_ip\_extra\_tags | Extra tags to set on the Public IP. | `map(string)` | `{}` | no |
| public\_ip\_zones | Availability Zones of the Public IP attached to the Virtual Machine. Can be `null` if no zone distpatch. | `list(number)` | <pre>[ 1, 2, 3 ]</pre> | no |
| resource\_group\_name | Resource Group name. | `string` | n/a | yes |
| secure\_boot\_enabled | Specifies if Secure Boot is enabled for the Virtual Machine. Defaults to `true`. Changing this forces a new resource to be created. | `bool` | `true` | no |
| spot\_instance\_enabled | `true` to deploy the Virtual Machine as a Spot Instance. | `bool` | `false` | no |
| spot\_instance\_eviction\_policy | Specifies what should happen when the Virtual Machine is evicted for price reasons. At this time, the only supported value is `Deallocate`. Changing this forces a new resource to be created. | `string` | `"Deallocate"` | no |
| spot\_instance\_max\_bid\_price | The maximum price you're willing to pay for this Virtual Machine in US dollars; must be greater than the current spot price. `-1` if you don't want the Virtual Machine to be evicted for price reasons. | `number` | `-1` | no |
| stack | Project stack name. | `string` | n/a | yes |
| static\_private\_ip | Static private IP address. Dynamic addressing if not set. | `string` | `null` | no |
| storage\_data\_disk\_config | Map of objects to configure storage data disk(s). | <pre>map(object({ name = optional(string) create_option = optional(string, "Empty") disk_iops_read_only = optional(number) disk_mbps_read_only = optional(number) disk_iops_read_write = optional(number) disk_mbps_read_write = optional(number) disk_size_gb = number lun = optional(number) caching = optional(string, "ReadWrite") storage_account_type = optional(string, "StandardSSD_ZRS") source_resource_id = optional(string) storage_account_id = optional(string) source_uri = optional(string) extra_tags = optional(map(string), {}) }))</pre> | `{}` | no |
| subnet | ID of the Subnet in which to create the Virtual Machine. | <pre>object({ id = string })</pre> | n/a | yes |
| ultra\_ssd\_enabled | Specifies whether Ultra Disks is enabled (`UltraSSD_LRS` storage type for data disks). | `bool` | `null` | no |
| user\_data | The base64-encoded user data which should be used for this Virtual Machine. | `string` | `null` | no |
| vm\_image | Virtual Machine source image information. See [documentation](https://www.terraform.io/docs/providers/azurerm/r/windows_virtual_machine.html#source_image_reference). | <pre>object({ publisher = string offer = string sku = string version = optional(string, "latest") })</pre> | <pre>{ "offer": "WindowsServer", "publisher": "MicrosoftWindowsServer", "sku": "2022-datacenter-g2", "version": "latest" }</pre> | no |
| vm\_image\_id | ID of the source image which this Virtual Machine should be created from. This variable supersedes `var.vm_image` if not `null`. | `string` | `null` | no |
| vm\_plan | Virtual Machine plan image information. See [documentation](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/linux_virtual_machine#plan). This variable has to be used for BYOS image. Before using BYOS image, you need to accept legal plan terms. See [documentation](https://docs.microsoft.com/en-us/cli/azure/vm/image?view=azure-cli-latest#az_vm_image_accept_terms). | <pre>object({ name = string product = string publisher = string })</pre> | `null` | no |
| vm\_size | Size (SKU) of the Virtual Machine to create. | `string` | n/a | yes |
| vtpm\_enabled | Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Defaults to `true`. Changing this forces a new resource to be created. | `bool` | `true` | no |
| zone\_id | Index of the Availability Zone which the Virtual Machine should be allocated in. | `number` | `null` | no |

## Outputs

| Name | Description |
| ---- | ----------- |
| admin\_password | Administrator password of the Virtual Machine. |
| admin\_username | Administrator username of the Virtual Machine. |
| hostname | Hostname of the Virtual Machine. |
| id | ID of the Virtual Machine. |
| identity\_principal\_id | Object ID of the Virtual Machine Managed Service Identity. |
| name | Name of the Virtual Machine. |
| nic\_id | ID of the network interface attached to the Virtual Machine. |
| nic\_ip\_configuration\_name | Name of the IP configuration for the network interface attached to the Virtual Machine. |
| nic\_name | Name of the network interface attached to the Virtual Machine. |
| private\_ip\_address | Private IP address of the Virtual Machine. |
| public\_domain\_name\_label | Public domain name of the Virtual Machine. |
| public\_ip\_address | Public IP address of the Virtual Machine. |
| public\_ip\_id | Public IP ID of the Virtual Machine. |
| public\_ip\_name | Public IP name of the Virtual Machine. |
| resource | Windows Virtual Machine resource object. |
| resource\_key\_vault\_certificate | WinRM Key Vault certificate resource object. |
| resource\_maintenance\_configuration\_assignment | Maintenance configuration assignment resource object. |
| resource\_network\_interface | Network interface resource object. |
| resource\_public\_ip | Public IP resource object. |
| terraform\_module | Information about this Terraform module. |
| winrm\_key\_vault\_certificate\_data | RAW Key Vault certificate data represented as a hexadecimal string. |
| winrm\_key\_vault\_certificate\_id | ID of the generated WinRM Key Vault certificate. |
| winrm\_key\_vault\_certificate\_name | Name of the generated WinRM Key Vault certificate. |
| winrm\_key\_vault\_certificate\_thumbprint | X509 thumbprint of the Key Vault certificate represented as a hexadecimal string. |

## Related documentation

Microsoft Azure documentation: [docs.microsoft.com/en-us/azure/virtual-machines/windows/](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/)

terraform-azurerm-windows-vm

terraform-azurerm-windows-vm Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

terraform-azurerm-windows-vm

terraform-azurerm-windows-vm Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README