Microsoft.Network privateEndpoints/privateDnsZoneGroups 2020-05-01

Template format

To create a Microsoft.Network/privateEndpoints/privateDnsZoneGroups resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Network/privateEndpoints/privateDnsZoneGroups",
  "apiVersion": "2020-05-01",
  "properties": {
    "privateDnsZoneConfigs": [
      {
        "name": "string",
        "properties": {
          "privateDnsZoneId": "string"
        }
      }
    ]
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Network/privateEndpoints/privateDnsZoneGroups object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes The name of the private dns zone group.
type enum Yes For JSON -privateDnsZoneGroups
-or-
Microsoft.Network/privateEndpoints/privateDnsZoneGroups

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2020-05-01
properties object Yes Properties of the private dns zone group. - PrivateDnsZoneGroupPropertiesFormat object

PrivateDnsZoneGroupPropertiesFormat object

Name Type Required Value
privateDnsZoneConfigs array No A collection of private dns zone configurations of the private dns zone group. - PrivateDnsZoneConfig object

PrivateDnsZoneConfig object

Name Type Required Value
name string No Name of the resource that is unique within a resource group. This name can be used to access the resource.
properties object No Properties of the private dns zone configuration. - PrivateDnsZonePropertiesFormat object

PrivateDnsZonePropertiesFormat object

Name Type Required Value
privateDnsZoneId string No The resource id of the private dns zone.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Connect to an Azure File Share via a Private Endpoint

Deploy to Azure
This sample shows how to use configure a virtual network and private DNS zone to access an Azure File Share via a private endpoint.
Create a Private AKS Cluster

Deploy to Azure
This sample shows how to create a private AKS cluster in a virtual network along with a jumpbox virtual machine.
AKS cluster with the Application Gateway Ingress Controller

Deploy to Azure
This sample shows how to deploy an AKS cluster with Application Gateway, Application Gateway Ingress Controller, Azure Container Registry, Log Analytics and Key Vault
Use Azure Firewall as a DNS Proxy in a Hub & Spoke topology

Deploy to Azure
This sample show how to deploy a hub-spoke topology in Azure using the Azure Firewall. The hub virtual network acts as a central point of connectivity to many spoke virtual networks that are connected to hub virtual network via virtual network peering.
min.io Azure Gateway

Deploy to Azure
Fully private min.io Azure Gateway deployment to provide an S3 compliant storage API backed by blob storage
Create a Private AKS Cluster

Deploy to Azure
This sample shows how to create a private AKS cluster in a virtual network along with a jumpbox virtual machine.
WebApp consuming a Azure SQL Private Endpoint

Deploy to Azure
This template shows how to create a Web app that consumes a private endpoint pointing to Azure SQL Server
Connect to a Event Hubs namespace via private endpoint

Deploy to Azure
This sample shows how to use configure a virtual network and private DNS zone to access a Event Hubs namespace via a private endpoint.
Connect to a Key Vault via private endpoint

Deploy to Azure
This sample shows how to use configure a virtual network and private DNS zone to access Key Vault via private endpoint.
Advanced template for Azure Machine Learning workspace

Deploy to Azure
A template that creates Azure Machine Learning workspace with private endpoints and resources behind VNET
Connect to a Service Bus namespace via private endpoint

Deploy to Azure
This sample shows how to use configure a virtual network and private DNS zone to access a Service Bus namespace via private endpoint.
Private Endpoint example

Deploy to Azure
This template shows how to create a private endpoint pointing to Azure SQL Server
Connect to a storage account from a VM via private endpoint

Deploy to Azure
This sample shows how to use connect a virtual network to access a blob storage account via private endpoint.
App Service Environment with Azure SQL backend

Deploy to Azure
This template creates an App Service Environment with an Azure SQL backend along with private endpoints along with associated resources typically used in an private/isolated environment.
Create Function App and private endpoint-secured Storage

Deploy to Azure
This template allows you to deploy an Azure Function App that communicates with Azure Storage over private endpoints.
Web App with Private Endpoint

Deploy to Azure
This template allows you to create a Web App and expose it through Private Endpoint
Web App with VNet Injection and Private Endpoint.

Deploy to Azure
This template allows you to create a secure end to end solution with two web apps, front end and back end, front end will consume securely the back through VNet injection and Private Endpoint