Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. privatelink
  5. getService

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.privatelink.getService

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

    Use this data source to access information about an existing Private Link Service.

    Example Usage

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

const example = azure.privatelink.getService({
    name: "myPrivateLinkService",
    resourceGroupName: "PrivateLinkServiceRG",
});
export const privateLinkServiceId = example.then(example => example.id);

    import pulumi
import pulumi_azure as azure

example = azure.privatelink.get_service(name="myPrivateLinkService",
    resource_group_name="PrivateLinkServiceRG")
pulumi.export("privateLinkServiceId", example.id)

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/privatelink"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := privatelink.GetService(ctx, &privatelink.GetServiceArgs{
			Name:              "myPrivateLinkService",
			ResourceGroupName: "PrivateLinkServiceRG",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("privateLinkServiceId", example.Id)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Azure.PrivateLink.GetService.Invoke(new()
    {
        Name = "myPrivateLinkService",
        ResourceGroupName = "PrivateLinkServiceRG",
    });

    return new Dictionary<string, object?>
    {
        ["privateLinkServiceId"] = example.Apply(getServiceResult => getServiceResult.Id),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.privatelink.PrivatelinkFunctions;
import com.pulumi.azure.privatelink.inputs.GetServiceArgs;
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 example = PrivatelinkFunctions.getService(GetServiceArgs.builder()
            .name("myPrivateLinkService")
            .resourceGroupName("PrivateLinkServiceRG")
            .build());

        ctx.export("privateLinkServiceId", example.applyValue(getServiceResult -> getServiceResult.id()));
    }
}

    variables:
  example:
    fn::invoke:
      function: azure:privatelink:getService
      arguments:
        name: myPrivateLinkService
        resourceGroupName: PrivateLinkServiceRG
