Skip to main content

privateendpoint

A private endpoint is a network interface that uses a private IP address from your virtual network. This network interface connects you privately and securely to a service that's powered by Azure Private Link. By enabling a private endpoint, you're bringing the service into your virtual network.

Attributes

AttributeTypeMandatoryValuesDefaultNotes
NameStringYes
PrivateLinkNameStringNo
NetworkInterfaceNameStringNo
LocationStringYes
ResourceGroupNameStringNo*Defaults to rg of the resource
VirtualNetworkObjectNo

Virtual Network

AttributeTypeMandatoryValuesDefaultNotes
VNetNameStringYes
SubnetNameStringYes
SubscriptionNameStringNo*Defaults to sub of the resource
ResourceGroupNameStringNo*Defaults to rg of the resource

Input by YAML

Object model for YAML deployment:

    PrivateEndPoint:
# Mandatory
Name: 'string'
Location: 'string'
# Optional
PrivateLinkName: 'string' # Defaults to pl-resource
NetworkInterfaceName: 'string' # Defaults to nic-resource
ResourceGroupName: 'string' # Defaults to RG of the resource
VirtualNetwork:
# Mandatory
VNetName: 'string'
SubnetName: 'string'
# Optional
ResourceGroupName: 'string' # Defaults to RG of the resource
SubscriptionName: 'string' # Defaults to Sub of the resource

Input by JSON

Object model for JSON deployment:

    {
"PrivateEndPoint": {
"Name": "string",
"Location": "string",
"PrivateLinkName": "string",
"NetworkInterfaceName": "string",
"ResourceGroupName": "string",
"VirtualNetwork": {
"VNetName": "string",
"SubnetName": "string",
"ResourceGroupName": "string",
"SubscriptionName": "string"
}
}
}