CNameRecord

Enables you to manage DNS CNAME Records within Azure DNS.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West US",
        });
        var exampleZone = new Azure.Dns.Zone("exampleZone", new Azure.Dns.ZoneArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
        });
        var exampleCNameRecord = new Azure.Dns.CNameRecord("exampleCNameRecord", new Azure.Dns.CNameRecordArgs
        {
            ZoneName = exampleZone.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            Ttl = 300,
            Record = "contoso.com",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/dns"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West US"),
        })
        if err != nil {
            return err
        }
        exampleZone, err := dns.NewZone(ctx, "exampleZone", &dns.ZoneArgs{
            ResourceGroupName: exampleResourceGroup.Name,
        })
        if err != nil {
            return err
        }
        _, err = dns.NewCNameRecord(ctx, "exampleCNameRecord", &dns.CNameRecordArgs{
            ZoneName:          exampleZone.Name,
            ResourceGroupName: exampleResourceGroup.Name,
            Ttl:               pulumi.Int(300),
            Record:            pulumi.String("contoso.com"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

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 * 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)

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West US",
        });
        var exampleZone = new Azure.Dns.Zone("exampleZone", new Azure.Dns.ZoneArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
        });
        var target = new Azure.Dns.CNameRecord("target", new Azure.Dns.CNameRecordArgs
        {
            ZoneName = exampleZone.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            Ttl = 300,
            Record = "contoso.com",
        });
        var exampleCNameRecord = new Azure.Dns.CNameRecord("exampleCNameRecord", new Azure.Dns.CNameRecordArgs
        {
            ZoneName = exampleZone.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            Ttl = 300,
            TargetResourceId = target.Id,
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/dns"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West US"),
        })
        if err != nil {
            return err
        }
        exampleZone, err := dns.NewZone(ctx, "exampleZone", &dns.ZoneArgs{
            ResourceGroupName: exampleResourceGroup.Name,
        })
        if err != nil {
            return err
        }
        target, err := dns.NewCNameRecord(ctx, "target", &dns.CNameRecordArgs{
            ZoneName:          exampleZone.Name,
            ResourceGroupName: exampleResourceGroup.Name,
            Ttl:               pulumi.Int(300),
            Record:            pulumi.String("contoso.com"),
        })
        if err != nil {
            return err
        }
        _, err = dns.NewCNameRecord(ctx, "exampleCNameRecord", &dns.CNameRecordArgs{
            ZoneName:          exampleZone.Name,
            ResourceGroupName: exampleResourceGroup.Name,
            Ttl:               pulumi.Int(300),
            TargetResourceId:  target.ID(),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

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)

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,
});

Create a CNameRecord Resource

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

def 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);

func NewCNameRecord(ctx *Context, name string, args CNameRecordArgs, opts ...ResourceOption) (*CNameRecord, error)

public CNameRecord(string name, CNameRecordArgs args, CustomResourceOptions? opts = null)

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

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args CNameRecordArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

CNameRecord Resource Properties

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

Inputs

The CNameRecord resource accepts the following input properties:

ResourceGroupName string: Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
Ttl int
ZoneName string: Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the DNS CNAME Record.
Record string: The target of the CNAME.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
TargetResourceId string: The Azure resource id of the target object. Conflicts with records

ResourceGroupName string: Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
Ttl int
ZoneName string: Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the DNS CNAME Record.
Record string: The target of the CNAME.
Tags map[string]string: A mapping of tags to assign to the resource.
TargetResourceId string: The Azure resource id of the target object. Conflicts with records

resourceGroupName string: Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
ttl number
zoneName string: Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.
name string: The name of the DNS CNAME Record.
record string: The target of the CNAME.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
targetResourceId string: The Azure resource id of the target object. Conflicts with records

resource_group_name str: Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
ttl float
zone_name str: Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.
name str: The name of the DNS CNAME Record.
record str: The target of the CNAME.
tags Dict[str, str]: A mapping of tags to assign to the resource.
target_resource_id str: The Azure resource id of the target object. Conflicts with records

Outputs

All input properties are implicitly available as output properties. Additionally, the CNameRecord resource produces the following output properties:

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

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

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

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

Look up an Existing CNameRecord Resource

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

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

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, __props__=None);

func GetCNameRecord(ctx *Context, name string, id IDInput, state *CNameRecordState, opts ...ResourceOption) (*CNameRecord, error)

public static CNameRecord Get(string name, Input<string> id, CNameRecordState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Fqdn string: The FQDN of the DNS CName Record.
Name string: The name of the DNS CNAME Record.
Record string: The target of the CNAME.
ResourceGroupName string: Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
TargetResourceId string: The Azure resource id of the target object. Conflicts with records
Ttl int
ZoneName string: Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

Fqdn string: The FQDN of the DNS CName Record.
Name string: The name of the DNS CNAME Record.
Record string: The target of the CNAME.
ResourceGroupName string: Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.
TargetResourceId string: The Azure resource id of the target object. Conflicts with records
Ttl int
ZoneName string: Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

fqdn string: The FQDN of the DNS CName Record.
name string: The name of the DNS CNAME Record.
record string: The target of the CNAME.
resourceGroupName string: Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
targetResourceId string: The Azure resource id of the target object. Conflicts with records
ttl number
zoneName string: Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

fqdn str: The FQDN of the DNS CName Record.
name str: The name of the DNS CNAME Record.
record str: The target of the CNAME.
resource_group_name str: Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.
target_resource_id str: The Azure resource id of the target object. Conflicts with records
ttl float
zone_name str: Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud