This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

privatedns¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.privatedns.AAAARecord(resource_name, opts=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS AAAA Records within Azure Private DNS.

import pulumi
import pulumi_azure as azure

test_resource_group = azure.core.ResourceGroup("testResourceGroup", location="West US")
test_zone = azure.privatedns.Zone("testZone", resource_group_name=test_resource_group.name)
test_aaaa_record = azure.privatedns.AAAARecord("testAAAARecord",
    zone_name=test_zone.name,
    resource_group_name=test_resource_group.name,
    ttl=300,
    records=[
        "fd5d:70bc:930e:d008:0000:0000:0000:7334",
        "fd5d:70bc:930e:d008::7335",
    ])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS A Record.
records (pulumi.Input[list]) – A list of IPv6 Addresses.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
zone_name (pulumi.Input[str]) – Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS AAAA Record.

name: pulumi.Output[str] = None¶: The name of the DNS A Record.

records: pulumi.Output[list] = None¶: A list of IPv6 Addresses.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

zone_name: pulumi.Output[str] = None¶: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, fqdn=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None)¶

Get an existing AAAARecord resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS AAAA Record.
name (pulumi.Input[str]) – The name of the DNS A Record.
records (pulumi.Input[list]) – A list of IPv6 Addresses.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
zone_name (pulumi.Input[str]) – Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.privatedns.ARecord(resource_name, opts=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS A Records within Azure Private DNS.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.privatedns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_a_record = azure.privatedns.ARecord("exampleARecord",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.name,
    ttl=300,
    records=["10.0.180.17"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS A Record.
records (pulumi.Input[list]) – List of IPv4 Addresses.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
zone_name (pulumi.Input[str]) – Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS A Record.

name: pulumi.Output[str] = None¶: The name of the DNS A Record.

records: pulumi.Output[list] = None¶: List of IPv4 Addresses.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

zone_name: pulumi.Output[str] = None¶: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, fqdn=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None)¶

Get an existing ARecord resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS A Record.
name (pulumi.Input[str]) – The name of the DNS A Record.
records (pulumi.Input[list]) – List of IPv4 Addresses.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
zone_name (pulumi.Input[str]) – Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.privatedns.AwaitableGetDnsZoneResult(id=None, max_number_of_record_sets=None, max_number_of_virtual_network_links=None, max_number_of_virtual_network_links_with_registration=None, name=None, number_of_record_sets=None, resource_group_name=None, tags=None)¶

class pulumi_azure.privatedns.CnameRecord(resource_name, opts=None, name=None, record=None, resource_group_name=None, tags=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS CNAME Records within Azure Private DNS.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.privatedns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_cname_record = azure.privatedns.CnameRecord("exampleCnameRecord",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.name,
    ttl=300,
    record="contoso.com")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS CNAME Record.
record (pulumi.Input[str]) – The target of the CNAME.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
zone_name (pulumi.Input[str]) – Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS CNAME Record.

name: pulumi.Output[str] = None¶: The name of the DNS CNAME Record.

record: pulumi.Output[str] = None¶: The target of the CNAME.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

zone_name: pulumi.Output[str] = None¶: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, fqdn=None, name=None, record=None, resource_group_name=None, tags=None, ttl=None, zone_name=None)¶

Get an existing CnameRecord resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS CNAME Record.
name (pulumi.Input[str]) – The name of the DNS CNAME Record.
record (pulumi.Input[str]) – The target of the CNAME.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
zone_name (pulumi.Input[str]) – Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.privatedns.GetDnsZoneResult(id=None, max_number_of_record_sets=None, max_number_of_virtual_network_links=None, max_number_of_virtual_network_links_with_registration=None, name=None, number_of_record_sets=None, resource_group_name=None, tags=None)¶

A collection of values returned by getDnsZone.

id = None¶: The provider-assigned unique ID for this managed resource.

max_number_of_record_sets = None¶: Maximum number of recordsets that can be created in this Private Zone.

max_number_of_virtual_network_links = None¶: Maximum number of Virtual Networks that can be linked to this Private Zone.

max_number_of_virtual_network_links_with_registration = None¶: Maximum number of Virtual Networks that can be linked to this Private Zone with registration enabled.

number_of_record_sets = None¶: The number of recordsets currently in the zone.

tags = None¶: A mapping of tags for the zone.

class pulumi_azure.privatedns.LinkService(resource_name, opts=None, auto_approval_subscription_ids=None, enable_proxy_protocol=None, load_balancer_frontend_ip_configuration_ids=None, location=None, name=None, nat_ip_configurations=None, resource_group_name=None, tags=None, visibility_subscription_ids=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Private Link Service.

NOTE Private Link is now in GA.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    address_spaces=["10.5.0.0/16"])
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.5.1.0/24",
    enforce_private_link_service_network_policies=True)
example_public_ip = azure.network.PublicIp("examplePublicIp",
    sku="Standard",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Static")
example_load_balancer = azure.lb.LoadBalancer("exampleLoadBalancer",
    sku="Standard",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    frontend_ip_configuration=[{
        "name": example_public_ip.name,
        "public_ip_address_id": example_public_ip.id,
    }])
example_link_service = azure.privatedns.LinkService("exampleLinkService",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    auto_approval_subscription_ids=["00000000-0000-0000-0000-000000000000"],
    visibility_subscription_ids=["00000000-0000-0000-0000-000000000000"],
    load_balancer_frontend_ip_configuration_ids=[example_load_balancer.frontend_ip_configurations[0]["id"]],
    nat_ip_configuration=[
        {
            "name": "primary",
            "private_ip_address": "10.5.1.17",
            "privateIpAddressVersion": "IPv4",
            "subnet_id": example_subnet.id,
            "primary": True,
        },
        {
            "name": "secondary",
            "private_ip_address": "10.5.1.18",
            "privateIpAddressVersion": "IPv4",
            "subnet_id": example_subnet.id,
            "primary": False,
        },
    ])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
auto_approval_subscription_ids (pulumi.Input[list]) – A list of Subscription UUID/GUID’s that will be automatically be able to use this Private Link Service.
enable_proxy_protocol (pulumi.Input[bool]) – Should the Private Link Service support the Proxy Protocol? Defaults to false.
load_balancer_frontend_ip_configuration_ids (pulumi.Input[list]) – A list of Frontend IP Configuration ID’s from a Standard Load Balancer, where traffic from the Private Link Service should be routed. You can use Load Balancer Rules to direct this traffic to appropriate backend pools where your applications are running.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of this Private Link Service. Changing this forces a new resource to be created.
nat_ip_configurations (pulumi.Input[list]) – One or more (up to 8) nat_ip_configuration block as defined below.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group where the Private Link Service should exist. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
visibility_subscription_ids (pulumi.Input[list]) – A list of Subscription UUID/GUID’s that will be able to see this Private Link Service.

The nat_ip_configurations object supports the following:

name (pulumi.Input[str]) - Specifies the name which should be used for the NAT IP Configuration. Changing this forces a new resource to be created.
primary (pulumi.Input[bool]) - Is this is the Primary IP Configuration? Changing this forces a new resource to be created.
private_ip_address (pulumi.Input[str]) - Specifies a Private Static IP Address for this IP Configuration.
privateIpAddressVersion (pulumi.Input[str]) - The version of the IP Protocol which should be used. At this time the only supported value is IPv4. Defaults to IPv4.
subnet_id (pulumi.Input[str]) - Specifies the ID of the Subnet which should be used for the Private Link Service.

alias: pulumi.Output[str] = None¶: A globally unique DNS Name for your Private Link Service. You can use this alias to request a connection to your Private Link Service.

auto_approval_subscription_ids: pulumi.Output[list] = None¶: A list of Subscription UUID/GUID’s that will be automatically be able to use this Private Link Service.

enable_proxy_protocol: pulumi.Output[bool] = None¶: Should the Private Link Service support the Proxy Protocol? Defaults to false.

load_balancer_frontend_ip_configuration_ids: pulumi.Output[list] = None¶: A list of Frontend IP Configuration ID’s from a Standard Load Balancer, where traffic from the Private Link Service should be routed. You can use Load Balancer Rules to direct this traffic to appropriate backend pools where your applications are running.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of this Private Link Service. Changing this forces a new resource to be created.

nat_ip_configurations: pulumi.Output[list] = None¶

One or more (up to 8) nat_ip_configuration block as defined below.

name (str) - Specifies the name which should be used for the NAT IP Configuration. Changing this forces a new resource to be created.
primary (bool) - Is this is the Primary IP Configuration? Changing this forces a new resource to be created.
private_ip_address (str) - Specifies a Private Static IP Address for this IP Configuration.
privateIpAddressVersion (str) - The version of the IP Protocol which should be used. At this time the only supported value is IPv4. Defaults to IPv4.
subnet_id (str) - Specifies the ID of the Subnet which should be used for the Private Link Service.

resource_group_name: pulumi.Output[str] = None¶: The name of the Resource Group where the Private Link Service should exist. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

visibility_subscription_ids: pulumi.Output[list] = None¶: A list of Subscription UUID/GUID’s that will be able to see this Private Link Service.

static get(resource_name, id, opts=None, alias=None, auto_approval_subscription_ids=None, enable_proxy_protocol=None, load_balancer_frontend_ip_configuration_ids=None, location=None, name=None, nat_ip_configurations=None, resource_group_name=None, tags=None, visibility_subscription_ids=None)¶

Get an existing LinkService resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
alias (pulumi.Input[str]) – A globally unique DNS Name for your Private Link Service. You can use this alias to request a connection to your Private Link Service.
auto_approval_subscription_ids (pulumi.Input[list]) – A list of Subscription UUID/GUID’s that will be automatically be able to use this Private Link Service.
enable_proxy_protocol (pulumi.Input[bool]) – Should the Private Link Service support the Proxy Protocol? Defaults to false.
load_balancer_frontend_ip_configuration_ids (pulumi.Input[list]) – A list of Frontend IP Configuration ID’s from a Standard Load Balancer, where traffic from the Private Link Service should be routed. You can use Load Balancer Rules to direct this traffic to appropriate backend pools where your applications are running.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of this Private Link Service. Changing this forces a new resource to be created.
nat_ip_configurations (pulumi.Input[list]) – One or more (up to 8) nat_ip_configuration block as defined below.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group where the Private Link Service should exist. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
visibility_subscription_ids (pulumi.Input[list]) – A list of Subscription UUID/GUID’s that will be able to see this Private Link Service.

The nat_ip_configurations object supports the following:

name (pulumi.Input[str]) - Specifies the name which should be used for the NAT IP Configuration. Changing this forces a new resource to be created.
primary (pulumi.Input[bool]) - Is this is the Primary IP Configuration? Changing this forces a new resource to be created.
private_ip_address (pulumi.Input[str]) - Specifies a Private Static IP Address for this IP Configuration.
privateIpAddressVersion (pulumi.Input[str]) - The version of the IP Protocol which should be used. At this time the only supported value is IPv4. Defaults to IPv4.
subnet_id (pulumi.Input[str]) - Specifies the ID of the Subnet which should be used for the Private Link Service.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.privatedns.MxRecord(resource_name, opts=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS MX Records within Azure Private DNS.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.privatedns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_mx_record = azure.privatedns.MxRecord("exampleMxRecord",
    resource_group_name=example_resource_group.name,
    zone_name=example_zone.name,
    ttl=300,
    record=[
        {
            "preference": 10,
            "exchange": "mx1.contoso.com",
        },
        {
            "preference": 20,
            "exchange": "backupmx.contoso.com",
        },
    ],
    tags={
        "Environment": "Production",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS MX Record. Changing this forces a new resource to be created. Default to ‘@’ for root zone entry.
records (pulumi.Input[list]) – One or more record blocks as defined below.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
zone_name (pulumi.Input[str]) – Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

The records object supports the following:

exchange (pulumi.Input[str]) - The FQDN of the exchange to MX record points to.
preference (pulumi.Input[float]) - The preference of the MX record.

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS MX Record.

name: pulumi.Output[str] = None¶: The name of the DNS MX Record. Changing this forces a new resource to be created. Default to ‘@’ for root zone entry.

records: pulumi.Output[list] = None¶

One or more record blocks as defined below.

exchange (str) - The FQDN of the exchange to MX record points to.
preference (float) - The preference of the MX record.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

zone_name: pulumi.Output[str] = None¶: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, fqdn=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None)¶

Get an existing MxRecord resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS MX Record.
name (pulumi.Input[str]) – The name of the DNS MX Record. Changing this forces a new resource to be created. Default to ‘@’ for root zone entry.
records (pulumi.Input[list]) – One or more record blocks as defined below.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
zone_name (pulumi.Input[str]) – Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

The records object supports the following:

exchange (pulumi.Input[str]) - The FQDN of the exchange to MX record points to.
preference (pulumi.Input[float]) - The preference of the MX record.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.privatedns.PTRRecord(resource_name, opts=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS PTR Records within Azure Private DNS.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.privatedns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_ptr_record = azure.privatedns.PTRRecord("examplePTRRecord",
    zone_name=example_zone.name,
    resource_group_name=example_resource_group.name,
    ttl=300,
    records=["test.example.com"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS PTR Record. Changing this forces a new resource to be created.
records (pulumi.Input[list]) – List of Fully Qualified Domain Names.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
zone_name (pulumi.Input[str]) – Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS PTR Record.

name: pulumi.Output[str] = None¶: The name of the DNS PTR Record. Changing this forces a new resource to be created.

records: pulumi.Output[list] = None¶: List of Fully Qualified Domain Names.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

zone_name: pulumi.Output[str] = None¶: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, fqdn=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None)¶

Get an existing PTRRecord resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS PTR Record.
name (pulumi.Input[str]) – The name of the DNS PTR Record. Changing this forces a new resource to be created.
records (pulumi.Input[list]) – List of Fully Qualified Domain Names.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
zone_name (pulumi.Input[str]) – Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.privatedns.SRVRecord(resource_name, opts=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS SRV Records within Azure Private DNS.

import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example", location="West US")
test_zone = azure.privatedns.Zone("testZone", resource_group_name=azurerm_resource_group["test"]["name"])
test_srv_record = azure.privatedns.SRVRecord("testSRVRecord",
    resource_group_name=azurerm_resource_group["test"]["name"],
    zone_name=test_zone.name,
    ttl=300,
    record=[
        {
            "priority": 1,
            "weight": 5,
            "port": 8080,
            "target": "target1.contoso.com",
        },
        {
            "priority": 10,
            "weight": 10,
            "port": 8080,
            "target": "target2.contoso.com",
        },
    ],
    tags={
        "Environment": "Production",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS SRV Record. Changing this forces a new resource to be created.
records (pulumi.Input[list]) – One or more record blocks as defined below.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
zone_name (pulumi.Input[str]) – Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

The records object supports the following:

port (pulumi.Input[float]) - The Port the service is listening on.
priority (pulumi.Input[float]) - The priority of the SRV record.
target (pulumi.Input[str]) - The FQDN of the service.
weight (pulumi.Input[float]) - The Weight of the SRV record.

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS SRV Record.

name: pulumi.Output[str] = None¶: The name of the DNS SRV Record. Changing this forces a new resource to be created.

records: pulumi.Output[list] = None¶

One or more record blocks as defined below.

port (float) - The Port the service is listening on.
priority (float) - The priority of the SRV record.
target (str) - The FQDN of the service.
weight (float) - The Weight of the SRV record.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

zone_name: pulumi.Output[str] = None¶: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, fqdn=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None)¶

Get an existing SRVRecord resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS SRV Record.
name (pulumi.Input[str]) – The name of the DNS SRV Record. Changing this forces a new resource to be created.
records (pulumi.Input[list]) – One or more record blocks as defined below.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
zone_name (pulumi.Input[str]) – Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

The records object supports the following:

port (pulumi.Input[float]) - The Port the service is listening on.
priority (pulumi.Input[float]) - The priority of the SRV record.
target (pulumi.Input[str]) - The FQDN of the service.
weight (pulumi.Input[float]) - The Weight of the SRV record.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.privatedns.TxtRecord(resource_name, opts=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage DNS TXT Records within Azure Private DNS.

import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example", location="West US")
test_zone = azure.privatedns.Zone("testZone", resource_group_name=azurerm_resource_group["test"]["name"])
test_txt_record = azure.privatedns.TxtRecord("testTxtRecord",
    resource_group_name=azurerm_resource_group["test"]["name"],
    zone_name=test_zone.name,
    ttl=300,
    record=[{
        "value": "v=spf1 mx ~all",
    }])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the DNS TXT Record. Changing this forces a new resource to be created.
records (pulumi.Input[list]) – One or more record blocks as defined below.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
zone_name (pulumi.Input[str]) – Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

The records object supports the following:

value (pulumi.Input[str]) - The value of the TXT record. Max length: 1024 characters

fqdn: pulumi.Output[str] = None¶: The FQDN of the DNS TXT Record.

name: pulumi.Output[str] = None¶: The name of the DNS TXT Record. Changing this forces a new resource to be created.

records: pulumi.Output[list] = None¶

One or more record blocks as defined below.

value (str) - The value of the TXT record. Max length: 1024 characters

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

zone_name: pulumi.Output[str] = None¶: Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, fqdn=None, name=None, records=None, resource_group_name=None, tags=None, ttl=None, zone_name=None)¶

Get an existing TxtRecord resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
fqdn (pulumi.Input[str]) – The FQDN of the DNS TXT Record.
name (pulumi.Input[str]) – The name of the DNS TXT Record. Changing this forces a new resource to be created.
records (pulumi.Input[list]) – One or more record blocks as defined below.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
zone_name (pulumi.Input[str]) – Specifies the Private DNS Zone where the resource exists. Changing this forces a new resource to be created.

The records object supports the following:

value (pulumi.Input[str]) - The value of the TXT record. Max length: 1024 characters

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.privatedns.Zone(resource_name, opts=None, name=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Enables you to manage Private DNS zones within Azure DNS. These zones are hosted on Azure’s name servers.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_zone = azure.privatedns.Zone("exampleZone", resource_group_name=example_resource_group.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the Private DNS Zone. Must be a valid domain name.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

max_number_of_record_sets: pulumi.Output[float] = None¶: The maximum number of record sets that can be created in this Private DNS zone.

max_number_of_virtual_network_links: pulumi.Output[float] = None¶: The maximum number of virtual networks that can be linked to this Private DNS zone.

max_number_of_virtual_network_links_with_registration: pulumi.Output[float] = None¶: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled.

name: pulumi.Output[str] = None¶: The name of the Private DNS Zone. Must be a valid domain name.

number_of_record_sets: pulumi.Output[float] = None¶: The current number of record sets in this Private DNS zone.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, max_number_of_record_sets=None, max_number_of_virtual_network_links=None, max_number_of_virtual_network_links_with_registration=None, name=None, number_of_record_sets=None, resource_group_name=None, tags=None)¶

Get an existing Zone resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
max_number_of_record_sets (pulumi.Input[float]) – The maximum number of record sets that can be created in this Private DNS zone.
max_number_of_virtual_network_links (pulumi.Input[float]) – The maximum number of virtual networks that can be linked to this Private DNS zone.
max_number_of_virtual_network_links_with_registration (pulumi.Input[float]) – The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled.
name (pulumi.Input[str]) – The name of the Private DNS Zone. Must be a valid domain name.
number_of_record_sets (pulumi.Input[float]) – The current number of record sets in this Private DNS zone.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.privatedns.ZoneVirtualNetworkLink(resource_name, opts=None, name=None, private_dns_zone_name=None, registration_enabled=None, resource_group_name=None, tags=None, virtual_network_id=None, __props__=None, __name__=None, __opts__=None)¶

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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
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"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the Private DNS Zone Virtual Network Link. Changing this forces a new resource to be created.
private_dns_zone_name (pulumi.Input[str]) – The name of the Private DNS zone (without a terminating dot). Changing this forces a new resource to be created.
registration_enabled (pulumi.Input[bool]) – Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled? Defaults to false.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
virtual_network_id (pulumi.Input[str]) – The Resource ID of the Virtual Network that should be linked to the DNS Zone. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the Private DNS Zone Virtual Network Link. Changing this forces a new resource to be created.

private_dns_zone_name: pulumi.Output[str] = None¶: The name of the Private DNS zone (without a terminating dot). Changing this forces a new resource to be created.

registration_enabled: pulumi.Output[bool] = None¶: Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled? Defaults to false.

resource_group_name: pulumi.Output[str] = None¶: Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

virtual_network_id: pulumi.Output[str] = None¶: The Resource ID of the Virtual Network that should be linked to the DNS Zone. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, name=None, private_dns_zone_name=None, registration_enabled=None, resource_group_name=None, tags=None, virtual_network_id=None)¶

Get an existing ZoneVirtualNetworkLink resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the Private DNS Zone Virtual Network Link. Changing this forces a new resource to be created.
private_dns_zone_name (pulumi.Input[str]) – The name of the Private DNS zone (without a terminating dot). Changing this forces a new resource to be created.
registration_enabled (pulumi.Input[bool]) – Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled? Defaults to false.
resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
virtual_network_id (pulumi.Input[str]) – The Resource ID of the Virtual Network that should be linked to the DNS Zone. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_azure.privatedns.get_dns_zone(name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing Private DNS Zone.

import pulumi
import pulumi_azure as azure

example = azure.privatedns.get_dns_zone(name="contoso.internal",
    resource_group_name="contoso-dns")
pulumi.export("privateDnsZoneId", example.id)

Parameters

name (str) – The name of the Private DNS Zone.
resource_group_name (str) – The Name of the Resource Group where the Private DNS Zone exists. If the Name of the Resource Group is not provided, the first Private DNS Zone from the list of Private DNS Zones in your subscription that matches name will be returned.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

privatedns¶

On This Page