1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. PrivateDnsZoneGroup
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.46.0 published on Friday, Jun 21, 2024 by Pulumi

azure-native.network.PrivateDnsZoneGroup

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.46.0 published on Friday, Jun 21, 2024 by Pulumi

    Private dns zone group resource. Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2020-11-01.

    Other available API versions: 2021-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01.

    Example Usage

    Create private dns zone group

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var privateDnsZoneGroup = new AzureNative.Network.PrivateDnsZoneGroup("privateDnsZoneGroup", new()
        {
            PrivateDnsZoneConfigs = new[]
            {
                new AzureNative.Network.Inputs.PrivateDnsZoneConfigArgs
                {
                    PrivateDnsZoneId = "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com",
                },
            },
            PrivateDnsZoneGroupName = "testPdnsgroup",
            PrivateEndpointName = "testPe",
            ResourceGroupName = "rg1",
        });
    
    });
    
    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.NewPrivateDnsZoneGroup(ctx, "privateDnsZoneGroup", &network.PrivateDnsZoneGroupArgs{
    			PrivateDnsZoneConfigs: network.PrivateDnsZoneConfigArray{
    				&network.PrivateDnsZoneConfigArgs{
    					PrivateDnsZoneId: pulumi.String("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com"),
    				},
    			},
    			PrivateDnsZoneGroupName: pulumi.String("testPdnsgroup"),
    			PrivateEndpointName:     pulumi.String("testPe"),
    			ResourceGroupName:       pulumi.String("rg1"),
    		})
    		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.PrivateDnsZoneGroup;
    import com.pulumi.azurenative.network.PrivateDnsZoneGroupArgs;
    import com.pulumi.azurenative.network.inputs.PrivateDnsZoneConfigArgs;
    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 privateDnsZoneGroup = new PrivateDnsZoneGroup("privateDnsZoneGroup", PrivateDnsZoneGroupArgs.builder()
                .privateDnsZoneConfigs(PrivateDnsZoneConfigArgs.builder()
                    .privateDnsZoneId("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com")
                    .build())
                .privateDnsZoneGroupName("testPdnsgroup")
                .privateEndpointName("testPe")
                .resourceGroupName("rg1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    private_dns_zone_group = azure_native.network.PrivateDnsZoneGroup("privateDnsZoneGroup",
        private_dns_zone_configs=[azure_native.network.PrivateDnsZoneConfigArgs(
            private_dns_zone_id="/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com",
        )],
        private_dns_zone_group_name="testPdnsgroup",
        private_endpoint_name="testPe",
        resource_group_name="rg1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const privateDnsZoneGroup = new azure_native.network.PrivateDnsZoneGroup("privateDnsZoneGroup", {
        privateDnsZoneConfigs: [{
            privateDnsZoneId: "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com",
        }],
        privateDnsZoneGroupName: "testPdnsgroup",
        privateEndpointName: "testPe",
        resourceGroupName: "rg1",
    });
    
    resources:
      privateDnsZoneGroup:
        type: azure-native:network:PrivateDnsZoneGroup
        properties:
          privateDnsZoneConfigs:
            - privateDnsZoneId: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com
          privateDnsZoneGroupName: testPdnsgroup
          privateEndpointName: testPe
          resourceGroupName: rg1
    

    Create PrivateDnsZoneGroup Resource

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

    Constructor syntax

    new PrivateDnsZoneGroup(name: string, args: PrivateDnsZoneGroupArgs, opts?: CustomResourceOptions);
    @overload
    def PrivateDnsZoneGroup(resource_name: str,
                            args: PrivateDnsZoneGroupArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def PrivateDnsZoneGroup(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            private_endpoint_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            id: Optional[str] = None,
                            name: Optional[str] = None,
                            private_dns_zone_configs: Optional[Sequence[PrivateDnsZoneConfigArgs]] = None,
                            private_dns_zone_group_name: Optional[str] = None)
    func NewPrivateDnsZoneGroup(ctx *Context, name string, args PrivateDnsZoneGroupArgs, opts ...ResourceOption) (*PrivateDnsZoneGroup, error)
    public PrivateDnsZoneGroup(string name, PrivateDnsZoneGroupArgs args, CustomResourceOptions? opts = null)
    public PrivateDnsZoneGroup(String name, PrivateDnsZoneGroupArgs args)
    public PrivateDnsZoneGroup(String name, PrivateDnsZoneGroupArgs args, CustomResourceOptions options)
    
    type: azure-native:network:PrivateDnsZoneGroup
    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 PrivateDnsZoneGroupArgs
    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 PrivateDnsZoneGroupArgs
    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 PrivateDnsZoneGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateDnsZoneGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateDnsZoneGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var privateDnsZoneGroupResource = new AzureNative.Network.PrivateDnsZoneGroup("privateDnsZoneGroupResource", new()
    {
        PrivateEndpointName = "string",
        ResourceGroupName = "string",
        Id = "string",
        Name = "string",
        PrivateDnsZoneConfigs = new[]
        {
            new AzureNative.Network.Inputs.PrivateDnsZoneConfigArgs
            {
                Name = "string",
                PrivateDnsZoneId = "string",
            },
        },
        PrivateDnsZoneGroupName = "string",
    });
    
    example, err := network.NewPrivateDnsZoneGroup(ctx, "privateDnsZoneGroupResource", &network.PrivateDnsZoneGroupArgs{
    PrivateEndpointName: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    Id: pulumi.String("string"),
    Name: pulumi.String("string"),
    PrivateDnsZoneConfigs: network.PrivateDnsZoneConfigArray{
    &network.PrivateDnsZoneConfigArgs{
    Name: pulumi.String("string"),
    PrivateDnsZoneId: pulumi.String("string"),
    },
    },
    PrivateDnsZoneGroupName: pulumi.String("string"),
    })
    
    var privateDnsZoneGroupResource = new PrivateDnsZoneGroup("privateDnsZoneGroupResource", PrivateDnsZoneGroupArgs.builder()
        .privateEndpointName("string")
        .resourceGroupName("string")
        .id("string")
        .name("string")
        .privateDnsZoneConfigs(PrivateDnsZoneConfigArgs.builder()
            .name("string")
            .privateDnsZoneId("string")
            .build())
        .privateDnsZoneGroupName("string")
        .build());
    
    private_dns_zone_group_resource = azure_native.network.PrivateDnsZoneGroup("privateDnsZoneGroupResource",
        private_endpoint_name="string",
        resource_group_name="string",
        id="string",
        name="string",
        private_dns_zone_configs=[azure_native.network.PrivateDnsZoneConfigArgs(
            name="string",
            private_dns_zone_id="string",
        )],
        private_dns_zone_group_name="string")
    
    const privateDnsZoneGroupResource = new azure_native.network.PrivateDnsZoneGroup("privateDnsZoneGroupResource", {
        privateEndpointName: "string",
        resourceGroupName: "string",
        id: "string",
        name: "string",
        privateDnsZoneConfigs: [{
            name: "string",
            privateDnsZoneId: "string",
        }],
        privateDnsZoneGroupName: "string",
    });
    
    type: azure-native:network:PrivateDnsZoneGroup
    properties:
        id: string
        name: string
        privateDnsZoneConfigs:
            - name: string
              privateDnsZoneId: string
        privateDnsZoneGroupName: string
        privateEndpointName: string
        resourceGroupName: string
    

    PrivateDnsZoneGroup Resource Properties

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

    Inputs

    The PrivateDnsZoneGroup resource accepts the following input properties:

    PrivateEndpointName string
    The name of the private endpoint.
    ResourceGroupName string
    The name of the resource group.
    Id string
    Resource ID.
    Name string
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    PrivateDnsZoneConfigs List<Pulumi.AzureNative.Network.Inputs.PrivateDnsZoneConfig>
    A collection of private dns zone configurations of the private dns zone group.
    PrivateDnsZoneGroupName string
    The name of the private dns zone group.
    PrivateEndpointName string
    The name of the private endpoint.
    ResourceGroupName string
    The name of the resource group.
    Id string
    Resource ID.
    Name string
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    PrivateDnsZoneConfigs []PrivateDnsZoneConfigArgs
    A collection of private dns zone configurations of the private dns zone group.
    PrivateDnsZoneGroupName string
    The name of the private dns zone group.
    privateEndpointName String
    The name of the private endpoint.
    resourceGroupName String
    The name of the resource group.
    id String
    Resource ID.
    name String
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    privateDnsZoneConfigs List<PrivateDnsZoneConfig>
    A collection of private dns zone configurations of the private dns zone group.
    privateDnsZoneGroupName String
    The name of the private dns zone group.
    privateEndpointName string
    The name of the private endpoint.
    resourceGroupName string
    The name of the resource group.
    id string
    Resource ID.
    name string
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    privateDnsZoneConfigs PrivateDnsZoneConfig[]
    A collection of private dns zone configurations of the private dns zone group.
    privateDnsZoneGroupName string
    The name of the private dns zone group.
    private_endpoint_name str
    The name of the private endpoint.
    resource_group_name str
    The name of the resource group.
    id str
    Resource ID.
    name str
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    private_dns_zone_configs Sequence[PrivateDnsZoneConfigArgs]
    A collection of private dns zone configurations of the private dns zone group.
    private_dns_zone_group_name str
    The name of the private dns zone group.
    privateEndpointName String
    The name of the private endpoint.
    resourceGroupName String
    The name of the resource group.
    id String
    Resource ID.
    name String
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    privateDnsZoneConfigs List<Property Map>
    A collection of private dns zone configurations of the private dns zone group.
    privateDnsZoneGroupName String
    The name of the private dns zone group.

    Outputs

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

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisioningState string
    The provisioning state of the private dns zone group resource.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisioningState string
    The provisioning state of the private dns zone group resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    provisioningState String
    The provisioning state of the private dns zone group resource.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    id string
    The provider-assigned unique ID for this managed resource.
    provisioningState string
    The provisioning state of the private dns zone group resource.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    id str
    The provider-assigned unique ID for this managed resource.
    provisioning_state str
    The provisioning state of the private dns zone group resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    provisioningState String
    The provisioning state of the private dns zone group resource.

    Supporting Types

    PrivateDnsZoneConfig, PrivateDnsZoneConfigArgs

    Name string
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    PrivateDnsZoneId string
    The resource id of the private dns zone.
    Name string
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    PrivateDnsZoneId string
    The resource id of the private dns zone.
    name String
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    privateDnsZoneId String
    The resource id of the private dns zone.
    name string
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    privateDnsZoneId string
    The resource id of the private dns zone.
    name str
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    private_dns_zone_id str
    The resource id of the private dns zone.
    name String
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    privateDnsZoneId String
    The resource id of the private dns zone.

    PrivateDnsZoneConfigResponse, PrivateDnsZoneConfigResponseArgs

    RecordSets List<Pulumi.AzureNative.Network.Inputs.RecordSetResponse>
    A collection of information regarding a recordSet, holding information to identify private resources.
    Name string
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    PrivateDnsZoneId string
    The resource id of the private dns zone.
    RecordSets []RecordSetResponse
    A collection of information regarding a recordSet, holding information to identify private resources.
    Name string
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    PrivateDnsZoneId string
    The resource id of the private dns zone.
    recordSets List<RecordSetResponse>
    A collection of information regarding a recordSet, holding information to identify private resources.
    name String
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    privateDnsZoneId String
    The resource id of the private dns zone.
    recordSets RecordSetResponse[]
    A collection of information regarding a recordSet, holding information to identify private resources.
    name string
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    privateDnsZoneId string
    The resource id of the private dns zone.
    record_sets Sequence[RecordSetResponse]
    A collection of information regarding a recordSet, holding information to identify private resources.
    name str
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    private_dns_zone_id str
    The resource id of the private dns zone.
    recordSets List<Property Map>
    A collection of information regarding a recordSet, holding information to identify private resources.
    name String
    Name of the resource that is unique within a resource group. This name can be used to access the resource.
    privateDnsZoneId String
    The resource id of the private dns zone.

    RecordSetResponse, RecordSetResponseArgs

    ProvisioningState string
    The provisioning state of the recordset.
    Fqdn string
    Fqdn that resolves to private endpoint ip address.
    IpAddresses List<string>
    The private ip address of the private endpoint.
    RecordSetName string
    Recordset name.
    RecordType string
    Resource record type.
    Ttl int
    Recordset time to live.
    ProvisioningState string
    The provisioning state of the recordset.
    Fqdn string
    Fqdn that resolves to private endpoint ip address.
    IpAddresses []string
    The private ip address of the private endpoint.
    RecordSetName string
    Recordset name.
    RecordType string
    Resource record type.
    Ttl int
    Recordset time to live.
    provisioningState String
    The provisioning state of the recordset.
    fqdn String
    Fqdn that resolves to private endpoint ip address.
    ipAddresses List<String>
    The private ip address of the private endpoint.
    recordSetName String
    Recordset name.
    recordType String
    Resource record type.
    ttl Integer
    Recordset time to live.
    provisioningState string
    The provisioning state of the recordset.
    fqdn string
    Fqdn that resolves to private endpoint ip address.
    ipAddresses string[]
    The private ip address of the private endpoint.
    recordSetName string
    Recordset name.
    recordType string
    Resource record type.
    ttl number
    Recordset time to live.
    provisioning_state str
    The provisioning state of the recordset.
    fqdn str
    Fqdn that resolves to private endpoint ip address.
    ip_addresses Sequence[str]
    The private ip address of the private endpoint.
    record_set_name str
    Recordset name.
    record_type str
    Resource record type.
    ttl int
    Recordset time to live.
    provisioningState String
    The provisioning state of the recordset.
    fqdn String
    Fqdn that resolves to private endpoint ip address.
    ipAddresses List<String>
    The private ip address of the private endpoint.
    recordSetName String
    Recordset name.
    recordType String
    Resource record type.
    ttl Number
    Recordset time to live.

    Import

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

    $ pulumi import azure-native:network:PrivateDnsZoneGroup testPdnsgroup /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups/{privateDnsZoneGroupName} 
    

    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.46.0 published on Friday, Jun 21, 2024 by Pulumi