terraform-azurerm-avm-res-compute-hostgroup

This is an AVM module to deploy dedicated host groups in Azure.

To use this module in your Terraform configuration, you'll need to provide values for the required variables. Here's a basic example:

module "azure_computehostgroup" {
  source = "./path_to_this_module"

  // ... mandatory variables ...
  dedicated_host_group_name = "dedicated_host_groupname"
  resource_group_name = "resource_group_name"
  location = "location"
  platform_fault_domain_count = 5 //acceptable values between 1 and 5

  // ... other optional variables, see example ...
}

[!IMPORTANT] As the overall AVM framework is not GA (generally available) yet - the CI framework and test automation is not fully functional and implemented across all supported languages yet - breaking changes are expected, and additional customer feedback is yet to be gathered and incorporated. Hence, modules MUST NOT be published at version 1.0.0 or higher at this time.

All module MUST be published as a pre-release version (e.g., 0.1.0, 0.1.1, 0.2.0, etc.) until the AVM framework becomes GA.

However, it is important to note that this DOES NOT mean that the modules cannot be consumed and utilized. They CAN be leveraged in all types of environments (dev, test, prod etc.). Consumers can treat them just like any other IaC module and raise issues or feature requests against them as they learn from the usage of the module. Consumers should also read the release notes for each version, if considering updating to a more recent version of a module to see if there are any considerations or breaking changes etc.

Requirements

The following requirements are needed by this module:

• terraform (>= 1.3.0)

• azurerm (>= 3.71.0)

• modtm (~> 0.3)

• random (>= 3.5.0)

Resources

The following resources are used by this module:

• azurerm_dedicated_host.this (resource)
• azurerm_dedicated_host_group.this (resource)
• azurerm_resource_group.this (resource)
• modtm_telemetry.telemetry (resource)
• random_uuid.telemetry (resource)
• azurerm_client_config.telemetry (data source)
• modtm_module_source.telemetry (data source)

Required Inputs

The following input variables are required:

dedicated_host_group_name

Description: The name of the dedicated host.

Type: string

location

Description: The location where the dedicated host group will be created.

Type: string

platform_fault_domain_count

Description: The number of fault domains that the host group can span.

Type: number

resource_group_name

Description: The resource group where dedicated host group will be deployed.

Type: string

Optional Inputs

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

automatic_placement_enabled

Description: Whether or not automatic placement is enabled for the host group.

Type: bool

Default: true

dedicated_hosts

Description: (Optional) A map of the hosts and their specifications in the Dedicated Host Group

Type:

map(object({
    name                    = string
    sku_name                = string
    auto_replace_on_failure = optional(bool, true)
    platform_fault_domain   = number
    license_type            = optional(string, "None")
    tags                    = optional(map(string), null)
  }))

Default: {}

enable_telemetry

Description: This variable controls whether or not telemetry is enabled for the module. For more information see https://aka.ms/avm/telemetryinfo. If it is set to false, then no telemetry will be collected.

Type: bool

Default: true

tags

Description: (Optional) Tags of the resource

Type: map(string)

Default: null

zone

Description: The Availability Zone for the Dedicated Host Group.

Type: string

Default: null

Outputs

The following outputs are exported:

host_ids

Description: A map of the hosts in the Dedicated Host Group to the resource IDs

name

Description: The name of the Dedicated Host Group

resource

Description: All atrributes of the Dedicated Host group

resource_id

Description: The resource ID of the Dedicated Host Group

Modules

No modules.

Data Collection

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.