MxRecord

Enables you to manage DNS MX Records within Azure DNS.

Create a MxRecord Resource

new MxRecord(name: string, args: MxRecordArgs, opts?: CustomResourceOptions);

def MxRecord(resource_name, opts=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None, __props__=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.
opts ResourceOptions: A bag of options that control this 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>: A list of values that make up the MX record. Each record block supports fields documented below.
ResourceGroupName string: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
Ttl int: The Time To Live (TTL) of the DNS record in seconds.
ZoneName string: Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
Name string: The name of the DNS MX Record. Defaults to @ (root). Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

Records []MxRecordRecord: A list of values that make up the MX record. Each record block supports fields documented below.
ResourceGroupName string: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
Ttl int: The Time To Live (TTL) of the DNS record in seconds.
ZoneName string: Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
Name string: The name of the DNS MX Record. Defaults to @ (root). Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.

records MxRecordRecord[]: A list of values that make up the MX record. Each record block supports fields documented below.
resourceGroupName string: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
ttl number: The Time To Live (TTL) of the DNS record in seconds.
zoneName string: Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
name string: The name of the DNS MX Record. Defaults to @ (root). Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

records List[MxRecordRecord]: A list of values that make up the MX record. Each record block supports fields documented below.
resource_group_name str: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
ttl float: The Time To Live (TTL) of the DNS record in seconds.
zone_name str: Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
name str: The name of the DNS MX Record. Defaults to @ (root). Changing this forces a new resource to be created.
tags Dict[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

static get(resource_name, id, opts=None, fqdn=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None, __props__=None);

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. Defaults to @ (root). Changing this forces a new resource to be created.
Records List<MxRecordRecordArgs>: A list of values that make up the MX record. Each record block supports fields documented 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: The Time To Live (TTL) of the DNS record in seconds.
ZoneName string: Specifies the DNS Zone where the DNS Zone (parent 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. Defaults to @ (root). Changing this forces a new resource to be created.
Records []MxRecordRecord: A list of values that make up the MX record. Each record block supports fields documented 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: The Time To Live (TTL) of the DNS record in seconds.
ZoneName string: Specifies the DNS Zone where the DNS Zone (parent 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. Defaults to @ (root). Changing this forces a new resource to be created.
records MxRecordRecord[]: A list of values that make up the MX record. Each record block supports fields documented 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: The Time To Live (TTL) of the DNS record in seconds.
zoneName string: Specifies the DNS Zone where the DNS Zone (parent 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. Defaults to @ (root). Changing this forces a new resource to be created.
records List[MxRecordRecord]: A list of values that make up the MX record. Each record block supports fields documented below.
resource_group_name str: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.
ttl float: The Time To Live (TTL) of the DNS record in seconds.
zone_name str: Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

Supporting Types

MxRecordRecord

See the input and output API doc for this type.

Exchange string: The mail server responsible for the domain covered by the MX record.
Preference string: String representing the “preference” value of the MX records. Records with lower preference value take priority.

Exchange string: The mail server responsible for the domain covered by the MX record.
Preference string: String representing the “preference” value of the MX records. Records with lower preference value take priority.

exchange string: The mail server responsible for the domain covered by the MX record.
preference string: String representing the “preference” value of the MX records. Records with lower preference value take priority.

exchange str: The mail server responsible for the domain covered by the MX record.
preference str: String representing the “preference” value of the MX records. Records with lower preference value take priority.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud