We recommend using Azure Native.
azure.privatedns.CnameRecord
Explore with Pulumi AI
Enables you to manage DNS CNAME Records within Azure Private DNS.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleZone = new azure.privatedns.Zone("example", {
name: "mydomain.com",
resourceGroupName: example.name,
});
const exampleCnameRecord = new azure.privatedns.CnameRecord("example", {
name: "test",
zoneName: exampleZone.name,
resourceGroupName: example.name,
ttl: 300,
record: "contoso.com",
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_zone = azure.privatedns.Zone("example",
name="mydomain.com",
resource_group_name=example.name)
example_cname_record = azure.privatedns.CnameRecord("example",
name="test",
zone_name=example_zone.name,
resource_group_name=example.name,
ttl=300,
record="contoso.com")
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/privatedns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleZone, err := privatedns.NewZone(ctx, "example", &privatedns.ZoneArgs{
Name: pulumi.String("mydomain.com"),
ResourceGroupName: example.Name,
})
if err != nil {
return err
}
_, err = privatedns.NewCnameRecord(ctx, "example", &privatedns.CnameRecordArgs{
Name: pulumi.String("test"),
ZoneName: exampleZone.Name,
ResourceGroupName: example.Name,
Ttl: pulumi.Int(300),
Record: pulumi.String("contoso.com"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleZone = new Azure.PrivateDns.Zone("example", new()
{
Name = "mydomain.com",
ResourceGroupName = example.Name,
});
var exampleCnameRecord = new Azure.PrivateDns.CnameRecord("example", new()
{
Name = "test",
ZoneName = exampleZone.Name,
ResourceGroupName = example.Name,
Ttl = 300,
Record = "contoso.com",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.privatedns.Zone;
import com.pulumi.azure.privatedns.ZoneArgs;
import com.pulumi.azure.privatedns.CnameRecord;
import com.pulumi.azure.privatedns.CnameRecordArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleZone = new Zone("exampleZone", ZoneArgs.builder()
.name("mydomain.com")
.resourceGroupName(example.name())
.build());
var exampleCnameRecord = new CnameRecord("exampleCnameRecord", CnameRecordArgs.builder()
.name("test")
.zoneName(exampleZone.name())
.resourceGroupName(example.name())
.ttl(300)
.record("contoso.com")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleZone:
type: azure:privatedns:Zone
name: example
properties:
name: mydomain.com
resourceGroupName: ${example.name}
exampleCnameRecord:
type: azure:privatedns:CnameRecord
name: example
properties:
name: test
zoneName: ${exampleZone.name}
resourceGroupName: ${example.name}
ttl: 300
record: contoso.com
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
The CnameRecord resource accepts the following input properties:
- Record string
- The target of the CNAME.
- Resource
Group stringName - 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. Possible values are between
0
and2147483647
. - Zone
Name 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. Changing this forces a new resource to be created.
- Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Record string
- The target of the CNAME.
- Resource
Group stringName - 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. Possible values are between
0
and2147483647
. - Zone
Name 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. Changing this forces a new resource to be created.
- map[string]string
- A mapping of tags to assign to the resource.
- record String
- The target of the CNAME.
- resource
Group StringName - 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. Possible values are between
0
and2147483647
. - zone
Name 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. Changing this forces a new resource to be created.
- Map<String,String>
- A mapping of tags to assign to the resource.
- record string
- The target of the CNAME.
- resource
Group stringName - 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. Possible values are between
0
and2147483647
. - zone
Name 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. Changing this forces a new resource to be created.
- {[key: string]: string}
- A mapping of tags to assign to the resource.
- record str
- The target of the CNAME.
- resource_
group_ strname - 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. Possible values are between
0
and2147483647
. - 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. Changing this forces a new resource to be created.
- Mapping[str, str]
- A mapping of tags to assign to the resource.
- record String
- The target of the CNAME.
- resource
Group StringName - 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. Possible values are between
0
and2147483647
. - zone
Name 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. Changing this forces a new resource to be created.
- 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:
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)
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. Changing this forces a new resource to be created.
- Record string
- The target of the CNAME.
- Resource
Group stringName - Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
- 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. Possible values are between
0
and2147483647
. - Zone
Name 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. Changing this forces a new resource to be created.
- Record string
- The target of the CNAME.
- Resource
Group stringName - Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
- 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. Possible values are between
0
and2147483647
. - Zone
Name 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. Changing this forces a new resource to be created.
- record String
- The target of the CNAME.
- resource
Group StringName - Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
- 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. Possible values are between
0
and2147483647
. - zone
Name 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. Changing this forces a new resource to be created.
- record string
- The target of the CNAME.
- resource
Group stringName - Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
- {[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. Possible values are between
0
and2147483647
. - zone
Name 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. Changing this forces a new resource to be created.
- record str
- The target of the CNAME.
- resource_
group_ strname - Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
- 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. Possible values are between
0
and2147483647
. - 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. Changing this forces a new resource to be created.
- record String
- The target of the CNAME.
- resource
Group StringName - Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
- Map<String>
- A mapping of tags to assign to the resource.
- ttl Number
- The Time To Live (TTL) of the DNS record in seconds. Possible values are between
0
and2147483647
. - zone
Name 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.