Azure v6.22.0, Apr 1 25

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.privatedns.LinkService

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

pulumi/pulumi-azure

Example Usage

TypeScript
Python
Go
C#
Java
YAML

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    name: example
    properties:
      name: example-network
      resourceGroupName: ${example.name}
      location: ${example.location}
      addressSpaces:
        - 10.5.0.0/16
  exampleSubnet:
    type: azure:network:Subnet
    name: example
    properties:
      name: example-subnet
      resourceGroupName: ${example.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.5.1.0/24
      enforcePrivateLinkServiceNetworkPolicies: true
  examplePublicIp:
    type: azure:network:PublicIp
    name: example
    properties:
      name: example-api
      sku: Standard
      location: ${example.location}
      resourceGroupName: ${example.name}
      allocationMethod: Static
  exampleLoadBalancer:
    type: azure:lb:LoadBalancer
    name: example
    properties:
      name: example-lb
      sku: Standard
      location: ${example.location}
      resourceGroupName: ${example.name}
      frontendIpConfigurations:
        - name: ${examplePublicIp.name}
          publicIpAddressId: ${examplePublicIp.id}
  exampleLinkService:
    type: azure:privatedns:LinkService
    name: example
    properties:
      name: example-privatelink
      resourceGroupName: ${example.name}
      location: ${example.location}
      autoApprovalSubscriptionIds:
        - 00000000-0000-0000-0000-000000000000
      visibilitySubscriptionIds:
        - 00000000-0000-0000-0000-000000000000
      loadBalancerFrontendIpConfigurationIds:
        - ${exampleLoadBalancer.frontendIpConfigurations[0].id}
      natIpConfigurations:
        - name: primary
          privateIpAddress: 10.5.1.17
          privateIpAddressVersion: IPv4
          subnetId: ${exampleSubnet.id}
          primary: true
        - name: secondary
          privateIpAddress: 10.5.1.18
          privateIpAddressVersion: IPv4
          subnetId: ${exampleSubnet.id}
          primary: false

Create LinkService Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

new LinkService(name: string, args: LinkServiceArgs, opts?: CustomResourceOptions);

@overload
def LinkService(resource_name: str,
                args: LinkServiceArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def LinkService(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                load_balancer_frontend_ip_configuration_ids: Optional[Sequence[str]] = None,
                nat_ip_configurations: Optional[Sequence[LinkServiceNatIpConfigurationArgs]] = None,
                resource_group_name: Optional[str] = None,
                auto_approval_subscription_ids: Optional[Sequence[str]] = None,
                enable_proxy_protocol: Optional[bool] = None,
                fqdns: Optional[Sequence[str]] = None,
                location: Optional[str] = None,
                name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                visibility_subscription_ids: Optional[Sequence[str]] = None)

func NewLinkService(ctx *Context, name string, args LinkServiceArgs, opts ...ResourceOption) (*LinkService, error)

public LinkService(string name, LinkServiceArgs args, CustomResourceOptions? opts = null)

public LinkService(String name, LinkServiceArgs args)
public LinkService(String name, LinkServiceArgs args, CustomResourceOptions options)

type: azure:privatedns:LinkService
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args LinkServiceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args LinkServiceArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args LinkServiceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args LinkServiceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args LinkServiceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

TypeScript
Python
Go
C#
Java
YAML

var linkServiceResource = new Azure.PrivateDns.LinkService("linkServiceResource", new()
{
    LoadBalancerFrontendIpConfigurationIds = new[]
    {
        "string",
    },
    NatIpConfigurations = new[]
    {
        new Azure.PrivateDns.Inputs.LinkServiceNatIpConfigurationArgs
        {
            Name = "string",
            Primary = false,
            SubnetId = "string",
            PrivateIpAddress = "string",
            PrivateIpAddressVersion = "string",
        },
    },
    ResourceGroupName = "string",
    AutoApprovalSubscriptionIds = new[]
    {
        "string",
    },
    EnableProxyProtocol = false,
    Fqdns = new[]
    {
        "string",
    },
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VisibilitySubscriptionIds = new[]
    {
        "string",
    },
});

example, err := privatedns.NewLinkService(ctx, "linkServiceResource", &privatedns.LinkServiceArgs{
	LoadBalancerFrontendIpConfigurationIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	NatIpConfigurations: privatedns.LinkServiceNatIpConfigurationArray{
		&privatedns.LinkServiceNatIpConfigurationArgs{
			Name:                    pulumi.String("string"),
			Primary:                 pulumi.Bool(false),
			SubnetId:                pulumi.String("string"),
			PrivateIpAddress:        pulumi.String("string"),
			PrivateIpAddressVersion: pulumi.String("string"),
		},
	},
	ResourceGroupName: pulumi.String("string"),
	AutoApprovalSubscriptionIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	EnableProxyProtocol: pulumi.Bool(false),
	Fqdns: pulumi.StringArray{
		pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VisibilitySubscriptionIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var linkServiceResource = new LinkService("linkServiceResource", LinkServiceArgs.builder()
    .loadBalancerFrontendIpConfigurationIds("string")
    .natIpConfigurations(LinkServiceNatIpConfigurationArgs.builder()
        .name("string")
        .primary(false)
        .subnetId("string")
        .privateIpAddress("string")
        .privateIpAddressVersion("string")
        .build())
    .resourceGroupName("string")
    .autoApprovalSubscriptionIds("string")
    .enableProxyProtocol(false)
    .fqdns("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .visibilitySubscriptionIds("string")
    .build());

link_service_resource = azure.privatedns.LinkService("linkServiceResource",
    load_balancer_frontend_ip_configuration_ids=["string"],
    nat_ip_configurations=[{
        "name": "string",
        "primary": False,
        "subnet_id": "string",
        "private_ip_address": "string",
        "private_ip_address_version": "string",
    }],
    resource_group_name="string",
    auto_approval_subscription_ids=["string"],
    enable_proxy_protocol=False,
    fqdns=["string"],
    location="string",
    name="string",
    tags={
        "string": "string",
    },
    visibility_subscription_ids=["string"])

const linkServiceResource = new azure.privatedns.LinkService("linkServiceResource", {
    loadBalancerFrontendIpConfigurationIds: ["string"],
    natIpConfigurations: [{
        name: "string",
        primary: false,
        subnetId: "string",
        privateIpAddress: "string",
        privateIpAddressVersion: "string",
    }],
    resourceGroupName: "string",
    autoApprovalSubscriptionIds: ["string"],
    enableProxyProtocol: false,
    fqdns: ["string"],
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
    visibilitySubscriptionIds: ["string"],
});

type: azure:privatedns:LinkService
properties:
    autoApprovalSubscriptionIds:
        - string
    enableProxyProtocol: false
    fqdns:
        - string
    loadBalancerFrontendIpConfigurationIds:
        - string
    location: string
    name: string
    natIpConfigurations:
        - name: string
          primary: false
          privateIpAddress: string
          privateIpAddressVersion: string
          subnetId: string
    resourceGroupName: string
    tags:
        string: string
    visibilitySubscriptionIds:
        - string

LinkService Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The LinkService resource accepts the following input properties:

LoadBalancerFrontendIpConfigurationIds List<string>: A list of Frontend IP Configuration IDs from a Standard Load Balancer, where traffic from the Private Link Service should be routed. You can use Load Balancer Rules to direct this traffic to appropriate backend pools where your applications are running. Changing this forces a new resource to be created.
NatIpConfigurations List<LinkServiceNatIpConfiguration>: One or more (up to 8) nat_ip_configuration block as defined below.
ResourceGroupName string: The name of the Resource Group where the Private Link Service should exist. Changing this forces a new resource to be created.
AutoApprovalSubscriptionIds List<string>: A list of Subscription UUID/GUID's that will be automatically be able to use this Private Link Service.
EnableProxyProtocol bool: Should the Private Link Service support the Proxy Protocol?
Fqdns List<string>: List of FQDNs allowed for the Private Link Service.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of this Private Link Service. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
VisibilitySubscriptionIds List<string>: A list of Subscription UUID/GUID's that will be able to see this Private Link Service.
NOTE: If no Subscription IDs are specified then Azure allows every Subscription to see this Private Link Service.

LoadBalancerFrontendIpConfigurationIds []string: A list of Frontend IP Configuration IDs from a Standard Load Balancer, where traffic from the Private Link Service should be routed. You can use Load Balancer Rules to direct this traffic to appropriate backend pools where your applications are running. Changing this forces a new resource to be created.
NatIpConfigurations []LinkServiceNatIpConfigurationArgs: One or more (up to 8) nat_ip_configuration block as defined below.
ResourceGroupName string: The name of the Resource Group where the Private Link Service should exist. Changing this forces a new resource to be created.
AutoApprovalSubscriptionIds []string: A list of Subscription UUID/GUID's that will be automatically be able to use this Private Link Service.
EnableProxyProtocol bool: Should the Private Link Service support the Proxy Protocol?
Fqdns []string: List of FQDNs allowed for the Private Link Service.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of this Private Link Service. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.
VisibilitySubscriptionIds []string: A list of Subscription UUID/GUID's that will be able to see this Private Link Service.
NOTE: If no Subscription IDs are specified then Azure allows every Subscription to see this Private Link Service.

loadBalancerFrontendIpConfigurationIds List<String>: A list of Frontend IP Configuration IDs from a Standard Load Balancer, where traffic from the Private Link Service should be routed. You can use Load Balancer Rules to direct this traffic to appropriate backend pools where your applications are running. Changing this forces a new resource to be created.
natIpConfigurations List<LinkServiceNatIpConfiguration>: One or more (up to 8) nat_ip_configuration block as defined below.
resourceGroupName String: The name of the Resource Group where the Private Link Service should exist. Changing this forces a new resource to be created.
autoApprovalSubscriptionIds List<String>: A list of Subscription UUID/GUID's that will be automatically be able to use this Private Link Service.
enableProxyProtocol Boolean: Should the Private Link Service support the Proxy Protocol?
fqdns List<String>: List of FQDNs allowed for the Private Link Service.
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the name of this Private Link Service. Changing this forces a new resource to be created.
tags Map<String,String>: A mapping of tags to assign to the resource.
visibilitySubscriptionIds List<String>: A list of Subscription UUID/GUID's that will be able to see this Private Link Service.
NOTE: If no Subscription IDs are specified then Azure allows every Subscription to see this Private Link Service.

loadBalancerFrontendIpConfigurationIds string[]: A list of Frontend IP Configuration IDs from a Standard Load Balancer, where traffic from the Private Link Service should be routed. You can use Load Balancer Rules to direct this traffic to appropriate backend pools where your applications are running. Changing this forces a new resource to be created.
natIpConfigurations LinkServiceNatIpConfiguration[]: One or more (up to 8) nat_ip_configuration block as defined below.
resourceGroupName string: The name of the Resource Group where the Private Link Service should exist. Changing this forces a new resource to be created.
autoApprovalSubscriptionIds string[]: A list of Subscription UUID/GUID's that will be automatically be able to use this Private Link Service.
enableProxyProtocol boolean: Should the Private Link Service support the Proxy Protocol?
fqdns string[]: List of FQDNs allowed for the Private Link Service.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of this Private Link Service. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
visibilitySubscriptionIds string[]: A list of Subscription UUID/GUID's that will be able to see this Private Link Service.
NOTE: If no Subscription IDs are specified then Azure allows every Subscription to see this Private Link Service.

load_balancer_frontend_ip_configuration_ids Sequence[str]: A list of Frontend IP Configuration IDs from a Standard Load Balancer, where traffic from the Private Link Service should be routed. You can use Load Balancer Rules to direct this traffic to appropriate backend pools where your applications are running. Changing this forces a new resource to be created.
nat_ip_configurations Sequence[LinkServiceNatIpConfigurationArgs]: One or more (up to 8) nat_ip_configuration block as defined below.
resource_group_name str: The name of the Resource Group where the Private Link Service should exist. Changing this forces a new resource to be created.
auto_approval_subscription_ids Sequence[str]: A list of Subscription UUID/GUID's that will be automatically be able to use this Private Link Service.
enable_proxy_protocol bool: Should the Private Link Service support the Proxy Protocol?
fqdns Sequence[str]: List of FQDNs allowed for the Private Link Service.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of this Private Link Service. Changing this forces a new resource to be created.
tags Mapping[str, str]: A mapping of tags to assign to the resource.
visibility_subscription_ids Sequence[str]: A list of Subscription UUID/GUID's that will be able to see this Private Link Service.
NOTE: If no Subscription IDs are specified then Azure allows every Subscription to see this Private Link Service.

loadBalancerFrontendIpConfigurationIds List<String>: A list of Frontend IP Configuration IDs from a Standard Load Balancer, where traffic from the Private Link Service should be routed. You can use Load Balancer Rules to direct this traffic to appropriate backend pools where your applications are running. Changing this forces a new resource to be created.
natIpConfigurations List<Property Map>: One or more (up to 8) nat_ip_configuration block as defined below.
resourceGroupName String: The name of the Resource Group where the Private Link Service should exist. Changing this forces a new resource to be created.
autoApprovalSubscriptionIds List<String>: A list of Subscription UUID/GUID's that will be automatically be able to use this Private Link Service.
enableProxyProtocol Boolean: Should the Private Link Service support the Proxy Protocol?
fqdns List<String>: List of FQDNs allowed for the Private Link Service.
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the name of this Private Link Service. Changing this forces a new resource to be created.
tags Map<String>: A mapping of tags to assign to the resource.
visibilitySubscriptionIds List<String>: A list of Subscription UUID/GUID's that will be able to see this Private Link Service.
NOTE: If no Subscription IDs are specified then Azure allows every Subscription to see this Private Link Service.

Outputs

All input properties are implicitly available as output properties. Additionally, the LinkService resource produces the following output properties:

Alias string: A globally unique DNS Name for your Private Link Service. You can use this alias to request a connection to your Private Link Service.
Id string: The provider-assigned unique ID for this managed resource.

Alias string: A globally unique DNS Name for your Private Link Service. You can use this alias to request a connection to your Private Link Service.
Id string: The provider-assigned unique ID for this managed resource.

alias String: A globally unique DNS Name for your Private Link Service. You can use this alias to request a connection to your Private Link Service.
id String: The provider-assigned unique ID for this managed resource.

alias string: A globally unique DNS Name for your Private Link Service. You can use this alias to request a connection to your Private Link Service.
id string: The provider-assigned unique ID for this managed resource.

alias str: A globally unique DNS Name for your Private Link Service. You can use this alias to request a connection to your Private Link Service.
id str: The provider-assigned unique ID for this managed resource.

alias String: A globally unique DNS Name for your Private Link Service. You can use this alias to request a connection to your Private Link Service.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing LinkService Resource

Get an existing LinkService resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: LinkServiceState, opts?: CustomResourceOptions): LinkService

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alias: Optional[str] = None,
        auto_approval_subscription_ids: Optional[Sequence[str]] = None,
        enable_proxy_protocol: Optional[bool] = None,
        fqdns: Optional[Sequence[str]] = None,
        load_balancer_frontend_ip_configuration_ids: Optional[Sequence[str]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        nat_ip_configurations: Optional[Sequence[LinkServiceNatIpConfigurationArgs]] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        visibility_subscription_ids: Optional[Sequence[str]] = None) -> LinkService

func GetLinkService(ctx *Context, name string, id IDInput, state *LinkServiceState, opts ...ResourceOption) (*LinkService, error)

public static LinkService Get(string name, Input<string> id, LinkServiceState? state, CustomResourceOptions? opts = null)

public static LinkService get(String name, Output<String> id, LinkServiceState state, CustomResourceOptions options)

resources:  _:    type: azure:privatedns:LinkService    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Alias string: A globally unique DNS Name for your Private Link Service. You can use this alias to request a connection to your Private Link Service.
AutoApprovalSubscriptionIds List<string>: A list of Subscription UUID/GUID's that will be automatically be able to use this Private Link Service.
EnableProxyProtocol bool: Should the Private Link Service support the Proxy Protocol?
Fqdns List<string>: List of FQDNs allowed for the Private Link Service.
LoadBalancerFrontendIpConfigurationIds List<string>: A list of Frontend IP Configuration IDs from a Standard Load Balancer, where traffic from the Private Link Service should be routed. You can use Load Balancer Rules to direct this traffic to appropriate backend pools where your applications are running. Changing this forces a new resource to be created.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of this Private Link Service. Changing this forces a new resource to be created.
NatIpConfigurations List<LinkServiceNatIpConfiguration>: One or more (up to 8) nat_ip_configuration block as defined below.
ResourceGroupName string: The name of the Resource Group where the Private Link Service should exist. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
VisibilitySubscriptionIds List<string>: A list of Subscription UUID/GUID's that will be able to see this Private Link Service.
NOTE: If no Subscription IDs are specified then Azure allows every Subscription to see this Private Link Service.

Alias string: A globally unique DNS Name for your Private Link Service. You can use this alias to request a connection to your Private Link Service.
AutoApprovalSubscriptionIds []string: A list of Subscription UUID/GUID's that will be automatically be able to use this Private Link Service.
EnableProxyProtocol bool: Should the Private Link Service support the Proxy Protocol?
Fqdns []string: List of FQDNs allowed for the Private Link Service.
LoadBalancerFrontendIpConfigurationIds []string: A list of Frontend IP Configuration IDs from a Standard Load Balancer, where traffic from the Private Link Service should be routed. You can use Load Balancer Rules to direct this traffic to appropriate backend pools where your applications are running. Changing this forces a new resource to be created.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of this Private Link Service. Changing this forces a new resource to be created.
NatIpConfigurations []LinkServiceNatIpConfigurationArgs: One or more (up to 8) nat_ip_configuration block as defined below.
ResourceGroupName string: The name of the Resource Group where the Private Link Service should exist. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.
VisibilitySubscriptionIds []string: A list of Subscription UUID/GUID's that will be able to see this Private Link Service.
NOTE: If no Subscription IDs are specified then Azure allows every Subscription to see this Private Link Service.

alias String: A globally unique DNS Name for your Private Link Service. You can use this alias to request a connection to your Private Link Service.
autoApprovalSubscriptionIds List<String>: A list of Subscription UUID/GUID's that will be automatically be able to use this Private Link Service.
enableProxyProtocol Boolean: Should the Private Link Service support the Proxy Protocol?
fqdns List<String>: List of FQDNs allowed for the Private Link Service.
loadBalancerFrontendIpConfigurationIds List<String>: A list of Frontend IP Configuration IDs from a Standard Load Balancer, where traffic from the Private Link Service should be routed. You can use Load Balancer Rules to direct this traffic to appropriate backend pools where your applications are running. Changing this forces a new resource to be created.
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the name of this Private Link Service. Changing this forces a new resource to be created.
natIpConfigurations List<LinkServiceNatIpConfiguration>: One or more (up to 8) nat_ip_configuration block as defined below.
resourceGroupName String: The name of the Resource Group where the Private Link Service should exist. Changing this forces a new resource to be created.
tags Map<String,String>: A mapping of tags to assign to the resource.
visibilitySubscriptionIds List<String>: A list of Subscription UUID/GUID's that will be able to see this Private Link Service.
NOTE: If no Subscription IDs are specified then Azure allows every Subscription to see this Private Link Service.

alias string: A globally unique DNS Name for your Private Link Service. You can use this alias to request a connection to your Private Link Service.
autoApprovalSubscriptionIds string[]: A list of Subscription UUID/GUID's that will be automatically be able to use this Private Link Service.
enableProxyProtocol boolean: Should the Private Link Service support the Proxy Protocol?
fqdns string[]: List of FQDNs allowed for the Private Link Service.
loadBalancerFrontendIpConfigurationIds string[]: A list of Frontend IP Configuration IDs from a Standard Load Balancer, where traffic from the Private Link Service should be routed. You can use Load Balancer Rules to direct this traffic to appropriate backend pools where your applications are running. Changing this forces a new resource to be created.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of this Private Link Service. Changing this forces a new resource to be created.
natIpConfigurations LinkServiceNatIpConfiguration[]: One or more (up to 8) nat_ip_configuration block as defined below.
resourceGroupName string: The name of the Resource Group where the Private Link Service should exist. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
visibilitySubscriptionIds string[]: A list of Subscription UUID/GUID's that will be able to see this Private Link Service.
NOTE: If no Subscription IDs are specified then Azure allows every Subscription to see this Private Link Service.

alias str: A globally unique DNS Name for your Private Link Service. You can use this alias to request a connection to your Private Link Service.
auto_approval_subscription_ids Sequence[str]: A list of Subscription UUID/GUID's that will be automatically be able to use this Private Link Service.
enable_proxy_protocol bool: Should the Private Link Service support the Proxy Protocol?
fqdns Sequence[str]: List of FQDNs allowed for the Private Link Service.
load_balancer_frontend_ip_configuration_ids Sequence[str]: A list of Frontend IP Configuration IDs from a Standard Load Balancer, where traffic from the Private Link Service should be routed. You can use Load Balancer Rules to direct this traffic to appropriate backend pools where your applications are running. Changing this forces a new resource to be created.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of this Private Link Service. Changing this forces a new resource to be created.
nat_ip_configurations Sequence[LinkServiceNatIpConfigurationArgs]: One or more (up to 8) nat_ip_configuration block as defined below.
resource_group_name str: The name of the Resource Group where the Private Link Service should exist. Changing this forces a new resource to be created.
tags Mapping[str, str]: A mapping of tags to assign to the resource.
visibility_subscription_ids Sequence[str]: A list of Subscription UUID/GUID's that will be able to see this Private Link Service.
NOTE: If no Subscription IDs are specified then Azure allows every Subscription to see this Private Link Service.

alias String: A globally unique DNS Name for your Private Link Service. You can use this alias to request a connection to your Private Link Service.
autoApprovalSubscriptionIds List<String>: A list of Subscription UUID/GUID's that will be automatically be able to use this Private Link Service.
enableProxyProtocol Boolean: Should the Private Link Service support the Proxy Protocol?
fqdns List<String>: List of FQDNs allowed for the Private Link Service.
loadBalancerFrontendIpConfigurationIds List<String>: A list of Frontend IP Configuration IDs from a Standard Load Balancer, where traffic from the Private Link Service should be routed. You can use Load Balancer Rules to direct this traffic to appropriate backend pools where your applications are running. Changing this forces a new resource to be created.
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the name of this Private Link Service. Changing this forces a new resource to be created.
natIpConfigurations List<Property Map>: One or more (up to 8) nat_ip_configuration block as defined below.
resourceGroupName String: The name of the Resource Group where the Private Link Service should exist. Changing this forces a new resource to be created.
tags Map<String>: A mapping of tags to assign to the resource.
visibilitySubscriptionIds List<String>: A list of Subscription UUID/GUID's that will be able to see this Private Link Service.
NOTE: If no Subscription IDs are specified then Azure allows every Subscription to see this Private Link Service.

Supporting Types

LinkServiceNatIpConfiguration
, LinkServiceNatIpConfigurationArgs

Name string: Specifies the name which should be used for the NAT IP Configuration. Changing this forces a new resource to be created.
Primary bool: Is this is the Primary IP Configuration? Changing this forces a new resource to be created.
SubnetId string: Specifies the ID of the Subnet which should be used for the Private Link Service.
NOTE: Verify that the Subnet's enforce_private_link_service_network_policies attribute is set to true.
PrivateIpAddress string: Specifies a Private Static IP Address for this IP Configuration.
PrivateIpAddressVersion string: The version of the IP Protocol which should be used. At this time the only supported value is IPv4. Defaults to IPv4.

Name string: Specifies the name which should be used for the NAT IP Configuration. Changing this forces a new resource to be created.
Primary bool: Is this is the Primary IP Configuration? Changing this forces a new resource to be created.
SubnetId string: Specifies the ID of the Subnet which should be used for the Private Link Service.
NOTE: Verify that the Subnet's enforce_private_link_service_network_policies attribute is set to true.
PrivateIpAddress string: Specifies a Private Static IP Address for this IP Configuration.
PrivateIpAddressVersion string: The version of the IP Protocol which should be used. At this time the only supported value is IPv4. Defaults to IPv4.

name String: Specifies the name which should be used for the NAT IP Configuration. Changing this forces a new resource to be created.
primary Boolean: Is this is the Primary IP Configuration? Changing this forces a new resource to be created.
subnetId String: Specifies the ID of the Subnet which should be used for the Private Link Service.
NOTE: Verify that the Subnet's enforce_private_link_service_network_policies attribute is set to true.
privateIpAddress String: Specifies a Private Static IP Address for this IP Configuration.
privateIpAddressVersion String: The version of the IP Protocol which should be used. At this time the only supported value is IPv4. Defaults to IPv4.

name string: Specifies the name which should be used for the NAT IP Configuration. Changing this forces a new resource to be created.
primary boolean: Is this is the Primary IP Configuration? Changing this forces a new resource to be created.
subnetId string: Specifies the ID of the Subnet which should be used for the Private Link Service.
NOTE: Verify that the Subnet's enforce_private_link_service_network_policies attribute is set to true.
privateIpAddress string: Specifies a Private Static IP Address for this IP Configuration.
privateIpAddressVersion string: The version of the IP Protocol which should be used. At this time the only supported value is IPv4. Defaults to IPv4.

name str: Specifies the name which should be used for the NAT IP Configuration. Changing this forces a new resource to be created.
primary bool: Is this is the Primary IP Configuration? Changing this forces a new resource to be created.
subnet_id str: Specifies the ID of the Subnet which should be used for the Private Link Service.
NOTE: Verify that the Subnet's enforce_private_link_service_network_policies attribute is set to true.
private_ip_address str: Specifies a Private Static IP Address for this IP Configuration.
private_ip_address_version str: The version of the IP Protocol which should be used. At this time the only supported value is IPv4. Defaults to IPv4.

name String: Specifies the name which should be used for the NAT IP Configuration. Changing this forces a new resource to be created.
primary Boolean: Is this is the Primary IP Configuration? Changing this forces a new resource to be created.
subnetId String: Specifies the ID of the Subnet which should be used for the Private Link Service.
NOTE: Verify that the Subnet's enforce_private_link_service_network_policies attribute is set to true.
privateIpAddress String: Specifies a Private Static IP Address for this IP Configuration.
privateIpAddressVersion String: The version of the IP Protocol which should be used. At this time the only supported value is IPv4. Defaults to IPv4.

Import

Private Link Services can be imported using the resource id, e.g.

$ pulumi import azure:privatedns/linkService:LinkService example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/privateLinkServices/service1

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

pulumi/pulumi-azure

azure.privatedns.LinkService

On this page

On this page

Example Usage

Create LinkService Resource

Constructor syntax

Parameters

Constructor example

LinkService Resource Properties

Inputs

Outputs

Look up Existing LinkService Resource

Supporting Types

LinkServiceNatIpConfiguration
, LinkServiceNatIpConfigurationArgs

Import

Package Details

On this page

On this page

azure.privatedns.LinkService

On this page

On this page

Example Usage

Create LinkService Resource

Constructor syntax

Parameters

Constructor example

LinkService Resource Properties

Inputs

Outputs

Look up Existing LinkService Resource

Supporting Types

LinkServiceNatIpConfiguration, LinkServiceNatIpConfigurationArgs

Import

Package Details

On this page

On this page

LinkServiceNatIpConfiguration
, LinkServiceNatIpConfigurationArgs