1. Packages
  2. Azure Classic
  3. API Docs
  4. privatedns
  5. PTRRecord

We recommend using Azure Native.

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

We recommend using Azure Native.

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

    Enables you to manage DNS PTR 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 examplePTRRecord = new Azure.PrivateDns.PTRRecord("examplePTRRecord", new Azure.PrivateDns.PTRRecordArgs
            {
                ZoneName = exampleZone.Name,
                ResourceGroupName = exampleResourceGroup.Name,
                Ttl = 300,
                Records = 
                {
                    "test.example.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.NewPTRRecord(ctx, "examplePTRRecord", &privatedns.PTRRecordArgs{
    			ZoneName:          exampleZone.Name,
    			ResourceGroupName: exampleResourceGroup.Name,
    			Ttl:               pulumi.Int(300),
    			Records: pulumi.StringArray{
    				pulumi.String("test.example.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 examplePTRRecord = new azure.privatedns.PTRRecord("examplePTRRecord", {
        zoneName: exampleZone.name,
        resourceGroupName: exampleResourceGroup.name,
        ttl: 300,
        records: ["test.example.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_ptr_record = azure.privatedns.PTRRecord("examplePTRRecord",
        zone_name=example_zone.name,
        resource_group_name=example_resource_group.name,
        ttl=300,
        records=["test.example.com"])
    

    Example coming soon!

    Create PTRRecord Resource

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

    Constructor syntax

    new PTRRecord(name: string, args: PTRRecordArgs, opts?: CustomResourceOptions);
    @overload
    def PTRRecord(resource_name: str,
                  args: PTRRecordArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def PTRRecord(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  records: Optional[Sequence[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 NewPTRRecord(ctx *Context, name string, args PTRRecordArgs, opts ...ResourceOption) (*PTRRecord, error)
    public PTRRecord(string name, PTRRecordArgs args, CustomResourceOptions? opts = null)
    public PTRRecord(String name, PTRRecordArgs args)
    public PTRRecord(String name, PTRRecordArgs args, CustomResourceOptions options)
    
    type: azure:privatedns:PTRRecord
    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 PTRRecordArgs
    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 PTRRecordArgs
    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 PTRRecordArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PTRRecordArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PTRRecordArgs
    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 ptrrecordResource = new Azure.PrivateDns.PTRRecord("ptrrecordResource", new()
    {
        Records = new[]
        {
            "string",
        },
        ResourceGroupName = "string",
        Ttl = 0,
        ZoneName = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := privatedns.NewPTRRecord(ctx, "ptrrecordResource", &privatedns.PTRRecordArgs{
    	Records: pulumi.StringArray{
    		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 ptrrecordResource = new PTRRecord("ptrrecordResource", PTRRecordArgs.builder()
        .records("string")
        .resourceGroupName("string")
        .ttl(0)
        .zoneName("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    ptrrecord_resource = azure.privatedns.PTRRecord("ptrrecordResource",
        records=["string"],
        resource_group_name="string",
        ttl=0,
        zone_name="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const ptrrecordResource = new azure.privatedns.PTRRecord("ptrrecordResource", {
        records: ["string"],
        resourceGroupName: "string",
        ttl: 0,
        zoneName: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure:privatedns:PTRRecord
    properties:
        name: string
        records:
            - string
        resourceGroupName: string
        tags:
            string: string
        ttl: 0
        zoneName: string
    

    PTRRecord 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 PTRRecord resource accepts the following input properties:

    Records List<string>
    List of Fully Qualified Domain Names.
    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 PTR Record. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Records []string
    List of Fully Qualified Domain Names.
    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 PTR Record. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    records List<String>
    List of Fully Qualified Domain Names.
    resourceGroupName String
    Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
    ttl Integer
    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 PTR Record. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    records string[]
    List of Fully Qualified Domain Names.
    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 PTR Record. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    records Sequence[str]
    List of Fully Qualified Domain Names.
    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 PTR Record. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    records List<String>
    List of Fully Qualified Domain Names.
    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 PTR Record. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Outputs

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

    Fqdn string
    The FQDN of the DNS PTR Record.
    Id string
    The provider-assigned unique ID for this managed resource.
    Fqdn string
    The FQDN of the DNS PTR Record.
    Id string
    The provider-assigned unique ID for this managed resource.
    fqdn String
    The FQDN of the DNS PTR Record.
    id String
    The provider-assigned unique ID for this managed resource.
    fqdn string
    The FQDN of the DNS PTR Record.
    id string
    The provider-assigned unique ID for this managed resource.
    fqdn str
    The FQDN of the DNS PTR Record.
    id str
    The provider-assigned unique ID for this managed resource.
    fqdn String
    The FQDN of the DNS PTR Record.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PTRRecord Resource

    Get an existing PTRRecord 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?: PTRRecordState, opts?: CustomResourceOptions): PTRRecord
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            fqdn: Optional[str] = None,
            name: Optional[str] = None,
            records: Optional[Sequence[str]] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            ttl: Optional[int] = None,
            zone_name: Optional[str] = None) -> PTRRecord
    func GetPTRRecord(ctx *Context, name string, id IDInput, state *PTRRecordState, opts ...ResourceOption) (*PTRRecord, error)
    public static PTRRecord Get(string name, Input<string> id, PTRRecordState? state, CustomResourceOptions? opts = null)
    public static PTRRecord get(String name, Output<String> id, PTRRecordState state, CustomResourceOptions options)
    resources:  _:    type: azure:privatedns:PTRRecord    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 PTR Record.
    Name string
    The name of the DNS PTR Record. Changing this forces a new resource to be created.
    Records List<string>
    List of Fully Qualified Domain Names.
    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 PTR Record.
    Name string
    The name of the DNS PTR Record. Changing this forces a new resource to be created.
    Records []string
    List of Fully Qualified Domain Names.
    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 PTR Record.
    name String
    The name of the DNS PTR Record. Changing this forces a new resource to be created.
    records List<String>
    List of Fully Qualified Domain Names.
    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
    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 PTR Record.
    name string
    The name of the DNS PTR Record. Changing this forces a new resource to be created.
    records string[]
    List of Fully Qualified Domain Names.
    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 PTR Record.
    name str
    The name of the DNS PTR Record. Changing this forces a new resource to be created.
    records Sequence[str]
    List of Fully Qualified Domain Names.
    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.
    fqdn String
    The FQDN of the DNS PTR Record.
    name String
    The name of the DNS PTR Record. Changing this forces a new resource to be created.
    records List<String>
    List of Fully Qualified Domain Names.
    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
    zoneName String
    Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

    Import

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

     $ pulumi import azure:privatedns/pTRRecord:PTRRecord example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/privateDnsZones/2.0.192.in-addr.arpa/PTR/15
    

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

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.