Private Endpoint Args
data class PrivateEndpointArgs(val customDnsConfigs: Output<List<CustomDnsConfigPropertiesFormatArgs>>? = null, val extendedLocation: Output<ExtendedLocationArgs>? = null, val id: Output<String>? = null, val location: Output<String>? = null, val manualPrivateLinkServiceConnections: Output<List<PrivateLinkServiceConnectionArgs>>? = null, val privateEndpointName: Output<String>? = null, val privateLinkServiceConnections: Output<List<PrivateLinkServiceConnectionArgs>>? = null, val resourceGroupName: Output<String>? = null, val subnet: Output<SubnetArgs>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<PrivateEndpointArgs>
Private endpoint resource. API Version: 2020-11-01.
Example Usage
Create private endpoint
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var privateEndpoint = new AzureNative.Network.PrivateEndpoint("privateEndpoint", new()
{
Location = "eastus2euap",
PrivateEndpointName = "testPe",
PrivateLinkServiceConnections = new[]
{
new AzureNative.Network.Inputs.PrivateLinkServiceConnectionArgs
{
GroupIds = new[]
{
"groupIdFromResource",
},
Name = "testPlc",
PrivateLinkServiceId = "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls",
RequestMessage = "Please approve my connection.",
},
},
ResourceGroupName = "rg1",
Subnet = new AzureNative.Network.Inputs.SubnetArgs
{
Id = "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet",
},
});
});
Content copied to clipboard
package main
import (
network "github.com/pulumi/pulumi-azure-native-sdk/network"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := network.NewPrivateEndpoint(ctx, "privateEndpoint", &network.PrivateEndpointArgs{
Location: pulumi.String("eastus2euap"),
PrivateEndpointName: pulumi.String("testPe"),
PrivateLinkServiceConnections: []network.PrivateLinkServiceConnectionArgs{
{
GroupIds: pulumi.StringArray{
pulumi.String("groupIdFromResource"),
},
Name: pulumi.String("testPlc"),
PrivateLinkServiceId: pulumi.String("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls"),
RequestMessage: pulumi.String("Please approve my connection."),
},
},
ResourceGroupName: pulumi.String("rg1"),
Subnet: &network.SubnetTypeArgs{
Id: pulumi.String("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet"),
},
})
if err != nil {
return err
}
return nil
})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.PrivateEndpoint;
import com.pulumi.azurenative.network.PrivateEndpointArgs;
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 privateEndpoint = new PrivateEndpoint("privateEndpoint", PrivateEndpointArgs.builder()
.location("eastus2euap")
.privateEndpointName("testPe")
.privateLinkServiceConnections(Map.ofEntries(
Map.entry("groupIds", "groupIdFromResource"),
Map.entry("name", "testPlc"),
Map.entry("privateLinkServiceId", "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls"),
Map.entry("requestMessage", "Please approve my connection.")
))
.resourceGroupName("rg1")
.subnet(Map.of("id", "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet"))
.build());
}
}
Content copied to clipboard
Create private endpoint with manual approval connection
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var privateEndpoint = new AzureNative.Network.PrivateEndpoint("privateEndpoint", new()
{
Location = "eastus",
ManualPrivateLinkServiceConnections = new[]
{
new AzureNative.Network.Inputs.PrivateLinkServiceConnectionArgs
{
GroupIds = new[]
{
"groupIdFromResource",
},
PrivateLinkServiceId = "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls",
RequestMessage = "Please manually approve my connection.",
},
},
PrivateEndpointName = "testPe",
ResourceGroupName = "rg1",
Subnet = new AzureNative.Network.Inputs.SubnetArgs
{
Id = "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet",
},
});
});
Content copied to clipboard
package main
import (
network "github.com/pulumi/pulumi-azure-native-sdk/network"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := network.NewPrivateEndpoint(ctx, "privateEndpoint", &network.PrivateEndpointArgs{
Location: pulumi.String("eastus"),
ManualPrivateLinkServiceConnections: []network.PrivateLinkServiceConnectionArgs{
{
GroupIds: pulumi.StringArray{
pulumi.String("groupIdFromResource"),
},
PrivateLinkServiceId: pulumi.String("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls"),
RequestMessage: pulumi.String("Please manually approve my connection."),
},
},
PrivateEndpointName: pulumi.String("testPe"),
ResourceGroupName: pulumi.String("rg1"),
Subnet: &network.SubnetTypeArgs{
Id: pulumi.String("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet"),
},
})
if err != nil {
return err
}
return nil
})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.PrivateEndpoint;
import com.pulumi.azurenative.network.PrivateEndpointArgs;
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 privateEndpoint = new PrivateEndpoint("privateEndpoint", PrivateEndpointArgs.builder()
.location("eastus")
.manualPrivateLinkServiceConnections(Map.ofEntries(
Map.entry("groupIds", "groupIdFromResource"),
Map.entry("privateLinkServiceId", "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls"),
Map.entry("requestMessage", "Please manually approve my connection.")
))
.privateEndpointName("testPe")
.resourceGroupName("rg1")
.subnet(Map.of("id", "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet"))
.build());
}
}
Content copied to clipboard
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:network:PrivateEndpoint testPe /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe
Content copied to clipboard
Constructors
Link copied to clipboard
constructor(customDnsConfigs: Output<List<CustomDnsConfigPropertiesFormatArgs>>? = null, extendedLocation: Output<ExtendedLocationArgs>? = null, id: Output<String>? = null, location: Output<String>? = null, manualPrivateLinkServiceConnections: Output<List<PrivateLinkServiceConnectionArgs>>? = null, privateEndpointName: Output<String>? = null, privateLinkServiceConnections: Output<List<PrivateLinkServiceConnectionArgs>>? = null, resourceGroupName: Output<String>? = null, subnet: Output<SubnetArgs>? = null, tags: Output<Map<String, String>>? = null)
Properties
Link copied to clipboard
An array of custom dns configurations.
Link copied to clipboard
The extended location of the load balancer.
Link copied to clipboard
A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.
Link copied to clipboard
The name of the private endpoint.
Link copied to clipboard
A grouping of information about the connection to the remote resource.
Link copied to clipboard
The name of the resource group.
Link copied to clipboard
The ID of the subnet from which the private IP will be allocated.