terraform-azurerm-avm-res-network-privateendpoint

[!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.9, < 2.0)

• azurerm (>= 3.71, < 5.0)

• modtm (~> 0.3)

• random (~> 3.5)

Resources

The following resources are used by this module:

• azurerm_management_lock.this (resource)
• azurerm_private_endpoint.this (resource)
• azurerm_private_endpoint_application_security_group_association.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:

location

Description: (Required) Azure region where the resource should be deployed. If null, the location will be inferred from the resource group location.

Type: string

name

Description: (Required) The name of the this resource.

Type: string

network_interface_name

Description: (Optional) The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created

Type: string

private_connection_resource_id

Description: (Required) The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to.

Type: string

resource_group_name

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

Type: string

subnet_resource_id

Description: (Required) Azure resource ID of the Subnet from which Private IP Addresses will be allocated for this Private Endpoint. Changing this forces a new resource to be created.

Type: string

Optional Inputs

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

application_security_group_association_ids

Description: (Optional) The resource ids of application security group to associate.

Type: set(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

ip_configurations

Description: (Optional) An ip_configuration block as defined below
map(object({
private_ip_address = "(Required) Specifies the static IP address within the private endpoint's subnet to be used. Changing this forces a new resource to be created."
subresource_name = "(Required) Specifies the subresource this IP address applies to."
member_name = "(Optional) Specifies the member name this IP address applies to." }))

Example Input:

ip_configurations ={
  "object1" = {
    name               = "<name_of_the_ip_configuration>"
    private_ip_address = "<value_of_the_static_IP >"
    subresource_name   = "<subresource_name>"
  }
}

Type:

map(object({
    name               = string
    private_ip_address = string
    subresource_name   = string
    member_name        = optional(string, "default")
  }))

Default: {}

lock

Description: The lock level to apply. Default is None. Possible values are None, CanNotDelete, and ReadOnly.

Type:

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

Default: null

private_dns_zone_group_name

Description: (Optional) Specifies the Name of the Private DNS Zone Group.

Type: string

Default: null

private_dns_zone_resource_ids

Description: (Optional) Specifies the list of Private DNS Zones to include within the private_dns_zone_group.

Type: list(string)

Default: []

private_service_connection_name

Description: (Optional) Specifies the Specifies the Name of the Private Service Connection.

Type: 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'.
• delegated_managed_identity_resource_id - (Optional) The delegated Azure Resource Id which contains a Managed Identity. Changing this forces a new resource to be created. This field is only used in cross-tenant scenario.
• principal_type - (Optional) The type of the principal_id. Possible values are User, Group and ServicePrincipal. It is necessary to explicitly set this attribute when creating role assignments if the principal creating the assignment is constrained by ABAC rules that filters on the PrincipalType attribute.

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

Example Input:

role_assignments ={
  "object1" = {
    role_definition_id_or_name = "<role_definition_1_name>"
    principal_id               = "<object_id_of_the_principal>"
  },
  "object2" = {
    role_definition_id_or_name = "<role_definition_2_name>"
    principal_id               = "<object_id_of_the_principal>"
    description                = "<description>"
  },
}

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

subresource_names

Description: (Optional) A list of subresource names which the Private Endpoint is able to connect to. [https://learn.microsoft.com/en-us/azure/private-link/private-endpoint-overview#private-link-resource]

Type: list(string)

Default: null

tags

Description: Tags to be applied to the resource

Type: map(string)

Default: null

Outputs

The following outputs are exported:

name

Description: Name of the resource.

resource

Description: Output of the resource.

resource_id

Description: ID of 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.