LinkService

Manages a Private Link Service.

NOTE Private Link is now in GA.

Create a LinkService Resource

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

def LinkService(resource_name, opts=None, auto_approval_subscription_ids=None, enable_proxy_protocol=None, load_balancer_frontend_ip_configuration_ids=None, location=None, name=None, nat_ip_configurations=None, resource_group_name=None, tags=None, visibility_subscription_ids=None, __props__=None);

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

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

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.
opts ResourceOptions: A bag of options that control this 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.

LinkService Resource Properties

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

Inputs

The LinkService resource accepts the following input properties:

LoadBalancerFrontendIpConfigurationIds List<string>: A list of Frontend IP Configuration ID’s 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.
NatIpConfigurations List<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 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? Defaults to false.
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. Changing this forces a new resource to be created.
VisibilitySubscriptionIds List<string>: A list of Subscription UUID/GUID’s that will be able to see this Private Link Service.

LoadBalancerFrontendIpConfigurationIds []string: A list of Frontend IP Configuration ID’s 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.
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 bool: Should the Private Link Service support the Proxy Protocol? Defaults to false.
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. Changing this forces a new resource to be created.
VisibilitySubscriptionIds []string: A list of Subscription UUID/GUID’s that will be able to see this Private Link Service.

loadBalancerFrontendIpConfigurationIds string[]: A list of Frontend IP Configuration ID’s 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.
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? Defaults to false.
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. Changing this forces a new resource to be created.
visibilitySubscriptionIds string[]: A list of Subscription UUID/GUID’s that will be able to see this Private Link Service.

load_balancer_frontend_ip_configuration_ids List[str]: A list of Frontend IP Configuration ID’s 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.
nat_ip_configurations List[LinkServiceNatIpConfiguration]: 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 List[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? Defaults to false.
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 Dict[str, str]: A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
visibility_subscription_ids List[str]: A list of Subscription UUID/GUID’s that will be able 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 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.

Look up an Existing LinkService Resource

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

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

static get(resource_name, id, opts=None, alias=None, auto_approval_subscription_ids=None, enable_proxy_protocol=None, load_balancer_frontend_ip_configuration_ids=None, location=None, name=None, nat_ip_configurations=None, resource_group_name=None, tags=None, visibility_subscription_ids=None, __props__=None);

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)

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.

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? Defaults to false.
LoadBalancerFrontendIpConfigurationIds List<string>: A list of Frontend IP Configuration ID’s 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.
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<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 Dictionary<string, string>: A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
VisibilitySubscriptionIds List<string>: A list of Subscription UUID/GUID’s that will be able 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? Defaults to false.
LoadBalancerFrontendIpConfigurationIds []string: A list of Frontend IP Configuration ID’s 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.
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 map[string]string: A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
VisibilitySubscriptionIds []string: A list of Subscription UUID/GUID’s that will be able 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? Defaults to false.
loadBalancerFrontendIpConfigurationIds string[]: A list of Frontend IP Configuration ID’s 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.
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. Changing this forces a new resource to be created.
visibilitySubscriptionIds string[]: A list of Subscription UUID/GUID’s that will be able 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 List[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? Defaults to false.
load_balancer_frontend_ip_configuration_ids List[str]: A list of Frontend IP Configuration ID’s 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.
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 List[LinkServiceNatIpConfiguration]: 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 Dict[str, str]: A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
visibility_subscription_ids List[str]: A list of Subscription UUID/GUID’s that will be able to see this Private Link Service.

Supporting Types

LinkServiceNatIpConfiguration

See the input and output API doc for this type.

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.
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.
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.
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.
privateIpAddressVersion str: The version of the IP Protocol which should be used. At this time the only supported value is IPv4. Defaults to IPv4.
private_ip_address str: Specifies a Private Static IP Address for this IP Configuration.

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