Module dns

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

AaaaRecord
ARecord
CaaRecord
CNameRecord
MxRecord
NsRecord
PtrRecord
SrvRecord
TxtRecord
Zone

Functions

getZone

Others

Resources

Resource AaaaRecord

class AaaaRecord extends CustomResource

Enables you to manage DNS AAAA Records within Azure DNS.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleZone = new azure.dns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const exampleAaaaRecord = new azure.dns.AaaaRecord("exampleAaaaRecord", {
    zoneName: exampleZone.name,
    resourceGroupName: exampleResourceGroup.name,
    ttl: 300,
});

Alias Record)

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleZone = new azure.dns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Dynamic",
    ipVersion: "IPv6",
});
const exampleAaaaRecord = new azure.dns.AaaaRecord("exampleAaaaRecord", {
    zoneName: exampleZone.name,
    resourceGroupName: exampleResourceGroup.name,
    ttl: 300,
    targetResourceId: examplePublicIp.id,
});

constructor

new AaaaRecord(name: string, args: AaaaRecordArgs, opts?: pulumi.CustomResourceOptions)

Create a AaaaRecord resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AaaaRecordState, opts?: pulumi.CustomResourceOptions): AaaaRecord

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AaaaRecord

Returns true if the given object is an instance of AaaaRecord. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the DNS AAAA Record.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the DNS AAAA Record.

property records

public records: pulumi.Output<string[] | undefined>;

List of IPv4 Addresses. Conflicts with targetResourceId.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property targetResourceId

public targetResourceId: pulumi.Output<string | undefined>;

The Azure resource id of the target object. Conflicts with records

property ttl

public ttl: pulumi.Output<number>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zoneName

public zoneName: pulumi.Output<string>;

Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

Resource ARecord

class ARecord extends CustomResource

Enables you to manage DNS A Records within Azure DNS.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleZone = new azure.dns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const exampleARecord = new azure.dns.ARecord("exampleARecord", {
    zoneName: exampleZone.name,
    resourceGroupName: exampleResourceGroup.name,
    ttl: 300,
    records: ["10.0.180.17"],
});

Alias Record)

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleZone = new azure.dns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Dynamic",
    ipVersion: "IPv4",
});
const exampleARecord = new azure.dns.ARecord("exampleARecord", {
    zoneName: exampleZone.name,
    resourceGroupName: exampleResourceGroup.name,
    ttl: 300,
    targetResourceId: examplePublicIp.id,
});

constructor

new ARecord(name: string, args: ARecordArgs, opts?: pulumi.CustomResourceOptions)

Create a ARecord resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ARecordState, opts?: pulumi.CustomResourceOptions): ARecord

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ARecord

Returns true if the given object is an instance of ARecord. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the DNS A Record.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the DNS A Record.

property records

public records: pulumi.Output<string[] | undefined>;

List of IPv4 Addresses. Conflicts with targetResourceId.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property targetResourceId

public targetResourceId: pulumi.Output<string | undefined>;

The Azure resource id of the target object. Conflicts with records

property ttl

public ttl: pulumi.Output<number>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zoneName

public zoneName: pulumi.Output<string>;

Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

Resource CaaRecord

class CaaRecord extends CustomResource

Enables you to manage DNS CAA Records within Azure DNS.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleZone = new azure.dns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const exampleCaaRecord = new azure.dns.CaaRecord("exampleCaaRecord", {
    zoneName: exampleZone.name,
    resourceGroupName: exampleResourceGroup.name,
    ttl: 300,
    record: [
        {
            flags: 0,
            tag: "issue",
            value: "example.com",
        },
        {
            flags: 0,
            tag: "issue",
            value: "example.net",
        },
        {
            flags: 0,
            tag: "issuewild",
            value: ";",
        },
        {
            flags: 0,
            tag: "iodef",
            value: "mailto:user@nonexisting.tld",
        },
    ],
    tags: {
        Environment: "Production",
    },
});

constructor

new CaaRecord(name: string, args: CaaRecordArgs, opts?: pulumi.CustomResourceOptions)

Create a CaaRecord resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CaaRecordState, opts?: pulumi.CustomResourceOptions): CaaRecord

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is CaaRecord

Returns true if the given object is an instance of CaaRecord. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the DNS CAA Record.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the DNS CAA Record. If you are creating the record in the apex of the zone use "@" as the name.

property records

public records: pulumi.Output<CaaRecordRecord[]>;

A list of values that make up the CAA record. Each record block supports fields documented below.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property ttl

public ttl: pulumi.Output<number>;

The Time To Live (TTL) of the DNS record in seconds.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zoneName

public zoneName: pulumi.Output<string>;

Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

Resource CNameRecord

class CNameRecord extends CustomResource

Enables you to manage DNS CNAME Records within Azure DNS.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleZone = new azure.dns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const exampleCNameRecord = new azure.dns.CNameRecord("exampleCNameRecord", {
    zoneName: exampleZone.name,
    resourceGroupName: exampleResourceGroup.name,
    ttl: 300,
    record: "contoso.com",
});

Alias Record)

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleZone = new azure.dns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const target = new azure.dns.CNameRecord("target", {
    zoneName: exampleZone.name,
    resourceGroupName: exampleResourceGroup.name,
    ttl: 300,
    record: "contoso.com",
});
const exampleCNameRecord = new azure.dns.CNameRecord("exampleCNameRecord", {
    zoneName: exampleZone.name,
    resourceGroupName: exampleResourceGroup.name,
    ttl: 300,
    targetResourceId: target.id,
});

constructor

new CNameRecord(name: string, args: CNameRecordArgs, opts?: pulumi.CustomResourceOptions)

Create a CNameRecord resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CNameRecordState, opts?: pulumi.CustomResourceOptions): CNameRecord

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is CNameRecord

Returns true if the given object is an instance of CNameRecord. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the DNS CName Record.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the DNS CNAME Record.

property record

public record: pulumi.Output<string | undefined>;

The target of the CNAME.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property targetResourceId

public targetResourceId: pulumi.Output<string | undefined>;

The Azure resource id of the target object. Conflicts with records

property ttl

public ttl: pulumi.Output<number>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zoneName

public zoneName: pulumi.Output<string>;

Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

Resource MxRecord

class MxRecord extends CustomResource

Enables you to manage DNS MX Records within Azure DNS.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleZone = new azure.dns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const exampleMxRecord = new azure.dns.MxRecord("exampleMxRecord", {
    zoneName: exampleZone.name,
    resourceGroupName: exampleResourceGroup.name,
    ttl: 300,
    record: [
        {
            preference: 10,
            exchange: "mail1.contoso.com",
        },
        {
            preference: 20,
            exchange: "mail2.contoso.com",
        },
    ],
    tags: {
        Environment: "Production",
    },
});

constructor

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

Create a MxRecord resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MxRecordState, opts?: pulumi.CustomResourceOptions): MxRecord

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is MxRecord

Returns true if the given object is an instance of MxRecord. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the DNS MX Record.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the DNS MX Record. Defaults to @ (root). Changing this forces a new resource to be created.

property records

public records: pulumi.Output<MxRecordRecord[]>;

A list of values that make up the MX record. Each record block supports fields documented below.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property ttl

public ttl: pulumi.Output<number>;

The Time To Live (TTL) of the DNS record in seconds.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zoneName

public zoneName: pulumi.Output<string>;

Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

Resource NsRecord

class NsRecord extends CustomResource

Enables you to manage DNS NS Records within Azure DNS.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleZone = new azure.dns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const exampleNsRecord = new azure.dns.NsRecord("exampleNsRecord", {
    zoneName: exampleZone.name,
    resourceGroupName: exampleResourceGroup.name,
    ttl: 300,
    records: [
        "ns1.contoso.com",
        "ns2.contoso.com",
    ],
    tags: {
        Environment: "Production",
    },
});

constructor

new NsRecord(name: string, args: NsRecordArgs, opts?: pulumi.CustomResourceOptions)

Create a NsRecord resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NsRecordState, opts?: pulumi.CustomResourceOptions): NsRecord

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NsRecord

Returns true if the given object is an instance of NsRecord. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the DNS NS Record.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the DNS NS Record.

property records

public records: pulumi.Output<string[]>;

A list of values that make up the NS record.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property ttl

public ttl: pulumi.Output<number>;

