PrivateLinkService

class PrivateLinkService : KotlinCustomResource

Private link service resource. Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01. Other available API versions: 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

Create private link service

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var privateLinkService = new AzureNative.Network.PrivateLinkService("privateLinkService", new()
{
AutoApproval = new AzureNative.Network.Inputs.PrivateLinkServicePropertiesAutoApprovalArgs
{
Subscriptions = new[]
{
"subscription1",
"subscription2",
},
},
Fqdns = new[]
{
"fqdn1",
"fqdn2",
"fqdn3",
},
IpConfigurations = new[]
{
new AzureNative.Network.Inputs.PrivateLinkServiceIpConfigurationArgs
{
Name = "fe-lb",
PrivateIPAddress = "10.0.1.4",
PrivateIPAddressVersion = AzureNative.Network.IPVersion.IPv4,
PrivateIPAllocationMethod = AzureNative.Network.IPAllocationMethod.Static,
Subnet = new AzureNative.Network.Inputs.SubnetArgs
{
Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb",
},
},
},
LoadBalancerFrontendIpConfigurations = new[]
{
new AzureNative.Network.Inputs.FrontendIPConfigurationArgs
{
Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
},
},
Location = "eastus",
ResourceGroupName = "rg1",
ServiceName = "testPls",
Visibility = new AzureNative.Network.Inputs.PrivateLinkServicePropertiesVisibilityArgs
{
Subscriptions = new[]
{
"subscription1",
"subscription2",
"subscription3",
},
},
});
});
package main
import (
network "github.com/pulumi/pulumi-azure-native-sdk/network/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := network.NewPrivateLinkService(ctx, "privateLinkService", &network.PrivateLinkServiceArgs{
AutoApproval: &network.PrivateLinkServicePropertiesAutoApprovalArgs{
Subscriptions: pulumi.StringArray{
pulumi.String("subscription1"),
pulumi.String("subscription2"),
},
},
Fqdns: pulumi.StringArray{
pulumi.String("fqdn1"),
pulumi.String("fqdn2"),
pulumi.String("fqdn3"),
},
IpConfigurations: network.PrivateLinkServiceIpConfigurationArray{
&network.PrivateLinkServiceIpConfigurationArgs{
Name: pulumi.String("fe-lb"),
PrivateIPAddress: pulumi.String("10.0.1.4"),
PrivateIPAddressVersion: pulumi.String(network.IPVersionIPv4),
PrivateIPAllocationMethod: pulumi.String(network.IPAllocationMethodStatic),
Subnet: &network.SubnetTypeArgs{
Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"),
},
},
},
LoadBalancerFrontendIpConfigurations: network.FrontendIPConfigurationArray{
&network.FrontendIPConfigurationArgs{
Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
},
},
Location: pulumi.String("eastus"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("testPls"),
Visibility: &network.PrivateLinkServicePropertiesVisibilityArgs{
Subscriptions: pulumi.StringArray{
pulumi.String("subscription1"),
pulumi.String("subscription2"),
pulumi.String("subscription3"),
},
},
})
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.azurenative.network.PrivateLinkService;
import com.pulumi.azurenative.network.PrivateLinkServiceArgs;
import com.pulumi.azurenative.network.inputs.PrivateLinkServicePropertiesAutoApprovalArgs;
import com.pulumi.azurenative.network.inputs.PrivateLinkServiceIpConfigurationArgs;
import com.pulumi.azurenative.network.inputs.SubnetArgs;
import com.pulumi.azurenative.network.inputs.FrontendIPConfigurationArgs;
import com.pulumi.azurenative.network.inputs.PrivateLinkServicePropertiesVisibilityArgs;
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 privateLinkService = new PrivateLinkService("privateLinkService", PrivateLinkServiceArgs.builder()
.autoApproval(PrivateLinkServicePropertiesAutoApprovalArgs.builder()
.subscriptions(
"subscription1",
"subscription2")
.build())
.fqdns(
"fqdn1",
"fqdn2",
"fqdn3")
.ipConfigurations(PrivateLinkServiceIpConfigurationArgs.builder()
.name("fe-lb")
.privateIPAddress("10.0.1.4")
.privateIPAddressVersion("IPv4")
.privateIPAllocationMethod("Static")
.subnet(SubnetArgs.builder()
.id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb")
.build())
.build())
.loadBalancerFrontendIpConfigurations(FrontendIPConfigurationArgs.builder()
.id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb")
.build())
.location("eastus")
.resourceGroupName("rg1")
.serviceName("testPls")
.visibility(PrivateLinkServicePropertiesVisibilityArgs.builder()
.subscriptions(
"subscription1",
"subscription2",
"subscription3")
.build())
.build());
}
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:network:PrivateLinkService testPls /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}

Properties

Link copied to clipboard
val alias: Output<String>

The alias of the private link service.

Link copied to clipboard

The auto-approval list of the private link service.

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard

The destination IP address of the private link service.

Link copied to clipboard

Whether the private link service is enabled for proxy protocol or not.

Link copied to clipboard
val etag: Output<String>

A unique read-only string that changes whenever the resource is updated.

Link copied to clipboard

The extended location of the load balancer.

Link copied to clipboard
val fqdns: Output<List<String>>?

The list of Fqdn.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

An array of private link service IP configurations.

Link copied to clipboard

An array of references to the load balancer IP configurations.

Link copied to clipboard
val location: Output<String>?

Resource location.

Link copied to clipboard
val name: Output<String>

Resource name.

Link copied to clipboard

An array of references to the network interfaces created for this private link service.

Link copied to clipboard

An array of list about connections to the private endpoint.

Link copied to clipboard

The provisioning state of the private link service resource.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val tags: Output<Map<String, String>>?

Resource tags.

Link copied to clipboard
val type: Output<String>

Resource type.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard

The visibility list of the private link service.