Azure Classic v5.43.0, May 6 23

We recommend using Azure Native.

Azure Classic v5.43.0 published on Saturday, May 6, 2023 by Pulumi

pulumi/pulumi-azure

azure.privatelink.Endpoint

Explore with Pulumi AI

We recommend using Azure Native.

Azure Classic v5.43.0 published on Saturday, May 6, 2023 by Pulumi

pulumi/pulumi-azure

Azure Private Endpoint is a network interface that connects you privately and securely to a service powered by Azure Private Link. Private Endpoint uses a private IP address from your VNet, effectively bringing the service into your VNet. The service could be an Azure service such as Azure Storage, SQL, etc. or your own Private Link Service.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("exampleVirtualNetwork", new()
    {
        AddressSpaces = new[]
        {
            "10.0.0.0/16",
        },
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var service = new Azure.Network.Subnet("service", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        VirtualNetworkName = exampleVirtualNetwork.Name,
        AddressPrefixes = new[]
        {
            "10.0.1.0/24",
        },
        EnforcePrivateLinkServiceNetworkPolicies = true,
    });

    var endpoint = new Azure.Network.Subnet("endpoint", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        VirtualNetworkName = exampleVirtualNetwork.Name,
        AddressPrefixes = new[]
        {
            "10.0.2.0/24",
        },
        EnforcePrivateLinkEndpointNetworkPolicies = true,
    });

    var examplePublicIp = new Azure.Network.PublicIp("examplePublicIp", new()
    {
        Sku = "Standard",
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        AllocationMethod = "Static",
    });

    var exampleLoadBalancer = new Azure.Lb.LoadBalancer("exampleLoadBalancer", new()
    {
        Sku = "Standard",
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        FrontendIpConfigurations = new[]
        {
            new Azure.Lb.Inputs.LoadBalancerFrontendIpConfigurationArgs
            {
                Name = examplePublicIp.Name,
                PublicIpAddressId = examplePublicIp.Id,
            },
        },
    });

    var exampleLinkService = new Azure.PrivateDns.LinkService("exampleLinkService", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        NatIpConfigurations = new[]
        {
            new Azure.PrivateDns.Inputs.LinkServiceNatIpConfigurationArgs
            {
                Name = examplePublicIp.Name,
                Primary = true,
                SubnetId = service.Id,
            },
        },
        LoadBalancerFrontendIpConfigurationIds = new[]
        {
            exampleLoadBalancer.FrontendIpConfigurations.Apply(frontendIpConfigurations => frontendIpConfigurations[0]?.Id),
        },
    });

    var exampleEndpoint = new Azure.PrivateLink.Endpoint("exampleEndpoint", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        SubnetId = endpoint.Id,
        PrivateServiceConnection = new Azure.PrivateLink.Inputs.EndpointPrivateServiceConnectionArgs
        {
            Name = "example-privateserviceconnection",
            PrivateConnectionResourceId = exampleLinkService.Id,
            IsManualConnection = false,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/lb"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/privatedns"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/privatelink"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "exampleVirtualNetwork", &network.VirtualNetworkArgs{
			AddressSpaces: pulumi.StringArray{
				pulumi.String("10.0.0.0/16"),
			},
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		service, err := network.NewSubnet(ctx, "service", &network.SubnetArgs{
			ResourceGroupName:  exampleResourceGroup.Name,
			VirtualNetworkName: exampleVirtualNetwork.Name,
			AddressPrefixes: pulumi.StringArray{
				pulumi.String("10.0.1.0/24"),
			},
			EnforcePrivateLinkServiceNetworkPolicies: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		endpoint, err := network.NewSubnet(ctx, "endpoint", &network.SubnetArgs{
			ResourceGroupName:  exampleResourceGroup.Name,
			VirtualNetworkName: exampleVirtualNetwork.Name,
			AddressPrefixes: pulumi.StringArray{
				pulumi.String("10.0.2.0/24"),
			},
			EnforcePrivateLinkEndpointNetworkPolicies: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		examplePublicIp, err := network.NewPublicIp(ctx, "examplePublicIp", &network.PublicIpArgs{
			Sku:               pulumi.String("Standard"),
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			AllocationMethod:  pulumi.String("Static"),
		})
		if err != nil {
			return err
		}
		exampleLoadBalancer, err := lb.NewLoadBalancer(ctx, "exampleLoadBalancer", &lb.LoadBalancerArgs{
			Sku:               pulumi.String("Standard"),
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			FrontendIpConfigurations: lb.LoadBalancerFrontendIpConfigurationArray{
				&lb.LoadBalancerFrontendIpConfigurationArgs{
					Name:              examplePublicIp.Name,
					PublicIpAddressId: examplePublicIp.ID(),
				},
			},
		})
		if err != nil {
			return err
		}
		exampleLinkService, err := privatedns.NewLinkService(ctx, "exampleLinkService", &privatedns.LinkServiceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			NatIpConfigurations: privatedns.LinkServiceNatIpConfigurationArray{
				&privatedns.LinkServiceNatIpConfigurationArgs{
					Name:     examplePublicIp.Name,
					Primary:  pulumi.Bool(true),
					SubnetId: service.ID(),
				},
			},
			LoadBalancerFrontendIpConfigurationIds: pulumi.StringArray{
				exampleLoadBalancer.FrontendIpConfigurations.ApplyT(func(frontendIpConfigurations []lb.LoadBalancerFrontendIpConfiguration) (*string, error) {
					return &frontendIpConfigurations[0].Id, nil
				}).(pulumi.StringPtrOutput),
			},
		})
		if err != nil {
			return err
		}
		_, err = privatelink.NewEndpoint(ctx, "exampleEndpoint", &privatelink.EndpointArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			SubnetId:          endpoint.ID(),
			PrivateServiceConnection: &privatelink.EndpointPrivateServiceConnectionArgs{
				Name:                        pulumi.String("example-privateserviceconnection"),
				PrivateConnectionResourceId: exampleLinkService.ID(),
				IsManualConnection:          pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.network.PublicIp;
import com.pulumi.azure.network.PublicIpArgs;
import com.pulumi.azure.lb.LoadBalancer;
import com.pulumi.azure.lb.LoadBalancerArgs;
import com.pulumi.azure.lb.inputs.LoadBalancerFrontendIpConfigurationArgs;
import com.pulumi.azure.privatedns.LinkService;
import com.pulumi.azure.privatedns.LinkServiceArgs;
import com.pulumi.azure.privatedns.inputs.LinkServiceNatIpConfigurationArgs;
import com.pulumi.azure.privatelink.Endpoint;
import com.pulumi.azure.privatelink.EndpointArgs;
import com.pulumi.azure.privatelink.inputs.EndpointPrivateServiceConnectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()        
            .addressSpaces("10.0.0.0/16")
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());

        var service = new Subnet("service", SubnetArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.0.1.0/24")
            .enforcePrivateLinkServiceNetworkPolicies(true)
            .build());

        var endpoint = new Subnet("endpoint", SubnetArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.0.2.0/24")
            .enforcePrivateLinkEndpointNetworkPolicies(true)
            .build());

        var examplePublicIp = new PublicIp("examplePublicIp", PublicIpArgs.builder()        
            .sku("Standard")
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .allocationMethod("Static")
            .build());

        var exampleLoadBalancer = new LoadBalancer("exampleLoadBalancer", LoadBalancerArgs.builder()        
            .sku("Standard")
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .frontendIpConfigurations(LoadBalancerFrontendIpConfigurationArgs.builder()
                .name(examplePublicIp.name())
                .publicIpAddressId(examplePublicIp.id())
                .build())
            .build());

        var exampleLinkService = new LinkService("exampleLinkService", LinkServiceArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .natIpConfigurations(LinkServiceNatIpConfigurationArgs.builder()
                .name(examplePublicIp.name())
                .primary(true)
                .subnetId(service.id())
                .build())
            .loadBalancerFrontendIpConfigurationIds(exampleLoadBalancer.frontendIpConfigurations().applyValue(frontendIpConfigurations -> frontendIpConfigurations[0].id()))
            .build());

        var exampleEndpoint = new Endpoint("exampleEndpoint", EndpointArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .subnetId(endpoint.id())
            .privateServiceConnection(EndpointPrivateServiceConnectionArgs.builder()
                .name("example-privateserviceconnection")
                .privateConnectionResourceId(exampleLinkService.id())
                .isManualConnection(false)
                .build())
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
service = azure.network.Subnet("service",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.0.1.0/24"],
    enforce_private_link_service_network_policies=True)
endpoint = azure.network.Subnet("endpoint",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.0.2.0/24"],
    enforce_private_link_endpoint_network_policies=True)
example_public_ip = azure.network.PublicIp("examplePublicIp",
    sku="Standard",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Static")
example_load_balancer = azure.lb.LoadBalancer("exampleLoadBalancer",
    sku="Standard",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    frontend_ip_configurations=[azure.lb.LoadBalancerFrontendIpConfigurationArgs(
        name=example_public_ip.name,
        public_ip_address_id=example_public_ip.id,
    )])
example_link_service = azure.privatedns.LinkService("exampleLinkService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    nat_ip_configurations=[azure.privatedns.LinkServiceNatIpConfigurationArgs(
        name=example_public_ip.name,
        primary=True,
        subnet_id=service.id,
    )],
    load_balancer_frontend_ip_configuration_ids=[example_load_balancer.frontend_ip_configurations[0].id])
example_endpoint = azure.privatelink.Endpoint("exampleEndpoint",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    subnet_id=endpoint.id,
    private_service_connection=azure.privatelink.EndpointPrivateServiceConnectionArgs(
        name="example-privateserviceconnection",
        private_connection_resource_id=example_link_service.id,
        is_manual_connection=False,
    ))

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const service = new azure.network.Subnet("service", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["10.0.1.0/24"],
    enforcePrivateLinkServiceNetworkPolicies: true,
});
const endpoint = new azure.network.Subnet("endpoint", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["10.0.2.0/24"],
    enforcePrivateLinkEndpointNetworkPolicies: true,
});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    sku: "Standard",
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
});
const exampleLoadBalancer = new azure.lb.LoadBalancer("exampleLoadBalancer", {
    sku: "Standard",
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    frontendIpConfigurations: [{
        name: examplePublicIp.name,
        publicIpAddressId: examplePublicIp.id,
    }],
});
const exampleLinkService = new azure.privatedns.LinkService("exampleLinkService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    natIpConfigurations: [{
        name: examplePublicIp.name,
        primary: true,
        subnetId: service.id,
    }],
    loadBalancerFrontendIpConfigurationIds: [exampleLoadBalancer.frontendIpConfigurations.apply(frontendIpConfigurations => frontendIpConfigurations?.[0]?.id)],
});
const exampleEndpoint = new azure.privatelink.Endpoint("exampleEndpoint", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    subnetId: endpoint.id,
    privateServiceConnection: {
        name: "example-privateserviceconnection",
        privateConnectionResourceId: exampleLinkService.id,
        isManualConnection: false,
    },
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    properties:
      addressSpaces:
        - 10.0.0.0/16
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  service:
    type: azure:network:Subnet
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.0.1.0/24
      enforcePrivateLinkServiceNetworkPolicies: true
  endpoint:
    type: azure:network:Subnet
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.0.2.0/24
      enforcePrivateLinkEndpointNetworkPolicies: true
  examplePublicIp:
    type: azure:network:PublicIp
    properties:
      sku: Standard
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      allocationMethod: Static
  exampleLoadBalancer:
    type: azure:lb:LoadBalancer
    properties:
      sku: Standard
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      frontendIpConfigurations:
        - name: ${examplePublicIp.name}
          publicIpAddressId: ${examplePublicIp.id}
  exampleLinkService:
    type: azure:privatedns:LinkService
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      natIpConfigurations:
        - name: ${examplePublicIp.name}
          primary: true
          subnetId: ${service.id}
      loadBalancerFrontendIpConfigurationIds:
        - ${exampleLoadBalancer.frontendIpConfigurations[0].id}
  exampleEndpoint:
    type: azure:privatelink:Endpoint
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      subnetId: ${endpoint.id}
      privateServiceConnection:
        name: example-privateserviceconnection
        privateConnectionResourceId: ${exampleLinkService.id}
        isManualConnection: false

Using a Private Link Service Alias with existing resources

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = Azure.Core.GetResourceGroup.Invoke(new()
    {
        Name = "example-resources",
    });

    var vnet = Azure.Network.GetVirtualNetwork.Invoke(new()
    {
        Name = "example-network",
        ResourceGroupName = exampleResourceGroup.Apply(getResourceGroupResult => getResourceGroupResult.Name),
    });

    var subnet = Azure.Network.GetSubnet.Invoke(new()
    {
        Name = "default",
        VirtualNetworkName = vnet.Apply(getVirtualNetworkResult => getVirtualNetworkResult.Name),
        ResourceGroupName = exampleResourceGroup.Apply(getResourceGroupResult => getResourceGroupResult.Name),
    });

    var exampleEndpoint = new Azure.PrivateLink.Endpoint("exampleEndpoint", new()
    {
        Location = exampleResourceGroup.Apply(getResourceGroupResult => getResourceGroupResult.Location),
        ResourceGroupName = exampleResourceGroup.Apply(getResourceGroupResult => getResourceGroupResult.Name),
        SubnetId = subnet.Apply(getSubnetResult => getSubnetResult.Id),
        PrivateServiceConnection = new Azure.PrivateLink.Inputs.EndpointPrivateServiceConnectionArgs
        {
            Name = "example-privateserviceconnection",
            PrivateConnectionResourceAlias = "example-privatelinkservice.d20286c8-4ea5-11eb-9584-8f53157226c6.centralus.azure.privatelinkservice",
            IsManualConnection = true,
            RequestMessage = "PL",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/privatelink"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.LookupResourceGroup(ctx, &core.LookupResourceGroupArgs{
			Name: "example-resources",
		}, nil)
		if err != nil {
			return err
		}
		vnet, err := network.LookupVirtualNetwork(ctx, &network.LookupVirtualNetworkArgs{
			Name:              "example-network",
			ResourceGroupName: exampleResourceGroup.Name,
		}, nil)
		if err != nil {
			return err
		}
		subnet, err := network.LookupSubnet(ctx, &network.LookupSubnetArgs{
			Name:               "default",
			VirtualNetworkName: vnet.Name,
			ResourceGroupName:  exampleResourceGroup.Name,
		}, nil)
		if err != nil {
			return err
		}
		_, err = privatelink.NewEndpoint(ctx, "exampleEndpoint", &privatelink.EndpointArgs{
			Location:          *pulumi.String(exampleResourceGroup.Location),
			ResourceGroupName: *pulumi.String(exampleResourceGroup.Name),
			SubnetId:          *pulumi.String(subnet.Id),
			PrivateServiceConnection: &privatelink.EndpointPrivateServiceConnectionArgs{
				Name:                           pulumi.String("example-privateserviceconnection"),
				PrivateConnectionResourceAlias: pulumi.String("example-privatelinkservice.d20286c8-4ea5-11eb-9584-8f53157226c6.centralus.azure.privatelinkservice"),
				IsManualConnection:             pulumi.Bool(true),
				RequestMessage:                 pulumi.String("PL"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.core.inputs.GetResourceGroupArgs;
import com.pulumi.azure.network.NetworkFunctions;
import com.pulumi.azure.network.inputs.GetVirtualNetworkArgs;
import com.pulumi.azure.network.inputs.GetSubnetArgs;
import com.pulumi.azure.privatelink.Endpoint;
import com.pulumi.azure.privatelink.EndpointArgs;
import com.pulumi.azure.privatelink.inputs.EndpointPrivateServiceConnectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleResourceGroup = CoreFunctions.getResourceGroup(GetResourceGroupArgs.builder()
            .name("example-resources")
            .build());

        final var vnet = NetworkFunctions.getVirtualNetwork(GetVirtualNetworkArgs.builder()
            .name("example-network")
            .resourceGroupName(exampleResourceGroup.applyValue(getResourceGroupResult -> getResourceGroupResult.name()))
            .build());

        final var subnet = NetworkFunctions.getSubnet(GetSubnetArgs.builder()
            .name("default")
            .virtualNetworkName(vnet.applyValue(getVirtualNetworkResult -> getVirtualNetworkResult.name()))
            .resourceGroupName(exampleResourceGroup.applyValue(getResourceGroupResult -> getResourceGroupResult.name()))
            .build());

        var exampleEndpoint = new Endpoint("exampleEndpoint", EndpointArgs.builder()        
            .location(exampleResourceGroup.applyValue(getResourceGroupResult -> getResourceGroupResult.location()))
            .resourceGroupName(exampleResourceGroup.applyValue(getResourceGroupResult -> getResourceGroupResult.name()))
            .subnetId(subnet.applyValue(getSubnetResult -> getSubnetResult.id()))
            .privateServiceConnection(EndpointPrivateServiceConnectionArgs.builder()
                .name("example-privateserviceconnection")
                .privateConnectionResourceAlias("example-privatelinkservice.d20286c8-4ea5-11eb-9584-8f53157226c6.centralus.azure.privatelinkservice")
                .isManualConnection(true)
                .requestMessage("PL")
                .build())
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.get_resource_group(name="example-resources")
vnet = azure.network.get_virtual_network(name="example-network",
    resource_group_name=example_resource_group.name)
subnet = azure.network.get_subnet(name="default",
    virtual_network_name=vnet.name,
    resource_group_name=example_resource_group.name)
example_endpoint = azure.privatelink.Endpoint("exampleEndpoint",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    subnet_id=subnet.id,
    private_service_connection=azure.privatelink.EndpointPrivateServiceConnectionArgs(
        name="example-privateserviceconnection",
        private_connection_resource_alias="example-privatelinkservice.d20286c8-4ea5-11eb-9584-8f53157226c6.centralus.azure.privatelinkservice",
        is_manual_connection=True,
        request_message="PL",
    ))

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = azure.core.getResourceGroup({
    name: "example-resources",
});
const vnet = exampleResourceGroup.then(exampleResourceGroup => azure.network.getVirtualNetwork({
    name: "example-network",
    resourceGroupName: exampleResourceGroup.name,
}));
const subnet = Promise.all([vnet, exampleResourceGroup]).then(([vnet, exampleResourceGroup]) => azure.network.getSubnet({
    name: "default",
    virtualNetworkName: vnet.name,
    resourceGroupName: exampleResourceGroup.name,
}));
const exampleEndpoint = new azure.privatelink.Endpoint("exampleEndpoint", {
    location: exampleResourceGroup.then(exampleResourceGroup => exampleResourceGroup.location),
    resourceGroupName: exampleResourceGroup.then(exampleResourceGroup => exampleResourceGroup.name),
    subnetId: subnet.then(subnet => subnet.id),
    privateServiceConnection: {
        name: "example-privateserviceconnection",
        privateConnectionResourceAlias: "example-privatelinkservice.d20286c8-4ea5-11eb-9584-8f53157226c6.centralus.azure.privatelinkservice",
        isManualConnection: true,
        requestMessage: "PL",
    },
});

resources:
  exampleEndpoint:
    type: azure:privatelink:Endpoint
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      subnetId: ${subnet.id}
      privateServiceConnection:
        name: example-privateserviceconnection
        privateConnectionResourceAlias: example-privatelinkservice.d20286c8-4ea5-11eb-9584-8f53157226c6.centralus.azure.privatelinkservice
        isManualConnection: true
        requestMessage: PL
variables:
  exampleResourceGroup:
    fn::invoke:
      Function: azure:core:getResourceGroup
      Arguments:
        name: example-resources
  vnet:
    fn::invoke:
      Function: azure:network:getVirtualNetwork
      Arguments:
        name: example-network
        resourceGroupName: ${exampleResourceGroup.name}
  subnet:
    fn::invoke:
      Function: azure:network:getSubnet
      Arguments:
        name: default
        virtualNetworkName: ${vnet.name}
        resourceGroupName: ${exampleResourceGroup.name}

Azure service, with proper DNS configuration

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleAccount = new Azure.Storage.Account("exampleAccount", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
    });

    var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("exampleVirtualNetwork", new()
    {
        AddressSpaces = new[]
        {
            "10.0.0.0/16",
        },
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleSubnet = new Azure.Network.Subnet("exampleSubnet", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        VirtualNetworkName = exampleVirtualNetwork.Name,
        AddressPrefixes = new[]
        {
            "10.0.2.0/24",
        },
    });

    var exampleZone = new Azure.PrivateDns.Zone("exampleZone", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleEndpoint = new Azure.PrivateLink.Endpoint("exampleEndpoint", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        SubnetId = exampleSubnet.Id,
        PrivateServiceConnection = new Azure.PrivateLink.Inputs.EndpointPrivateServiceConnectionArgs
        {
            Name = "example-privateserviceconnection",
            PrivateConnectionResourceId = exampleAccount.Id,
            SubresourceNames = new[]
            {
                "blob",
            },
            IsManualConnection = false,
        },
        PrivateDnsZoneGroup = new Azure.PrivateLink.Inputs.EndpointPrivateDnsZoneGroupArgs
        {
            Name = "example-dns-zone-group",
            PrivateDnsZoneIds = new[]
            {
                exampleZone.Id,
            },
        },
    });

    var exampleZoneVirtualNetworkLink = new Azure.PrivateDns.ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        PrivateDnsZoneName = exampleZone.Name,
        VirtualNetworkId = exampleVirtualNetwork.Id,
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/privatedns"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/privatelink"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
			ResourceGroupName:      exampleResourceGroup.Name,
			Location:               exampleResourceGroup.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "exampleVirtualNetwork", &network.VirtualNetworkArgs{
			AddressSpaces: pulumi.StringArray{
				pulumi.String("10.0.0.0/16"),
			},
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		exampleSubnet, err := network.NewSubnet(ctx, "exampleSubnet", &network.SubnetArgs{
			ResourceGroupName:  exampleResourceGroup.Name,
			VirtualNetworkName: exampleVirtualNetwork.Name,
			AddressPrefixes: pulumi.StringArray{
				pulumi.String("10.0.2.0/24"),
			},
		})
		if err != nil {
			return err
		}
		exampleZone, err := privatedns.NewZone(ctx, "exampleZone", &privatedns.ZoneArgs{
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		_, err = privatelink.NewEndpoint(ctx, "exampleEndpoint", &privatelink.EndpointArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			SubnetId:          exampleSubnet.ID(),
			PrivateServiceConnection: &privatelink.EndpointPrivateServiceConnectionArgs{
				Name:                        pulumi.String("example-privateserviceconnection"),
				PrivateConnectionResourceId: exampleAccount.ID(),
				SubresourceNames: pulumi.StringArray{
					pulumi.String("blob"),
				},
				IsManualConnection: pulumi.Bool(false),
			},
			PrivateDnsZoneGroup: &privatelink.EndpointPrivateDnsZoneGroupArgs{
				Name: pulumi.String("example-dns-zone-group"),
				PrivateDnsZoneIds: pulumi.StringArray{
					exampleZone.ID(),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = privatedns.NewZoneVirtualNetworkLink(ctx, "exampleZoneVirtualNetworkLink", &privatedns.ZoneVirtualNetworkLinkArgs{
			ResourceGroupName:  exampleResourceGroup.Name,
			PrivateDnsZoneName: exampleZone.Name,
			VirtualNetworkId:   exampleVirtualNetwork.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.privatedns.Zone;
import com.pulumi.azure.privatedns.ZoneArgs;
import com.pulumi.azure.privatelink.Endpoint;
import com.pulumi.azure.privatelink.EndpointArgs;
import com.pulumi.azure.privatelink.inputs.EndpointPrivateServiceConnectionArgs;
import com.pulumi.azure.privatelink.inputs.EndpointPrivateDnsZoneGroupArgs;
import com.pulumi.azure.privatedns.ZoneVirtualNetworkLink;
import com.pulumi.azure.privatedns.ZoneVirtualNetworkLinkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());

        var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()        
            .addressSpaces("10.0.0.0/16")
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());

        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.0.2.0/24")
            .build());

        var exampleZone = new Zone("exampleZone", ZoneArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .build());

        var exampleEndpoint = new Endpoint("exampleEndpoint", EndpointArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .subnetId(exampleSubnet.id())
            .privateServiceConnection(EndpointPrivateServiceConnectionArgs.builder()
                .name("example-privateserviceconnection")
                .privateConnectionResourceId(exampleAccount.id())
                .subresourceNames("blob")
                .isManualConnection(false)
                .build())
            .privateDnsZoneGroup(EndpointPrivateDnsZoneGroupArgs.builder()
                .name("example-dns-zone-group")
                .privateDnsZoneIds(exampleZone.id())
                .build())
            .build());

        var exampleZoneVirtualNetworkLink = new ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink", ZoneVirtualNetworkLinkArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .privateDnsZoneName(exampleZone.name())
            .virtualNetworkId(exampleVirtualNetwork.id())
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.0.2.0/24"])
example_zone = azure.privatedns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_endpoint = azure.privatelink.Endpoint("exampleEndpoint",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    subnet_id=example_subnet.id,
    private_service_connection=azure.privatelink.EndpointPrivateServiceConnectionArgs(
        name="example-privateserviceconnection",
        private_connection_resource_id=example_account.id,
        subresource_names=["blob"],
        is_manual_connection=False,
    ),
    private_dns_zone_group=azure.privatelink.EndpointPrivateDnsZoneGroupArgs(
        name="example-dns-zone-group",
        private_dns_zone_ids=[example_zone.id],
    ))
example_zone_virtual_network_link = azure.privatedns.ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink",
    resource_group_name=example_resource_group.name,
    private_dns_zone_name=example_zone.name,
    virtual_network_id=example_virtual_network.id)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["10.0.2.0/24"],
});
const exampleZone = new azure.privatedns.Zone("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const exampleEndpoint = new azure.privatelink.Endpoint("exampleEndpoint", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    subnetId: exampleSubnet.id,
    privateServiceConnection: {
        name: "example-privateserviceconnection",
        privateConnectionResourceId: exampleAccount.id,
        subresourceNames: ["blob"],
        isManualConnection: false,
    },
    privateDnsZoneGroup: {
        name: "example-dns-zone-group",
        privateDnsZoneIds: [exampleZone.id],
    },
});
const exampleZoneVirtualNetworkLink = new azure.privatedns.ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink", {
    resourceGroupName: exampleResourceGroup.name,
    privateDnsZoneName: exampleZone.name,
    virtualNetworkId: exampleVirtualNetwork.id,
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleAccount:
    type: azure:storage:Account
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      accountTier: Standard
      accountReplicationType: LRS
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    properties:
      addressSpaces:
        - 10.0.0.0/16
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleSubnet:
    type: azure:network:Subnet
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.0.2.0/24
  exampleEndpoint:
    type: azure:privatelink:Endpoint
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      subnetId: ${exampleSubnet.id}
      privateServiceConnection:
        name: example-privateserviceconnection
        privateConnectionResourceId: ${exampleAccount.id}
        subresourceNames:
          - blob
        isManualConnection: false
      privateDnsZoneGroup:
        name: example-dns-zone-group
        privateDnsZoneIds:
          - ${exampleZone.id}
  exampleZone:
    type: azure:privatedns:Zone
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
  exampleZoneVirtualNetworkLink:
    type: azure:privatedns:ZoneVirtualNetworkLink
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      privateDnsZoneName: ${exampleZone.name}
      virtualNetworkId: ${exampleVirtualNetwork.id}

Create Endpoint Resource

new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);

@overload
def Endpoint(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             custom_network_interface_name: Optional[str] = None,
             ip_configurations: Optional[Sequence[EndpointIpConfigurationArgs]] = None,
             location: Optional[str] = None,
             name: Optional[str] = None,
             private_dns_zone_group: Optional[EndpointPrivateDnsZoneGroupArgs] = None,
             private_service_connection: Optional[EndpointPrivateServiceConnectionArgs] = None,
             resource_group_name: Optional[str] = None,
             subnet_id: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None)
@overload
def Endpoint(resource_name: str,
             args: EndpointArgs,
             opts: Optional[ResourceOptions] = None)

func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)

public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)

public Endpoint(String name, EndpointArgs args)
public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)

type: azure:privatelink:Endpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Endpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Endpoint resource accepts the following input properties:

PrivateServiceConnection EndpointPrivateServiceConnectionArgs: A private_service_connection block as defined below.
ResourceGroupName string: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
SubnetId string: The ID of the Subnet from which Private IP Addresses will be allocated for this Private Endpoint. Changing this forces a new resource to be created.
CustomNetworkInterfaceName string: The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
IpConfigurations List<EndpointIpConfigurationArgs>: One or more ip_configuration blocks as defined below. This allows a static IP address to be set for this Private Endpoint, otherwise an address is dynamically allocated from the Subnet.
Location string: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
PrivateDnsZoneGroup EndpointPrivateDnsZoneGroupArgs: A private_dns_zone_group block as defined below.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

PrivateServiceConnection EndpointPrivateServiceConnectionArgs: A private_service_connection block as defined below.
ResourceGroupName string: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
SubnetId string: The ID of the Subnet from which Private IP Addresses will be allocated for this Private Endpoint. Changing this forces a new resource to be created.
CustomNetworkInterfaceName string: The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
IpConfigurations []EndpointIpConfigurationArgs: One or more ip_configuration blocks as defined below. This allows a static IP address to be set for this Private Endpoint, otherwise an address is dynamically allocated from the Subnet.
Location string: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
PrivateDnsZoneGroup EndpointPrivateDnsZoneGroupArgs: A private_dns_zone_group block as defined below.
Tags map[string]string: A mapping of tags to assign to the resource.

privateServiceConnection EndpointPrivateServiceConnectionArgs: A private_service_connection block as defined below.
resourceGroupName String: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
subnetId String: The ID of the Subnet from which Private IP Addresses will be allocated for this Private Endpoint. Changing this forces a new resource to be created.
customNetworkInterfaceName String: The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
ipConfigurations List<EndpointIpConfigurationArgs>: One or more ip_configuration blocks as defined below. This allows a static IP address to be set for this Private Endpoint, otherwise an address is dynamically allocated from the Subnet.
location String: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
privateDnsZoneGroup EndpointPrivateDnsZoneGroupArgs: A private_dns_zone_group block as defined below.
tags Map<String,String>: A mapping of tags to assign to the resource.

privateServiceConnection EndpointPrivateServiceConnectionArgs: A private_service_connection block as defined below.
resourceGroupName string: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
subnetId string: The ID of the Subnet from which Private IP Addresses will be allocated for this Private Endpoint. Changing this forces a new resource to be created.
customNetworkInterfaceName string: The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
ipConfigurations EndpointIpConfigurationArgs[]: One or more ip_configuration blocks as defined below. This allows a static IP address to be set for this Private Endpoint, otherwise an address is dynamically allocated from the Subnet.
location string: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
privateDnsZoneGroup EndpointPrivateDnsZoneGroupArgs: A private_dns_zone_group block as defined below.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

private_service_connection EndpointPrivateServiceConnectionArgs: A private_service_connection block as defined below.
resource_group_name str: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
subnet_id str: The ID of the Subnet from which Private IP Addresses will be allocated for this Private Endpoint. Changing this forces a new resource to be created.
custom_network_interface_name str: The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
ip_configurations Sequence[EndpointIpConfigurationArgs]: One or more ip_configuration blocks as defined below. This allows a static IP address to be set for this Private Endpoint, otherwise an address is dynamically allocated from the Subnet.
location str: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
private_dns_zone_group EndpointPrivateDnsZoneGroupArgs: A private_dns_zone_group block as defined below.
tags Mapping[str, str]: A mapping of tags to assign to the resource.

privateServiceConnection Property Map: A private_service_connection block as defined below.
resourceGroupName String: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
subnetId String: The ID of the Subnet from which Private IP Addresses will be allocated for this Private Endpoint. Changing this forces a new resource to be created.
customNetworkInterfaceName String: The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
ipConfigurations List<Property Map>: One or more ip_configuration blocks as defined below. This allows a static IP address to be set for this Private Endpoint, otherwise an address is dynamically allocated from the Subnet.
location String: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
privateDnsZoneGroup Property Map: A private_dns_zone_group block as defined below.
tags Map<String>: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Endpoint resource produces the following output properties:

CustomDnsConfigs List<EndpointCustomDnsConfig>: A custom_dns_configs block as defined below.
Id string: The provider-assigned unique ID for this managed resource.
NetworkInterfaces List<EndpointNetworkInterface>: A network_interface block as defined below.
PrivateDnsZoneConfigs List<EndpointPrivateDnsZoneConfig>: A private_dns_zone_configs block as defined below.

CustomDnsConfigs []EndpointCustomDnsConfig: A custom_dns_configs block as defined below.
Id string: The provider-assigned unique ID for this managed resource.
NetworkInterfaces []EndpointNetworkInterface: A network_interface block as defined below.
PrivateDnsZoneConfigs []EndpointPrivateDnsZoneConfig: A private_dns_zone_configs block as defined below.

customDnsConfigs List<EndpointCustomDnsConfig>: A custom_dns_configs block as defined below.
id String: The provider-assigned unique ID for this managed resource.
networkInterfaces List<EndpointNetworkInterface>: A network_interface block as defined below.
privateDnsZoneConfigs List<EndpointPrivateDnsZoneConfig>: A private_dns_zone_configs block as defined below.

customDnsConfigs EndpointCustomDnsConfig[]: A custom_dns_configs block as defined below.
id string: The provider-assigned unique ID for this managed resource.
networkInterfaces EndpointNetworkInterface[]: A network_interface block as defined below.
privateDnsZoneConfigs EndpointPrivateDnsZoneConfig[]: A private_dns_zone_configs block as defined below.

custom_dns_configs Sequence[EndpointCustomDnsConfig]: A custom_dns_configs block as defined below.
id str: The provider-assigned unique ID for this managed resource.
network_interfaces Sequence[EndpointNetworkInterface]: A network_interface block as defined below.
private_dns_zone_configs Sequence[EndpointPrivateDnsZoneConfig]: A private_dns_zone_configs block as defined below.

customDnsConfigs List<Property Map>: A custom_dns_configs block as defined below.
id String: The provider-assigned unique ID for this managed resource.
networkInterfaces List<Property Map>: A network_interface block as defined below.
privateDnsZoneConfigs List<Property Map>: A private_dns_zone_configs block as defined below.

Look up Existing Endpoint Resource

Get an existing Endpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EndpointState, opts?: CustomResourceOptions): Endpoint

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_dns_configs: Optional[Sequence[EndpointCustomDnsConfigArgs]] = None,
        custom_network_interface_name: Optional[str] = None,
        ip_configurations: Optional[Sequence[EndpointIpConfigurationArgs]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        network_interfaces: Optional[Sequence[EndpointNetworkInterfaceArgs]] = None,
        private_dns_zone_configs: Optional[Sequence[EndpointPrivateDnsZoneConfigArgs]] = None,
        private_dns_zone_group: Optional[EndpointPrivateDnsZoneGroupArgs] = None,
        private_service_connection: Optional[EndpointPrivateServiceConnectionArgs] = None,
        resource_group_name: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Endpoint

func GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)

public static Endpoint Get(string name, Input<string> id, EndpointState? state, CustomResourceOptions? opts = null)

public static Endpoint get(String name, Output<String> id, EndpointState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CustomDnsConfigs List<EndpointCustomDnsConfigArgs>: A custom_dns_configs block as defined below.
CustomNetworkInterfaceName string: The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
IpConfigurations List<EndpointIpConfigurationArgs>: One or more ip_configuration blocks as defined below. This allows a static IP address to be set for this Private Endpoint, otherwise an address is dynamically allocated from the Subnet.
Location string: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
NetworkInterfaces List<EndpointNetworkInterfaceArgs>: A network_interface block as defined below.
PrivateDnsZoneConfigs List<EndpointPrivateDnsZoneConfigArgs>: A private_dns_zone_configs block as defined below.
PrivateDnsZoneGroup EndpointPrivateDnsZoneGroupArgs: A private_dns_zone_group block as defined below.
PrivateServiceConnection EndpointPrivateServiceConnectionArgs: A private_service_connection block as defined below.
ResourceGroupName string: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
SubnetId string: The ID of the Subnet from which Private IP Addresses will be allocated for this Private Endpoint. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

CustomDnsConfigs []EndpointCustomDnsConfigArgs: A custom_dns_configs block as defined below.
CustomNetworkInterfaceName string: The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
IpConfigurations []EndpointIpConfigurationArgs: One or more ip_configuration blocks as defined below. This allows a static IP address to be set for this Private Endpoint, otherwise an address is dynamically allocated from the Subnet.
Location string: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
NetworkInterfaces []EndpointNetworkInterfaceArgs: A network_interface block as defined below.
PrivateDnsZoneConfigs []EndpointPrivateDnsZoneConfigArgs: A private_dns_zone_configs block as defined below.
PrivateDnsZoneGroup EndpointPrivateDnsZoneGroupArgs: A private_dns_zone_group block as defined below.
PrivateServiceConnection EndpointPrivateServiceConnectionArgs: A private_service_connection block as defined below.
ResourceGroupName string: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
SubnetId string: The ID of the Subnet from which Private IP Addresses will be allocated for this Private Endpoint. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.

customDnsConfigs List<EndpointCustomDnsConfigArgs>: A custom_dns_configs block as defined below.
customNetworkInterfaceName String: The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
ipConfigurations List<EndpointIpConfigurationArgs>: One or more ip_configuration blocks as defined below. This allows a static IP address to be set for this Private Endpoint, otherwise an address is dynamically allocated from the Subnet.
location String: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
networkInterfaces List<EndpointNetworkInterfaceArgs>: A network_interface block as defined below.
privateDnsZoneConfigs List<EndpointPrivateDnsZoneConfigArgs>: A private_dns_zone_configs block as defined below.
privateDnsZoneGroup EndpointPrivateDnsZoneGroupArgs: A private_dns_zone_group block as defined below.
privateServiceConnection EndpointPrivateServiceConnectionArgs: A private_service_connection block as defined below.
resourceGroupName String: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
subnetId String: The ID of the Subnet from which Private IP Addresses will be allocated for this Private Endpoint. Changing this forces a new resource to be created.
tags Map<String,String>: A mapping of tags to assign to the resource.

customDnsConfigs EndpointCustomDnsConfigArgs[]: A custom_dns_configs block as defined below.
customNetworkInterfaceName string: The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
ipConfigurations EndpointIpConfigurationArgs[]: One or more ip_configuration blocks as defined below. This allows a static IP address to be set for this Private Endpoint, otherwise an address is dynamically allocated from the Subnet.
location string: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
networkInterfaces EndpointNetworkInterfaceArgs[]: A network_interface block as defined below.
privateDnsZoneConfigs EndpointPrivateDnsZoneConfigArgs[]: A private_dns_zone_configs block as defined below.
privateDnsZoneGroup EndpointPrivateDnsZoneGroupArgs: A private_dns_zone_group block as defined below.
privateServiceConnection EndpointPrivateServiceConnectionArgs: A private_service_connection block as defined below.
resourceGroupName string: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
subnetId string: The ID of the Subnet from which Private IP Addresses will be allocated for this Private Endpoint. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

custom_dns_configs Sequence[EndpointCustomDnsConfigArgs]: A custom_dns_configs block as defined below.
custom_network_interface_name str: The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
ip_configurations Sequence[EndpointIpConfigurationArgs]: One or more ip_configuration blocks as defined below. This allows a static IP address to be set for this Private Endpoint, otherwise an address is dynamically allocated from the Subnet.
location str: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
network_interfaces Sequence[EndpointNetworkInterfaceArgs]: A network_interface block as defined below.
private_dns_zone_configs Sequence[EndpointPrivateDnsZoneConfigArgs]: A private_dns_zone_configs block as defined below.
private_dns_zone_group EndpointPrivateDnsZoneGroupArgs: A private_dns_zone_group block as defined below.
private_service_connection EndpointPrivateServiceConnectionArgs: A private_service_connection block as defined below.
resource_group_name str: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
subnet_id str: The ID of the Subnet from which Private IP Addresses will be allocated for this Private Endpoint. Changing this forces a new resource to be created.
tags Mapping[str, str]: A mapping of tags to assign to the resource.

customDnsConfigs List<Property Map>: A custom_dns_configs block as defined below.
customNetworkInterfaceName String: The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
ipConfigurations List<Property Map>: One or more ip_configuration blocks as defined below. This allows a static IP address to be set for this Private Endpoint, otherwise an address is dynamically allocated from the Subnet.
location String: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
networkInterfaces List<Property Map>: A network_interface block as defined below.
privateDnsZoneConfigs List<Property Map>: A private_dns_zone_configs block as defined below.
privateDnsZoneGroup Property Map: A private_dns_zone_group block as defined below.
privateServiceConnection Property Map: A private_service_connection block as defined below.
resourceGroupName String: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
subnetId String: The ID of the Subnet from which Private IP Addresses will be allocated for this Private Endpoint. Changing this forces a new resource to be created.
tags Map<String>: A mapping of tags to assign to the resource.

Supporting Types

EndpointCustomDnsConfig

Fqdn string: The fully qualified domain name to the private_dns_zone.
IpAddresses List<string>: A list of all IP Addresses that map to the private_dns_zone fqdn.

Fqdn string: The fully qualified domain name to the private_dns_zone.
IpAddresses []string: A list of all IP Addresses that map to the private_dns_zone fqdn.

fqdn String: The fully qualified domain name to the private_dns_zone.
ipAddresses List<String>: A list of all IP Addresses that map to the private_dns_zone fqdn.

fqdn string: The fully qualified domain name to the private_dns_zone.
ipAddresses string[]: A list of all IP Addresses that map to the private_dns_zone fqdn.

fqdn str: The fully qualified domain name to the private_dns_zone.
ip_addresses Sequence[str]: A list of all IP Addresses that map to the private_dns_zone fqdn.

fqdn String: The fully qualified domain name to the private_dns_zone.
ipAddresses List<String>: A list of all IP Addresses that map to the private_dns_zone fqdn.

EndpointIpConfiguration

Name string: Specifies the Name of the IP Configuration. Changing this forces a new resource to be created.
PrivateIpAddress string: Specifies the static IP address within the private endpoint's subnet to be used. Changing this forces a new resource to be created.
MemberName string: Specifies the member name this IP address applies to. If it is not specified, it will use the value of subresource_name. Changing this forces a new resource to be created.
SubresourceName string: Specifies the subresource this IP address applies to. subresource_names corresponds to group_id. Changing this forces a new resource to be created.

Name string: Specifies the Name of the IP Configuration. Changing this forces a new resource to be created.
PrivateIpAddress string: Specifies the static IP address within the private endpoint's subnet to be used. Changing this forces a new resource to be created.
MemberName string: Specifies the member name this IP address applies to. If it is not specified, it will use the value of subresource_name. Changing this forces a new resource to be created.
SubresourceName string: Specifies the subresource this IP address applies to. subresource_names corresponds to group_id. Changing this forces a new resource to be created.

name String: Specifies the Name of the IP Configuration. Changing this forces a new resource to be created.
privateIpAddress String: Specifies the static IP address within the private endpoint's subnet to be used. Changing this forces a new resource to be created.
memberName String: Specifies the member name this IP address applies to. If it is not specified, it will use the value of subresource_name. Changing this forces a new resource to be created.
subresourceName String: Specifies the subresource this IP address applies to. subresource_names corresponds to group_id. Changing this forces a new resource to be created.

name string: Specifies the Name of the IP Configuration. Changing this forces a new resource to be created.
privateIpAddress string: Specifies the static IP address within the private endpoint's subnet to be used. Changing this forces a new resource to be created.
memberName string: Specifies the member name this IP address applies to. If it is not specified, it will use the value of subresource_name. Changing this forces a new resource to be created.
subresourceName string: Specifies the subresource this IP address applies to. subresource_names corresponds to group_id. Changing this forces a new resource to be created.

name str: Specifies the Name of the IP Configuration. Changing this forces a new resource to be created.
private_ip_address str: Specifies the static IP address within the private endpoint's subnet to be used. Changing this forces a new resource to be created.
member_name str: Specifies the member name this IP address applies to. If it is not specified, it will use the value of subresource_name. Changing this forces a new resource to be created.
subresource_name str: Specifies the subresource this IP address applies to. subresource_names corresponds to group_id. Changing this forces a new resource to be created.

name String: Specifies the Name of the IP Configuration. Changing this forces a new resource to be created.
privateIpAddress String: Specifies the static IP address within the private endpoint's subnet to be used. Changing this forces a new resource to be created.
memberName String: Specifies the member name this IP address applies to. If it is not specified, it will use the value of subresource_name. Changing this forces a new resource to be created.
subresourceName String: Specifies the subresource this IP address applies to. subresource_names corresponds to group_id. Changing this forces a new resource to be created.

EndpointNetworkInterface

Id string: The ID of the Private DNS Zone Config.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.

Id string: The ID of the Private DNS Zone Config.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.

id String: The ID of the Private DNS Zone Config.
name String: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.

id string: The ID of the Private DNS Zone Config.
name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.

id str: The ID of the Private DNS Zone Config.
name str: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.

id String: The ID of the Private DNS Zone Config.
name String: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.

EndpointPrivateDnsZoneConfig

Id string: The ID of the Private DNS Zone Config.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
PrivateDnsZoneId string: A list of IP Addresses
RecordSets List<EndpointPrivateDnsZoneConfigRecordSet>: A record_sets block as defined below.

Id string: The ID of the Private DNS Zone Config.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
PrivateDnsZoneId string: A list of IP Addresses
RecordSets []EndpointPrivateDnsZoneConfigRecordSet: A record_sets block as defined below.

id String: The ID of the Private DNS Zone Config.
name String: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
privateDnsZoneId String: A list of IP Addresses
recordSets List<EndpointPrivateDnsZoneConfigRecordSet>: A record_sets block as defined below.

id string: The ID of the Private DNS Zone Config.
name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
privateDnsZoneId string: A list of IP Addresses
recordSets EndpointPrivateDnsZoneConfigRecordSet[]: A record_sets block as defined below.

id str: The ID of the Private DNS Zone Config.
name str: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
private_dns_zone_id str: A list of IP Addresses
record_sets Sequence[EndpointPrivateDnsZoneConfigRecordSet]: A record_sets block as defined below.

id String: The ID of the Private DNS Zone Config.
name String: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
privateDnsZoneId String: A list of IP Addresses
recordSets List<Property Map>: A record_sets block as defined below.

EndpointPrivateDnsZoneConfigRecordSet

Fqdn string: The fully qualified domain name to the private_dns_zone.
IpAddresses List<string>: A list of all IP Addresses that map to the private_dns_zone fqdn.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
Ttl int: The time to live for each connection to the private_dns_zone.
Type string: The type of DNS record.

Fqdn string: The fully qualified domain name to the private_dns_zone.
IpAddresses []string: A list of all IP Addresses that map to the private_dns_zone fqdn.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
Ttl int: The time to live for each connection to the private_dns_zone.
Type string: The type of DNS record.

fqdn String: The fully qualified domain name to the private_dns_zone.
ipAddresses List<String>: A list of all IP Addresses that map to the private_dns_zone fqdn.
name String: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
ttl Integer: The time to live for each connection to the private_dns_zone.
type String: The type of DNS record.

fqdn string: The fully qualified domain name to the private_dns_zone.
ipAddresses string[]: A list of all IP Addresses that map to the private_dns_zone fqdn.
name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
ttl number: The time to live for each connection to the private_dns_zone.
type string: The type of DNS record.

fqdn str: The fully qualified domain name to the private_dns_zone.
ip_addresses Sequence[str]: A list of all IP Addresses that map to the private_dns_zone fqdn.
name str: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
ttl int: The time to live for each connection to the private_dns_zone.
type str: The type of DNS record.

fqdn String: The fully qualified domain name to the private_dns_zone.
ipAddresses List<String>: A list of all IP Addresses that map to the private_dns_zone fqdn.
name String: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
ttl Number: The time to live for each connection to the private_dns_zone.
type String: The type of DNS record.

EndpointPrivateDnsZoneGroup

Name string: Specifies the Name of the Private DNS Zone Group.
PrivateDnsZoneIds List<string>: Specifies the list of Private DNS Zones to include within the private_dns_zone_group.
Id string: The ID of the Private DNS Zone Config.

Name string: Specifies the Name of the Private DNS Zone Group.
PrivateDnsZoneIds []string: Specifies the list of Private DNS Zones to include within the private_dns_zone_group.
Id string: The ID of the Private DNS Zone Config.

name String: Specifies the Name of the Private DNS Zone Group.
privateDnsZoneIds List<String>: Specifies the list of Private DNS Zones to include within the private_dns_zone_group.
id String: The ID of the Private DNS Zone Config.

name string: Specifies the Name of the Private DNS Zone Group.
privateDnsZoneIds string[]: Specifies the list of Private DNS Zones to include within the private_dns_zone_group.
id string: The ID of the Private DNS Zone Config.

name str: Specifies the Name of the Private DNS Zone Group.
private_dns_zone_ids Sequence[str]: Specifies the list of Private DNS Zones to include within the private_dns_zone_group.
id str: The ID of the Private DNS Zone Config.

name String: Specifies the Name of the Private DNS Zone Group.
privateDnsZoneIds List<String>: Specifies the list of Private DNS Zones to include within the private_dns_zone_group.
id String: The ID of the Private DNS Zone Config.

EndpointPrivateServiceConnection

IsManualConnection bool: Does the Private Endpoint require Manual Approval from the remote resource owner? Changing this forces a new resource to be created.
Name string: Specifies the Name of the Private Service Connection. Changing this forces a new resource to be created.
PrivateConnectionResourceAlias string: The Service Alias of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of private_connection_resource_id or private_connection_resource_alias must be specified. Changing this forces a new resource to be created.
PrivateConnectionResourceId string: The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of private_connection_resource_id or private_connection_resource_alias must be specified. Changing this forces a new resource to be created. For a web app or function app slot, the parent web app should be used in this field instead of a reference to the slot itself.
PrivateIpAddress string: Specifies the static IP address within the private endpoint's subnet to be used. Changing this forces a new resource to be created.
RequestMessage string: A message passed to the owner of the remote resource when the private endpoint attempts to establish the connection to the remote resource. The request message can be a maximum of 140 characters in length. Only valid if is_manual_connection is set to true.
SubresourceNames List<string>: A list of subresource names which the Private Endpoint is able to connect to. subresource_names corresponds to group_id. Possible values are detailed in the product documentation in the Subresources column. Changing this forces a new resource to be created.

IsManualConnection bool: Does the Private Endpoint require Manual Approval from the remote resource owner? Changing this forces a new resource to be created.
Name string: Specifies the Name of the Private Service Connection. Changing this forces a new resource to be created.
PrivateConnectionResourceAlias string: The Service Alias of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of private_connection_resource_id or private_connection_resource_alias must be specified. Changing this forces a new resource to be created.
PrivateConnectionResourceId string: The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of private_connection_resource_id or private_connection_resource_alias must be specified. Changing this forces a new resource to be created. For a web app or function app slot, the parent web app should be used in this field instead of a reference to the slot itself.
PrivateIpAddress string: Specifies the static IP address within the private endpoint's subnet to be used. Changing this forces a new resource to be created.
RequestMessage string: A message passed to the owner of the remote resource when the private endpoint attempts to establish the connection to the remote resource. The request message can be a maximum of 140 characters in length. Only valid if is_manual_connection is set to true.
SubresourceNames []string: A list of subresource names which the Private Endpoint is able to connect to. subresource_names corresponds to group_id. Possible values are detailed in the product documentation in the Subresources column. Changing this forces a new resource to be created.

isManualConnection Boolean: Does the Private Endpoint require Manual Approval from the remote resource owner? Changing this forces a new resource to be created.
name String: Specifies the Name of the Private Service Connection. Changing this forces a new resource to be created.
privateConnectionResourceAlias String: The Service Alias of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of private_connection_resource_id or private_connection_resource_alias must be specified. Changing this forces a new resource to be created.
privateConnectionResourceId String: The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of private_connection_resource_id or private_connection_resource_alias must be specified. Changing this forces a new resource to be created. For a web app or function app slot, the parent web app should be used in this field instead of a reference to the slot itself.
privateIpAddress String: Specifies the static IP address within the private endpoint's subnet to be used. Changing this forces a new resource to be created.
requestMessage String: A message passed to the owner of the remote resource when the private endpoint attempts to establish the connection to the remote resource. The request message can be a maximum of 140 characters in length. Only valid if is_manual_connection is set to true.
subresourceNames List<String>: A list of subresource names which the Private Endpoint is able to connect to. subresource_names corresponds to group_id. Possible values are detailed in the product documentation in the Subresources column. Changing this forces a new resource to be created.

isManualConnection boolean: Does the Private Endpoint require Manual Approval from the remote resource owner? Changing this forces a new resource to be created.
name string: Specifies the Name of the Private Service Connection. Changing this forces a new resource to be created.
privateConnectionResourceAlias string: The Service Alias of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of private_connection_resource_id or private_connection_resource_alias must be specified. Changing this forces a new resource to be created.
privateConnectionResourceId string: The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of private_connection_resource_id or private_connection_resource_alias must be specified. Changing this forces a new resource to be created. For a web app or function app slot, the parent web app should be used in this field instead of a reference to the slot itself.
privateIpAddress string: Specifies the static IP address within the private endpoint's subnet to be used. Changing this forces a new resource to be created.
requestMessage string: A message passed to the owner of the remote resource when the private endpoint attempts to establish the connection to the remote resource. The request message can be a maximum of 140 characters in length. Only valid if is_manual_connection is set to true.
subresourceNames string[]: A list of subresource names which the Private Endpoint is able to connect to. subresource_names corresponds to group_id. Possible values are detailed in the product documentation in the Subresources column. Changing this forces a new resource to be created.

is_manual_connection bool: Does the Private Endpoint require Manual Approval from the remote resource owner? Changing this forces a new resource to be created.
name str: Specifies the Name of the Private Service Connection. Changing this forces a new resource to be created.
private_connection_resource_alias str: The Service Alias of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of private_connection_resource_id or private_connection_resource_alias must be specified. Changing this forces a new resource to be created.
private_connection_resource_id str: The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of private_connection_resource_id or private_connection_resource_alias must be specified. Changing this forces a new resource to be created. For a web app or function app slot, the parent web app should be used in this field instead of a reference to the slot itself.
private_ip_address str: Specifies the static IP address within the private endpoint's subnet to be used. Changing this forces a new resource to be created.
request_message str: A message passed to the owner of the remote resource when the private endpoint attempts to establish the connection to the remote resource. The request message can be a maximum of 140 characters in length. Only valid if is_manual_connection is set to true.
subresource_names Sequence[str]: A list of subresource names which the Private Endpoint is able to connect to. subresource_names corresponds to group_id. Possible values are detailed in the product documentation in the Subresources column. Changing this forces a new resource to be created.

isManualConnection Boolean: Does the Private Endpoint require Manual Approval from the remote resource owner? Changing this forces a new resource to be created.
name String: Specifies the Name of the Private Service Connection. Changing this forces a new resource to be created.
privateConnectionResourceAlias String: The Service Alias of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of private_connection_resource_id or private_connection_resource_alias must be specified. Changing this forces a new resource to be created.
privateConnectionResourceId String: The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of private_connection_resource_id or private_connection_resource_alias must be specified. Changing this forces a new resource to be created. For a web app or function app slot, the parent web app should be used in this field instead of a reference to the slot itself.
privateIpAddress String: Specifies the static IP address within the private endpoint's subnet to be used. Changing this forces a new resource to be created.
requestMessage String: A message passed to the owner of the remote resource when the private endpoint attempts to establish the connection to the remote resource. The request message can be a maximum of 140 characters in length. Only valid if is_manual_connection is set to true.
subresourceNames List<String>: A list of subresource names which the Private Endpoint is able to connect to. subresource_names corresponds to group_id. Possible values are detailed in the product documentation in the Subresources column. Changing this forces a new resource to be created.

Import

Private Endpoints can be imported using the resource id, e.g.

 $ pulumi import azure:privatelink/endpoint:Endpoint example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/privateEndpoints/endpoint1

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure Classic v5.43.0 published on Saturday, May 6, 2023 by Pulumi

pulumi/pulumi-azure

azure.privatelink.Endpoint

On this page

On this page

Example Usage

Create Endpoint Resource

Endpoint Resource Properties

Inputs

Outputs

Look up Existing Endpoint Resource

Supporting Types

EndpointCustomDnsConfig

EndpointIpConfiguration

EndpointNetworkInterface

EndpointPrivateDnsZoneConfig

EndpointPrivateDnsZoneConfigRecordSet

EndpointPrivateDnsZoneGroup

EndpointPrivateServiceConnection

Import

Package Details

On this page

On this page