TxtRecord

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

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Azure.Core.ResourceGroup("example", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var testZone = new Azure.PrivateDns.Zone("testZone", new Azure.PrivateDns.ZoneArgs
        {
            ResourceGroupName = azurerm_resource_group.Test.Name,
        });
        var testTxtRecord = new Azure.PrivateDns.TxtRecord("testTxtRecord", new Azure.PrivateDns.TxtRecordArgs
        {
            ResourceGroupName = azurerm_resource_group.Test.Name,
            ZoneName = testZone.Name,
            Ttl = 300,
            Records = 
            {
                new Azure.PrivateDns.Inputs.TxtRecordRecordArgs
                {
                    Value = "v=spf1 mx ~all",
                },
            },
        });
    }

}

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 {
		_, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		testZone, err := privatedns.NewZone(ctx, "testZone", &privatedns.ZoneArgs{
			ResourceGroupName: pulumi.Any(azurerm_resource_group.Test.Name),
		})
		if err != nil {
			return err
		}
		_, err = privatedns.NewTxtRecord(ctx, "testTxtRecord", &privatedns.TxtRecordArgs{
			ResourceGroupName: pulumi.Any(azurerm_resource_group.Test.Name),
			ZoneName:          testZone.Name,
			Ttl:               pulumi.Int(300),
			Records: privatedns.TxtRecordRecordArray{
				&privatedns.TxtRecordRecordArgs{
					Value: pulumi.String("v=spf1 mx ~all"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example", location="West Europe")
test_zone = azure.privatedns.Zone("testZone", resource_group_name=azurerm_resource_group["test"]["name"])
test_txt_record = azure.privatedns.TxtRecord("testTxtRecord",
    resource_group_name=azurerm_resource_group["test"]["name"],
    zone_name=test_zone.name,
    ttl=300,
    records=[azure.privatedns.TxtRecordRecordArgs(
        value="v=spf1 mx ~all",
    )])

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {location: "West Europe"});
const testZone = new azure.privatedns.Zone("testZone", {resourceGroupName: azurerm_resource_group.test.name});
const testTxtRecord = new azure.privatedns.TxtRecord("testTxtRecord", {
    resourceGroupName: azurerm_resource_group.test.name,
    zoneName: testZone.name,
    ttl: 300,
    records: [{
        value: "v=spf1 mx ~all",
    }],
});

Create a TxtRecord Resource

new TxtRecord(name: string, args: TxtRecordArgs, opts?: CustomResourceOptions);

@overload
def TxtRecord(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              name: Optional[str] = None,
              records: Optional[Sequence[TxtRecordRecordArgs]] = None,
              resource_group_name: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              ttl: Optional[int] = None,
              zone_name: Optional[str] = None)
@overload
def TxtRecord(resource_name: str,
              args: TxtRecordArgs,
              opts: Optional[ResourceOptions] = None)

func NewTxtRecord(ctx *Context, name string, args TxtRecordArgs, opts ...ResourceOption) (*TxtRecord, error)

public TxtRecord(string name, TxtRecordArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args TxtRecordArgs: 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 TxtRecordArgs: 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 TxtRecordArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TxtRecordArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

TxtRecord Resource Properties

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

Inputs

The TxtRecord resource accepts the following input properties:

Records List<TxtRecordRecordArgs>: 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 TXT Record. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

Records []TxtRecordRecord: 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 TXT Record. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.

records TxtRecordRecordArgs[]: 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 TXT Record. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

records Sequence[TxtRecordRecordArgs]: 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 TXT Record. Changing this forces a new resource to be created.
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 TxtRecord resource produces the following output properties:

Fqdn string: The FQDN of the DNS TXT Record.
Id string: The provider-assigned unique ID for this managed resource.

Fqdn string: The FQDN of the DNS TXT Record.
Id string: The provider-assigned unique ID for this managed resource.

fqdn string: The FQDN of the DNS TXT Record.
id string: The provider-assigned unique ID for this managed resource.

fqdn str: The FQDN of the DNS TXT Record.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing TxtRecord Resource

Get an existing TxtRecord 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?: TxtRecordState, opts?: CustomResourceOptions): TxtRecord

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        fqdn: Optional[str] = None,
        name: Optional[str] = None,
        records: Optional[Sequence[TxtRecordRecordArgs]] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        ttl: Optional[int] = None,
        zone_name: Optional[str] = None) -> TxtRecord

func GetTxtRecord(ctx *Context, name string, id IDInput, state *TxtRecordState, opts ...ResourceOption) (*TxtRecord, error)

public static TxtRecord Get(string name, Input<string> id, TxtRecordState? 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 TXT Record.
Name string: The name of the DNS TXT Record. Changing this forces a new resource to be created.
Records List<TxtRecordRecordArgs>: 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 TXT Record.
Name string: The name of the DNS TXT Record. Changing this forces a new resource to be created.
Records []TxtRecordRecord: 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 TXT Record.
name string: The name of the DNS TXT Record. Changing this forces a new resource to be created.
records TxtRecordRecordArgs[]: 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 TXT Record.
name str: The name of the DNS TXT Record. Changing this forces a new resource to be created.
records Sequence[TxtRecordRecordArgs]: 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

TxtRecordRecord

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

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

value string: The value of the TXT record. Max length: 1024 characters

value str: The value of the TXT record. Max length: 1024 characters

Import

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

 $ pulumi import azure:privatedns/txtRecord:TxtRecord test /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/privateDnsZones/contoso.com/TXT/test

Package Details

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