Microsoft.Network privateEndpoints/privateDnsZoneGroups 2022-01-01

• Latest
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01

Bicep resource definition

The privateEndpoints/privateDnsZoneGroups resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/privateEndpoints/privateDnsZoneGroups resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2022-01-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    privateDnsZoneConfigs: [
      {
        name: 'string'
        properties: {
          privateDnsZoneId: 'string'
        }
      }
    ]
  }
}

Property values

privateEndpoints/privateDnsZoneGroups

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: privateEndpoints
properties	Properties of the private dns zone group.	PrivateDnsZoneGroupPropertiesFormat

PrivateDnsZoneGroupPropertiesFormat

Name	Description	Value
privateDnsZoneConfigs	A collection of private dns zone configurations of the private dns zone group.	PrivateDnsZoneConfig[]

PrivateDnsZoneConfig

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

PrivateDnsZonePropertiesFormat

Name	Description	Value
privateDnsZoneId	The resource id of the private dns zone.	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
min.io Azure Gateway	Fully private min.io Azure Gateway deployment to provide an S3 compliant storage API backed by blob storage
AKS Cluster with a NAT Gateway and an Application Gateway	This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections.
Create a Private AKS Cluster	This sample shows how to create a private AKS cluster in a virtual network along with a jumpbox virtual machine.
Create a Private AKS Cluster with a Public DNS Zone	This sample shows how to a deploy a private AKS cluster with a Public DNS Zone.
WebApp consuming a Azure SQL Private Endpoint	This template shows how to create a Web app that consumes a private endpoint pointing to Azure SQL Server
Create an API Management service with a private endpoint	This template will create an API Management service, a virtual network and a private endpoint exposing the API Management service to the virtual network.
Azure Batch pool without public IP addresses	This template creates Azure Batch simplified node communication pool without public IP addresses.
Deploy an Azure Databricks Workspace with PE,CMK all forms	This template allows you to create an Azure Databricks workspace with PrivateEndpoint and managed services and CMK with DBFS encryption.
Azure Databricks All-in-one Templat VNetInjection-Pvtendpt	This template allows you to create a network security group, a virtual network and an Azure Databricks workspace with the virtual network, and Private Endpoint.
Azure Digital Twins with Function and Private Link service	This template creates an Azure Digital Twins service configured with a Virtual Network connected Azure Function that can communicate through a Private Link Endpoint to Digital Twins. It also creates a Private DNS Zone to allow seamless hostname resolution of the Digital Twins Endpoint from the Virtual Network to the Private Endpoint internal subnet IP address. The hostname is stored as a setting to the Azure Function with name 'ADT_ENDPOINT'.
Connect to a Event Hubs namespace via private endpoint	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	This sample shows how to use configure a virtual network and private DNS zone to access Key Vault via private endpoint.
Azure Machine Learning end-to-end secure setup	This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
Azure Machine Learning end-to-end secure setup (legacy)	This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
Create an Azure Machine Learning service workspace (vnet)	This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. This configuration describes the set of resources you require to get started with Azure Machine Learning in a network isolated set up.
Create an Azure Machine Learning service workspace (legacy)	This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. This configuration describes the set of resources you require to get started with Azure Machine Learning in a network isolated set up.
AKS cluster with the Application Gateway Ingress Controller	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	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.
Azure Cognitive Search service with private endpoint	This template creates an Azure Cognitive Search service with a private endpoint.
Connect to a Service Bus namespace via private endpoint	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	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	This sample shows how to use connect a virtual network to access a blob storage account via private endpoint.
Connect to an Azure File Share via a Private Endpoint	This sample shows how to use configure a virtual network and private DNS zone to access an Azure File Share via a private endpoint.
App Service Environment with Azure SQL backend	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.
Private Function App and private endpoint-secured Storage	This template provisions a function app on a Premium plan that has private endpoints and communicates with Azure Storage over private endpoints.
Create Function App and private endpoint-secured Storage	This template allows you to deploy an Azure Function App that communicates with Azure Storage over private endpoints.
Function App secured by Azure Frontdoor	This template allows you to deploy an azure premium function protected and published by Azure Frontdoor premium. The conenction between Azure Frontdoor and Azure Functions is protected by Azure Private Link.
Web App with Private Endpoint	This template allows you to create a Web App and expose it through Private Endpoint
Application Gateway with internal API Management and Web App	Application Gateway routing Internet traffic to a virtual network (internal mode) API Management instance which services a web API hosted in an Azure Web App.
Web App with VNet Injection and Private Endpoint	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
Secure N-tier Web App	This template allows you to create a secure end to end solution with two web apps with staging slots, front end and back end, front end will consume securely the back through VNet injection and Private Endpoint
Create a Web App, PE and Application Gateway v2	This template creates an Azure Web App with Private endpoint in Azure Virtual Network Subnet , an Application Gateway v2. The Application Gateway is deployed in a vNet (subnet). The Web App restricts access to traffic from the subnet using private endpoint

ARM template resource definition

The privateEndpoints/privateDnsZoneGroups resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

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

Property values

privateEndpoints/privateDnsZoneGroups

Name	Description	Value
type	The resource type	'Microsoft.Network/privateEndpoints/privateDnsZoneGroups'
apiVersion	The resource api version	'2022-01-01'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
properties	Properties of the private dns zone group.	PrivateDnsZoneGroupPropertiesFormat

