Skip to content

Data Source: azurermPrivateDnsMxRecord

Use this data source to access information about an existing Private DNS MX Record within Azure DNS.

\~> Note: The Azure DNS API has a throttle limit of 500 read (GET) operations per 5 minutes - whilst the default read timeouts will work for most cases - in larger configurations you may need to set a larger read timeout then the default 5min. Although, we'd generally recommend that you split the resources out into smaller Terraform configurations to avoid the problem entirely.

Example Usage

import * as cdktf from "cdktf";
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
new cdktf.TerraformOutput(this, "private_dns_mx_record_id", {
  value: "${data.azurerm_private_dns_mx_record.example.id}",
});
new azurerm.privateDnsMxRecord.PrivateDnsMxRecord(this, "example", {
  name: "test",
  resource_group_name: "test-rg",
  zone_name: "test-zone",
});

Argument Reference

  • name - The name of the Private DNS MX Record.

  • resourceGroupName - Specifies the resource group where the Private DNS Zone (parent resource) exists.

  • zoneName - Specifies the Private DNS Zone where the resource exists.

Attributes Reference

  • id - The Private DNS MX Record ID.

  • fqdn - The FQDN of the Private DNS MX Record.

  • ttl - The Time To Live (TTL) of the Private DNS record in seconds.

  • record - A list of values that make up the MX record. Each record block supports fields documented below.

  • tags - A mapping of tags assigned to the resource.

The record block supports:

  • preference - String representing the "preference” value of the MX records. Records with lower preference value take priority.

  • exchange - The mail server responsible for the domain covered by the MX record.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the Private DNS MX Record.