MxRecord

Enables you to manage DNS MX Records within Azure Private DNS.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleZone = new Azure.PrivateDns.Zone("exampleZone", new Azure.PrivateDns.ZoneArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
        });
        var exampleMxRecord = new Azure.PrivateDns.MxRecord("exampleMxRecord", new Azure.PrivateDns.MxRecordArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            ZoneName = exampleZone.Name,
            Ttl = 300,
            Records = 
            {
                new Azure.PrivateDns.Inputs.MxRecordRecordArgs
                {
                    Preference = 10,
                    Exchange = "mx1.contoso.com",
                },
                new Azure.PrivateDns.Inputs.MxRecordRecordArgs
                {
                    Preference = 20,
                    Exchange = "backupmx.contoso.com",
                },
            },
            Tags = 
            {
                { "Environment", "Production" },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/privatedns"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleZone, err := privatedns.NewZone(ctx, "exampleZone", &privatedns.ZoneArgs{
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		_, err = privatedns.NewMxRecord(ctx, "exampleMxRecord", &privatedns.MxRecordArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			ZoneName:          exampleZone.Name,
			Ttl:               pulumi.Int(300),
			Records: privatedns.MxRecordRecordArray{
				&privatedns.MxRecordRecordArgs{
					Preference: pulumi.Int(10),
					Exchange:   pulumi.String("mx1.contoso.com"),
				},
				&privatedns.MxRecordRecordArgs{
					Preference: pulumi.Int(20),
					Exchange:   pulumi.String("backupmx.contoso.com"),
				},
			},
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_zone = azure.privatedns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_mx_record = azure.privatedns.MxRecord("exampleMxRecord",
    resource_group_name=example_resource_group.name,
    zone_name=example_zone.name,
    ttl=300,
    records=[
        azure.privatedns.MxRecordRecordArgs(
            preference=10,
            exchange="mx1.contoso.com",
        ),
        azure.privatedns.MxRecordRecordArgs(
            preference=20,
            exchange="backupmx.contoso.com",
        ),
    ],
    tags={
        "Environment": "Production",
    })
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleZone = new azure.privatedns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const exampleMxRecord = new azure.privatedns.MxRecord("exampleMxRecord", {
    resourceGroupName: exampleResourceGroup.name,
    zoneName: exampleZone.name,
    ttl: 300,
    records: [
        {
            preference: 10,
            exchange: "mx1.contoso.com",
        },
        {
            preference: 20,
            exchange: "backupmx.contoso.com",
        },
    ],
    tags: {
        Environment: "Production",
    },
});

Create a MxRecord Resource

new MxRecord(name: string, args: MxRecordArgs, opts?: CustomResourceOptions);
@overload
def MxRecord(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             name: Optional[str] = None,
             records: Optional[Sequence[MxRecordRecordArgs]] = None,
             resource_group_name: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             ttl: Optional[int] = None,
             zone_name: Optional[str] = None)
@overload
def MxRecord(resource_name: str,
             args: MxRecordArgs,
             opts: Optional[ResourceOptions] = None)
func NewMxRecord(ctx *Context, name string, args MxRecordArgs, opts ...ResourceOption) (*MxRecord, error)
public MxRecord(string name, MxRecordArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args MxRecordArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args MxRecordArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args MxRecordArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args MxRecordArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

MxRecord Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The MxRecord resource accepts the following input properties:

Records List<MxRecordRecordArgs>
One or more record blocks as defined below.
ResourceGroupName string
Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
Ttl int
ZoneName string
Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.
Name string
The name of the DNS MX Record. Changing this forces a new resource to be created. Default to ‘@’ for root zone entry.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
Records []MxRecordRecord
One or more record blocks as defined below.
ResourceGroupName string
Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
Ttl int
ZoneName string
Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.
Name string
The name of the DNS MX Record. Changing this forces a new resource to be created. Default to ‘@’ for root zone entry.
Tags map[string]string
A mapping of tags to assign to the resource.
records MxRecordRecordArgs[]
One or more record blocks as defined below.
resourceGroupName string
Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
ttl number
zoneName string
Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.
name string
The name of the DNS MX Record. Changing this forces a new resource to be created. Default to ‘@’ for root zone entry.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
records Sequence[MxRecordRecordArgs]
One or more record blocks as defined below.
resource_group_name str
Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
ttl int
zone_name str
Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.
name str
The name of the DNS MX Record. Changing this forces a new resource to be created. Default to ‘@’ for root zone entry.
tags Mapping[str, str]
A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the MxRecord resource produces the following output properties:

Fqdn string
The FQDN of the DNS MX Record.
Id string
The provider-assigned unique ID for this managed resource.
Fqdn string
The FQDN of the DNS MX Record.
Id string
The provider-assigned unique ID for this managed resource.
fqdn string
The FQDN of the DNS MX Record.
id string
The provider-assigned unique ID for this managed resource.
fqdn str
The FQDN of the DNS MX Record.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing MxRecord Resource

Get an existing MxRecord resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MxRecordState, opts?: CustomResourceOptions): MxRecord
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        fqdn: Optional[str] = None,
        name: Optional[str] = None,
        records: Optional[Sequence[MxRecordRecordArgs]] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        ttl: Optional[int] = None,
        zone_name: Optional[str] = None) -> MxRecord
func GetMxRecord(ctx *Context, name string, id IDInput, state *MxRecordState, opts ...ResourceOption) (*MxRecord, error)
public static MxRecord Get(string name, Input<string> id, MxRecordState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Fqdn string
The FQDN of the DNS MX Record.
Name string
The name of the DNS MX Record. Changing this forces a new resource to be created. Default to ‘@’ for root zone entry.
Records List<MxRecordRecordArgs>
One or more record blocks as defined below.
ResourceGroupName string
Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
Ttl int
ZoneName string
Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.
Fqdn string
The FQDN of the DNS MX Record.
Name string
The name of the DNS MX Record. Changing this forces a new resource to be created. Default to ‘@’ for root zone entry.
Records []MxRecordRecord
One or more record blocks as defined below.
ResourceGroupName string
Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
Ttl int
ZoneName string
Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.
fqdn string
The FQDN of the DNS MX Record.
name string
The name of the DNS MX Record. Changing this forces a new resource to be created. Default to ‘@’ for root zone entry.
records MxRecordRecordArgs[]
One or more record blocks as defined below.
resourceGroupName string
Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
ttl number
zoneName string
Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.
fqdn str
The FQDN of the DNS MX Record.
name str
The name of the DNS MX Record. Changing this forces a new resource to be created. Default to ‘@’ for root zone entry.
records Sequence[MxRecordRecordArgs]
One or more record blocks as defined below.
resource_group_name str
Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
ttl int
zone_name str
Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

Supporting Types

MxRecordRecord

Exchange string
The FQDN of the exchange to MX record points to.
Preference int
The preference of the MX record.
Exchange string
The FQDN of the exchange to MX record points to.
Preference int
The preference of the MX record.
exchange string
The FQDN of the exchange to MX record points to.
preference number
The preference of the MX record.
exchange str
The FQDN of the exchange to MX record points to.
preference int
The preference of the MX record.

Import

Private DNS MX Records can be imported using the resource id, e.g.

 $ pulumi import azure:privatedns/mxRecord:MxRecord example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/privateDnsZones/contoso.com/MX/@

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.