Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. Zone
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.Zone

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 DNS zone. Azure REST API version: 2018-05-01. Prior API version in Azure Native 1.x: 2018-05-01.

    Other available API versions: 2023-07-01-preview.

    Example Usage

    Create zone

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

return await Deployment.RunAsync(() => 
{
    var zone = new AzureNative.Network.Zone("zone", new()
    {
        Location = "Global",
        ResourceGroupName = "rg1",
        Tags = 
        {
            { "key1", "value1" },
        },
        ZoneName = "zone1",
    });

});

    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.NewZone(ctx, "zone", &network.ZoneArgs{
			Location:          pulumi.String("Global"),
			ResourceGroupName: pulumi.String("rg1"),
			Tags: pulumi.StringMap{
				"key1": pulumi.String("value1"),
			},
			ZoneName: pulumi.String("zone1"),
		})
		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.Zone;
import com.pulumi.azurenative.network.ZoneArgs;
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 zone = new Zone("zone", ZoneArgs.builder()
            .location("Global")
            .resourceGroupName("rg1")
            .tags(Map.of("key1", "value1"))
            .zoneName("zone1")
            .build());

    }
}

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

const zone = new azure_native.network.Zone("zone", {
    location: "Global",
    resourceGroupName: "rg1",
    tags: {
        key1: "value1",
    },
    zoneName: "zone1",
});

    import pulumi
import pulumi_azure_native as azure_native

zone = azure_native.network.Zone("zone",
    location="Global",
    resource_group_name="rg1",
    tags={
        "key1": "value1",
    },
    zone_name="zone1")

    resources:
  zone:
    type: azure-native:network:Zone
    properties:
      location: Global
      resourceGroupName: rg1
      tags:
        key1: value1
      zoneName: zone1

    Create Zone Resource

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

    Constructor syntax

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

@overload
def Zone(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         resource_group_name: Optional[str] = None,
         location: Optional[str] = None,
         registration_virtual_networks: Optional[Sequence[SubResourceArgs]] = None,
         resolution_virtual_networks: Optional[Sequence[SubResourceArgs]] = None,
         tags: Optional[Mapping[str, str]] = None,
         zone_name: Optional[str] = None,
         zone_type: Optional[ZoneType] = None)
    func NewZone(ctx *Context, name string, args ZoneArgs, opts ...ResourceOption) (*Zone, error)
    public Zone(string name, ZoneArgs args, CustomResourceOptions? opts = null)
    public Zone(String name, ZoneArgs args)
