Private Endpoint¶

Creates a private endpoint for an Azure PaaS resource and optionally binds it to private DNS zones through a private DNS zone group, so the resource resolves to a private address inside the virtual network.

Summary¶

Private endpoint with private DNS zone group binding.

Module Information¶

Property	Value
Owner	platform-team
Support	Support
Version	1.0.0

Resource Types¶

Resource Type
`Microsoft.Network/privateEndpoints`
`Microsoft.Network/privateEndpoints/privateDnsZoneGroups`

Usage¶

module private_endpoint 'br:geitbicepmodweucr01.azurecr.io/bicep/modules/network/private-endpoint:1.0.0' = {
  name: 'private_endpoint'
  params: {
    // Required parameters
    par_private_endpoint_name: <string>
    par_subnet_id: <string>
    par_private_link_service_id: <string>
    par_group_ids: <array>
  }
}

Parameters¶

Name	Type	Description	Default
`par_custom_network_interface_name`	`string`	Optional. Custom name for the endpoint network interface. Defaults to empty, meaning Azure generates the name.	``
`par_group_ids`	`array`	Sub-resource names the private endpoint connects to. For Key Vault this is [ 'vault' ].	required
`par_location`	`string`	Azure region for the private endpoint. Must match the region of the subnet. Defaults to the resource group location.	`[resourceGroup().location]`
`par_private_dns_zone_group_name`	`string`	Name of the private DNS zone group resource. Defaults to default.	`default`
`par_private_dns_zone_ids`	`array`	Optional. Resource IDs of private DNS zones to bind through a private DNS zone group. For Key Vault this is the ID of the privatelink.vaultcore.azure.net zone. Defaults to none, which leaves DNS resolution to the consumer.	``
`par_private_endpoint_name`	`string`	Name of the private endpoint.	required
`par_private_link_service_id`	`string`	Resource ID of the target PaaS resource, for example a Key Vault.	required
`par_subnet_id`	`string`	Resource ID of the subnet the private endpoint is created in. The subnet must have privateEndpointNetworkPolicies set to Disabled.	required
`par_tags`	`object`	Resource tags applied to the private endpoint.	``

Outputs¶

Name	Type	Description
`out_network_interface_id`	`string`	Resource ID of the network interface created for the private endpoint.
`out_private_endpoint_id`	`string`	Resource ID of the deployed private endpoint.
`out_private_endpoint_name`	`string`	Name of the deployed private endpoint.

Versions¶

Pin an exact version. Ranges are not supported.

Version	Reference
`1.0.0` (latest)	`br/Euvic-Modules:network/private-endpoint:1.0.0`