azure.privatedns.CnameRecord (v4)

Azure v4.42.0 (4.x), Mar 9 26

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

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 Europe",
        });
        var exampleZone = new Azure.PrivateDns.Zone("exampleZone", new Azure.PrivateDns.ZoneArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
        });
        var exampleCnameRecord = new Azure.PrivateDns.CnameRecord("exampleCnameRecord", new Azure.PrivateDns.CnameRecordArgs
        {
            ZoneName = exampleZone.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            Ttl = 300,
            Record = "contoso.com",
        });
    }

}

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/privatedns"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

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

Example coming soon!

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleZone = new azure.privatedns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const exampleCnameRecord = new azure.privatedns.CnameRecord("exampleCnameRecord", {
    zoneName: exampleZone.name,
    resourceGroupName: exampleResourceGroup.name,
    ttl: 300,
    record: "contoso.com",
});

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_zone = azure.privatedns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_cname_record = azure.privatedns.CnameRecord("exampleCnameRecord",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.name,
    ttl=300,
    record="contoso.com")

Example coming soon!

Create CnameRecord Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CnameRecord(name: string, args: CnameRecordArgs, opts?: CustomResourceOptions);

@overload
def CnameRecord(resource_name: str,
                args: CnameRecordArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def CnameRecord(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                record: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                ttl: Optional[int] = None,
                zone_name: Optional[str] = None,
                name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)

func NewCnameRecord(ctx *Context, name string, args CnameRecordArgs, opts ...ResourceOption) (*CnameRecord, error)

public CnameRecord(string name, CnameRecordArgs args, CustomResourceOptions? opts = null)

public CnameRecord(String name, CnameRecordArgs args)
public CnameRecord(String name, CnameRecordArgs args, CustomResourceOptions options)

type: azure:privatedns:CnameRecord
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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.
args CnameRecordArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args 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.

name String: The unique name of the resource.
args CnameRecordArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var azureCnameRecordResource = new Azure.PrivateDns.CnameRecord("azureCnameRecordResource", new()
{
    Record = "string",
    ResourceGroupName = "string",
    Ttl = 0,
    ZoneName = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

example, err := privatedns.NewCnameRecord(ctx, "azureCnameRecordResource", &privatedns.CnameRecordArgs{
	Record:            pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Ttl:               pulumi.Int(0),
	ZoneName:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

var azureCnameRecordResource = new CnameRecord("azureCnameRecordResource", CnameRecordArgs.builder()
    .record("string")
    .resourceGroupName("string")
    .ttl(0)
    .zoneName("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

azure_cname_record_resource = azure.privatedns.CnameRecord("azureCnameRecordResource",
    record="string",
    resource_group_name="string",
    ttl=0,
    zone_name="string",
    name="string",
    tags={
        "string": "string",
    })

const azureCnameRecordResource = new azure.privatedns.CnameRecord("azureCnameRecordResource", {
    record: "string",
    resourceGroupName: "string",
    ttl: 0,
    zoneName: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

type: azure:privatedns:CnameRecord
properties:
    name: string
    record: string
    resourceGroupName: string
    tags:
        string: string
    ttl: 0
    zoneName: string

CnameRecord Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CnameRecord resource accepts the following input properties:

Record string: The target of the CNAME.
ResourceGroupName string: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
Ttl int: The Time To Live (TTL) of the DNS record in seconds.
ZoneName string: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the DNS CNAME Record.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

Record string: The target of the CNAME.
ResourceGroupName string: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
Ttl int: The Time To Live (TTL) of the DNS record in seconds.
ZoneName string: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the DNS CNAME Record.
Tags map[string]string: A mapping of tags to assign to the resource.

record String: The target of the CNAME.
resourceGroupName String: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
ttl Integer: The Time To Live (TTL) of the DNS record in seconds.
zoneName String: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.
name String: The name of the DNS CNAME Record.
tags Map<String,String>: A mapping of tags to assign to the resource.

record string: The target of the CNAME.
resourceGroupName string: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
ttl number: The Time To Live (TTL) of the DNS record in seconds.
zoneName string: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.
name string: The name of the DNS CNAME Record.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

record str: The target of the CNAME.
resource_group_name str: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
ttl int: The Time To Live (TTL) of the DNS record in seconds.
zone_name str: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.
name str: The name of the DNS CNAME Record.
tags Mapping[str, str]: A mapping of tags to assign to the resource.

record String: The target of the CNAME.
resourceGroupName String: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
ttl Number: The Time To Live (TTL) of the DNS record in seconds.
zoneName String: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.
name String: The name of the DNS CNAME Record.
tags Map<String>: A mapping of tags to assign to the resource.

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 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.

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

Look up 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

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

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)

public static CnameRecord get(String name, Output<String> id, CnameRecordState state, CustomResourceOptions options)

resources:  _:    type: azure:privatedns:CnameRecord    get:      id: ${id}

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.

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 resource exists. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
Ttl int: The Time To Live (TTL) of the DNS record in seconds.
ZoneName string: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

Fqdn string: The FQDN of the DNS 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 resource exists. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.
Ttl int: The Time To Live (TTL) of the DNS record in seconds.
ZoneName string: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

fqdn String: The FQDN of the DNS 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 resource exists. Changing this forces a new resource to be created.
tags Map<String,String>: A mapping of tags to assign to the resource.
ttl Integer: The Time To Live (TTL) of the DNS record in seconds.
zoneName String: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

fqdn string: The FQDN of the DNS 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 resource exists. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
ttl number: The Time To Live (TTL) of the DNS record in seconds.
zoneName string: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

fqdn str: The FQDN of the DNS 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 resource exists. Changing this forces a new resource to be created.
tags Mapping[str, str]: A mapping of tags to assign to the resource.
ttl int: The Time To Live (TTL) of the DNS record in seconds.
zone_name str: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

fqdn String: The FQDN of the DNS 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 resource exists. Changing this forces a new resource to be created.
tags Map<String>: A mapping of tags to assign to the resource.
ttl Number: The Time To Live (TTL) of the DNS record in seconds.
zoneName String: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

Import

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

 $ pulumi import azure:privatedns/cnameRecord:CnameRecord example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/privateDnsZones/zone1/CNAME/myrecord1

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

azure.privatedns.CnameRecord

On this page

On this page

Example Usage

Create CnameRecord Resource

Constructor syntax

Parameters

Constructor example

CnameRecord Resource Properties

Inputs

Outputs

Look up Existing CnameRecord Resource

Import

Package Details

On this page

On this page