public Zone(String name, ZoneArgs args, CustomResourceOptions options)

    type: azure-native:network:Zone
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 ZoneArgs
    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 ZoneArgs
    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 ZoneArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ZoneArgs
    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 zoneResource = new AzureNative.Network.Zone("zoneResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    RegistrationVirtualNetworks = new[]
    {
        new AzureNative.Network.Inputs.SubResourceArgs
        {
            Id = "string",
        },
    },
    ResolutionVirtualNetworks = new[]
    {
        new AzureNative.Network.Inputs.SubResourceArgs
        {
            Id = "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
    ZoneName = "string",
    ZoneType = AzureNative.Network.ZoneType.Public,
});

    example, err := network.NewZone(ctx, "zoneResource", &network.ZoneArgs{
	ResourceGroupName: pulumi.String("string"),
	Location:          pulumi.String("string"),
	RegistrationVirtualNetworks: network.SubResourceArray{
		&network.SubResourceArgs{
			Id: pulumi.String("string"),
		},
	},
	ResolutionVirtualNetworks: network.SubResourceArray{
		&network.SubResourceArgs{
			Id: pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ZoneName: pulumi.String("string"),
	ZoneType: network.ZoneTypePublic,
})

    var zoneResource = new Zone("zoneResource", ZoneArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .registrationVirtualNetworks(SubResourceArgs.builder()
        .id("string")
        .build())
    .resolutionVirtualNetworks(SubResourceArgs.builder()
        .id("string")
        .build())
    .tags(Map.of("string", "string"))
    .zoneName("string")
    .zoneType("Public")
    .build());

    zone_resource = azure_native.network.Zone("zoneResource",
    resource_group_name="string",
    location="string",
    registration_virtual_networks=[{
        "id": "string",
    }],
    resolution_virtual_networks=[{
        "id": "string",
    }],
    tags={
        "string": "string",
    },
    zone_name="string",
    zone_type=azure_native.network.ZoneType.PUBLIC)

    const zoneResource = new azure_native.network.Zone("zoneResource", {
    resourceGroupName: "string",
    location: "string",
    registrationVirtualNetworks: [{
        id: "string",
    }],
    resolutionVirtualNetworks: [{
        id: "string",
    }],
    tags: {
        string: "string",
    },
    zoneName: "string",
    zoneType: azure_native.network.ZoneType.Public,
});

    type: azure-native:network:Zone
properties:
    location: string
    registrationVirtualNetworks:
        - id: string
    resolutionVirtualNetworks:
        - id: string
    resourceGroupName: string
    tags:
        string: string
    zoneName: string
    zoneType: Public

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

    ResourceGroupName string
    The name of the resource group.
    Location string
    Resource location.
    RegistrationVirtualNetworks List<Pulumi.AzureNative.Network.Inputs.SubResource>
    A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.
    ResolutionVirtualNetworks List<Pulumi.AzureNative.Network.Inputs.SubResource>
    A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.
    Tags Dictionary<string, string>
    Resource tags.
    ZoneName string
    The name of the DNS zone (without a terminating dot).
    ZoneType Pulumi.AzureNative.Network.ZoneType
    The type of this DNS zone (Public or Private).
    ResourceGroupName string
    The name of the resource group.
    Location string
    Resource location.
    RegistrationVirtualNetworks []SubResourceArgs
    A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.
    ResolutionVirtualNetworks []SubResourceArgs
    A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.
    Tags map[string]string
    Resource tags.
    ZoneName string
    The name of the DNS zone (without a terminating dot).
    ZoneType ZoneType
    The type of this DNS zone (Public or Private).
    resourceGroupName String
    The name of the resource group.
    location String
    Resource location.
    registrationVirtualNetworks List<SubResource>
    A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.
    resolutionVirtualNetworks List<SubResource>
    A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.
    tags Map<String,String>
    Resource tags.
    zoneName String
    The name of the DNS zone (without a terminating dot).
    zoneType ZoneType
    The type of this DNS zone (Public or Private).
    resourceGroupName string
    The name of the resource group.
    location string
    Resource location.
    registrationVirtualNetworks SubResource[]
    A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.
    resolutionVirtualNetworks SubResource[]
    A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.
    tags {[key: string]: string}
    Resource tags.
    zoneName string
    The name of the DNS zone (without a terminating dot).
    zoneType ZoneType
    The type of this DNS zone (Public or Private).
    resource_group_name str
    The name of the resource group.
    location str
    Resource location.
    registration_virtual_networks Sequence[SubResourceArgs]
    A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.
    resolution_virtual_networks Sequence[SubResourceArgs]
    A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.
    tags Mapping[str, str]
    Resource tags.
    zone_name str
    The name of the DNS zone (without a terminating dot).
    zone_type ZoneType
    The type of this DNS zone (Public or Private).
    resourceGroupName String
    The name of the resource group.
    location String
    Resource location.
    registrationVirtualNetworks List<Property Map>
    A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.
    resolutionVirtualNetworks List<Property Map>
    A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.
    tags Map<String>
    Resource tags.
    zoneName String
    The name of the DNS zone (without a terminating dot).
    zoneType "Public" | "Private"
    The type of this DNS zone (Public or Private).

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    MaxNumberOfRecordSets double
    The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    MaxNumberOfRecordsPerRecordSet double
    The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    Name string
    Resource name.
    NameServers List<string>
    The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    NumberOfRecordSets double
    The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    Type string
    Resource type.
    Etag string
    The etag of the zone.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxNumberOfRecordSets float64
    The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    MaxNumberOfRecordsPerRecordSet float64
    The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    Name string
    Resource name.
    NameServers []string
    The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    NumberOfRecordSets float64
    The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    Type string
    Resource type.
    Etag string
    The etag of the zone.
    id String
    The provider-assigned unique ID for this managed resource.
    maxNumberOfRecordSets Double
    The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    maxNumberOfRecordsPerRecordSet Double
    The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    name String
    Resource name.
    nameServers List<String>
    The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    numberOfRecordSets Double
    The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    type String
    Resource type.
    etag String
    The etag of the zone.
    id string
    The provider-assigned unique ID for this managed resource.
    maxNumberOfRecordSets number
    The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    maxNumberOfRecordsPerRecordSet number
    The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    name string
    Resource name.
    nameServers string[]
    The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    numberOfRecordSets number
    The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    type string
    Resource type.
    etag string
    The etag of the zone.
    id str
    The provider-assigned unique ID for this managed resource.
    max_number_of_record_sets float
    The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    max_number_of_records_per_record_set float
    The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    name str
    Resource name.
    name_servers Sequence[str]
    The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    number_of_record_sets float
    The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    type str
    Resource type.
    etag str
    The etag of the zone.
    id String
    The provider-assigned unique ID for this managed resource.
    maxNumberOfRecordSets Number
    The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    maxNumberOfRecordsPerRecordSet Number
    The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    name String
    Resource name.
    nameServers List<String>
    The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    numberOfRecordSets Number
    The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    type String
    Resource type.
    etag String
    The etag of the zone.

    Supporting Types

    SubResource, SubResourceArgs

    Id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    Id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id String
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id str
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id String
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.

    SubResourceResponse, SubResourceResponseArgs

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    ZoneType, ZoneTypeArgs

    Public
    Public
    Private
    Private
    ZoneTypePublic
    Public
    ZoneTypePrivate
    Private
    Public
    Public
    Private
    Private
    Public
    Public
    Private
    Private
    PUBLIC
    Public
    PRIVATE
    Private
    "Public"
    Public
    "Private"
    Private

    Import

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

    $ pulumi import azure-native:network:Zone zone1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}

    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