The Time To Live (TTL) of the DNS record in seconds.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zoneName

public zoneName: pulumi.Output<string>;

Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

Resource PtrRecord

class PtrRecord extends CustomResource

Enables you to manage DNS PTR Records within Azure DNS.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleZone = new azure.dns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const examplePtrRecord = new azure.dns.PtrRecord("examplePtrRecord", {
    zoneName: exampleZone.name,
    resourceGroupName: exampleResourceGroup.name,
    ttl: 300,
    records: ["yourdomain.com"],
});

constructor

new PtrRecord(name: string, args: PtrRecordArgs, opts?: pulumi.CustomResourceOptions)

Create a PtrRecord resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PtrRecordState, opts?: pulumi.CustomResourceOptions): PtrRecord

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is PtrRecord

Returns true if the given object is an instance of PtrRecord. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the DNS PTR Record.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the DNS PTR Record.

property records

public records: pulumi.Output<string[]>;

List of Fully Qualified Domain Names.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property ttl

public ttl: pulumi.Output<number>;

The Time To Live (TTL) of the DNS record in seconds.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zoneName

public zoneName: pulumi.Output<string>;

Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

Resource SrvRecord

class SrvRecord extends CustomResource

Enables you to manage DNS SRV Records within Azure DNS.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleZone = new azure.dns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const exampleSrvRecord = new azure.dns.SrvRecord("exampleSrvRecord", {
    zoneName: exampleZone.name,
    resourceGroupName: exampleResourceGroup.name,
    ttl: 300,
    record: [{
        priority: 1,
        weight: 5,
        port: 8080,
        target: "target1.contoso.com",
    }],
    tags: {
        Environment: "Production",
    },
});

constructor

new SrvRecord(name: string, args: SrvRecordArgs, opts?: pulumi.CustomResourceOptions)

Create a SrvRecord resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SrvRecordState, opts?: pulumi.CustomResourceOptions): SrvRecord

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SrvRecord

Returns true if the given object is an instance of SrvRecord. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the DNS SRV Record.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the DNS SRV Record.

property records

public records: pulumi.Output<SrvRecordRecord[]>;

A list of values that make up the SRV record. Each record block supports fields documented below.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property ttl

public ttl: pulumi.Output<number>;

The Time To Live (TTL) of the DNS record in seconds.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zoneName

public zoneName: pulumi.Output<string>;

Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

Resource TxtRecord

class TxtRecord extends CustomResource

Enables you to manage DNS TXT Records within Azure DNS.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleZone = new azure.dns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const exampleTxtRecord = new azure.dns.TxtRecord("exampleTxtRecord", {
    zoneName: exampleZone.name,
    resourceGroupName: exampleResourceGroup.name,
    ttl: 300,
    record: [
        {
            value: "google-site-authenticator",
        },
        {
            value: "more site information here",
        },
    ],
    tags: {
        Environment: "Production",
    },
});

constructor

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

Create a TxtRecord resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TxtRecordState, opts?: pulumi.CustomResourceOptions): TxtRecord

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is TxtRecord

Returns true if the given object is an instance of TxtRecord. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the DNS TXT Record.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the DNS TXT Record.

property records

public records: pulumi.Output<TxtRecordRecord[]>;

A list of values that make up the txt record. Each record block supports fields documented below.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property ttl

public ttl: pulumi.Output<number>;

The Time To Live (TTL) of the DNS record in seconds.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zoneName

public zoneName: pulumi.Output<string>;

Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

Resource Zone

class Zone extends CustomResource

Enables you to manage DNS zones within Azure DNS. These zones are hosted on Azure’s name servers to which you can delegate the zone from the parent domain.

Example Usage

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

const example = new azure.core.ResourceGroup("example", {location: "West US"});
const example_public = new azure.dns.Zone("example-public", {resourceGroupName: example.name});
const example_private = new azure.privatedns.Zone("example-private", {resourceGroupName: example.name});

constructor

new Zone(name: string, args: ZoneArgs, opts?: pulumi.CustomResourceOptions)

Create a Zone resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ZoneState, opts?: pulumi.CustomResourceOptions): Zone

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Zone

Returns true if the given object is an instance of Zone. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property maxNumberOfRecordSets

