Zone
Enables you to manage Private DNS zones within Azure DNS. These zones are hosted on Azure’s name servers.
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,
});
}
}
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
}
_, err = privatedns.NewZone(ctx, "exampleZone", &privatedns.ZoneArgs{
ResourceGroupName: exampleResourceGroup.Name,
})
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)
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});
Create a Zone Resource
new Zone(name: string, args: ZoneArgs, opts?: CustomResourceOptions);
@overload
def Zone(resource_name: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = None,
resource_group_name: Optional[str] = None,
soa_record: Optional[ZoneSoaRecordArgs] = None,
tags: Optional[Mapping[str, str]] = None)
@overload
def Zone(resource_name: str,
args: ZoneArgs,
opts: Optional[ResourceOptions] = None)
func NewZone(ctx *Context, name string, args ZoneArgs, opts ...ResourceOption) (*Zone, error)
public Zone(string name, ZoneArgs args, CustomResourceOptions? opts = null)
- 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.
Zone Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The Zone resource accepts the following input properties:
- Resource
Group stringName - Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
- Name string
- The name of the Private DNS Zone. Must be a valid domain name.
- Soa
Record ZoneSoa Record Args - An
soa_record
block as defined below. Changing this forces a new resource to be created. - Dictionary<string, string>
- A mapping of tags to assign to the Record Set.
- Resource
Group stringName - Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
- Name string
- The name of the Private DNS Zone. Must be a valid domain name.
- Soa
Record ZoneSoa Record - An
soa_record
block as defined below. Changing this forces a new resource to be created. - map[string]string
- A mapping of tags to assign to the Record Set.
- resource
Group stringName - Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
- name string
- The name of the Private DNS Zone. Must be a valid domain name.
- soa
Record ZoneSoa Record Args - An
soa_record
block as defined below. Changing this forces a new resource to be created. - {[key: string]: string}
- A mapping of tags to assign to the Record Set.
- resource_
group_ strname - Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
- name str
- The name of the Private DNS Zone. Must be a valid domain name.
- soa_
record ZoneSoa Record Args - An
soa_record
block as defined below. Changing this forces a new resource to be created. - Mapping[str, str]
- A mapping of tags to assign to the Record Set.
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.
- Max
Number intOf Record Sets - The maximum number of record sets that can be created in this Private DNS zone.
- Max
Number intOf Virtual Network Links - The maximum number of virtual networks that can be linked to this Private DNS zone.
- Max
Number intOf Virtual Network Links With Registration - The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled.
- Number
Of intRecord Sets - The current number of record sets in this Private DNS zone.
- Id string
- The provider-assigned unique ID for this managed resource.
- Max
Number intOf Record Sets - The maximum number of record sets that can be created in this Private DNS zone.
- Max
Number intOf Virtual Network Links - The maximum number of virtual networks that can be linked to this Private DNS zone.
- Max
Number intOf Virtual Network Links With Registration - The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled.
- Number
Of intRecord Sets - The current number of record sets in this Private DNS zone.
- id string
- The provider-assigned unique ID for this managed resource.
- max
Number numberOf Record Sets - The maximum number of record sets that can be created in this Private DNS zone.
- max
Number numberOf Virtual Network Links - The maximum number of virtual networks that can be linked to this Private DNS zone.
- max
Number numberOf Virtual Network Links With Registration - The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled.
- number
Of numberRecord Sets - The current number of record sets in this Private DNS zone.
- id str
- The provider-assigned unique ID for this managed resource.
- max_
number_ intof_ record_ sets - The maximum number of record sets that can be created in this Private DNS zone.
- max_
number_ intof_ virtual_ network_ links - The maximum number of virtual networks that can be linked to this Private DNS zone.
- max_
number_ intof_ virtual_ network_ links_ with_ registration - The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled.
- number_
of_ intrecord_ sets - The current number of record sets in this Private DNS zone.
Look up an Existing Zone Resource
Get an existing Zone 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?: ZoneState, opts?: CustomResourceOptions): Zone
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
max_number_of_record_sets: Optional[int] = None,
max_number_of_virtual_network_links: Optional[int] = None,
max_number_of_virtual_network_links_with_registration: Optional[int] = None,
name: Optional[str] = None,
number_of_record_sets: Optional[int] = None,
resource_group_name: Optional[str] = None,
soa_record: Optional[ZoneSoaRecordArgs] = None,
tags: Optional[Mapping[str, str]] = None) -> Zone
func GetZone(ctx *Context, name string, id IDInput, state *ZoneState, opts ...ResourceOption) (*Zone, error)
public static Zone Get(string name, Input<string> id, ZoneState? 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:
- Max
Number intOf Record Sets - The maximum number of record sets that can be created in this Private DNS zone.
- Max
Number intOf Virtual Network Links - The maximum number of virtual networks that can be linked to this Private DNS zone.
- Max
Number intOf Virtual Network Links With Registration - The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled.
- Name string
- The name of the Private DNS Zone. Must be a valid domain name.
- Number
Of intRecord Sets - The current number of record sets in this Private DNS zone.
- Resource
Group stringName - Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
- Soa
Record ZoneSoa Record Args - An
soa_record
block as defined below. Changing this forces a new resource to be created. - Dictionary<string, string>
- A mapping of tags to assign to the Record Set.
- Max
Number intOf Record Sets - The maximum number of record sets that can be created in this Private DNS zone.
- Max
Number intOf Virtual Network Links - The maximum number of virtual networks that can be linked to this Private DNS zone.
- Max
Number intOf Virtual Network Links With Registration - The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled.
- Name string
- The name of the Private DNS Zone. Must be a valid domain name.
- Number
Of intRecord Sets - The current number of record sets in this Private DNS zone.
- Resource
Group stringName - Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
- Soa
Record ZoneSoa Record - An
soa_record
block as defined below. Changing this forces a new resource to be created. - map[string]string
- A mapping of tags to assign to the Record Set.
- max
Number numberOf Record Sets - The maximum number of record sets that can be created in this Private DNS zone.
- max
Number numberOf Virtual Network Links - The maximum number of virtual networks that can be linked to this Private DNS zone.
- max
Number numberOf Virtual Network Links With Registration - The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled.
- name string
- The name of the Private DNS Zone. Must be a valid domain name.
- number
Of numberRecord Sets - The current number of record sets in this Private DNS zone.
- resource
Group stringName - Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
- soa
Record ZoneSoa Record Args - An
soa_record
block as defined below. Changing this forces a new resource to be created. - {[key: string]: string}
- A mapping of tags to assign to the Record Set.
- max_
number_ intof_ record_ sets - The maximum number of record sets that can be created in this Private DNS zone.
- max_
number_ intof_ virtual_ network_ links - The maximum number of virtual networks that can be linked to this Private DNS zone.
- max_
number_ intof_ virtual_ network_ links_ with_ registration - The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled.
- name str
- The name of the Private DNS Zone. Must be a valid domain name.
- number_
of_ intrecord_ sets - The current number of record sets in this Private DNS zone.
- resource_
group_ strname - Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
- soa_
record ZoneSoa Record Args - An
soa_record
block as defined below. Changing this forces a new resource to be created. - Mapping[str, str]
- A mapping of tags to assign to the Record Set.
Supporting Types
ZoneSoaRecord
- Email string
- The email contact for the SOA record.
- Expire
Time int - The expire time for the SOA record. Defaults to
2419200
. - Fqdn string
- The fully qualified domain name of the Record Set.
- Host
Name string - The domain name of the authoritative name server for the SOA record.
- Minimum
Ttl int - The minimum Time To Live for the SOA record. By convention, it is used to determine the negative caching duration. Defaults to
10
. - Refresh
Time int - The refresh time for the SOA record. Defaults to
3600
. - Retry
Time int - The retry time for the SOA record. Defaults to
300
. - Serial
Number int - The serial number for the SOA record.
- Dictionary<string, string>
- A mapping of tags to assign to the Record Set.
- Ttl int
- The Time To Live of the SOA Record in seconds. Defaults to
3600
.
- Email string
- The email contact for the SOA record.
- Expire
Time int - The expire time for the SOA record. Defaults to
2419200
. - Fqdn string
- The fully qualified domain name of the Record Set.
- Host
Name string - The domain name of the authoritative name server for the SOA record.
- Minimum
Ttl int - The minimum Time To Live for the SOA record. By convention, it is used to determine the negative caching duration. Defaults to
10
. - Refresh
Time int - The refresh time for the SOA record. Defaults to
3600
. - Retry
Time int - The retry time for the SOA record. Defaults to
300
. - Serial
Number int - The serial number for the SOA record.
- map[string]string
- A mapping of tags to assign to the Record Set.
- Ttl int
- The Time To Live of the SOA Record in seconds. Defaults to
3600
.
- email string
- The email contact for the SOA record.
- expire
Time number - The expire time for the SOA record. Defaults to
2419200
. - fqdn string
- The fully qualified domain name of the Record Set.
- host
Name string - The domain name of the authoritative name server for the SOA record.
- minimum
Ttl number - The minimum Time To Live for the SOA record. By convention, it is used to determine the negative caching duration. Defaults to
10
. - refresh
Time number - The refresh time for the SOA record. Defaults to
3600
. - retry
Time number - The retry time for the SOA record. Defaults to
300
. - serial
Number number - The serial number for the SOA record.
- {[key: string]: string}
- A mapping of tags to assign to the Record Set.
- ttl number
- The Time To Live of the SOA Record in seconds. Defaults to
3600
.
- email str
- The email contact for the SOA record.
- expire_
time int - The expire time for the SOA record. Defaults to
2419200
. - fqdn str
- The fully qualified domain name of the Record Set.
- host_
name str - The domain name of the authoritative name server for the SOA record.
- minimum_
ttl int - The minimum Time To Live for the SOA record. By convention, it is used to determine the negative caching duration. Defaults to
10
. - refresh_
time int - The refresh time for the SOA record. Defaults to
3600
. - retry_
time int - The retry time for the SOA record. Defaults to
300
. - serial_
number int - The serial number for the SOA record.
- Mapping[str, str]
- A mapping of tags to assign to the Record Set.
- ttl int
- The Time To Live of the SOA Record in seconds. Defaults to
3600
.
Import
Private DNS Zones can be imported using the resource id
, e.g.
$ pulumi import azure:privatedns/zone:Zone zone1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/privateDnsZones/zone1
Package Details
- Repository
- https://github.com/pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.