Skip to content

Commit

Permalink
Fix document mismatch for vmss
Browse files Browse the repository at this point in the history
  • Loading branch information
myc2h6o committed Jan 3, 2023
1 parent 55e4fdb commit 9567dfa
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ resource "azurerm_orchestrated_virtual_machine_scale_set" "example" {

* `additional_capabilities` - (Optional) An `additional_capabilities` block as defined below.

* `encryption_at_host_enabled` - (Optional) Should disks attached to this Virtual Machine Scale Set be encrypted by enabling Encryption at Host?

* `instances` - (Optional) The number of Virtual Machines in the Orcestrated Virtual Machine Scale Set.

* `network_interface` - (Optional) One or more `network_interface` blocks as defined below.
Expand All @@ -59,6 +61,10 @@ resource "azurerm_orchestrated_virtual_machine_scale_set" "example" {

* `os_disk` - (Optional) An `os_disk` block as defined below.

* `automatic_instance_repair` - (Optional) An `automatic_instance_repair` block as defined below.

-> **NOTE:** To enable the `automatic_instance_repair`, the Orchestrated Virtual Machine Scale Set must have a valid `health_probe_id` or an [Application Health Extension](https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-health-extension).

* `boot_diagnostics` - (Optional) A `boot_diagnostics` block as defined below.

* `capacity_reservation_group_id` - (Optional) Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
Expand Down Expand Up @@ -103,6 +109,10 @@ resource "azurerm_orchestrated_virtual_machine_scale_set" "example" {

* `proximity_placement_group_id` - (Optional) The ID of the Proximity Placement Group which the Orchestrated Virtual Machine should be assigned to. Changing this forces a new resource to be created.

* `zone_balance` - (Optional) Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to `false`. Changing this forces a new resource to be created.

-> **NOTE:** This can only be set to `true` when one or more `zones` are configured.

* `zones` - (Optional) Specifies a list of Availability Zones in which this Orchestrated Virtual Machine should be located. Changing this forces a new Orchestrated Virtual Machine to be created.

-> **NOTE:** Due to a limitation of the Azure API at this time only one Availability Zone can be defined.
Expand Down Expand Up @@ -135,14 +145,6 @@ A `windows_configuration` block supports the following:

* `admin_password` - (Required) The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.

* `automatic_instance_repair` - (Optional) An `automatic_instance_repair` block as defined below.

-> **NOTE:** To enable the `automatic_instance_repair`, the Orchestrated Virtual Machine Scale Set must have a valid `health_probe_id` or an [Application Health Extension](https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-health-extension).

* `computer_name_prefix` - (Optional) The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the `name` field. If the value of the `name` field is not a valid `computer_name_prefix`, then you must specify `computer_name_prefix`.

* `enable_automatic_updates` - (Optional) Are automatic updates enabled for this Virtual Machine? Defaults to `true`.

* `hotpatching_enabled` - (Optional) Should the VM be patched without requiring a reboot? Possible values are `true` or `false`. Defaults to `false`. For more information about hot patching please see the [product documentation](https://docs.microsoft.com/azure/automanage/automanage-hotpatch).

-> **NOTE:** 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, the VM's `sku_name` is set to a [Azure generation 2](https://docs.microsoft.com/azure/virtual-machines/generation-2#generation-2-vm-sizes) VM SKU and the `extension` contains an application health extension. An example of how to correctly configure a Orchestrated Virtual Machine Scale Set to provision a Windows Virtual Machine with hotpatching enabled can be found in the [`./examples/orchestrated-vm-scale-set/hotpatching-enabled`](https://github.com/hashicorp/terraform-provider-azurerm/tree/main/examples/orchestrated-vm-scale-set/hotpatching-enabled) directory within the GitHub Repository.
Expand Down Expand Up @@ -229,6 +231,8 @@ An `admin_ssh_key` block supports the following:

A `winrm_listener` block supports the following:

* `Protocol` - (Required) Specifies the protocol of listener. Possible values are `Http` or `Https`

* `certificate_url` - (Optional) The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to `Https`.

-> **NOTE:** This can be sourced from the `secret_id` field within the `azurerm_key_vault_certificate` Resource.
Expand Down Expand Up @@ -279,6 +283,10 @@ A `data_disk` block supports the following:

* `storage_account_type` - (Required) The Type of Storage Account which should back this Data Disk. Possible values include `Standard_LRS`, `StandardSSD_LRS`, `StandardSSD_ZRS`, `Premium_LRS`, `PremiumV2_LRS`, `Premium_ZRS` and `UltraSSD_LRS`.

* `disk_encryption_set_id` - (Optional) The ID of the Disk Encryption Set which should be used to encrypt the Data Disk. Changing this forces a new resource to be created.

* `write_accelerator_enabled` - (Optional) Specifies if Write Accelerator is enabled on the Data Disk. Defaults to `false`.

---

An `extension` block supports the following:
Expand Down Expand Up @@ -309,6 +317,8 @@ An `extension` block supports the following:

-> **NOTE:** Operational failures such as not connecting to the VM will not be suppressed regardless of the `failure_suppression_enabled` value.

* `settings` - (Optional) A JSON String which specifies Settings for the Extension.

---

An `ip_configuration` block supports the following:
Expand Down Expand Up @@ -378,6 +388,8 @@ An `os_disk` block supports the following:
-> **NOTE:** Disk Encryption Sets are in Public Preview in a limited set of regions

* `disk_size_gb` - (Optional) The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine Scale Set is sourced from.
*
* `write_accelerator_enabled` - (Optional) Specifies if Write Accelerator is enabled on the OS Disk. Defaults to `false`.

---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/windows_virtual_machine.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ A `termination_notification` block supports the following:

A `winrm_listener` block supports the following:

* `Protocol` - (Required) Specifies Specifies the protocol of listener. Possible values are `Http` or `Https`
* `Protocol` - (Required) Specifies the protocol of listener. Possible values are `Http` or `Https`

* `certificate_url` - (Optional) The Secret URL of a Key Vault Certificate, which must be specified when `protocol` is set to `Https`. Changing this forces a new resource to be created.

Expand Down

0 comments on commit 9567dfa

Please sign in to comment.