public maxNumberOfRecordSets: pulumi.Output<number>;

(Optional) Maximum number of Records in the zone. Defaults to 1000.

property name

public name: pulumi.Output<string>;

The name of the DNS Zone. Must be a valid domain name.

property nameServers

public nameServers: pulumi.Output<string[]>;

(Optional) A list of values that make up the NS record for the zone.

property numberOfRecordSets

public numberOfRecordSets: pulumi.Output<number>;

(Optional) The number of records already in the zone.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getZone

getZone(args: GetZoneArgs, opts?: pulumi.InvokeOptions): Promise<GetZoneResult>

Use this data source to access information about an existing DNS Zone.

Example Usage

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

const example = azure.dns.getZone({
    name: "search-eventhubns",
    resourceGroupName: "search-service",
});
export const dnsZoneId = example.then(example => example.id);

Others

interface AaaaRecordArgs

interface AaaaRecordArgs

The set of arguments for constructing a AaaaRecord resource.

property name

name?: pulumi.Input<string>;

The name of the DNS AAAA Record.

property records

records?: pulumi.Input<pulumi.Input<string>[]>;

List of IPv4 Addresses. Conflicts with targetResourceId.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property targetResourceId

targetResourceId?: pulumi.Input<string>;

The Azure resource id of the target object. Conflicts with records

property ttl

ttl: pulumi.Input<number>;

property zoneName

zoneName: pulumi.Input<string>;

Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

interface AaaaRecordState

interface AaaaRecordState

Input properties used for looking up and filtering AaaaRecord resources.

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the DNS AAAA Record.

property name

name?: pulumi.Input<string>;

The name of the DNS AAAA Record.

property records

records?: pulumi.Input<pulumi.Input<string>[]>;

List of IPv4 Addresses. Conflicts with targetResourceId.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property targetResourceId

targetResourceId?: pulumi.Input<string>;

The Azure resource id of the target object. Conflicts with records

property ttl

ttl?: pulumi.Input<number>;

property zoneName

zoneName?: pulumi.Input<string>;

Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

interface ARecordArgs

interface ARecordArgs

The set of arguments for constructing a ARecord resource.

property name

name?: pulumi.Input<string>;

The name of the DNS A Record.

property records

records?: pulumi.Input<pulumi.Input<string>[]>;

List of IPv4 Addresses. Conflicts with targetResourceId.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property targetResourceId

targetResourceId?: pulumi.Input<string>;

The Azure resource id of the target object. Conflicts with records

property ttl

ttl: pulumi.Input<number>;

property zoneName

zoneName: pulumi.Input<string>;

Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

interface ARecordState

interface ARecordState

Input properties used for looking up and filtering ARecord resources.

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the DNS A Record.

property name

name?: pulumi.Input<string>;

The name of the DNS A Record.

property records

records?: pulumi.Input<pulumi.Input<string>[]>;

List of IPv4 Addresses. Conflicts with targetResourceId.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property targetResourceId

targetResourceId?: pulumi.Input<string>;

The Azure resource id of the target object. Conflicts with records

property ttl

ttl?: pulumi.Input<number>;

property zoneName

zoneName?: pulumi.Input<string>;

Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

interface CaaRecordArgs

interface CaaRecordArgs

The set of arguments for constructing a CaaRecord resource.

property name

name?: pulumi.Input<string>;

The name of the DNS CAA Record. If you are creating the record in the apex of the zone use "@" as the name.

property records

records: pulumi.Input<pulumi.Input<CaaRecordRecord>[]>;

A list of values that make up the CAA record. Each record block supports fields documented below.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property ttl

ttl: pulumi.Input<number>;

The Time To Live (TTL) of the DNS record in seconds.

property zoneName

zoneName: pulumi.Input<string>;

Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

interface CaaRecordState

interface CaaRecordState

Input properties used for looking up and filtering CaaRecord resources.

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the DNS CAA Record.

property name

name?: pulumi.Input<string>;

The name of the DNS CAA Record. If you are creating the record in the apex of the zone use "@" as the name.

property records

records?: pulumi.Input<pulumi.Input<CaaRecordRecord>[]>;

A list of values that make up the CAA record. Each record block supports fields documented below.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property ttl

