Azure Classic
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 Europe",
});
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/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/dns"
"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 := 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
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleZone = new Zone("exampleZone", ZoneArgs.builder()
.resourceGroupName(exampleResourceGroup.getName())
.build());
var exampleCNameRecord = new CNameRecord("exampleCNameRecord", CNameRecordArgs.builder()
.zoneName(exampleZone.getName())
.resourceGroupName(exampleResourceGroup.getName())
.ttl(300)
.record("contoso.com")
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
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 Europe"});
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",
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleZone:
type: azure:dns:Zone
properties:
resourceGroupName: ${exampleResourceGroup.name}
exampleCNameRecord:
type: azure:dns:CNameRecord
properties:
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 Europe",
});
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/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/dns"
"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 := 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
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleZone = new Zone("exampleZone", ZoneArgs.builder()
.resourceGroupName(exampleResourceGroup.getName())
.build());
var target = new CNameRecord("target", CNameRecordArgs.builder()
.zoneName(exampleZone.getName())
.resourceGroupName(exampleResourceGroup.getName())
.ttl(300)
.record("contoso.com")
.build());
var exampleCNameRecord = new CNameRecord("exampleCNameRecord", CNameRecordArgs.builder()
.zoneName(exampleZone.getName())
.resourceGroupName(exampleResourceGroup.getName())
.ttl(300)
.targetResourceId(target.getId())
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
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 Europe"});
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,
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleZone:
type: azure:dns:Zone
properties:
resourceGroupName: ${exampleResourceGroup.name}
target:
type: azure:dns:CNameRecord
properties:
zoneName: ${exampleZone.name}
resourceGroupName: ${exampleResourceGroup.name}
ttl: 300
record: contoso.com
exampleCNameRecord:
type: azure:dns:CNameRecord
properties:
zoneName: ${exampleZone.name}
resourceGroupName: ${exampleResourceGroup.name}
ttl: 300
targetResourceId: ${target.id}
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,
target_resource_id: Optional[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)
public CNameRecord(String name, CNameRecordArgs args)
public CNameRecord(String name, CNameRecordArgs args, CustomResourceOptions options)
type: azure:dns:CNameRecord
properties: # The arguments to resource properties.
options: # 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.
- 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.
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
The CNameRecord resource accepts the following input properties:
- Resource
Group stringName Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
- Ttl int
- Zone
Name 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.
- Dictionary<string, string>
A mapping of tags to assign to the resource.
- Target
Resource stringId The Azure resource id of the target object. Conflicts with
records
- Resource
Group stringName Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
- Ttl int
- Zone
Name 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.
- map[string]string
A mapping of tags to assign to the resource.
- Target
Resource stringId The Azure resource id of the target object. Conflicts with
records
- resource
Group StringName Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
- ttl Integer
- zone
Name 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.
- Map
A mapping of tags to assign to the resource.
- target
Resource StringId The Azure resource id of the target object. Conflicts with
records
- resource
Group stringName Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
- ttl number
- zone
Name 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.
- {[key: string]: string}
A mapping of tags to assign to the resource.
- target
Resource stringId The Azure resource id of the target object. Conflicts with
records
- resource_
group_ strname Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
- ttl int
- 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.
- Mapping[str, str]
A mapping of tags to assign to the resource.
- target_
resource_ strid The Azure resource id of the target object. Conflicts with
records
- resource
Group StringName Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
- ttl Number
- zone
Name 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.
- Map
A mapping of tags to assign to the resource.
- target
Resource StringId 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:
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,
target_resource_id: Optional[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)
Resource lookup is not supported in YAML
- 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.
- 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.
- Resource
Group stringName Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
- Dictionary<string, string>
A mapping of tags to assign to the resource.
- Target
Resource stringId The Azure resource id of the target object. Conflicts with
records
- Ttl int
- Zone
Name 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.
- Resource
Group stringName Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
- map[string]string
A mapping of tags to assign to the resource.
- Target
Resource stringId The Azure resource id of the target object. Conflicts with
records
- Ttl int
- Zone
Name 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.
- resource
Group StringName Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
- Map
A mapping of tags to assign to the resource.
- target
Resource StringId The Azure resource id of the target object. Conflicts with
records
- ttl Integer
- zone
Name 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.
- resource
Group stringName Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
- {[key: string]: string}
A mapping of tags to assign to the resource.
- target
Resource stringId The Azure resource id of the target object. Conflicts with
records
- ttl number
- zone
Name 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_ strname Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
- Mapping[str, str]
A mapping of tags to assign to the resource.
- target_
resource_ strid The Azure resource id of the target object. Conflicts with
records
- ttl int
- zone_
name str 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.
- resource
Group StringName Specifies the resource group where the DNS Zone (parent resource) exists. Changing this forces a new resource to be created.
- Map
A mapping of tags to assign to the resource.
- target
Resource StringId The Azure resource id of the target object. Conflicts with
records
- ttl Number
- zone
Name String Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.
Import
CNAME records can be imported using the resource id
, e.g.
$ pulumi import azure:dns/cNameRecord:CNameRecord example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/dnszones/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.