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.

dns¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.dns.ARecord(resource_name, opts=None, name=None, records=None, resource_group_name=None, tags=None, target_resource_id=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS A Records within Azure DNS.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.dns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_a_record = azure.dns.ARecord("exampleARecord",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.name,
    ttl=300,
    records=["10.0.180.17"])

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.dns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Dynamic",
    ip_version="IPv4")
example_a_record = azure.dns.ARecord("exampleARecord",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.name,
    ttl=300,
    target_resource_id=example_public_ip.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS A Record.
records (pulumi.Input[list]) – List of IPv4 Addresses. Conflicts with target_resource_id.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
target_resource_id (pulumi.Input[str]) – The Azure resource id of the target object. Conflicts with records
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS A Record.

name: pulumi.Output[str] = None¶: The name of the DNS A Record.

records: pulumi.Output[list] = None¶: List of IPv4 Addresses. Conflicts with target_resource_id.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

target_resource_id: pulumi.Output[str] = None¶: The Azure resource id of the target object. Conflicts with records

zone_name: pulumi.Output[str] = None¶: Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

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

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS A Record.
name (pulumi.Input[str]) – The name of the DNS A Record.
records (pulumi.Input[list]) – List of IPv4 Addresses. Conflicts with target_resource_id.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
target_resource_id (pulumi.Input[str]) – The Azure resource id of the target object. Conflicts with records
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.dns.AaaaRecord(resource_name, opts=None, name=None, records=None, resource_group_name=None, tags=None, target_resource_id=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS AAAA Records within Azure DNS.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.dns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_aaaa_record = azure.dns.AaaaRecord("exampleAaaaRecord",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.name,
    ttl=300)

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.dns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Dynamic",
    ip_version="IPv6")
example_aaaa_record = azure.dns.AaaaRecord("exampleAaaaRecord",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.name,
    ttl=300,
    target_resource_id=example_public_ip.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS AAAA Record.
records (pulumi.Input[list]) – List of IPv4 Addresses. Conflicts with target_resource_id.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
target_resource_id (pulumi.Input[str]) – The Azure resource id of the target object. Conflicts with records
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS AAAA Record.

name: pulumi.Output[str] = None¶: The name of the DNS AAAA Record.

records: pulumi.Output[list] = None¶: List of IPv4 Addresses. Conflicts with target_resource_id.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

target_resource_id: pulumi.Output[str] = None¶: The Azure resource id of the target object. Conflicts with records

zone_name: pulumi.Output[str] = None¶: Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

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

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS AAAA Record.
name (pulumi.Input[str]) – The name of the DNS AAAA Record.
records (pulumi.Input[list]) – List of IPv4 Addresses. Conflicts with target_resource_id.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
target_resource_id (pulumi.Input[str]) – The Azure resource id of the target object. Conflicts with records
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.dns.AwaitableGetZoneResult(id=None, max_number_of_record_sets=None, name=None, name_servers=None, number_of_record_sets=None, resource_group_name=None, tags=None)¶

class pulumi_azure.dns.CNameRecord(resource_name, opts=None, name=None, record=None, resource_group_name=None, tags=None, target_resource_id=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS CNAME Records within Azure DNS.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.dns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_c_name_record = azure.dns.CNameRecord("exampleCNameRecord",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.name,
    ttl=300,
    record="contoso.com")

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.dns.Zone("exampleZone", resource_group_name=example_resource_group.name)
target = azure.dns.CNameRecord("target",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.name,
    ttl=300,
    record="contoso.com")
example_c_name_record = azure.dns.CNameRecord("exampleCNameRecord",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.name,
    ttl=300,
    target_resource_id=target.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS CNAME Record.
record (pulumi.Input[str]) – The target of the CNAME.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
target_resource_id (pulumi.Input[str]) – The Azure resource id of the target object. Conflicts with records
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS CName Record.

name: pulumi.Output[str] = None¶: The name of the DNS CNAME Record.

record: pulumi.Output[str] = None¶: The target of the CNAME.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

target_resource_id: pulumi.Output[str] = None¶: The Azure resource id of the target object. Conflicts with records

zone_name: pulumi.Output[str] = None¶: Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, fqdn=None, name=None, record=None, resource_group_name=None, tags=None, target_resource_id=None, ttl=None, zone_name=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS CName Record.
name (pulumi.Input[str]) – The name of the DNS CNAME Record.
record (pulumi.Input[str]) – The target of the CNAME.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
target_resource_id (pulumi.Input[str]) – The Azure resource id of the target object. Conflicts with records
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.dns.CaaRecord(resource_name, opts=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS CAA Records within Azure DNS.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.dns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_caa_record = azure.dns.CaaRecord("exampleCaaRecord",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.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",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS CAA Record. If you are creating the record in the apex of the zone use "@" as the name.
records (pulumi.Input[list]) – A list of values that make up the CAA record. Each record block supports fields documented below.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
ttl (pulumi.Input[float]) – The Time To Live (TTL) of the DNS record in seconds.
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

The records object supports the following:

flags (pulumi.Input[float]) - Extensible CAA flags, currently only 1 is implemented to set the issuer critical flag.
tag (pulumi.Input[str]) - A property tag, options are issue, issuewild and iodef.
value (pulumi.Input[str]) - A property value such as a registrar domain.

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS CAA Record.

name: pulumi.Output[str] = None¶: The name of the DNS CAA Record. If you are creating the record in the apex of the zone use "@" as the name.

records: pulumi.Output[list] = None¶

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

flags (float) - Extensible CAA flags, currently only 1 is implemented to set the issuer critical flag.
tag (str) - A property tag, options are issue, issuewild and iodef.
value (str) - A property value such as a registrar domain.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

ttl: pulumi.Output[float] = None¶: The Time To Live (TTL) of the DNS record in seconds.

zone_name: pulumi.Output[str] = None¶: Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

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

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS CAA Record.
name (pulumi.Input[str]) – The name of the DNS CAA Record. If you are creating the record in the apex of the zone use "@" as the name.
records (pulumi.Input[list]) – A list of values that make up the CAA record. Each record block supports fields documented below.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
ttl (pulumi.Input[float]) – The Time To Live (TTL) of the DNS record in seconds.
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

The records object supports the following:

flags (pulumi.Input[float]) - Extensible CAA flags, currently only 1 is implemented to set the issuer critical flag.
tag (pulumi.Input[str]) - A property tag, options are issue, issuewild and iodef.
value (pulumi.Input[str]) - A property value such as a registrar domain.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.dns.GetZoneResult(id=None, max_number_of_record_sets=None, name=None, name_servers=None, number_of_record_sets=None, resource_group_name=None, tags=None)¶

A collection of values returned by getZone.

id = None¶: The provider-assigned unique ID for this managed resource.

max_number_of_record_sets = None¶: Maximum number of Records in the zone.

name_servers = None¶: A list of values that make up the NS record for the zone.

number_of_record_sets = None¶: The number of records already in the zone.

tags = None¶: A mapping of tags to assign to the EventHub Namespace.

class pulumi_azure.dns.MxRecord(resource_name, opts=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS MX Records within Azure DNS.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.dns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_mx_record = azure.dns.MxRecord("exampleMxRecord",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.name,
    ttl=300,
    record=[
        {
            "preference": 10,
            "exchange": "mail1.contoso.com",
        },
        {
            "preference": 20,
            "exchange": "mail2.contoso.com",
        },
    ],
    tags={
        "Environment": "Production",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS MX Record. Defaults to @ (root). Changing this forces a new resource to be created.
records (pulumi.Input[list]) – A list of values that make up the MX record. Each record block supports fields documented below.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
ttl (pulumi.Input[float]) – The Time To Live (TTL) of the DNS record in seconds.
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

The records object supports the following:

exchange (pulumi.Input[str]) - The mail server responsible for the domain covered by the MX record.
preference (pulumi.Input[str]) - String representing the “preference” value of the MX records. Records with lower preference value take priority.

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS MX Record.

name: pulumi.Output[str] = None¶: The name of the DNS MX Record. Defaults to @ (root). Changing this forces a new resource to be created.

records: pulumi.Output[list] = None¶

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

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.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

ttl: pulumi.Output[float] = None¶: The Time To Live (TTL) of the DNS record in seconds.

zone_name: pulumi.Output[str] = None¶: Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

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

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS MX Record.
name (pulumi.Input[str]) – The name of the DNS MX Record. Defaults to @ (root). Changing this forces a new resource to be created.
records (pulumi.Input[list]) – A list of values that make up the MX record. Each record block supports fields documented below.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
ttl (pulumi.Input[float]) – The Time To Live (TTL) of the DNS record in seconds.
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

The records object supports the following:

exchange (pulumi.Input[str]) - The mail server responsible for the domain covered by the MX record.
preference (pulumi.Input[str]) - String representing the “preference” value of the MX records. Records with lower preference value take priority.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.dns.NsRecord(resource_name, opts=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS NS Records within Azure DNS.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.dns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_ns_record = azure.dns.NsRecord("exampleNsRecord",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.name,
    ttl=300,
    records=[
        "ns1.contoso.com",
        "ns2.contoso.com",
    ],
    tags={
        "Environment": "Production",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS NS Record.
records (pulumi.Input[list]) – A list of values that make up the NS record.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
ttl (pulumi.Input[float]) – The Time To Live (TTL) of the DNS record in seconds.
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS NS Record.

name: pulumi.Output[str] = None¶: The name of the DNS NS Record.

records: pulumi.Output[list] = None¶: A list of values that make up the NS record.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

ttl: pulumi.Output[float] = None¶: The Time To Live (TTL) of the DNS record in seconds.

zone_name: pulumi.Output[str] = None¶: Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

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

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS NS Record.
name (pulumi.Input[str]) – The name of the DNS NS Record.
records (pulumi.Input[list]) – A list of values that make up the NS record.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
ttl (pulumi.Input[float]) – The Time To Live (TTL) of the DNS record in seconds.
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.dns.PtrRecord(resource_name, opts=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS PTR Records within Azure DNS.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.dns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_ptr_record = azure.dns.PtrRecord("examplePtrRecord",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.name,
    ttl=300,
    records=["yourdomain.com"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS PTR Record.
records (pulumi.Input[list]) – List of Fully Qualified Domain Names.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
ttl (pulumi.Input[float]) – The Time To Live (TTL) of the DNS record in seconds.
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS PTR Record.

name: pulumi.Output[str] = None¶: The name of the DNS PTR Record.

records: pulumi.Output[list] = None¶: List of Fully Qualified Domain Names.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

ttl: pulumi.Output[float] = None¶: The Time To Live (TTL) of the DNS record in seconds.

zone_name: pulumi.Output[str] = None¶: Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

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

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS PTR Record.
name (pulumi.Input[str]) – The name of the DNS PTR Record.
records (pulumi.Input[list]) – List of Fully Qualified Domain Names.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
ttl (pulumi.Input[float]) – The Time To Live (TTL) of the DNS record in seconds.
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.dns.SrvRecord(resource_name, opts=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS SRV Records within Azure DNS.

import pulumi
import pulumi_azure as azure

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

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS SRV Record.
records (pulumi.Input[list]) – A list of values that make up the SRV record. Each record block supports fields documented below.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
ttl (pulumi.Input[float]) – The Time To Live (TTL) of the DNS record in seconds.
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

The records object supports the following:

port (pulumi.Input[float]) - Port the service is listening on.
priority (pulumi.Input[float]) - Priority of the SRV record.
target (pulumi.Input[str]) - FQDN of the service.
weight (pulumi.Input[float]) - Weight of the SRV record.

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS SRV Record.

name: pulumi.Output[str] = None¶: The name of the DNS SRV Record.

records: pulumi.Output[list] = None¶

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

port (float) - Port the service is listening on.
priority (float) - Priority of the SRV record.
target (str) - FQDN of the service.
weight (float) - Weight of the SRV record.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

ttl: pulumi.Output[float] = None¶: The Time To Live (TTL) of the DNS record in seconds.

zone_name: pulumi.Output[str] = None¶: Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

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

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS SRV Record.
name (pulumi.Input[str]) – The name of the DNS SRV Record.
records (pulumi.Input[list]) – A list of values that make up the SRV record. Each record block supports fields documented below.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
ttl (pulumi.Input[float]) – The Time To Live (TTL) of the DNS record in seconds.
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

The records object supports the following:

port (pulumi.Input[float]) - Port the service is listening on.
priority (pulumi.Input[float]) - Priority of the SRV record.
target (pulumi.Input[str]) - FQDN of the service.
weight (pulumi.Input[float]) - Weight of the SRV record.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.dns.TxtRecord(resource_name, opts=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS TXT Records within Azure DNS.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.dns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_txt_record = azure.dns.TxtRecord("exampleTxtRecord",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.name,
    ttl=300,
    record=[
        {
            "value": "google-site-authenticator",
        },
        {
            "value": "more site information here",
        },
    ],
    tags={
        "Environment": "Production",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS TXT Record.
records (pulumi.Input[list]) – A list of values that make up the txt record. Each record block supports fields documented below.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
ttl (pulumi.Input[float]) – The Time To Live (TTL) of the DNS record in seconds.
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

The records object supports the following:

value (pulumi.Input[str]) - The value of the record. Max length: 1024 characters

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS TXT Record.

name: pulumi.Output[str] = None¶: The name of the DNS TXT Record.

records: pulumi.Output[list] = None¶

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

value (str) - The value of the record. Max length: 1024 characters

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

ttl: pulumi.Output[float] = None¶: The Time To Live (TTL) of the DNS record in seconds.

zone_name: pulumi.Output[str] = None¶: Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

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

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS TXT Record.
name (pulumi.Input[str]) – The name of the DNS TXT Record.
records (pulumi.Input[list]) – A list of values that make up the txt record. Each record block supports fields documented below.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
ttl (pulumi.Input[float]) – The Time To Live (TTL) of the DNS record in seconds.
zone_name (pulumi.Input[str]) – Specifies the DNS Zone where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.

The records object supports the following:

value (pulumi.Input[str]) - The value of the record. Max length: 1024 characters

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.dns.Zone(resource_name, opts=None, name=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

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.

import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example", location="West US")
example_public = azure.dns.Zone("example-public", resource_group_name=example.name)
example_private = azure.privatedns.Zone("example-private", resource_group_name=example.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS Zone. Must be a valid domain name.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

max_number_of_record_sets: pulumi.Output[float] = None¶: (Optional) Maximum number of Records in the zone. Defaults to 1000.

name: pulumi.Output[str] = None¶: The name of the DNS Zone. Must be a valid domain name.

name_servers: pulumi.Output[list] = None¶: (Optional) A list of values that make up the NS record for the zone.

number_of_record_sets: pulumi.Output[float] = None¶: (Optional) The number of records already in the zone.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, max_number_of_record_sets=None, name=None, name_servers=None, number_of_record_sets=None, resource_group_name=None, tags=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
max_number_of_record_sets (pulumi.Input[float]) – (Optional) Maximum number of Records in the zone. Defaults to 1000.
name (pulumi.Input[str]) – The name of the DNS Zone. Must be a valid domain name.
name_servers (pulumi.Input[list]) – (Optional) A list of values that make up the NS record for the zone.
number_of_record_sets (pulumi.Input[float]) – (Optional) The number of records already in the zone.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_azure.dns.get_zone(name=None, resource_group_name=None, opts=None)¶

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

import pulumi
import pulumi_azure as azure

example = azure.dns.get_zone(name="search-eventhubns",
    resource_group_name="search-service")
pulumi.export("dnsZoneId", example.id)

Parameters

name (str) – The name of the DNS Zone.
resource_group_name (str) – 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.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

dns¶

On This Page