Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. privatedns
  5. ResolverForwardingRule

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.privatedns.ResolverForwardingRule

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

    Manages a Private DNS Resolver Forwarding Rule.

    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 exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
    name: "example-vnet",
    resourceGroupName: example.name,
    location: example.location,
    addressSpaces: ["10.0.0.0/16"],
});
const exampleSubnet = new azure.network.Subnet("example", {
    name: "outbounddns",
    resourceGroupName: example.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["10.0.0.64/28"],
    delegations: [{
        name: "Microsoft.Network.dnsResolvers",
        serviceDelegation: {
            actions: ["Microsoft.Network/virtualNetworks/subnets/join/action"],
            name: "Microsoft.Network/dnsResolvers",
        },
    }],
});
const exampleResolver = new azure.privatedns.Resolver("example", {
    name: "example-resolver",
    resourceGroupName: example.name,
    location: example.location,
    virtualNetworkId: exampleVirtualNetwork.id,
});
const exampleResolverOutboundEndpoint = new azure.privatedns.ResolverOutboundEndpoint("example", {
    name: "example-endpoint",
    privateDnsResolverId: exampleResolver.id,
    location: exampleResolver.location,
    subnetId: exampleSubnet.id,
    tags: {
        key: "value",
    },
});
const exampleResolverDnsForwardingRuleset = new azure.privatedns.ResolverDnsForwardingRuleset("example", {
    name: "example-drdfr",
    resourceGroupName: example.name,
    location: example.location,
    privateDnsResolverOutboundEndpointIds: [exampleResolverOutboundEndpoint.id],
});
const exampleResolverForwardingRule = new azure.privatedns.ResolverForwardingRule("example", {
    name: "example-rule",
    dnsForwardingRulesetId: exampleResolverDnsForwardingRuleset.id,
    domainName: "onprem.local.",
    enabled: true,
    targetDnsServers: [{
        ipAddress: "10.10.0.1",
        port: 53,
    }],
    metadata: {
        key: "value",
    },
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="west europe")
example_virtual_network = azure.network.VirtualNetwork("example",
    name="example-vnet",
    resource_group_name=example.name,
    location=example.location,
    address_spaces=["10.0.0.0/16"])
example_subnet = azure.network.Subnet("example",
    name="outbounddns",
    resource_group_name=example.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.0.0.64/28"],
    delegations=[{
        "name": "Microsoft.Network.dnsResolvers",
        "service_delegation": {
            "actions": ["Microsoft.Network/virtualNetworks/subnets/join/action"],
            "name": "Microsoft.Network/dnsResolvers",
        },
    }])
example_resolver = azure.privatedns.Resolver("example",
    name="example-resolver",
    resource_group_name=example.name,
    location=example.location,
    virtual_network_id=example_virtual_network.id)
example_resolver_outbound_endpoint = azure.privatedns.ResolverOutboundEndpoint("example",
    name="example-endpoint",
    private_dns_resolver_id=example_resolver.id,
    location=example_resolver.location,
    subnet_id=example_subnet.id,
    tags={
        "key": "value",
    })
example_resolver_dns_forwarding_ruleset = azure.privatedns.ResolverDnsForwardingRuleset("example",
    name="example-drdfr",
    resource_group_name=example.name,
    location=example.location,
    private_dns_resolver_outbound_endpoint_ids=[example_resolver_outbound_endpoint.id])
example_resolver_forwarding_rule = azure.privatedns.ResolverForwardingRule("example",
    name="example-rule",
    dns_forwarding_ruleset_id=example_resolver_dns_forwarding_ruleset.id,
    domain_name="onprem.local.",
    enabled=True,
    target_dns_servers=[{
        "ip_address": "10.10.0.1",
        "port": 53,
    }],
    metadata={
        "key": "value",
    })

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"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
		}
		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
			Name:              pulumi.String("example-vnet"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			AddressSpaces: pulumi.StringArray{
				pulumi.String("10.0.0.0/16"),
			},
		})
		if err != nil {
			return err
		}
		exampleSubnet, err := network.NewSubnet(ctx, "example", &network.SubnetArgs{
			Name:               pulumi.String("outbounddns"),
			ResourceGroupName:  example.Name,
			VirtualNetworkName: exampleVirtualNetwork.Name,
			AddressPrefixes: pulumi.StringArray{
				pulumi.String("10.0.0.64/28"),
			},
			Delegations: network.SubnetDelegationArray{
				&network.SubnetDelegationArgs{
					Name: pulumi.String("Microsoft.Network.dnsResolvers"),
					ServiceDelegation: &network.SubnetDelegationServiceDelegationArgs{
						Actions: pulumi.StringArray{
							pulumi.String("Microsoft.Network/virtualNetworks/subnets/join/action"),
						},
						Name: pulumi.String("Microsoft.Network/dnsResolvers"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		exampleResolver, err := privatedns.NewResolver(ctx, "example", &privatedns.ResolverArgs{
			Name:              pulumi.String("example-resolver"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			VirtualNetworkId:  exampleVirtualNetwork.ID(),
		})
		if err != nil {
			return err
		}
		exampleResolverOutboundEndpoint, err := privatedns.NewResolverOutboundEndpoint(ctx, "example", &privatedns.ResolverOutboundEndpointArgs{
			Name:                 pulumi.String("example-endpoint"),
			PrivateDnsResolverId: exampleResolver.ID(),
			Location:             exampleResolver.Location,
			SubnetId:             exampleSubnet.ID(),
			Tags: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		exampleResolverDnsForwardingRuleset, err := privatedns.NewResolverDnsForwardingRuleset(ctx, "example", &privatedns.ResolverDnsForwardingRulesetArgs{
			Name:              pulumi.String("example-drdfr"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			PrivateDnsResolverOutboundEndpointIds: pulumi.StringArray{
				exampleResolverOutboundEndpoint.ID(),
			},
		})
		if err != nil {
			return err
		}
		_, err = privatedns.NewResolverForwardingRule(ctx, "example", &privatedns.ResolverForwardingRuleArgs{
			Name:                   pulumi.String("example-rule"),
			DnsForwardingRulesetId: exampleResolverDnsForwardingRuleset.ID(),
			DomainName:             pulumi.String("onprem.local."),
			Enabled:                pulumi.Bool(true),
			TargetDnsServers: privatedns.ResolverForwardingRuleTargetDnsServerArray{
				&privatedns.ResolverForwardingRuleTargetDnsServerArgs{
					IpAddress: pulumi.String("10.10.0.1"),
					Port:      pulumi.Int(53),
				},
			},
			Metadata: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		})
		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 exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
    {
        Name = "example-vnet",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AddressSpaces = new[]
        {
            "10.0.0.0/16",
        },
    });

    var exampleSubnet = new Azure.Network.Subnet("example", new()
    {
        Name = "outbounddns",
        ResourceGroupName = example.Name,
        VirtualNetworkName = exampleVirtualNetwork.Name,
        AddressPrefixes = new[]
        {
            "10.0.0.64/28",
        },
        Delegations = new[]
        {
            new Azure.Network.Inputs.SubnetDelegationArgs
            {
                Name = "Microsoft.Network.dnsResolvers",
                ServiceDelegation = new Azure.Network.Inputs.SubnetDelegationServiceDelegationArgs
                {
                    Actions = new[]
                    {
                        "Microsoft.Network/virtualNetworks/subnets/join/action",
                    },
                    Name = "Microsoft.Network/dnsResolvers",
                },
            },
        },
    });

    var exampleResolver = new Azure.PrivateDns.Resolver("example", new()
    {
        Name = "example-resolver",
        ResourceGroupName = example.Name,
        Location = example.Location,
        VirtualNetworkId = exampleVirtualNetwork.Id,
    });

    var exampleResolverOutboundEndpoint = new Azure.PrivateDns.ResolverOutboundEndpoint("example", new()
    {
        Name = "example-endpoint",
        PrivateDnsResolverId = exampleResolver.Id,
        Location = exampleResolver.Location,
        SubnetId = exampleSubnet.Id,
        Tags = 
        {
            { "key", "value" },
        },
    });

    var exampleResolverDnsForwardingRuleset = new Azure.PrivateDns.ResolverDnsForwardingRuleset("example", new()
    {
        Name = "example-drdfr",
        ResourceGroupName = example.Name,
        Location = example.Location,
        PrivateDnsResolverOutboundEndpointIds = new[]
        {
            exampleResolverOutboundEndpoint.Id,
        },
    });

    var exampleResolverForwardingRule = new Azure.PrivateDns.ResolverForwardingRule("example", new()
    {
        Name = "example-rule",
        DnsForwardingRulesetId = exampleResolverDnsForwardingRuleset.Id,
        DomainName = "onprem.local.",
        Enabled = true,
        TargetDnsServers = new[]
        {
            new Azure.PrivateDns.Inputs.ResolverForwardingRuleTargetDnsServerArgs
            {
                IpAddress = "10.10.0.1",
                Port = 53,
            },
        },
        Metadata = 
        {
            { "key", "value" },
        },
    });

});

    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.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.network.inputs.SubnetDelegationArgs;
import com.pulumi.azure.network.inputs.SubnetDelegationServiceDelegationArgs;
import com.pulumi.azure.privatedns.Resolver;
import com.pulumi.azure.privatedns.ResolverArgs;
import com.pulumi.azure.privatedns.ResolverOutboundEndpoint;
import com.pulumi.azure.privatedns.ResolverOutboundEndpointArgs;
import com.pulumi.azure.privatedns.ResolverDnsForwardingRuleset;
import com.pulumi.azure.privatedns.ResolverDnsForwardingRulesetArgs;
import com.pulumi.azure.privatedns.ResolverForwardingRule;
import com.pulumi.azure.privatedns.ResolverForwardingRuleArgs;
import com.pulumi.azure.privatedns.inputs.ResolverForwardingRuleTargetDnsServerArgs;
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 exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
            .name("example-vnet")
            .resourceGroupName(example.name())
            .location(example.location())
            .addressSpaces("10.0.0.0/16")
            .build());

        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
            .name("outbounddns")
            .resourceGroupName(example.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.0.0.64/28")
            .delegations(SubnetDelegationArgs.builder()
                .name("Microsoft.Network.dnsResolvers")
                .serviceDelegation(SubnetDelegationServiceDelegationArgs.builder()
                    .actions("Microsoft.Network/virtualNetworks/subnets/join/action")
                    .name("Microsoft.Network/dnsResolvers")
                    .build())
                .build())
            .build());

        var exampleResolver = new Resolver("exampleResolver", ResolverArgs.builder()
            .name("example-resolver")
            .resourceGroupName(example.name())
            .location(example.location())
            .virtualNetworkId(exampleVirtualNetwork.id())
            .build());

        var exampleResolverOutboundEndpoint = new ResolverOutboundEndpoint("exampleResolverOutboundEndpoint", ResolverOutboundEndpointArgs.builder()
            .name("example-endpoint")
            .privateDnsResolverId(exampleResolver.id())
            .location(exampleResolver.location())
            .subnetId(exampleSubnet.id())
            .tags(Map.of("key", "value"))
            .build());

        var exampleResolverDnsForwardingRuleset = new ResolverDnsForwardingRuleset("exampleResolverDnsForwardingRuleset", ResolverDnsForwardingRulesetArgs.builder()
            .name("example-drdfr")
            .resourceGroupName(example.name())
            .location(example.location())
            .privateDnsResolverOutboundEndpointIds(exampleResolverOutboundEndpoint.id())
            .build());

        var exampleResolverForwardingRule = new ResolverForwardingRule("exampleResolverForwardingRule", ResolverForwardingRuleArgs.builder()
            .name("example-rule")
            .dnsForwardingRulesetId(exampleResolverDnsForwardingRuleset.id())
            .domainName("onprem.local.")
            .enabled(true)
            .targetDnsServers(ResolverForwardingRuleTargetDnsServerArgs.builder()
                .ipAddress("10.10.0.1")
                .port(53)
                .build())
            .metadata(Map.of("key", "value"))
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: west europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    name: example
    properties:
      name: example-vnet
      resourceGroupName: ${example.name}
      location: ${example.location}
      addressSpaces:
        - 10.0.0.0/16
  exampleSubnet:
    type: azure:network:Subnet
    name: example
    properties:
      name: outbounddns
      resourceGroupName: ${example.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.0.0.64/28
      delegations:
        - name: Microsoft.Network.dnsResolvers
          serviceDelegation:
            actions:
              - Microsoft.Network/virtualNetworks/subnets/join/action
            name: Microsoft.Network/dnsResolvers
  exampleResolver:
    type: azure:privatedns:Resolver
    name: example
    properties:
      name: example-resolver
      resourceGroupName: ${example.name}
      location: ${example.location}
      virtualNetworkId: ${exampleVirtualNetwork.id}
  exampleResolverOutboundEndpoint:
    type: azure:privatedns:ResolverOutboundEndpoint
    name: example
    properties:
      name: example-endpoint
      privateDnsResolverId: ${exampleResolver.id}
      location: ${exampleResolver.location}
      subnetId: ${exampleSubnet.id}
      tags:
        key: value
  exampleResolverDnsForwardingRuleset:
    type: azure:privatedns:ResolverDnsForwardingRuleset
    name: example
    properties:
      name: example-drdfr
      resourceGroupName: ${example.name}
      location: ${example.location}
      privateDnsResolverOutboundEndpointIds:
        - ${exampleResolverOutboundEndpoint.id}
  exampleResolverForwardingRule:
    type: azure:privatedns:ResolverForwardingRule
    name: example
    properties:
      name: example-rule
      dnsForwardingRulesetId: ${exampleResolverDnsForwardingRuleset.id}
      domainName: onprem.local.
      enabled: true
      targetDnsServers:
        - ipAddress: 10.10.0.1
          port: 53
      metadata:
        key: value

    Create ResolverForwardingRule Resource

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

    Constructor syntax

    new ResolverForwardingRule(name: string, args: ResolverForwardingRuleArgs, opts?: CustomResourceOptions);
    @overload
def ResolverForwardingRule(resource_name: str,
                           args: ResolverForwardingRuleArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def ResolverForwardingRule(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           dns_forwarding_ruleset_id: Optional[str] = None,
                           domain_name: Optional[str] = None,
                           target_dns_servers: Optional[Sequence[ResolverForwardingRuleTargetDnsServerArgs]] = None,
                           enabled: Optional[bool] = None,
                           metadata: Optional[Mapping[str, str]] = None,
                           name: Optional[str] = None)
    func NewResolverForwardingRule(ctx *Context, name string, args ResolverForwardingRuleArgs, opts ...ResourceOption) (*ResolverForwardingRule, error)
    public ResolverForwardingRule(string name, ResolverForwardingRuleArgs args, CustomResourceOptions? opts = null)
    public ResolverForwardingRule(String name, ResolverForwardingRuleArgs args)
public ResolverForwardingRule(String name, ResolverForwardingRuleArgs args, CustomResourceOptions options)

    type: azure:privatedns:ResolverForwardingRule
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 ResolverForwardingRuleArgs
    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 ResolverForwardingRuleArgs
    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 ResolverForwardingRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ResolverForwardingRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ResolverForwardingRuleArgs
    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 resolverForwardingRuleResource = new Azure.PrivateDns.ResolverForwardingRule("resolverForwardingRuleResource", new()
{
    DnsForwardingRulesetId = "string",
    DomainName = "string",
    TargetDnsServers = new[]
    {
        new Azure.PrivateDns.Inputs.ResolverForwardingRuleTargetDnsServerArgs
        {
            IpAddress = "string",
            Port = 0,
        },
    },
    Enabled = false,
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
});

    example, err := privatedns.NewResolverForwardingRule(ctx, "resolverForwardingRuleResource", &privatedns.ResolverForwardingRuleArgs{
	DnsForwardingRulesetId: pulumi.String("string"),
	DomainName:             pulumi.String("string"),
	TargetDnsServers: privatedns.ResolverForwardingRuleTargetDnsServerArray{
		&privatedns.ResolverForwardingRuleTargetDnsServerArgs{
			IpAddress: pulumi.String("string"),
			Port:      pulumi.Int(0),
		},
	},
	Enabled: pulumi.Bool(false),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var resolverForwardingRuleResource = new ResolverForwardingRule("resolverForwardingRuleResource", ResolverForwardingRuleArgs.builder()
    .dnsForwardingRulesetId("string")
    .domainName("string")
    .targetDnsServers(ResolverForwardingRuleTargetDnsServerArgs.builder()
        .ipAddress("string")
        .port(0)
        .build())
    .enabled(false)
    .metadata(Map.of("string", "string"))
    .name("string")
    .build());

    resolver_forwarding_rule_resource = azure.privatedns.ResolverForwardingRule("resolverForwardingRuleResource",
    dns_forwarding_ruleset_id="string",
    domain_name="string",
    target_dns_servers=[{
        "ip_address": "string",
        "port": 0,
    }],
    enabled=False,
    metadata={
        "string": "string",
    },
    name="string")

    const resolverForwardingRuleResource = new azure.privatedns.ResolverForwardingRule("resolverForwardingRuleResource", {
    dnsForwardingRulesetId: "string",
    domainName: "string",
    targetDnsServers: [{
        ipAddress: "string",
        port: 0,
    }],
    enabled: false,
    metadata: {
        string: "string",
    },
    name: "string",
});

    type: azure:privatedns:ResolverForwardingRule
properties:
    dnsForwardingRulesetId: string
    domainName: string
    enabled: false
    metadata:
        string: string
    name: string
    targetDnsServers:
        - ipAddress: string
          port: 0

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

    DnsForwardingRulesetId string
    Specifies the ID of the Private DNS Resolver Forwarding Ruleset. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    DomainName string
    Specifies the domain name for the Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    TargetDnsServers List<ResolverForwardingRuleTargetDnsServer>
    Can be specified multiple times to define multiple target DNS servers. Each target_dns_servers block as defined below.
    Enabled bool
    Specifies the state of the Private DNS Resolver Forwarding Rule. Defaults to true.
    Metadata Dictionary<string, string>
    Metadata attached to the Private DNS Resolver Forwarding Rule.
    Name string
    Specifies the name which should be used for this Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    DnsForwardingRulesetId string
    Specifies the ID of the Private DNS Resolver Forwarding Ruleset. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    DomainName string
    Specifies the domain name for the Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    TargetDnsServers []ResolverForwardingRuleTargetDnsServerArgs
    Can be specified multiple times to define multiple target DNS servers. Each target_dns_servers block as defined below.
    Enabled bool
    Specifies the state of the Private DNS Resolver Forwarding Rule. Defaults to true.
    Metadata map[string]string
    Metadata attached to the Private DNS Resolver Forwarding Rule.
    Name string
    Specifies the name which should be used for this Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    dnsForwardingRulesetId String
    Specifies the ID of the Private DNS Resolver Forwarding Ruleset. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    domainName String
    Specifies the domain name for the Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    targetDnsServers List<ResolverForwardingRuleTargetDnsServer>
    Can be specified multiple times to define multiple target DNS servers. Each target_dns_servers block as defined below.
    enabled Boolean
    Specifies the state of the Private DNS Resolver Forwarding Rule. Defaults to true.
    metadata Map<String,String>
    Metadata attached to the Private DNS Resolver Forwarding Rule.
    name String
    Specifies the name which should be used for this Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    dnsForwardingRulesetId string
    Specifies the ID of the Private DNS Resolver Forwarding Ruleset. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    domainName string
    Specifies the domain name for the Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    targetDnsServers ResolverForwardingRuleTargetDnsServer[]
    Can be specified multiple times to define multiple target DNS servers. Each target_dns_servers block as defined below.
    enabled boolean
    Specifies the state of the Private DNS Resolver Forwarding Rule. Defaults to true.
    metadata {[key: string]: string}
    Metadata attached to the Private DNS Resolver Forwarding Rule.
    name string
    Specifies the name which should be used for this Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    dns_forwarding_ruleset_id str
    Specifies the ID of the Private DNS Resolver Forwarding Ruleset. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    domain_name str
    Specifies the domain name for the Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    target_dns_servers Sequence[ResolverForwardingRuleTargetDnsServerArgs]
    Can be specified multiple times to define multiple target DNS servers. Each target_dns_servers block as defined below.
    enabled bool
    Specifies the state of the Private DNS Resolver Forwarding Rule. Defaults to true.
    metadata Mapping[str, str]
    Metadata attached to the Private DNS Resolver Forwarding Rule.
    name str
    Specifies the name which should be used for this Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    dnsForwardingRulesetId String
    Specifies the ID of the Private DNS Resolver Forwarding Ruleset. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    domainName String
    Specifies the domain name for the Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    targetDnsServers List<Property Map>
    Can be specified multiple times to define multiple target DNS servers. Each target_dns_servers block as defined below.
    enabled Boolean
    Specifies the state of the Private DNS Resolver Forwarding Rule. Defaults to true.
    metadata Map<String>
    Metadata attached to the Private DNS Resolver Forwarding Rule.
    name String
    Specifies the name which should be used for this Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ResolverForwardingRule Resource

    Get an existing ResolverForwardingRule 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?: ResolverForwardingRuleState, opts?: CustomResourceOptions): ResolverForwardingRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dns_forwarding_ruleset_id: Optional[str] = None,
        domain_name: Optional[str] = None,
        enabled: Optional[bool] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        target_dns_servers: Optional[Sequence[ResolverForwardingRuleTargetDnsServerArgs]] = None) -> ResolverForwardingRule
    func GetResolverForwardingRule(ctx *Context, name string, id IDInput, state *ResolverForwardingRuleState, opts ...ResourceOption) (*ResolverForwardingRule, error)
    public static ResolverForwardingRule Get(string name, Input<string> id, ResolverForwardingRuleState? state, CustomResourceOptions? opts = null)
    public static ResolverForwardingRule get(String name, Output<String> id, ResolverForwardingRuleState state, CustomResourceOptions options)
    resources:  _:    type: azure:privatedns:ResolverForwardingRule    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:
    DnsForwardingRulesetId string
    Specifies the ID of the Private DNS Resolver Forwarding Ruleset. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    DomainName string
    Specifies the domain name for the Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    Enabled bool
    Specifies the state of the Private DNS Resolver Forwarding Rule. Defaults to true.
    Metadata Dictionary<string, string>
    Metadata attached to the Private DNS Resolver Forwarding Rule.
    Name string
    Specifies the name which should be used for this Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    TargetDnsServers List<ResolverForwardingRuleTargetDnsServer>
    Can be specified multiple times to define multiple target DNS servers. Each target_dns_servers block as defined below.
    DnsForwardingRulesetId string
    Specifies the ID of the Private DNS Resolver Forwarding Ruleset. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    DomainName string
    Specifies the domain name for the Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    Enabled bool
    Specifies the state of the Private DNS Resolver Forwarding Rule. Defaults to true.
    Metadata map[string]string
    Metadata attached to the Private DNS Resolver Forwarding Rule.
    Name string
    Specifies the name which should be used for this Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    TargetDnsServers []ResolverForwardingRuleTargetDnsServerArgs
    Can be specified multiple times to define multiple target DNS servers. Each target_dns_servers block as defined below.
    dnsForwardingRulesetId String
    Specifies the ID of the Private DNS Resolver Forwarding Ruleset. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    domainName String
    Specifies the domain name for the Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    enabled Boolean
    Specifies the state of the Private DNS Resolver Forwarding Rule. Defaults to true.
    metadata Map<String,String>
    Metadata attached to the Private DNS Resolver Forwarding Rule.
    name String
    Specifies the name which should be used for this Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    targetDnsServers List<ResolverForwardingRuleTargetDnsServer>
    Can be specified multiple times to define multiple target DNS servers. Each target_dns_servers block as defined below.
    dnsForwardingRulesetId string
    Specifies the ID of the Private DNS Resolver Forwarding Ruleset. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    domainName string
    Specifies the domain name for the Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    enabled boolean
    Specifies the state of the Private DNS Resolver Forwarding Rule. Defaults to true.
    metadata {[key: string]: string}
    Metadata attached to the Private DNS Resolver Forwarding Rule.
    name string
    Specifies the name which should be used for this Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    targetDnsServers ResolverForwardingRuleTargetDnsServer[]
    Can be specified multiple times to define multiple target DNS servers. Each target_dns_servers block as defined below.
    dns_forwarding_ruleset_id str
    Specifies the ID of the Private DNS Resolver Forwarding Ruleset. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    domain_name str
    Specifies the domain name for the Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    enabled bool
    Specifies the state of the Private DNS Resolver Forwarding Rule. Defaults to true.
    metadata Mapping[str, str]
    Metadata attached to the Private DNS Resolver Forwarding Rule.
    name str
    Specifies the name which should be used for this Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    target_dns_servers Sequence[ResolverForwardingRuleTargetDnsServerArgs]
    Can be specified multiple times to define multiple target DNS servers. Each target_dns_servers block as defined below.
    dnsForwardingRulesetId String
    Specifies the ID of the Private DNS Resolver Forwarding Ruleset. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    domainName String
    Specifies the domain name for the Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    enabled Boolean
    Specifies the state of the Private DNS Resolver Forwarding Rule. Defaults to true.
    metadata Map<String>
    Metadata attached to the Private DNS Resolver Forwarding Rule.
    name String
    Specifies the name which should be used for this Private DNS Resolver Forwarding Rule. Changing this forces a new Private DNS Resolver Forwarding Rule to be created.
    targetDnsServers List<Property Map>
    Can be specified multiple times to define multiple target DNS servers. Each target_dns_servers block as defined below.

    Supporting Types

    ResolverForwardingRuleTargetDnsServer, ResolverForwardingRuleTargetDnsServerArgs

    IpAddress string
    DNS server IP address.
    Port int
    DNS server port.
    IpAddress string
    DNS server IP address.
    Port int
    DNS server port.
    ipAddress String
    DNS server IP address.
    port Integer
    DNS server port.
    ipAddress string
    DNS server IP address.
    port number
    DNS server port.
    ip_address str
    DNS server IP address.
    port int
    DNS server port.
    ipAddress String
    DNS server IP address.
    port Number
    DNS server port.

    Import

    Private DNS Resolver Forwarding Rules can be imported using the resource id, e.g.

    $ pulumi import azure:privatedns/resolverForwardingRule:ResolverForwardingRule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Network/dnsForwardingRulesets/dnsForwardingRuleset1/forwardingRules/forwardingRule1

    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.

    Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-azure