Skip to content

Azure/terraform-azurerm-avm-res-network-dnszone

Repository files navigation

terraform-azurerm-avm-template

This is a template repo for Terraform Azure Verified Modules.

Things to do:

  1. Set up a GitHub repo environment called test.
  2. Configure environment protection rule to ensure that approval is required before deploying to this environment.
  3. Create a user-assigned managed identity in your test subscription.
  4. Create a role assignment for the managed identity on your test subscription, use the minimum required role.
  5. Configure federated identity credentials on the user assigned managed identity. Use the GitHub environment.
  6. Search and update TODOs within the code and remove the TODO comments once complete.

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:

Resources

The following resources are used by this module:

Required Inputs

The following input variables are required:

Description: The name of the this resource.

Type: string

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

Type: string

Optional Inputs

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

Description: A map of objects where each object contains information to create a A record.

Type:

map(object({
    name                = string
    resource_group_name = string
    zone_name           = string
    ttl                 = number
    records             = list(string)
    target_resource_id  = optional(string)
    tags                = optional(map(string), null)
  }))

Default: {}

Description: A map of objects where each object contains information to create a AAAA record.

Type:

map(object({
    name                = string
    resource_group_name = string
    zone_name           = string
    ttl                 = number
    records             = list(string)
    target_resource_id  = optional(string)
    tags                = optional(map(string), null)
  }))

Default: {}

Description: A map of objects where each object contains information to create a CAA record.

Type:

map(object({
    name                = string
    resource_group_name = string
    zone_name           = string
    ttl                 = number
    record = map(object({
      flags = string
      tag   = string
      value = string
    }))
    tags = optional(map(string), null)
  }))

Default: {}

Description: A map of objects where each object contains information to create a CNAME record.

Type:

map(object({
    name                = string
    resource_group_name = string
    zone_name           = string
    ttl                 = number
    record              = string
    tags                = optional(map(string), null)
    target_resource_id  = optional(string)
  }))

Default: {}

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: A map of objects where each object contains information to create a MX record.

Type:

map(object({
    name                = optional(string, "@")
    resource_group_name = string
    zone_name           = string
    ttl                 = number
    records = map(object({
      preference = number
      exchange   = string
    }))
    tags = optional(map(string), null)
  }))

Default: {}

Description: A map of objects where each object contains information to create a NS record.

Type:

map(object({
    name                = string
    resource_group_name = string
    zone_name           = string
    ttl                 = number
    records             = list(string)
    tags                = optional(map(string), null)
  }))

Default: {}

Description: A map of objects where each object contains information to create a PTR record.

Type:

map(object({
    name                = string
    resource_group_name = string
    zone_name           = string
    ttl                 = number
    records             = list(string)
    tags                = optional(map(string), null)
  }))

Default: {}

Description: A map of objects where each object contains information to create a SRV record.

Type:

map(object({
    name                = string
    resource_group_name = string
    zone_name           = string
    ttl                 = number
    records = map(object({
      priority = number
      weight   = number
      port     = number
      target   = string
    }))
    tags = optional(map(string), null)
  }))

Default: {}

Description: (Optional) Tags of the resource.

Type: map(string)

Default: null

Description: A map of objects where each object contains information to create a TXT record.

Type:

map(object({
    name                = string
    resource_group_name = string
    zone_name           = string
    ttl                 = number
    records = map(object({
      value = string
    }))
    tags = optional(map(string), null)
  }))

Default: {}

Outputs

The following outputs are exported:

Description: The a record output

Description: The aaaa record output

Description: The caa record output

Description: The cname record output

Description: Maximum number of Records in Zone output

Description: The mx record output

Description: List of values that make up NS Record for Zone

Description: The ns record output

Description: Number of records in DNS Zone

Description: The ptr record output

Description: Id of dns zone

Description: The srv record output

Description: The txt record output

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.