ttl?: pulumi.Input<number>;

The Time To Live (TTL) of the DNS record in seconds.

property zoneName

zoneName?: pulumi.Input<string>;

Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

interface CNameRecordArgs

interface CNameRecordArgs

The set of arguments for constructing a CNameRecord resource.

property name

name?: pulumi.Input<string>;

The name of the DNS CNAME Record.

property record

record?: pulumi.Input<string>;

The target of the CNAME.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property targetResourceId

targetResourceId?: pulumi.Input<string>;

The Azure resource id of the target object. Conflicts with records

property ttl

ttl: pulumi.Input<number>;

property zoneName

zoneName: pulumi.Input<string>;

Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

interface CNameRecordState

interface CNameRecordState

Input properties used for looking up and filtering CNameRecord resources.

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the DNS CName Record.

property name

name?: pulumi.Input<string>;

The name of the DNS CNAME Record.

property record

record?: pulumi.Input<string>;

The target of the CNAME.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property targetResourceId

targetResourceId?: pulumi.Input<string>;

The Azure resource id of the target object. Conflicts with records

property ttl

ttl?: pulumi.Input<number>;

property zoneName

zoneName?: pulumi.Input<string>;

Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

interface GetZoneArgs

interface GetZoneArgs

A collection of arguments for invoking getZone.

property name

name: string;

The name of the DNS Zone.

property resourceGroupName

resourceGroupName?: undefined | string;

The Name of the Resource Group where the DNS Zone exists. If the Name of the Resource Group is not provided, the first DNS Zone from the list of DNS Zones in your subscription that matches name will be returned.

interface GetZoneResult

interface GetZoneResult

A collection of values returned by getZone.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property maxNumberOfRecordSets

maxNumberOfRecordSets: number;

Maximum number of Records in the zone.

property name

name: string;

property nameServers

nameServers: string[];

A list of values that make up the NS record for the zone.

property numberOfRecordSets

numberOfRecordSets: number;

The number of records already in the zone.

property resourceGroupName

resourceGroupName: string;

property tags

tags: {[key: string]: string};

A mapping of tags to assign to the EventHub Namespace.

interface MxRecordArgs

interface MxRecordArgs

The set of arguments for constructing a MxRecord resource.

property name

name?: pulumi.Input<string>;

The name of the DNS MX Record. Defaults to @ (root). Changing this forces a new resource to be created.

property records

records: pulumi.Input<pulumi.Input<MxRecordRecord>[]>;

A list of values that make up the MX record. Each record block supports fields documented below.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property ttl

ttl: pulumi.Input<number>;

The Time To Live (TTL) of the DNS record in seconds.

property zoneName

zoneName: pulumi.Input<string>;

Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

interface MxRecordState

interface MxRecordState

Input properties used for looking up and filtering MxRecord resources.

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the DNS MX Record.

property name

name?: pulumi.Input<string>;

The name of the DNS MX Record. Defaults to @ (root). Changing this forces a new resource to be created.

property records

records?: pulumi.Input<pulumi.Input<MxRecordRecord>[]>;

A list of values that make up the MX record. Each record block supports fields documented below.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property ttl

ttl?: pulumi.Input<number>;

The Time To Live (TTL) of the DNS record in seconds.

property zoneName

zoneName?: pulumi.Input<string>;

Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

interface NsRecordArgs

interface NsRecordArgs

The set of arguments for constructing a NsRecord resource.

property name

name?: pulumi.Input<string>;

The name of the DNS NS Record.

property records

records: pulumi.Input<pulumi.Input<string>[]>;

A list of values that make up the NS record.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property ttl

ttl: pulumi.Input<number>;

The Time To Live (TTL) of the DNS record in seconds.

property zoneName

zoneName: pulumi.Input<string>;

Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

interface NsRecordState

interface NsRecordState

Input properties used for looking up and filtering NsRecord resources.

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the DNS NS Record.

property name

name?: pulumi.Input<string>;

The name of the DNS NS Record.

property records

records?: pulumi.Input<pulumi.Input<string>[]>;

A list of values that make up the NS record.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property ttl

ttl?: pulumi.Input<number>;

The Time To Live (TTL) of the DNS record in seconds.

property zoneName