PrivateDnsZoneGroupPropertiesFormat

Name	Description	Value
privateDnsZoneConfigs	A collection of private dns zone configurations of the private dns zone group.	PrivateDnsZoneConfig[]

PrivateDnsZoneConfig

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

PrivateDnsZonePropertiesFormat

Name	Description	Value
privateDnsZoneId	The resource id of the private dns zone.	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
min.io Azure Gateway	Fully private min.io Azure Gateway deployment to provide an S3 compliant storage API backed by blob storage
AKS Cluster with a NAT Gateway and an Application Gateway	This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections.
Create a Private AKS Cluster	This sample shows how to create a private AKS cluster in a virtual network along with a jumpbox virtual machine.
Create a Private AKS Cluster with a Public DNS Zone	This sample shows how to a deploy a private AKS cluster with a Public DNS Zone.
WebApp consuming a Azure SQL Private Endpoint	This template shows how to create a Web app that consumes a private endpoint pointing to Azure SQL Server
Create an API Management service with a private endpoint	This template will create an API Management service, a virtual network and a private endpoint exposing the API Management service to the virtual network.
Azure Batch pool without public IP addresses	This template creates Azure Batch simplified node communication pool without public IP addresses.
Deploy an Azure Databricks Workspace with PE,CMK all forms	This template allows you to create an Azure Databricks workspace with PrivateEndpoint and managed services and CMK with DBFS encryption.
Azure Databricks All-in-one Templat VNetInjection-Pvtendpt	This template allows you to create a network security group, a virtual network and an Azure Databricks workspace with the virtual network, and Private Endpoint.
Azure Digital Twins with Function and Private Link service	This template creates an Azure Digital Twins service configured with a Virtual Network connected Azure Function that can communicate through a Private Link Endpoint to Digital Twins. It also creates a Private DNS Zone to allow seamless hostname resolution of the Digital Twins Endpoint from the Virtual Network to the Private Endpoint internal subnet IP address. The hostname is stored as a setting to the Azure Function with name 'ADT_ENDPOINT'.
Connect to a Event Hubs namespace via private endpoint	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	This sample shows how to use configure a virtual network and private DNS zone to access Key Vault via private endpoint.
Azure Machine Learning end-to-end secure setup	This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
Azure Machine Learning end-to-end secure setup (legacy)	This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
Create an Azure Machine Learning service workspace (vnet)	This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. This configuration describes the set of resources you require to get started with Azure Machine Learning in a network isolated set up.
Create an Azure Machine Learning service workspace (legacy)	This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. This configuration describes the set of resources you require to get started with Azure Machine Learning in a network isolated set up.
AKS cluster with the Application Gateway Ingress Controller	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	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.
Azure Cognitive Search service with private endpoint	This template creates an Azure Cognitive Search service with a private endpoint.
Connect to a Service Bus namespace via private endpoint	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	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	This sample shows how to use connect a virtual network to access a blob storage account via private endpoint.
Connect to an Azure File Share via a Private Endpoint	This sample shows how to use configure a virtual network and private DNS zone to access an Azure File Share via a private endpoint.
App Service Environment with Azure SQL backend	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.
Private Function App and private endpoint-secured Storage	This template provisions a function app on a Premium plan that has private endpoints and communicates with Azure Storage over private endpoints.
Create Function App and private endpoint-secured Storage	This template allows you to deploy an Azure Function App that communicates with Azure Storage over private endpoints.
Function App secured by Azure Frontdoor	This template allows you to deploy an azure premium function protected and published by Azure Frontdoor premium. The conenction between Azure Frontdoor and Azure Functions is protected by Azure Private Link.
Web App with Private Endpoint	This template allows you to create a Web App and expose it through Private Endpoint
Application Gateway with internal API Management and Web App	Application Gateway routing Internet traffic to a virtual network (internal mode) API Management instance which services a web API hosted in an Azure Web App.
Web App with VNet Injection and Private Endpoint	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
Secure N-tier Web App	This template allows you to create a secure end to end solution with two web apps with staging slots, front end and back end, front end will consume securely the back through VNet injection and Private Endpoint
Create a Web App, PE and Application Gateway v2	This template creates an Azure Web App with Private endpoint in Azure Virtual Network Subnet , an Application Gateway v2. The Application Gateway is deployed in a vNet (subnet). The Web App restricts access to traffic from the subnet using private endpoint

Terraform (AzAPI provider) resource definition

The privateEndpoints/privateDnsZoneGroups resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/privateEndpoints/privateDnsZoneGroups resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2022-01-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      privateDnsZoneConfigs = [
        {
          name = "string"
          properties = {
            privateDnsZoneId = "string"
          }
        }
      ]
    }
  })
}

Property values

privateEndpoints/privateDnsZoneGroups

Name	Description	Value
type	The resource type	"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2022-01-01"
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: privateEndpoints
properties	Properties of the private dns zone group.	PrivateDnsZoneGroupPropertiesFormat

PrivateDnsZoneGroupPropertiesFormat

Name	Description	Value
privateDnsZoneConfigs	A collection of private dns zone configurations of the private dns zone group.	PrivateDnsZoneConfig[]

PrivateDnsZoneConfig

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

PrivateDnsZonePropertiesFormat

Name	Description	Value
privateDnsZoneId	The resource id of the private dns zone.	string