terraform-azurerm-avm-res-azurestackhci-virtualmachineinstance

Provision for AzureStackHCI virtual machine.

Requirements

The following requirements are needed by this module:

• terraform (~> 1.5)

• azapi (~> 2.0)

• azurerm (~> 4.0)

• modtm (~> 0.3)

• random (~> 3.5)

Resources

The following resources are used by this module:

• azapi_resource.data_disks (resource)
• azapi_resource.domain_join (resource)
• azapi_resource.hybrid_compute_machine (resource)
• azapi_resource.nic (resource)
• azapi_resource.virtual_machine (resource)
• azurerm_management_lock.this (resource)
• azurerm_role_assignment.this (resource)
• modtm_telemetry.telemetry (resource)
• random_uuid.telemetry (resource)
• azurerm_client_config.telemetry (data source)
• azurerm_resource_group.rg (data source)
• modtm_module_source.telemetry (data source)

Required Inputs

The following input variables are required:

admin_password

Description: Admin password

Type: string

admin_username

Description: Admin username

Type: string

custom_location_id

Description: The custom location ID for the Azure Stack HCI cluster.

Type: string

image_id

Description: The name of a Marketplace Gallery Image already downloaded to the Azure Stack HCI cluster. For example: winServer2022-01

Type: string

location

Description: Azure region where the resource should be deployed.

Type: string

logical_network_id

Description: The ID of the logical network to use for the NIC.

Type: string

name

Description: Name of the VM resource

Type: string

resource_group_name

Description: The resource group where the resources will be deployed.

Type: string

Optional Inputs

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

auto_upgrade_minor_version

Description: Whether to enable auto upgrade minor version

Type: bool

Default: true

data_disk_params

Description: The array description of the dataDisks to attach to the vm. Provide an empty array for no additional disks, or an array following the example below.

Type:

map(object({
    name        = string
    diskSizeGB  = number
    dynamic     = bool
    tags        = optional(map(string))
    containerId = optional(string)
  }))

Default: {}

domain_join_extension_tags

Description: (Optional) Tags of the domain join extension.

Type: map(string)

Default: null

domain_join_password

Description: Optional Password of User with permissions to join the domain. - Required if 'domain_to_join' is specified.

Type: string

Default: null

domain_join_user_name

Description: Optional User Name with permissions to join the domain. example: domain-joiner - Required if 'domain_to_join' is specified.

Type: string

Default: ""

domain_target_ou

Description: Optional domain organizational unit to join. example: ou=computers,dc=contoso,dc=com - Required if 'domain_to_join' is specified.

Type: string

Default: ""

domain_to_join

Description: Optional Domain name to join - specify to join the VM to domain. example: contoso.com - If left empty, ou, username and password parameters will not be evaluated in the deployment.

Type: string

Default: ""

dynamic_memory

Description: Enable dynamic memory

Type: bool

Default: true

dynamic_memory_buffer

Description: Buffer memory in MB when dynamic memory is enabled

Type: number

Default: 20

dynamic_memory_max

Description: Maximum memory in MB when dynamic memory is enabled

Type: number

Default: 8192

dynamic_memory_min

Description: Minimum memory in MB when dynamic memory is enabled

Type: number

Default: 512

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: false

http_proxy

Description: HTTP URL for proxy server. An example URL is:http://proxy.example.com:3128.

Type: string

Default: null

https_proxy

Description: HTTPS URL for proxy server. The server may still use an HTTP address as shown in this example: http://proxy.example.com:3128.

Type: string

Default: null

linux_ssh_config

Description: SSH configuration with public keys for linux.

Type:

object({
    publicKeys = list(object({
      keyData = string
      path    = string
    }))
  })

Default: null

lock

Description: Controls the Resource Lock configuration for this resource. The following properties can be specified:

• kind - (Required) The type of lock. Possible values are \"CanNotDelete\" and \"ReadOnly\".
• name - (Optional) The name of the lock. If not specified, a name will be generated based on the kind value. Changing this forces the creation of a new resource.

Type:

object({
    kind = string
    name = optional(string, null)
  })

Default: null

managed_identities

Description: Controls the Managed Identity configuration on this resource. The following properties can be specified:

• system_assigned - (Optional) Specifies if the System Assigned Managed Identity should be enabled.
• user_assigned_resource_ids - (Optional) Specifies a list of User Assigned Managed Identity resource IDs to be assigned to this resource.

Type:

object({
    system_assigned            = optional(bool, false)
    user_assigned_resource_ids = optional(set(string), [])
  })

Default: {}

memory_mb

Description: Memory in MB

Type: number

Default: 8192

nic_tags

Description: (Optional) Tags of the nic.

Type: map(string)

Default: null

no_proxy

Description: URLs, which can bypass proxy. Typical examples would be [localhost,127.0.0.1,.svc,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,100.0.0.0/8]

Type: list(string)

Default: []

os_type

Description: The OS type of the VM. Possible values are 'Windows' and 'Linux'.

Type: string

Default: "Windows"

private_ip_address

Description: The private IP address of the NIC

Type: string

Default: ""

role_assignments

Description: A map of role assignments to create on this resource. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.

• role_definition_id_or_name - The ID or name of the role definition to assign to the principal.
• principal_id - The ID of the principal to assign the role to.
• description - The description of the role assignment.
• skip_service_principal_aad_check - If set to true, skips the Azure Active Directory check for the service principal in the tenant. Defaults to false.
• condition - The condition which will be used to scope the role assignment.
• condition_version - The version of the condition syntax. Valid values are '2.0'.

Note: only set skip_service_principal_aad_check to true if you are assigning a role to a service principal.

Type:

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: {}

secure_boot_enabled

Description: Enable secure boot

Type: bool

Default: true

tags

Description: (Optional) Tags of the arc vm.

Type: map(string)

Default: null

trusted_ca

Description: Alternative CA cert to use for connecting to proxy servers.

Type: string

Default: null

type_handler_version

Description: The version of the type handler to use.

Type: string

Default: "1.3"

user_storage_id

Description: The user storage ID to store images.

Type: string

Default: ""

v_cpu_count

Description: Number of vCPUs

Type: number

Default: 2

windows_ssh_config

Description: SSH configuration with public keys for windows.

Type:

object({
    publicKeys = list(object({
      keyData = string
      path    = string
    }))
  })

Default: null

Outputs

The following outputs are exported:

resource_id

Description: This is the full output for the resource.

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.

 
 {
  "workingFolder": "packages",
  "packages": [
    // packages defined earlier
    {
      "name": "avm-terraform/azurestackhci-vm-instance",
      "version": "2.0.0"
    }
  ]
}