Skip to content
Docs Try Aspire

AzurePrivateEndpointExtensions Methods

Class Methods 1 member
Provides extension methods for adding Azure Private Endpoint resources to the application model.
AddPrivateEndpoint(IResourceBuilder<AzureSubnetResource>, IResourceBuilder<IAzurePrivateEndpointTarget>) Section titled AddPrivateEndpoint(IResourceBuilder<AzureSubnetResource>, IResourceBuilder<IAzurePrivateEndpointTarget>) extension IResourceBuilder<AzurePrivateEndpointResource>
Adds an Azure Private Endpoint resource to the subnet.
public static class AzurePrivateEndpointExtensions
{
public static IResourceBuilder<AzurePrivateEndpointResource> AddPrivateEndpoint(
this IResourceBuilder<AzureSubnetResource> subnet,
IResourceBuilder<IAzurePrivateEndpointTarget> target)
{
// ...
}
}
subnet IResourceBuilder<AzureSubnetResource> The subnet to add the private endpoint to.
target IResourceBuilder<IAzurePrivateEndpointTarget> The target Azure resource to connect via private link.
IResourceBuilder<AzurePrivateEndpointResource> A reference to the ApplicationModel.IResourceBuilder`1.

This method automatically creates the Private DNS Zone, VNet Link, and DNS Zone Group required for private endpoint DNS resolution. Private DNS Zones are shared across multiple private endpoints that use the same zone name.

When a private endpoint is added, the target resource (or its parent) is automatically configured to deny public network access. To override this behavior, use AzureProvisioningResourceExtensions.ConfigureInfrastructure to customize the network settings.

This example creates a virtual network with a subnet and adds a private endpoint for Azure Storage blobs:

var vnet = builder.AddAzureVirtualNetwork("vnet");
var peSubnet = vnet.AddSubnet("pe-subnet", "10.0.1.0/24");
var storage = builder.AddAzureStorage("storage");
var blobs = storage.AddBlobs("blobs");
peSubnet.AddPrivateEndpoint(blobs);