Provision for AzureStackHCI virtual machine.
The following requirements are needed by this module:
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)
The following input variables are required:
Description: Admin password
Type: string
Description: Admin username
Type: string
Description: The custom location ID for the Azure Stack HCI cluster.
Type: string
Description: The name of a Marketplace Gallery Image already downloaded to the Azure Stack HCI cluster. For example: winServer2022-01
Type: string
Description: Azure region where the resource should be deployed.
Type: string
Description: The ID of the logical network to use for the NIC.
Type: string
Description: Name of the VM resource
Type: string
Description: The resource group where the resources will be deployed.
Type: string
The following input variables are optional (have default values):
Description: Whether to enable auto upgrade minor version
Type: bool
Default: true
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: {}
Description: (Optional) Tags of the domain join extension.
Type: map(string)
Default: null
Description: Optional Password of User with permissions to join the domain. - Required if 'domain_to_join' is specified.
Type: string
Default: null
Description: Optional User Name with permissions to join the domain. example: domain-joiner - Required if 'domain_to_join' is specified.
Type: string
Default: ""
Description: Optional domain organizational unit to join. example: ou=computers,dc=contoso,dc=com - Required if 'domain_to_join' is specified.
Type: string
Default: ""
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: ""
Description: Enable dynamic memory
Type: bool
Default: true
Description: Buffer memory in MB when dynamic memory is enabled
Type: number
Default: 20
Description: Maximum memory in MB when dynamic memory is enabled
Type: number
Default: 8192
Description: Minimum memory in MB when dynamic memory is enabled
Type: number
Default: 512
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
Description: HTTP URL for proxy server. An example URL is:http://proxy.example.com:3128.
Type: string
Default: null
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
Description: SSH configuration with public keys for linux.
Type:
object({
publicKeys = list(object({
keyData = string
path = string
}))
})Default: null
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 thekindvalue. Changing this forces the creation of a new resource.
Type:
object({
kind = string
name = optional(string, null)
})Default: null
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: {}
Description: Memory in MB
Type: number
Default: 8192
Description: (Optional) Tags of the nic.
Type: map(string)
Default: null
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: []
Description: The OS type of the VM. Possible values are 'Windows' and 'Linux'.
Type: string
Default: "Windows"
Description: The private IP address of the NIC
Type: string
Default: ""
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_checkto 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: {}
Description: Enable secure boot
Type: bool
Default: true
Description: (Optional) Tags of the arc vm.
Type: map(string)
Default: null
Description: Alternative CA cert to use for connecting to proxy servers.
Type: string
Default: null
Description: The version of the type handler to use.
Type: string
Default: "1.3"
Description: The user storage ID to store images.
Type: string
Default: ""
Description: Number of vCPUs
Type: number
Default: 2
Description: SSH configuration with public keys for windows.
Type:
object({
publicKeys = list(object({
keyData = string
path = string
}))
})Default: null
The following outputs are exported:
Description: This is the full output for the resource.
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.