We recommend using Azure Native.
azure.privatelink.Endpoint
Explore with Pulumi AI
Manages a Private Endpoint.
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:
- Private
Service EndpointConnection Private Service Connection Args A
private_service_connection
block as defined below.- Resource
Group stringName 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 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.
- Custom
Network stringInterface Name The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
- Ip
Configurations List<EndpointIp Configuration Args> 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.
- Private
Dns EndpointZone Group Private Dns Zone Group Args A
private_dns_zone_group
block as defined below.- Dictionary<string, string>
A mapping of tags to assign to the resource.
- Private
Service EndpointConnection Private Service Connection Args A
private_service_connection
block as defined below.- Resource
Group stringName 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 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.
- Custom
Network stringInterface Name The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
- Ip
Configurations []EndpointIp Configuration Args 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.
- Private
Dns EndpointZone Group Private Dns Zone Group Args A
private_dns_zone_group
block as defined below.- map[string]string
A mapping of tags to assign to the resource.
- private
Service EndpointConnection Private Service Connection Args A
private_service_connection
block as defined below.- resource
Group StringName 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 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.
- custom
Network StringInterface Name The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
- ip
Configurations List<EndpointIp Configuration Args> 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.
- private
Dns EndpointZone Group Private Dns Zone Group Args A
private_dns_zone_group
block as defined below.- Map<String,String>
A mapping of tags to assign to the resource.
- private
Service EndpointConnection Private Service Connection Args A
private_service_connection
block as defined below.- resource
Group stringName 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 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.
- custom
Network stringInterface Name The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
- ip
Configurations EndpointIp Configuration Args[] 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.
- private
Dns EndpointZone Group Private Dns Zone Group Args A
private_dns_zone_group
block as defined below.- {[key: string]: string}
A mapping of tags to assign to the resource.
- private_
service_ Endpointconnection Private Service Connection Args A
private_service_connection
block as defined below.- resource_
group_ strname 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_ strinterface_ name The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
- ip_
configurations Sequence[EndpointIp Configuration Args] 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_ Endpointzone_ group Private Dns Zone Group Args A
private_dns_zone_group
block as defined below.- Mapping[str, str]
A mapping of tags to assign to the resource.
- private
Service Property MapConnection A
private_service_connection
block as defined below.- resource
Group StringName 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 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.
- custom
Network StringInterface Name The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
- ip
Configurations 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.
- private
Dns Property MapZone Group A
private_dns_zone_group
block as defined below.- 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:
- Custom
Dns List<EndpointConfigs Custom Dns Config> A
custom_dns_configs
block as defined below.- Id string
The provider-assigned unique ID for this managed resource.
- Network
Interfaces List<EndpointNetwork Interface> A
network_interface
block as defined below.- Private
Dns List<EndpointZone Configs Private Dns Zone Config> A
private_dns_zone_configs
block as defined below.
- Custom
Dns []EndpointConfigs Custom Dns Config A
custom_dns_configs
block as defined below.- Id string
The provider-assigned unique ID for this managed resource.
- Network
Interfaces []EndpointNetwork Interface A
network_interface
block as defined below.- Private
Dns []EndpointZone Configs Private Dns Zone Config A
private_dns_zone_configs
block as defined below.
- custom
Dns List<EndpointConfigs Custom Dns Config> A
custom_dns_configs
block as defined below.- id String
The provider-assigned unique ID for this managed resource.
- network
Interfaces List<EndpointNetwork Interface> A
network_interface
block as defined below.- private
Dns List<EndpointZone Configs Private Dns Zone Config> A
private_dns_zone_configs
block as defined below.
- custom
Dns EndpointConfigs Custom Dns Config[] A
custom_dns_configs
block as defined below.- id string
The provider-assigned unique ID for this managed resource.
- network
Interfaces EndpointNetwork Interface[] A
network_interface
block as defined below.- private
Dns EndpointZone Configs Private Dns Zone Config[] A
private_dns_zone_configs
block as defined below.
- custom_
dns_ Sequence[Endpointconfigs Custom Dns Config] A
custom_dns_configs
block as defined below.- id str
The provider-assigned unique ID for this managed resource.
- network_
interfaces Sequence[EndpointNetwork Interface] A
network_interface
block as defined below.- private_
dns_ Sequence[Endpointzone_ configs Private Dns Zone Config] A
private_dns_zone_configs
block as defined below.
- custom
Dns List<Property Map>Configs A
custom_dns_configs
block as defined below.- id String
The provider-assigned unique ID for this managed resource.
- network
Interfaces List<Property Map> A
network_interface
block as defined below.- private
Dns List<Property Map>Zone Configs 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.
- Custom
Dns List<EndpointConfigs Custom Dns Config Args> A
custom_dns_configs
block as defined below.- Custom
Network stringInterface Name The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
- Ip
Configurations List<EndpointIp Configuration Args> 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.
- Network
Interfaces List<EndpointNetwork Interface Args> A
network_interface
block as defined below.- Private
Dns List<EndpointZone Configs Private Dns Zone Config Args> A
private_dns_zone_configs
block as defined below.- Private
Dns EndpointZone Group Private Dns Zone Group Args A
private_dns_zone_group
block as defined below.- Private
Service EndpointConnection Private Service Connection Args A
private_service_connection
block as defined below.- Resource
Group stringName 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 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.
- Dictionary<string, string>
A mapping of tags to assign to the resource.
- Custom
Dns []EndpointConfigs Custom Dns Config Args A
custom_dns_configs
block as defined below.- Custom
Network stringInterface Name The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
- Ip
Configurations []EndpointIp Configuration Args 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.
- Network
Interfaces []EndpointNetwork Interface Args A
network_interface
block as defined below.- Private
Dns []EndpointZone Configs Private Dns Zone Config Args A
private_dns_zone_configs
block as defined below.- Private
Dns EndpointZone Group Private Dns Zone Group Args A
private_dns_zone_group
block as defined below.- Private
Service EndpointConnection Private Service Connection Args A
private_service_connection
block as defined below.- Resource
Group stringName 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 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.
- map[string]string
A mapping of tags to assign to the resource.
- custom
Dns List<EndpointConfigs Custom Dns Config Args> A
custom_dns_configs
block as defined below.- custom
Network StringInterface Name The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
- ip
Configurations List<EndpointIp Configuration Args> 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.
- network
Interfaces List<EndpointNetwork Interface Args> A
network_interface
block as defined below.- private
Dns List<EndpointZone Configs Private Dns Zone Config Args> A
private_dns_zone_configs
block as defined below.- private
Dns EndpointZone Group Private Dns Zone Group Args A
private_dns_zone_group
block as defined below.- private
Service EndpointConnection Private Service Connection Args A
private_service_connection
block as defined below.- resource
Group StringName 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 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.
- Map<String,String>
A mapping of tags to assign to the resource.
- custom
Dns EndpointConfigs Custom Dns Config Args[] A
custom_dns_configs
block as defined below.- custom
Network stringInterface Name The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
- ip
Configurations EndpointIp Configuration Args[] 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.
- network
Interfaces EndpointNetwork Interface Args[] A
network_interface
block as defined below.- private
Dns EndpointZone Configs Private Dns Zone Config Args[] A
private_dns_zone_configs
block as defined below.- private
Dns EndpointZone Group Private Dns Zone Group Args A
private_dns_zone_group
block as defined below.- private
Service EndpointConnection Private Service Connection Args A
private_service_connection
block as defined below.- resource
Group stringName 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 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.
- {[key: string]: string}
A mapping of tags to assign to the resource.
- custom_
dns_ Sequence[Endpointconfigs Custom Dns Config Args] A
custom_dns_configs
block as defined below.- custom_
network_ strinterface_ name The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
- ip_
configurations Sequence[EndpointIp Configuration Args] 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[EndpointNetwork Interface Args] A
network_interface
block as defined below.- private_
dns_ Sequence[Endpointzone_ configs Private Dns Zone Config Args] A
private_dns_zone_configs
block as defined below.- private_
dns_ Endpointzone_ group Private Dns Zone Group Args A
private_dns_zone_group
block as defined below.- private_
service_ Endpointconnection Private Service Connection Args A
private_service_connection
block as defined below.- resource_
group_ strname 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.
- Mapping[str, str]
A mapping of tags to assign to the resource.
- custom
Dns List<Property Map>Configs A
custom_dns_configs
block as defined below.- custom
Network StringInterface Name The custom name of the network interface attached to the private endpoint. Changing this forces a new resource to be created.
- ip
Configurations 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.
- network
Interfaces List<Property Map> A
network_interface
block as defined below.- private
Dns List<Property Map>Zone Configs A
private_dns_zone_configs
block as defined below.- private
Dns Property MapZone Group A
private_dns_zone_group
block as defined below.- private
Service Property MapConnection A
private_service_connection
block as defined below.- resource
Group StringName 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 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.
- 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
.- Ip
Addresses 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
.- Ip
Addresses []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
.- ip
Addresses 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
.- ip
Addresses 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
.- ip
Addresses 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.
- Private
Ip stringAddress 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 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.- Subresource
Name string Specifies the subresource this IP address applies to.
subresource_names
corresponds togroup_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.
- Private
Ip stringAddress 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 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.- Subresource
Name string Specifies the subresource this IP address applies to.
subresource_names
corresponds togroup_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.
- private
Ip StringAddress 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 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.- subresource
Name String Specifies the subresource this IP address applies to.
subresource_names
corresponds togroup_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.
- private
Ip stringAddress 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 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.- subresource
Name string Specifies the subresource this IP address applies to.
subresource_names
corresponds togroup_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_ straddress 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 togroup_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.
- private
Ip StringAddress 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 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.- subresource
Name String Specifies the subresource this IP address applies to.
subresource_names
corresponds togroup_id
. Changing this forces a new resource to be created.
EndpointNetworkInterface
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.
- Private
Dns stringZone Id A list of IP Addresses
- Record
Sets List<EndpointPrivate Dns Zone Config Record Set> 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.
- Private
Dns stringZone Id A list of IP Addresses
- Record
Sets []EndpointPrivate Dns Zone Config Record Set 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.
- private
Dns StringZone Id A list of IP Addresses
- record
Sets List<EndpointPrivate Dns Zone Config Record Set> 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.
- private
Dns stringZone Id A list of IP Addresses
- record
Sets EndpointPrivate Dns Zone Config Record Set[] 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_ strzone_ id A list of IP Addresses
- record_
sets Sequence[EndpointPrivate Dns Zone Config Record Set] 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.
- private
Dns StringZone Id A list of IP Addresses
- record
Sets List<Property Map> A
record_sets
block as defined below.
EndpointPrivateDnsZoneConfigRecordSet
- Fqdn string
The fully qualified domain name to the
private_dns_zone
.- Ip
Addresses 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
.- Ip
Addresses []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
.- ip
Addresses 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
.- ip
Addresses 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
.- ip
Addresses 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.
- Private
Dns List<string>Zone Ids 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.
- Private
Dns []stringZone Ids 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.
- private
Dns List<String>Zone Ids 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.
- private
Dns string[]Zone Ids 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_ Sequence[str]zone_ ids 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.
- private
Dns List<String>Zone Ids 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
- Is
Manual boolConnection 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.
- Private
Connection stringResource Alias The Service Alias of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of
private_connection_resource_id
orprivate_connection_resource_alias
must be specified. Changing this forces a new resource to be created.- Private
Connection stringResource Id The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of
private_connection_resource_id
orprivate_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 stringAddress 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 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 ifis_manual_connection
is set totrue
.- Subresource
Names List<string> A list of subresource names which the Private Endpoint is able to connect to.
subresource_names
corresponds togroup_id
. Possible values are detailed in the product documentation in theSubresources
column. Changing this forces a new resource to be created.
- Is
Manual boolConnection 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.
- Private
Connection stringResource Alias The Service Alias of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of
private_connection_resource_id
orprivate_connection_resource_alias
must be specified. Changing this forces a new resource to be created.- Private
Connection stringResource Id The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of
private_connection_resource_id
orprivate_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 stringAddress 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 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 ifis_manual_connection
is set totrue
.- Subresource
Names []string A list of subresource names which the Private Endpoint is able to connect to.
subresource_names
corresponds togroup_id
. Possible values are detailed in the product documentation in theSubresources
column. Changing this forces a new resource to be created.
- is
Manual BooleanConnection 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.
- private
Connection StringResource Alias The Service Alias of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of
private_connection_resource_id
orprivate_connection_resource_alias
must be specified. Changing this forces a new resource to be created.- private
Connection StringResource Id The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of
private_connection_resource_id
orprivate_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 StringAddress 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 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 ifis_manual_connection
is set totrue
.- subresource
Names List<String> A list of subresource names which the Private Endpoint is able to connect to.
subresource_names
corresponds togroup_id
. Possible values are detailed in the product documentation in theSubresources
column. Changing this forces a new resource to be created.
- is
Manual booleanConnection 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.
- private
Connection stringResource Alias The Service Alias of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of
private_connection_resource_id
orprivate_connection_resource_alias
must be specified. Changing this forces a new resource to be created.- private
Connection stringResource Id The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of
private_connection_resource_id
orprivate_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 stringAddress 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 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 ifis_manual_connection
is set totrue
.- subresource
Names string[] A list of subresource names which the Private Endpoint is able to connect to.
subresource_names
corresponds togroup_id
. Possible values are detailed in the product documentation in theSubresources
column. Changing this forces a new resource to be created.
- is_
manual_ boolconnection 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_ strresource_ alias The Service Alias of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of
private_connection_resource_id
orprivate_connection_resource_alias
must be specified. Changing this forces a new resource to be created.- private_
connection_ strresource_ id The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of
private_connection_resource_id
orprivate_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_ straddress 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 ifis_manual_connection
is set totrue
.- subresource_
names Sequence[str] A list of subresource names which the Private Endpoint is able to connect to.
subresource_names
corresponds togroup_id
. Possible values are detailed in the product documentation in theSubresources
column. Changing this forces a new resource to be created.
- is
Manual BooleanConnection 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.
- private
Connection StringResource Alias The Service Alias of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of
private_connection_resource_id
orprivate_connection_resource_alias
must be specified. Changing this forces a new resource to be created.- private
Connection StringResource Id The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. One of
private_connection_resource_id
orprivate_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 StringAddress 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 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 ifis_manual_connection
is set totrue
.- subresource
Names List<String> A list of subresource names which the Private Endpoint is able to connect to.
subresource_names
corresponds togroup_id
. Possible values are detailed in the product documentation in theSubresources
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.