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

We recommend using Azure Native.

Azure Classic v6.8.0 published on Monday, Nov 4, 2024 by Pulumi

azure.dns.getTxtRecord

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.8.0 published on Monday, Nov 4, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.dns.getTxtRecord({
        name: "test",
        zoneName: "test-zone",
        resourceGroupName: "test-rg",
    });
    export const dnsTxtRecordId = example.then(example => example.id);
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.dns.get_txt_record(name="test",
        zone_name="test-zone",
        resource_group_name="test-rg")
    pulumi.export("dnsTxtRecordId", example.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/dns"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := dns.LookupTxtRecord(ctx, &dns.LookupTxtRecordArgs{
    			Name:              "test",
    			ZoneName:          "test-zone",
    			ResourceGroupName: "test-rg",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("dnsTxtRecordId", 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.GetTxtRecord.Invoke(new()
        {
            Name = "test",
            ZoneName = "test-zone",
            ResourceGroupName = "test-rg",
        });
    
        return new Dictionary<string, object?>
        {
            ["dnsTxtRecordId"] = example.Apply(getTxtRecordResult => getTxtRecordResult.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.GetTxtRecordArgs;
    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.getTxtRecord(GetTxtRecordArgs.builder()
                .name("test")
                .zoneName("test-zone")
                .resourceGroupName("test-rg")
                .build());
    
            ctx.export("dnsTxtRecordId", example.applyValue(getTxtRecordResult -> getTxtRecordResult.id()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: azure:dns:getTxtRecord
          Arguments:
            name: test
            zoneName: test-zone
            resourceGroupName: test-rg
    outputs:
      dnsTxtRecordId: ${example.id}
    

    Using getTxtRecord

    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 getTxtRecord(args: GetTxtRecordArgs, opts?: InvokeOptions): Promise<GetTxtRecordResult>
    function getTxtRecordOutput(args: GetTxtRecordOutputArgs, opts?: InvokeOptions): Output<GetTxtRecordResult>
    def get_txt_record(name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       zone_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetTxtRecordResult
    def get_txt_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[GetTxtRecordResult]
    func LookupTxtRecord(ctx *Context, args *LookupTxtRecordArgs, opts ...InvokeOption) (*LookupTxtRecordResult, error)
    func LookupTxtRecordOutput(ctx *Context, args *LookupTxtRecordOutputArgs, opts ...InvokeOption) LookupTxtRecordResultOutput

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

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

    The following arguments are supported:

    Name string
    The name of the DNS TXT 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 TXT 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 TXT 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 TXT 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 str
    The name of the DNS TXT 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 String
    The name of the DNS TXT Record.
    resourceGroupName String
    Specifies the resource group where the DNS Zone (parent resource) exists.
    zoneName String
    Specifies the DNS Zone where the resource exists.

    getTxtRecord Result

    The following output properties are available:

    Fqdn string
    The FQDN of the DNS TXT Record.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Records List<GetTxtRecordRecord>
    A list of values that make up the txt 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
    Fqdn string
    The FQDN of the DNS TXT Record.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Records []GetTxtRecordRecord
    A list of values that make up the txt 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
    fqdn String
    The FQDN of the DNS TXT Record.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    records List<GetTxtRecordRecord>
    A list of values that make up the txt 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
    fqdn string
    The FQDN of the DNS TXT Record.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    records GetTxtRecordRecord[]
    A list of values that make up the txt 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
    fqdn str
    The FQDN of the DNS TXT Record.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    records Sequence[GetTxtRecordRecord]
    A list of values that make up the txt 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
    fqdn String
    The FQDN of the DNS TXT Record.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    records List<Property Map>
    A list of values that make up the txt 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

    Supporting Types

    GetTxtRecordRecord

    Value string
    The value of the record. Max length: 1024 characters
    Value string
    The value of the record. Max length: 1024 characters
    value String
    The value of the record. Max length: 1024 characters
    value string
    The value of the record. Max length: 1024 characters
    value str
    The value of the record. Max length: 1024 characters
    value String
    The value of the record. Max length: 1024 characters

    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 v6.8.0 published on Monday, Nov 4, 2024 by Pulumi