1. Packages
  2. Azure Classic
  3. API Docs
  4. dns
  5. getMxRecord

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

azure.dns.getMxRecord

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.dns.getMxRecord({
        name: "test",
        zoneName: "test-zone",
        resourceGroupName: "test-rg",
    });
    export const dnsMxRecordId = example.then(example => example.id);
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.dns.get_mx_record(name="test",
        zone_name="test-zone",
        resource_group_name="test-rg")
    pulumi.export("dnsMxRecordId", example.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/dns"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := dns.LookupMxRecord(ctx, &dns.LookupMxRecordArgs{
    			Name:              pulumi.StringRef("test"),
    			ZoneName:          "test-zone",
    			ResourceGroupName: "test-rg",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("dnsMxRecordId", example.Id)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Azure.Dns.GetMxRecord.Invoke(new()
        {
            Name = "test",
            ZoneName = "test-zone",
            ResourceGroupName = "test-rg",
        });
    
        return new Dictionary<string, object?>
        {
            ["dnsMxRecordId"] = example.Apply(getMxRecordResult => getMxRecordResult.Id),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.dns.DnsFunctions;
    import com.pulumi.azure.dns.inputs.GetMxRecordArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = DnsFunctions.getMxRecord(GetMxRecordArgs.builder()
                .name("test")
                .zoneName("test-zone")
                .resourceGroupName("test-rg")
                .build());
    
            ctx.export("dnsMxRecordId", example.applyValue(getMxRecordResult -> getMxRecordResult.id()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: azure:dns:getMxRecord
          Arguments:
            name: test
            zoneName: test-zone
            resourceGroupName: test-rg
    outputs:
      dnsMxRecordId: ${example.id}
    

    Using getMxRecord

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getMxRecord(args: GetMxRecordArgs, opts?: InvokeOptions): Promise<GetMxRecordResult>
    function getMxRecordOutput(args: GetMxRecordOutputArgs, opts?: InvokeOptions): Output<GetMxRecordResult>
    def get_mx_record(name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      zone_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetMxRecordResult
    def get_mx_record_output(name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      zone_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetMxRecordResult]
    func LookupMxRecord(ctx *Context, args *LookupMxRecordArgs, opts ...InvokeOption) (*LookupMxRecordResult, error)
    func LookupMxRecordOutput(ctx *Context, args *LookupMxRecordOutputArgs, opts ...InvokeOption) LookupMxRecordResultOutput

    > Note: This function is named LookupMxRecord in the Go SDK.

    public static class GetMxRecord 
    {
        public static Task<GetMxRecordResult> InvokeAsync(GetMxRecordArgs args, InvokeOptions? opts = null)
        public static Output<GetMxRecordResult> Invoke(GetMxRecordInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMxRecordResult> getMxRecord(GetMxRecordArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure:dns/getMxRecord:getMxRecord
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    Specifies the resource group where the DNS Zone (parent resource) exists.
    ZoneName string
    Specifies the DNS Zone where the resource exists.
    Name string
    The name of the DNS MX Record.
    ResourceGroupName string
    Specifies the resource group where the DNS Zone (parent resource) exists.
    ZoneName string
    Specifies the DNS Zone where the resource exists.
    Name string
    The name of the DNS MX Record.
    resourceGroupName String
    Specifies the resource group where the DNS Zone (parent resource) exists.
    zoneName String
    Specifies the DNS Zone where the resource exists.
    name String
    The name of the DNS MX Record.
    resourceGroupName string
    Specifies the resource group where the DNS Zone (parent resource) exists.
    zoneName string
    Specifies the DNS Zone where the resource exists.
    name string
    The name of the DNS MX Record.
    resource_group_name str
    Specifies the resource group where the DNS Zone (parent resource) exists.
    zone_name str
    Specifies the DNS Zone where the resource exists.
    name str
    The name of the DNS MX Record.
    resourceGroupName String
    Specifies the resource group where the DNS Zone (parent resource) exists.
    zoneName String
    Specifies the DNS Zone where the resource exists.
    name String
    The name of the DNS MX Record.

    getMxRecord Result

    The following output properties are available:

    Fqdn string
    The FQDN of the DNS MX Record.
    Id string
    The provider-assigned unique ID for this managed resource.
    Records List<GetMxRecordRecord>
    A list of values that make up the MX record. Each record block supports fields documented below.
    ResourceGroupName string
    Tags Dictionary<string, string>
    A mapping of tags assigned to the resource.
    Ttl int
    The Time To Live (TTL) of the DNS record in seconds.
    ZoneName string
    Name string
    Fqdn string
    The FQDN of the DNS MX Record.
    Id string
    The provider-assigned unique ID for this managed resource.
    Records []GetMxRecordRecord
    A list of values that make up the MX record. Each record block supports fields documented below.
    ResourceGroupName string
    Tags map[string]string
    A mapping of tags assigned to the resource.
    Ttl int
    The Time To Live (TTL) of the DNS record in seconds.
    ZoneName string
    Name string
    fqdn String
    The FQDN of the DNS MX Record.
    id String
    The provider-assigned unique ID for this managed resource.
    records List<GetMxRecordRecord>
    A list of values that make up the MX record. Each record block supports fields documented below.
    resourceGroupName String
    tags Map<String,String>
    A mapping of tags assigned to the resource.
    ttl Integer
    The Time To Live (TTL) of the DNS record in seconds.
    zoneName String
    name String
    fqdn string
    The FQDN of the DNS MX Record.
    id string
    The provider-assigned unique ID for this managed resource.
    records GetMxRecordRecord[]
    A list of values that make up the MX record. Each record block supports fields documented below.
    resourceGroupName string
    tags {[key: string]: string}
    A mapping of tags assigned to the resource.
    ttl number
    The Time To Live (TTL) of the DNS record in seconds.
    zoneName string
    name string
    fqdn str
    The FQDN of the DNS MX Record.
    id str
    The provider-assigned unique ID for this managed resource.
    records Sequence[GetMxRecordRecord]
    A list of values that make up the MX record. Each record block supports fields documented below.
    resource_group_name str
    tags Mapping[str, str]
    A mapping of tags assigned to the resource.
    ttl int
    The Time To Live (TTL) of the DNS record in seconds.
    zone_name str
    name str
    fqdn String
    The FQDN of the DNS MX Record.
    id String
    The provider-assigned unique ID for this managed resource.
    records List<Property Map>
    A list of values that make up the MX record. Each record block supports fields documented below.
    resourceGroupName String
    tags Map<String>
    A mapping of tags assigned to the resource.
    ttl Number
    The Time To Live (TTL) of the DNS record in seconds.
    zoneName String
    name String

    Supporting Types

    GetMxRecordRecord

    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 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.
    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.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi