GetService

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

NOTE Private Link is currently in Public Preview.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.PrivateLink.GetService.InvokeAsync(new Azure.PrivateLink.GetServiceArgs
        {
            Name = "myPrivateLinkService",
            ResourceGroupName = "PrivateLinkServiceRG",
        }));
        this.PrivateLinkServiceId = example.Apply(example => example.Id);
    }

    [Output("privateLinkServiceId")]
    public Output<string> PrivateLinkServiceId { get; set; }
}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/privatelink"
    "github.com/pulumi/pulumi/sdk/v2/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
    })
}

import pulumi
import pulumi_azure as azure

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

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);

Using GetService

function getService(args: GetServiceArgs, opts?: InvokeOptions): Promise<GetServiceResult>

function  get_service(name=None, resource_group_name=None, opts=None)

func GetService(ctx *Context, args *GetServiceArgs, opts ...InvokeOption) (*GetServiceResult, error)

public static class GetService {
    public static Task<GetServiceResult> InvokeAsync(GetServiceArgs args, InvokeOptions? opts = null)
}

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 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.

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 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 List[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 List[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 List[GetServiceNatIpConfiguration]: The nat_ip_configuration block as defined below.
resource_group_name str
tags Dict[str, str]: A mapping of tags to assign to the resource.
visibility_subscription_ids List[str]: The list of subscription(s) globally unique identifiers(GUID) that will be able to see the private link service.

Supporting Types

GetServiceNatIpConfiguration

See the output API doc for this type.

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 str: The name of the private link service.
primary bool: Value that indicates if the IP configuration is the primary configuration or not.
privateIpAddressVersion str: The version of the IP Protocol.
private_ip_address str: The private IP address of the NAT IP configuration.
subnet_id str: The ID of the subnet to be used by the service.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetService

Example Usage

Using GetService

GetService Result

Supporting Types

GetServiceNatIpConfiguration

Package Details

On This Page