zoneName?: pulumi.Input<string>;

Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

interface PtrRecordArgs

interface PtrRecordArgs

The set of arguments for constructing a PtrRecord resource.

property name

name?: pulumi.Input<string>;

The name of the DNS PTR Record.

property records

records: pulumi.Input<pulumi.Input<string>[]>;

List of Fully Qualified Domain Names.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property ttl

ttl: pulumi.Input<number>;

The Time To Live (TTL) of the DNS record in seconds.

property zoneName

zoneName: pulumi.Input<string>;

Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

interface PtrRecordState

interface PtrRecordState

Input properties used for looking up and filtering PtrRecord resources.

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the DNS PTR Record.

property name

name?: pulumi.Input<string>;

The name of the DNS PTR Record.

property records

records?: pulumi.Input<pulumi.Input<string>[]>;

List of Fully Qualified Domain Names.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property ttl

ttl?: pulumi.Input<number>;

The Time To Live (TTL) of the DNS record in seconds.

property zoneName

zoneName?: pulumi.Input<string>;

Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

interface SrvRecordArgs

interface SrvRecordArgs

The set of arguments for constructing a SrvRecord resource.

property name

name?: pulumi.Input<string>;

The name of the DNS SRV Record.

property records

records: pulumi.Input<pulumi.Input<SrvRecordRecord>[]>;

A list of values that make up the SRV record. Each record block supports fields documented below.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property ttl

ttl: pulumi.Input<number>;

The Time To Live (TTL) of the DNS record in seconds.

property zoneName

zoneName: pulumi.Input<string>;

Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

interface SrvRecordState

interface SrvRecordState

Input properties used for looking up and filtering SrvRecord resources.

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the DNS SRV Record.

property name

name?: pulumi.Input<string>;

The name of the DNS SRV Record.

property records

records?: pulumi.Input<pulumi.Input<SrvRecordRecord>[]>;

A list of values that make up the SRV record. Each record block supports fields documented below.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property ttl

ttl?: pulumi.Input<number>;

The Time To Live (TTL) of the DNS record in seconds.

property zoneName

zoneName?: pulumi.Input<string>;

Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

interface TxtRecordArgs

interface TxtRecordArgs

The set of arguments for constructing a TxtRecord resource.

property name

name?: pulumi.Input<string>;

The name of the DNS TXT Record.

property records

records: pulumi.Input<pulumi.Input<TxtRecordRecord>[]>;

A list of values that make up the txt record. Each record block supports fields documented below.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property ttl

ttl: pulumi.Input<number>;

The Time To Live (TTL) of the DNS record in seconds.

property zoneName

zoneName: pulumi.Input<string>;

Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

interface TxtRecordState

interface TxtRecordState

Input properties used for looking up and filtering TxtRecord resources.

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the DNS TXT Record.

property name

name?: pulumi.Input<string>;

The name of the DNS TXT Record.

property records

records?: pulumi.Input<pulumi.Input<TxtRecordRecord>[]>;

A list of values that make up the txt record. Each record block supports fields documented below.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property ttl

ttl?: pulumi.Input<number>;

The Time To Live (TTL) of the DNS record in seconds.

property zoneName

zoneName?: pulumi.Input<string>;

Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

interface ZoneArgs

interface ZoneArgs

The set of arguments for constructing a Zone resource.

property name

name?: pulumi.Input<string>;

The name of the DNS Zone. Must be a valid domain name.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface ZoneState

interface ZoneState

Input properties used for looking up and filtering Zone resources.

property maxNumberOfRecordSets

maxNumberOfRecordSets?: pulumi.Input<number>;

(Optional) Maximum number of Records in the zone. Defaults to 1000.

property name

name?: pulumi.Input<string>;

The name of the DNS Zone. Must be a valid domain name.

property nameServers

nameServers?: pulumi.Input<pulumi.Input<string>[]>;

(Optional) A list of values that make up the NS record for the zone.

property numberOfRecordSets

numberOfRecordSets?: pulumi.Input<number>;

(Optional) The number of records already in the zone.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module dns

Resources

Functions

Others

Resources

Example Usage

Alias Record)

Example Usage

Alias Record)

Example Usage

Example Usage

Alias Record)

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage