ZoneVirtualNetworkLink

Enables you to manage Private DNS zone Virtual Network Links. These Links enable DNS resolution and registration inside Azure Virtual Networks using 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 exampleZoneVirtualNetworkLink = new Azure.PrivateDns.ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink", new Azure.PrivateDns.ZoneVirtualNetworkLinkArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            PrivateDnsZoneName = exampleZone.Name,
            VirtualNetworkId = azurerm_virtual_network.Example.Id,
        });
    }

}
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.NewZoneVirtualNetworkLink(ctx, "exampleZoneVirtualNetworkLink", &privatedns.ZoneVirtualNetworkLinkArgs{
			ResourceGroupName:  exampleResourceGroup.Name,
			PrivateDnsZoneName: exampleZone.Name,
			VirtualNetworkId:   pulumi.Any(azurerm_virtual_network.Example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_zone = azure.privatedns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_zone_virtual_network_link = azure.privatedns.ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink",
    resource_group_name=example_resource_group.name,
    private_dns_zone_name=example_zone.name,
    virtual_network_id=azurerm_virtual_network["example"]["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.privatedns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const exampleZoneVirtualNetworkLink = new azure.privatedns.ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink", {
    resourceGroupName: exampleResourceGroup.name,
    privateDnsZoneName: exampleZone.name,
    virtualNetworkId: azurerm_virtual_network.example.id,
});

Create a ZoneVirtualNetworkLink Resource

new ZoneVirtualNetworkLink(name: string, args: ZoneVirtualNetworkLinkArgs, opts?: CustomResourceOptions);
@overload
def ZoneVirtualNetworkLink(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           name: Optional[str] = None,
                           private_dns_zone_name: Optional[str] = None,
                           registration_enabled: Optional[bool] = None,
                           resource_group_name: Optional[str] = None,
                           tags: Optional[Mapping[str, str]] = None,
                           virtual_network_id: Optional[str] = None)
@overload
def ZoneVirtualNetworkLink(resource_name: str,
                           args: ZoneVirtualNetworkLinkArgs,
                           opts: Optional[ResourceOptions] = None)
func NewZoneVirtualNetworkLink(ctx *Context, name string, args ZoneVirtualNetworkLinkArgs, opts ...ResourceOption) (*ZoneVirtualNetworkLink, error)
public ZoneVirtualNetworkLink(string name, ZoneVirtualNetworkLinkArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ZoneVirtualNetworkLinkArgs
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 ZoneVirtualNetworkLinkArgs
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 ZoneVirtualNetworkLinkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ZoneVirtualNetworkLinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

ZoneVirtualNetworkLink Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ZoneVirtualNetworkLink resource accepts the following input properties:

PrivateDnsZoneName string
The name of the Private DNS zone (without a terminating dot). Changing this forces a new resource to be created.
ResourceGroupName string
Specifies the resource group where the Private DNS Zone exists. Changing this forces a new resource to be created.
VirtualNetworkId string
The ID of the Virtual Network that should be linked to the DNS Zone. Changing this forces a new resource to be created.
Name string
The name of the Private DNS Zone Virtual Network Link. Changing this forces a new resource to be created.
RegistrationEnabled bool
Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled? Defaults to false.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
PrivateDnsZoneName string
The name of the Private DNS zone (without a terminating dot). Changing this forces a new resource to be created.
ResourceGroupName string
Specifies the resource group where the Private DNS Zone exists. Changing this forces a new resource to be created.
VirtualNetworkId string
The ID of the Virtual Network that should be linked to the DNS Zone. Changing this forces a new resource to be created.
Name string
The name of the Private DNS Zone Virtual Network Link. Changing this forces a new resource to be created.
RegistrationEnabled bool
Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled? Defaults to false.
Tags map[string]string
A mapping of tags to assign to the resource.
privateDnsZoneName string
The name of the Private DNS zone (without a terminating dot). Changing this forces a new resource to be created.
resourceGroupName string
Specifies the resource group where the Private DNS Zone exists. Changing this forces a new resource to be created.
virtualNetworkId string
The ID of the Virtual Network that should be linked to the DNS Zone. Changing this forces a new resource to be created.
name string
The name of the Private DNS Zone Virtual Network Link. Changing this forces a new resource to be created.
registrationEnabled boolean
Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled? Defaults to false.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
private_dns_zone_name str
The name of the Private DNS zone (without a terminating dot). Changing this forces a new resource to be created.
resource_group_name str
Specifies the resource group where the Private DNS Zone exists. Changing this forces a new resource to be created.
virtual_network_id str
The ID of the Virtual Network that should be linked to the DNS Zone. Changing this forces a new resource to be created.
name str
The name of the Private DNS Zone Virtual Network Link. Changing this forces a new resource to be created.
registration_enabled bool
Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled? Defaults to false.
tags Mapping[str, str]
A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the ZoneVirtualNetworkLink 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing ZoneVirtualNetworkLink Resource

Get an existing ZoneVirtualNetworkLink 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?: ZoneVirtualNetworkLinkState, opts?: CustomResourceOptions): ZoneVirtualNetworkLink
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        private_dns_zone_name: Optional[str] = None,
        registration_enabled: Optional[bool] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        virtual_network_id: Optional[str] = None) -> ZoneVirtualNetworkLink
func GetZoneVirtualNetworkLink(ctx *Context, name string, id IDInput, state *ZoneVirtualNetworkLinkState, opts ...ResourceOption) (*ZoneVirtualNetworkLink, error)
public static ZoneVirtualNetworkLink Get(string name, Input<string> id, ZoneVirtualNetworkLinkState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Name string
The name of the Private DNS Zone Virtual Network Link. Changing this forces a new resource to be created.
PrivateDnsZoneName string
The name of the Private DNS zone (without a terminating dot). Changing this forces a new resource to be created.
RegistrationEnabled bool
Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled? Defaults to false.
ResourceGroupName string
Specifies the resource group where the Private DNS Zone exists. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
VirtualNetworkId string
The ID of the Virtual Network that should be linked to the DNS Zone. Changing this forces a new resource to be created.
Name string
The name of the Private DNS Zone Virtual Network Link. Changing this forces a new resource to be created.
PrivateDnsZoneName string
The name of the Private DNS zone (without a terminating dot). Changing this forces a new resource to be created.
RegistrationEnabled bool
Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled? Defaults to false.
ResourceGroupName string
Specifies the resource group where the Private DNS Zone exists. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
VirtualNetworkId string
The ID of the Virtual Network that should be linked to the DNS Zone. Changing this forces a new resource to be created.
name string
The name of the Private DNS Zone Virtual Network Link. Changing this forces a new resource to be created.
privateDnsZoneName string
The name of the Private DNS zone (without a terminating dot). Changing this forces a new resource to be created.
registrationEnabled boolean
Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled? Defaults to false.
resourceGroupName string
Specifies the resource group where the Private DNS Zone exists. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
virtualNetworkId string
The ID of the Virtual Network that should be linked to the DNS Zone. Changing this forces a new resource to be created.
name str
The name of the Private DNS Zone Virtual Network Link. Changing this forces a new resource to be created.
private_dns_zone_name str
The name of the Private DNS zone (without a terminating dot). Changing this forces a new resource to be created.
registration_enabled bool
Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled? Defaults to false.
resource_group_name str
Specifies the resource group where the Private DNS Zone exists. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
virtual_network_id str
The ID of the Virtual Network that should be linked to the DNS Zone. Changing this forces a new resource to be created.

Import

Private DNS Zone Virtual Network Links can be imported using the resource id, e.g.

 $ pulumi import azure:privatedns/zoneVirtualNetworkLink:ZoneVirtualNetworkLink link1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/privateDnsZones/zone1.com/virtualNetworkLinks/myVnetLink1

Package Details

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