terraform-azurerm-avm-res-azurestackhci-logical_network

Module to provision azure stack hci logical networks.

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.logical_network (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)
• modtm_module_source.telemetry (data source)

Required Inputs

The following input variables are required:

custom_location_id

Description: The id of the Custom location that used to create hybrid aks

Type: string

location

Description: Azure region where the resource should be deployed.

Type: string

name

Description: The name of the logical network

Type: string

resource_group_id

Description: The resource group ID for the Azure Stack HCI logical network.

Type: string

vm_switch_name

Description: The name of the virtual switch that is used by the network.

Type: string

Optional Inputs

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

address_prefix

Description: The CIDR prefix of the subnet that used by kubernetes cluster nodes, it will create VM with the ip address in this range

Type: string

Default: null

default_gateway

Description: The default gateway for the network.

Type: string

Default: null

dns_servers

Description: A list of DNS server IP addresses.

Type: list(string)

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

ending_address

Description: The ending IP address of the IP address range.

Type: string

Default: null

ip_allocation_method

Description: The IP address allocation method, must be either 'Static' or 'Dynamic'. Default is dynamic

Type: string

Default: "Dynamic"

ip_configuration_references

Description: A list of IP configuration references.

Type:

list(object({
    ID = 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

logical_network_tags

Description: (Optional) Tags of the logical network.

Type: map(string)

Default: null

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

route_name

Description: The name of the route

Type: string

Default: null

starting_address

Description: The starting IP address of the IP address range.

Type: string

Default: null

subnet_0_name

Description: The name of the subnet

Type: string

Default: "default"

vlan_id

Description: The vlan id of the logical network, default means no vlan id is specified

Type: 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.