outputs:
  privateLinkServiceId: ${example.id}

    Using getService

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getService(args: GetServiceArgs, opts?: InvokeOptions): Promise<GetServiceResult>
function getServiceOutput(args: GetServiceOutputArgs, opts?: InvokeOptions): Output<GetServiceResult>
    def get_service(name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetServiceResult
def get_service_output(name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetServiceResult]
    func GetService(ctx *Context, args *GetServiceArgs, opts ...InvokeOption) (*GetServiceResult, error)
func GetServiceOutput(ctx *Context, args *GetServiceOutputArgs, opts ...InvokeOption) GetServiceResultOutput

    > Note: This function is named GetService in the Go SDK.

    public static class GetService 
{
    public static Task<GetServiceResult> InvokeAsync(GetServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceResult> Invoke(GetServiceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
public static Output<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)

    fn::invoke:
  function: azure:privatelink/getService:getService
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the private link service.
    ResourceGroupName string
    The name of the resource group in which the private link service resides.
    Name string
    The name of the private link service.
    ResourceGroupName string
    The name of the resource group in which the private link service resides.
    name String
    The name of the private link service.
    resourceGroupName String
    The name of the resource group in which the private link service resides.
    name string
    The name of the private link service.
    resourceGroupName string
    The name of the resource group in which the private link service resides.
    name str
    The name of the private link service.
    resource_group_name str
    The name of the resource group in which the private link service resides.
    name String
    The name of the private link service.
    resourceGroupName String
    The name of the resource group in which the private link service resides.

    getService Result

    The following output properties are available:

    Alias string
    The alias is a globally unique name for your private link service which Azure generates for you. Your can use this alias to request a connection to your private link service.
    AutoApprovalSubscriptionIds List<string>
    The list of subscription(s) globally unique identifiers that will be auto approved to use the private link service.
    EnableProxyProtocol bool
    Does the Private Link Service support the Proxy Protocol?
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerFrontendIpConfigurationIds List<string>
    The list of Standard Load Balancer(SLB) resource IDs. The Private Link service is tied to the frontend IP address of a SLB. All traffic destined for the private link service will reach the frontend of the SLB. You can configure SLB rules to direct this traffic to appropriate backend pools where your applications are running.
    Location string
    The supported Azure location where the resource exists.
    Name string
    The name of private link service NAT IP configuration.
    NatIpConfigurations List<GetServiceNatIpConfiguration>
    The nat_ip_configuration block as defined below.
    ResourceGroupName string
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    VisibilitySubscriptionIds List<string>
    The list of subscription(s) globally unique identifiers(GUID) that will be able to see the private link service.
    Alias string
    The alias is a globally unique name for your private link service which Azure generates for you. Your can use this alias to request a connection to your private link service.
    AutoApprovalSubscriptionIds []string
    The list of subscription(s) globally unique identifiers that will be auto approved to use the private link service.
    EnableProxyProtocol bool
    Does the Private Link Service support the Proxy Protocol?
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerFrontendIpConfigurationIds []string
    The list of Standard Load Balancer(SLB) resource IDs. The Private Link service is tied to the frontend IP address of a SLB. All traffic destined for the private link service will reach the frontend of the SLB. You can configure SLB rules to direct this traffic to appropriate backend pools where your applications are running.
    Location string
    The supported Azure location where the resource exists.
    Name string
    The name of private link service NAT IP configuration.
    NatIpConfigurations []GetServiceNatIpConfiguration
    The nat_ip_configuration block as defined below.
    ResourceGroupName string
    Tags map[string]string
    A mapping of tags to assign to the resource.
    VisibilitySubscriptionIds []string
    The list of subscription(s) globally unique identifiers(GUID) that will be able to see the private link service.
    alias String
    The alias is a globally unique name for your private link service which Azure generates for you. Your can use this alias to request a connection to your private link service.
    autoApprovalSubscriptionIds List<String>
    The list of subscription(s) globally unique identifiers that will be auto approved to use the private link service.
    enableProxyProtocol Boolean
    Does the Private Link Service support the Proxy Protocol?
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerFrontendIpConfigurationIds List<String>
    The list of Standard Load Balancer(SLB) resource IDs. The Private Link service is tied to the frontend IP address of a SLB. All traffic destined for the private link service will reach the frontend of the SLB. You can configure SLB rules to direct this traffic to appropriate backend pools where your applications are running.
    location String
    The supported Azure location where the resource exists.
    name String
    The name of private link service NAT IP configuration.
    natIpConfigurations List<GetServiceNatIpConfiguration>
    The nat_ip_configuration block as defined below.
    resourceGroupName String
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    visibilitySubscriptionIds List<String>
    The list of subscription(s) globally unique identifiers(GUID) that will be able to see the private link service.
    alias string
    The alias is a globally unique name for your private link service which Azure generates for you. Your can use this alias to request a connection to your private link service.
    autoApprovalSubscriptionIds string[]
    The list of subscription(s) globally unique identifiers that will be auto approved to use the private link service.
    enableProxyProtocol boolean
    Does the Private Link Service support the Proxy Protocol?
    id string
    The provider-assigned unique ID for this managed resource.
    loadBalancerFrontendIpConfigurationIds string[]
    The list of Standard Load Balancer(SLB) resource IDs. The Private Link service is tied to the frontend IP address of a SLB. All traffic destined for the private link service will reach the frontend of the SLB. You can configure SLB rules to direct this traffic to appropriate backend pools where your applications are running.
    location string
    The supported Azure location where the resource exists.
    name string
    The name of private link service NAT IP configuration.
    natIpConfigurations GetServiceNatIpConfiguration[]
    The nat_ip_configuration block as defined below.
    resourceGroupName string
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    visibilitySubscriptionIds string[]
    The list of subscription(s) globally unique identifiers(GUID) that will be able to see the private link service.
    alias str
    The alias is a globally unique name for your private link service which Azure generates for you. Your can use this alias to request a connection to your private link service.
    auto_approval_subscription_ids Sequence[str]
    The list of subscription(s) globally unique identifiers that will be auto approved to use the private link service.
    enable_proxy_protocol bool
    Does the Private Link Service support the Proxy Protocol?
    id str
    The provider-assigned unique ID for this managed resource.
    load_balancer_frontend_ip_configuration_ids Sequence[str]
    The list of Standard Load Balancer(SLB) resource IDs. The Private Link service is tied to the frontend IP address of a SLB. All traffic destined for the private link service will reach the frontend of the SLB. You can configure SLB rules to direct this traffic to appropriate backend pools where your applications are running.
    location str
    The supported Azure location where the resource exists.
    name str
    The name of private link service NAT IP configuration.
    nat_ip_configurations Sequence[GetServiceNatIpConfiguration]
    The nat_ip_configuration block as defined below.
    resource_group_name str
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    visibility_subscription_ids Sequence[str]
    The list of subscription(s) globally unique identifiers(GUID) that will be able to see the private link service.
    alias String
    The alias is a globally unique name for your private link service which Azure generates for you. Your can use this alias to request a connection to your private link service.
    autoApprovalSubscriptionIds List<String>
    The list of subscription(s) globally unique identifiers that will be auto approved to use the private link service.
    enableProxyProtocol Boolean
    Does the Private Link Service support the Proxy Protocol?
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerFrontendIpConfigurationIds List<String>
    The list of Standard Load Balancer(SLB) resource IDs. The Private Link service is tied to the frontend IP address of a SLB. All traffic destined for the private link service will reach the frontend of the SLB. You can configure SLB rules to direct this traffic to appropriate backend pools where your applications are running.
    location String
    The supported Azure location where the resource exists.
    name String
    The name of private link service NAT IP configuration.
    natIpConfigurations List<Property Map>
    The nat_ip_configuration block as defined below.
    resourceGroupName String
    tags Map<String>
    A mapping of tags to assign to the resource.
    visibilitySubscriptionIds List<String>
    The list of subscription(s) globally unique identifiers(GUID) that will be able to see the private link service.

    Supporting Types

    GetServiceNatIpConfiguration

    Name string
    The name of the private link service.
    Primary bool
    Value that indicates if the IP configuration is the primary configuration or not.
    PrivateIpAddress string
    The private IP address of the NAT IP configuration.
    PrivateIpAddressVersion string
    The version of the IP Protocol.
    SubnetId string
    The ID of the subnet to be used by the service.
    Name string
    The name of the private link service.
    Primary bool
    Value that indicates if the IP configuration is the primary configuration or not.
    PrivateIpAddress string
    The private IP address of the NAT IP configuration.
    PrivateIpAddressVersion string
    The version of the IP Protocol.
    SubnetId string
    The ID of the subnet to be used by the service.
    name String
    The name of the private link service.
    primary Boolean
    Value that indicates if the IP configuration is the primary configuration or not.
    privateIpAddress String
    The private IP address of the NAT IP configuration.
    privateIpAddressVersion String
    The version of the IP Protocol.
    subnetId String
    The ID of the subnet to be used by the service.
    name string
    The name of the private link service.
    primary boolean
    Value that indicates if the IP configuration is the primary configuration or not.
    privateIpAddress string
    The private IP address of the NAT IP configuration.
    privateIpAddressVersion string
    The version of the IP Protocol.
    subnetId string
    The ID of the subnet to be used by the service.
    name str
    The name of the private link service.
    primary bool
    Value that indicates if the IP configuration is the primary configuration or not.
    private_ip_address str
    The private IP address of the NAT IP configuration.
    private_ip_address_version str
    The version of the IP Protocol.
    subnet_id str
    The ID of the subnet to be used by the service.
    name String
    The name of the private link service.
    primary Boolean
    Value that indicates if the IP configuration is the primary configuration or not.
    privateIpAddress String
    The private IP address of the NAT IP configuration.
    privateIpAddressVersion String
    The version of the IP Protocol.
    subnetId String
    The ID of the subnet to be used by the service.

    Package Details

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

    We recommend using Azure Native.

    Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-azure