CnameRecord

Enables you to manage DNS CNAME Records within Azure Private 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 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
	})
}
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")
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",
});

Create a CnameRecord Resource

new CnameRecord(name: string, args: CnameRecordArgs, opts?: CustomResourceOptions);
@overload
def CnameRecord(resource_name: str,
                opts: Optional[ResourceOptions] = 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)
@overload
def CnameRecord(resource_name: str,
                args: CnameRecordArgs,
                opts: Optional[ResourceOptions] = 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.
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.

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:

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

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
@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)
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 resource exists. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
Ttl int
ZoneName string
Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.
Fqdn string
The FQDN of the DNS 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
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
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
zone_name str
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

Package Details

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