Skip to content

Data Source: azurermPrivateLinkService

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

Example Usage

import * as cdktf from "cdktf";
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const dataAzurermPrivateLinkServiceExample =
  new azurerm.dataAzurermPrivateLinkService.DataAzurermPrivateLinkService(
    this,
    "example",
    {
      name: "myPrivateLinkService",
      resource_group_name: "PrivateLinkServiceRG",
    }
  );
new cdktf.TerraformOutput(this, "private_link_service_id", {
  value: dataAzurermPrivateLinkServiceExample.id,
});

Argument Reference

The following arguments are supported:

  • name - The name of the private link service.

  • resourceGroupName - The name of the resource group in which the private link service resides.

Attributes Reference

The following attributes are exported:

  • id - The Azure resource ID of the Private Link Service.

  • alias - 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 - The list of subscription(s) globally unique identifiers that will be auto approved to use the private link service.

  • enableProxyProtocol - Does the Private Link Service support the Proxy Protocol?

  • loadBalancerFrontendIpConfigurationIds - 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 - The supported Azure location where the resource exists.

  • natIpConfiguration - The natIpConfiguration block as defined below.

  • tags - A mapping of tags to assign to the resource.

  • visibilitySubscriptionIds - The list of subscription(s) globally unique identifiers(GUID) that will be able to see the private link service.

The natIpConfiguration block exports the following:

  • name - The name of private link service NAT IP configuration.

  • privateIpAddress - The private IP address of the NAT IP configuration.

  • privateIpAddressVersion - The version of the IP Protocol.

  • subnetId - The ID of the subnet to be used by the service.

  • primary - Value that indicates if the IP configuration is the primary configuration or not.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the Private Link Service.