Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. PrivateZone
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.PrivateZone

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Describes a Private DNS zone. Azure REST API version: 2020-06-01. Prior API version in Azure Native 1.x: 2020-06-01.

    Other available API versions: 2024-06-01.

    Example Usage

    PUT Private DNS Zone

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var privateZone = new AzureNative.Network.PrivateZone("privateZone", new()
    {
        Location = "Global",
        PrivateZoneName = "privatezone1.com",
        ResourceGroupName = "resourceGroup1",
        Tags = 
        {
            { "key1", "value1" },
        },
    });

});

    package main

import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewPrivateZone(ctx, "privateZone", &network.PrivateZoneArgs{
			Location:          pulumi.String("Global"),
			PrivateZoneName:   pulumi.String("privatezone1.com"),
			ResourceGroupName: pulumi.String("resourceGroup1"),
			Tags: pulumi.StringMap{
				"key1": pulumi.String("value1"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.PrivateZone;
import com.pulumi.azurenative.network.PrivateZoneArgs;
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 privateZone = new PrivateZone("privateZone", PrivateZoneArgs.builder()
            .location("Global")
            .privateZoneName("privatezone1.com")
            .resourceGroupName("resourceGroup1")
            .tags(Map.of("key1", "value1"))
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const privateZone = new azure_native.network.PrivateZone("privateZone", {
    location: "Global",
    privateZoneName: "privatezone1.com",
    resourceGroupName: "resourceGroup1",
    tags: {
        key1: "value1",
    },
});

    import pulumi
import pulumi_azure_native as azure_native

private_zone = azure_native.network.PrivateZone("privateZone",
    location="Global",
    private_zone_name="privatezone1.com",
    resource_group_name="resourceGroup1",
    tags={
        "key1": "value1",
    })

    resources:
  privateZone:
    type: azure-native:network:PrivateZone
    properties:
      location: Global
      privateZoneName: privatezone1.com
      resourceGroupName: resourceGroup1
      tags:
        key1: value1

    Create PrivateZone Resource

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

    Constructor syntax

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

@overload
def PrivateZone(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                resource_group_name: Optional[str] = None,
                location: Optional[str] = None,
                private_zone_name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
    func NewPrivateZone(ctx *Context, name string, args PrivateZoneArgs, opts ...ResourceOption) (*PrivateZone, error)
    public PrivateZone(string name, PrivateZoneArgs args, CustomResourceOptions? opts = null)
    public PrivateZone(String name, PrivateZoneArgs args)
public PrivateZone(String name, PrivateZoneArgs args, CustomResourceOptions options)

    type: azure-native:network:PrivateZone
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 PrivateZoneArgs
    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 PrivateZoneArgs
    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 PrivateZoneArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateZoneArgs
    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 privateZoneResource = new AzureNative.Network.PrivateZone("privateZoneResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    PrivateZoneName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := network.NewPrivateZone(ctx, "privateZoneResource", &network.PrivateZoneArgs{
	ResourceGroupName: pulumi.String("string"),
	Location:          pulumi.String("string"),
	PrivateZoneName:   pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var privateZoneResource = new PrivateZone("privateZoneResource", PrivateZoneArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .privateZoneName("string")
    .tags(Map.of("string", "string"))
    .build());

    private_zone_resource = azure_native.network.PrivateZone("privateZoneResource",
    resource_group_name="string",
    location="string",
    private_zone_name="string",
    tags={
        "string": "string",
    })

    const privateZoneResource = new azure_native.network.PrivateZone("privateZoneResource", {
    resourceGroupName: "string",
    location: "string",
    privateZoneName: "string",
    tags: {
        string: "string",
    },
});

    type: azure-native:network:PrivateZone
properties:
    location: string
    privateZoneName: string
    resourceGroupName: string
    tags:
        string: string

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

    ResourceGroupName string
    The name of the resource group.
    Location string
    The Azure Region where the resource lives
    PrivateZoneName string
    The name of the Private DNS zone (without a terminating dot).
    Tags Dictionary<string, string>
    Resource tags.
    ResourceGroupName string
    The name of the resource group.
    Location string
    The Azure Region where the resource lives
    PrivateZoneName string
    The name of the Private DNS zone (without a terminating dot).
    Tags map[string]string
    Resource tags.
    resourceGroupName String
    The name of the resource group.
    location String
    The Azure Region where the resource lives
    privateZoneName String
    The name of the Private DNS zone (without a terminating dot).
    tags Map<String,String>
    Resource tags.
    resourceGroupName string
    The name of the resource group.
    location string
    The Azure Region where the resource lives
    privateZoneName string
    The name of the Private DNS zone (without a terminating dot).
    tags {[key: string]: string}
    Resource tags.
    resource_group_name str
    The name of the resource group.
    location str
    The Azure Region where the resource lives
    private_zone_name str
    The name of the Private DNS zone (without a terminating dot).
    tags Mapping[str, str]
    Resource tags.
    resourceGroupName String
    The name of the resource group.
    location String
    The Azure Region where the resource lives
    privateZoneName String
    The name of the Private DNS zone (without a terminating dot).
    tags Map<String>
    Resource tags.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    InternalId string
    Private zone internal Id
    MaxNumberOfRecordSets double
    The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    MaxNumberOfVirtualNetworkLinks double
    The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    MaxNumberOfVirtualNetworkLinksWithRegistration double
    The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    Name string
    The name of the resource
    NumberOfRecordSets double
    The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    NumberOfVirtualNetworkLinks double
    The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    NumberOfVirtualNetworkLinksWithRegistration double
    The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    ProvisioningState string
    The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.
    Type string
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    Etag string
    The ETag of the zone.
    Id string
    The provider-assigned unique ID for this managed resource.
    InternalId string
    Private zone internal Id
    MaxNumberOfRecordSets float64
    The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    MaxNumberOfVirtualNetworkLinks float64
    The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    MaxNumberOfVirtualNetworkLinksWithRegistration float64
    The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    Name string
    The name of the resource
    NumberOfRecordSets float64
    The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    NumberOfVirtualNetworkLinks float64
    The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    NumberOfVirtualNetworkLinksWithRegistration float64
    The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    ProvisioningState string
    The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.
    Type string
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    Etag string
    The ETag of the zone.
    id String
    The provider-assigned unique ID for this managed resource.
    internalId String
    Private zone internal Id
    maxNumberOfRecordSets Double
    The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    maxNumberOfVirtualNetworkLinks Double
    The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    maxNumberOfVirtualNetworkLinksWithRegistration Double
    The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    name String
    The name of the resource
    numberOfRecordSets Double
    The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    numberOfVirtualNetworkLinks Double
    The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    numberOfVirtualNetworkLinksWithRegistration Double
    The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    provisioningState String
    The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.
    type String
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    etag String
    The ETag of the zone.
    id string
    The provider-assigned unique ID for this managed resource.
    internalId string
    Private zone internal Id
    maxNumberOfRecordSets number
    The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    maxNumberOfVirtualNetworkLinks number
    The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    maxNumberOfVirtualNetworkLinksWithRegistration number
    The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    name string
    The name of the resource
    numberOfRecordSets number
    The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    numberOfVirtualNetworkLinks number
    The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    numberOfVirtualNetworkLinksWithRegistration number
    The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    provisioningState string
    The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.
    type string
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    etag string
    The ETag of the zone.
    id str
    The provider-assigned unique ID for this managed resource.
    internal_id str
    Private zone internal Id
    max_number_of_record_sets float
    The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    max_number_of_virtual_network_links float
    The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    max_number_of_virtual_network_links_with_registration float
    The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    name str
    The name of the resource
    number_of_record_sets float
    The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    number_of_virtual_network_links float
    The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    number_of_virtual_network_links_with_registration float
    The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    provisioning_state str
    The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.
    type str
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    etag str
    The ETag of the zone.
    id String
    The provider-assigned unique ID for this managed resource.
    internalId String
    Private zone internal Id
    maxNumberOfRecordSets Number
    The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    maxNumberOfVirtualNetworkLinks Number
    The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    maxNumberOfVirtualNetworkLinksWithRegistration Number
    The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    name String
    The name of the resource
    numberOfRecordSets Number
    The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    numberOfVirtualNetworkLinks Number
    The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    numberOfVirtualNetworkLinksWithRegistration Number
    The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    provisioningState String
    The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.
    type String
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    etag String
    The ETag of the zone.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:network:PrivateZone privatezone1.com /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native