Microsoft.Network privateLinkServices 2020-08-01

The privateLinkServices resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Network/privateLinkServices resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Network/privateLinkServices@2020-08-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  extendedLocation: {
    name: 'string'
    type: 'EdgeZone'
  }
  properties: {
    autoApproval: {
      subscriptions: [ 'string' ]
    }
    enableProxyProtocol: bool
    fqdns: [ 'string' ]
    ipConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          primary: bool
          privateIPAddress: 'string'
          privateIPAddressVersion: 'string'
          privateIPAllocationMethod: 'string'
          subnet: {
            id: 'string'
            name: 'string'
            properties: {
              addressPrefix: 'string'
              addressPrefixes: [ 'string' ]
              applicationGatewayIpConfigurations: [
                {
                  id: 'string'
                  name: 'string'
                  properties: {
                    subnet: {
                      id: 'string'
                    }
                  }
                }
              ]
              delegations: [
                {
                  id: 'string'
                  name: 'string'
                  properties: {
                    serviceName: 'string'
                  }
                  type: 'string'
                }
              ]
              ipAllocations: [
                {
                  id: 'string'
                }
              ]
              natGateway: {
                id: 'string'
              }
              networkSecurityGroup: {
                id: 'string'
                location: 'string'
                properties: {
                  securityRules: [
                    {
                      id: 'string'
                      name: 'string'
                      properties: {
                        access: 'string'
                        description: 'string'
                        destinationAddressPrefix: 'string'
                        destinationAddressPrefixes: [ 'string' ]
                        destinationApplicationSecurityGroups: [
                          {
                            id: 'string'
                            location: 'string'
                            properties: {}
                            tags: {
                              tagName1: 'tagValue1'
                              tagName2: 'tagValue2'
                            }
                          }
                        ]
                        destinationPortRange: 'string'
                        destinationPortRanges: [ 'string' ]
                        direction: 'string'
                        priority: int
                        protocol: 'string'
                        sourceAddressPrefix: 'string'
                        sourceAddressPrefixes: [ 'string' ]
                        sourceApplicationSecurityGroups: [
                          {
                            id: 'string'
                            location: 'string'
                            properties: {}
                            tags: {
                              tagName1: 'tagValue1'
                              tagName2: 'tagValue2'
                            }
                          }
                        ]
                        sourcePortRange: 'string'
                        sourcePortRanges: [ 'string' ]
                      }
                      type: 'string'
                    }
                  ]
                }
                tags: {
                  tagName1: 'tagValue1'
                  tagName2: 'tagValue2'
                }
              }
              privateEndpointNetworkPolicies: 'string'
              privateLinkServiceNetworkPolicies: 'string'
              routeTable: {
                id: 'string'
                location: 'string'
                properties: {
                  disableBgpRoutePropagation: bool
                  routes: [
                    {
                      id: 'string'
                      name: 'string'
                      properties: {
                        addressPrefix: 'string'
                        hasBgpOverride: bool
                        nextHopIpAddress: 'string'
                        nextHopType: 'string'
                      }
                      type: 'string'
                    }
                  ]
                }
                tags: {
                  tagName1: 'tagValue1'
                  tagName2: 'tagValue2'
                }
              }
              serviceEndpointPolicies: [
                {
                  id: 'string'
                  location: 'string'
                  properties: {
                    serviceEndpointPolicyDefinitions: [
                      {
                        id: 'string'
                        name: 'string'
                        properties: {
                          description: 'string'
                          service: 'string'
                          serviceResources: [ 'string' ]
                        }
                      }
                    ]
                  }
                  tags: {
                    tagName1: 'tagValue1'
                    tagName2: 'tagValue2'
                  }
                }
              ]
              serviceEndpoints: [
                {
                  locations: [ 'string' ]
                  service: 'string'
                }
              ]
            }
            type: 'string'
          }
        }
      }
    ]
    loadBalancerFrontendIpConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          privateIPAddress: 'string'
          privateIPAddressVersion: 'string'
          privateIPAllocationMethod: 'string'
          publicIPAddress: {
            extendedLocation: {
              name: 'string'
              type: 'EdgeZone'
            }
            id: 'string'
            location: 'string'
            properties: {
              ddosSettings: {
                ddosCustomPolicy: {
                  id: 'string'
                }
                protectedIP: bool
                protectionCoverage: 'string'
              }
              dnsSettings: {
                domainNameLabel: 'string'
                fqdn: 'string'
                reverseFqdn: 'string'
              }
              idleTimeoutInMinutes: int
              ipAddress: 'string'
              ipTags: [
                {
                  ipTagType: 'string'
                  tag: 'string'
                }
              ]
              linkedPublicIPAddress: {
              migrationPhase: 'string'
              natGateway: {
                id: 'string'
                location: 'string'
                properties: {
                  idleTimeoutInMinutes: int
                  publicIpAddresses: [
                    {
                      id: 'string'
                    }
                  ]
                  publicIpPrefixes: [
                    {
                      id: 'string'
                    }
                  ]
                }
                sku: {
                  name: 'Standard'
                }
                tags: {
                  tagName1: 'tagValue1'
                  tagName2: 'tagValue2'
                }
                zones: [ 'string' ]
              }
              publicIPAddressVersion: 'string'
              publicIPAllocationMethod: 'string'
              publicIPPrefix: {
                id: 'string'
              }
              servicePublicIPAddress: {}
            sku: {
              name: 'string'
              tier: 'string'
            }
            tags: {
              tagName1: 'tagValue1'
              tagName2: 'tagValue2'
            }
            zones: [ 'string' ]
          }
          publicIPPrefix: {
            id: 'string'
          }
          subnet: {
            id: 'string'
            name: 'string'
            properties: {
              addressPrefix: 'string'
              addressPrefixes: [ 'string' ]
              applicationGatewayIpConfigurations: [
                {
                  id: 'string'
                  name: 'string'
                  properties: {
                    subnet: {
                      id: 'string'
                    }
                  }
                }
              ]
              delegations: [
                {
                  id: 'string'
                  name: 'string'
                  properties: {
                    serviceName: 'string'
                  }
                  type: 'string'
                }
              ]
              ipAllocations: [
                {
                  id: 'string'
                }
              ]
              natGateway: {
                id: 'string'
              }
              networkSecurityGroup: {
                id: 'string'
                location: 'string'
                properties: {
                  securityRules: [
                    {
                      id: 'string'
                      name: 'string'
                      properties: {
                        access: 'string'
                        description: 'string'
                        destinationAddressPrefix: 'string'
                        destinationAddressPrefixes: [ 'string' ]
                        destinationApplicationSecurityGroups: [
                          {
                            id: 'string'
                            location: 'string'
                            properties: {}
                            tags: {
                              tagName1: 'tagValue1'
                              tagName2: 'tagValue2'
                            }
                          }
                        ]
                        destinationPortRange: 'string'
                        destinationPortRanges: [ 'string' ]
                        direction: 'string'
                        priority: int
                        protocol: 'string'
                        sourceAddressPrefix: 'string'
                        sourceAddressPrefixes: [ 'string' ]
                        sourceApplicationSecurityGroups: [
                          {
                            id: 'string'
                            location: 'string'
                            properties: {}
                            tags: {
                              tagName1: 'tagValue1'
                              tagName2: 'tagValue2'
                            }
                          }
                        ]
                        sourcePortRange: 'string'
                        sourcePortRanges: [ 'string' ]
                      }
                      type: 'string'
                    }
                  ]
                }
                tags: {
                  tagName1: 'tagValue1'
                  tagName2: 'tagValue2'
                }
              }
              privateEndpointNetworkPolicies: 'string'
              privateLinkServiceNetworkPolicies: 'string'
              routeTable: {
                id: 'string'
                location: 'string'
                properties: {
                  disableBgpRoutePropagation: bool
                  routes: [
                    {
                      id: 'string'
                      name: 'string'
                      properties: {
                        addressPrefix: 'string'
                        hasBgpOverride: bool
                        nextHopIpAddress: 'string'
                        nextHopType: 'string'
                      }
                      type: 'string'
                    }
                  ]
                }
                tags: {
                  tagName1: 'tagValue1'
                  tagName2: 'tagValue2'
                }
              }
              serviceEndpointPolicies: [
                {
                  id: 'string'
                  location: 'string'
                  properties: {
                    serviceEndpointPolicyDefinitions: [
                      {
                        id: 'string'
                        name: 'string'
                        properties: {
                          description: 'string'
                          service: 'string'
                          serviceResources: [ 'string' ]
                        }
                      }
                    ]
                  }
                  tags: {
                    tagName1: 'tagValue1'
                    tagName2: 'tagValue2'
                  }
                }
              ]
              serviceEndpoints: [
                {
                  locations: [ 'string' ]
                  service: 'string'
                }
              ]
            }
            type: 'string'
          }
        }
        zones: [ 'string' ]
      }
    ]
    visibility: {
      subscriptions: [ 'string' ]
    }
  }
}

Property values

privateLinkServices

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Network/privateLinkServices'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2020-08-01'
name The resource name string (required)
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
extendedLocation ExtendedLocation complex type. ExtendedLocation
properties Properties of the private link service. PrivateLinkServiceProperties

ExtendedLocation

Name Description Value
name The name of the extended location. string (required)
type The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. 'EdgeZone'

PrivateLinkServiceProperties

Name Description Value
autoApproval The auto-approval list of the private link service. PrivateLinkServicePropertiesAutoApproval
enableProxyProtocol Whether the private link service is enabled for proxy protocol or not. bool
fqdns The list of Fqdn. string[]
ipConfigurations An array of private link service IP configurations. PrivateLinkServiceIpConfiguration[]
loadBalancerFrontendIpConfigurations An array of references to the load balancer IP configurations. FrontendIPConfiguration[]
visibility The visibility list of the private link service. PrivateLinkServicePropertiesVisibility

PrivateLinkServicePropertiesAutoApproval

Name Description Value
subscriptions The list of subscriptions. string[]

PrivateLinkServiceIpConfiguration

Name Description Value
id Resource ID. string
name The name of private link service ip configuration. string
properties Properties of private link service IP configuration. PrivateLinkServiceIpConfigurationProperties

PrivateLinkServiceIpConfigurationProperties

Name Description Value
primary Whether the ip configuration is primary or not. bool
privateIPAddress The private IP address of the IP configuration. string
privateIPAddressVersion IP address version. 'IPv4'
'IPv6'
privateIPAllocationMethod IP address allocation method. 'Dynamic'
'Static'
subnet Subnet in a virtual network resource. Subnet

Subnet

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Properties of the subnet. SubnetPropertiesFormat
type Resource type. string

SubnetPropertiesFormat

Name Description Value
addressPrefix The address prefix for the subnet. string
addressPrefixes List of address prefixes for the subnet. string[]
applicationGatewayIpConfigurations Application gateway IP configurations of virtual network resource. ApplicationGatewayIPConfiguration[]
delegations An array of references to the delegations on the subnet. Delegation[]
ipAllocations Array of IpAllocation which reference this subnet. SubResource[]
natGateway Reference to another subresource. SubResource
networkSecurityGroup NetworkSecurityGroup resource. NetworkSecurityGroup
privateEndpointNetworkPolicies Enable or Disable apply network policies on private end point in the subnet. 'Disabled'
'Enabled'
privateLinkServiceNetworkPolicies Enable or Disable apply network policies on private link service in the subnet. 'Disabled'
'Enabled'
routeTable Route table resource. RouteTable
serviceEndpointPolicies An array of service endpoint policies. ServiceEndpointPolicy[]
serviceEndpoints An array of service endpoints. ServiceEndpointPropertiesFormat[]

ApplicationGatewayIPConfiguration

Name Description Value
id Resource ID. string
name Name of the IP configuration that is unique within an Application Gateway. string
properties Properties of IP configuration of an application gateway. ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationGatewayIPConfigurationPropertiesFormat

Name Description Value
subnet Reference to another subresource. SubResource

SubResource

Name Description Value
id Resource ID. string

Delegation

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a subnet. This name can be used to access the resource. string
properties Properties of a service delegation. ServiceDelegationPropertiesFormat
type Resource type. string

ServiceDelegationPropertiesFormat

Name Description Value
serviceName The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). string

NetworkSecurityGroup

Name Description Value
id Resource ID. string
location Resource location. string
properties Network Security Group resource. NetworkSecurityGroupPropertiesFormat
tags Resource tags. Dictionary of tag names and values. See Tags in templates

NetworkSecurityGroupPropertiesFormat

Name Description Value
securityRules A collection of security rules of the network security group. SecurityRule[]

SecurityRule

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Security rule resource. SecurityRulePropertiesFormat
type The type of the resource. string

SecurityRulePropertiesFormat

Name Description Value
access Whether network traffic is allowed or denied. 'Allow'
'Deny'
description A description for this rule. Restricted to 140 chars. string
destinationAddressPrefix The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. string
destinationAddressPrefixes The destination address prefixes. CIDR or destination IP ranges. string[]
destinationApplicationSecurityGroups The application security group specified as destination. ApplicationSecurityGroup[]
destinationPortRange The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. string
destinationPortRanges The destination port ranges. string[]
direction The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. 'Inbound'
'Outbound'
priority The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. int
protocol Network protocol this rule applies to. '*'
'Ah'
'Esp'
'Icmp'
'Tcp'
'Udp'
sourceAddressPrefix The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. string
sourceAddressPrefixes The CIDR or source IP ranges. string[]
sourceApplicationSecurityGroups The application security group specified as source. ApplicationSecurityGroup[]
sourcePortRange The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. string
sourcePortRanges The source port ranges. string[]

ApplicationSecurityGroup

Name Description Value
id Resource ID. string
location Resource location. string
properties Application security group properties. ApplicationSecurityGroupPropertiesFormat
tags Resource tags. Dictionary of tag names and values. See Tags in templates

ApplicationSecurityGroupPropertiesFormat

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

RouteTable

Name Description Value
id Resource ID. string
location Resource location. string
properties Route Table resource. RouteTablePropertiesFormat
tags Resource tags. Dictionary of tag names and values. See Tags in templates

RouteTablePropertiesFormat

Name Description Value
disableBgpRoutePropagation Whether to disable the routes learned by BGP on that route table. True means disable. bool
routes Collection of routes contained within a route table. Route[]

Route

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Route resource. RoutePropertiesFormat
type The type of the resource. string

RoutePropertiesFormat

Name Description Value
addressPrefix The destination CIDR to which the route applies. string
hasBgpOverride A value indicating whether this route overrides overlapping BGP routes regardless of LPM. bool
nextHopIpAddress The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. string
nextHopType The type of Azure hop the packet should be sent to. 'Internet'
'None'
'VirtualAppliance'
'VirtualNetworkGateway'
'VnetLocal'

ServiceEndpointPolicy

Name Description Value
id Resource ID. string
location Resource location. string
properties Service Endpoint Policy resource. ServiceEndpointPolicyPropertiesFormat
tags Resource tags. Dictionary of tag names and values. See Tags in templates

ServiceEndpointPolicyPropertiesFormat

Name Description Value
serviceEndpointPolicyDefinitions A collection of service endpoint policy definitions of the service endpoint policy. ServiceEndpointPolicyDefinition[]

ServiceEndpointPolicyDefinition

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Service Endpoint policy definition resource. ServiceEndpointPolicyDefinitionPropertiesFormat

ServiceEndpointPolicyDefinitionPropertiesFormat

Name Description Value
description A description for this rule. Restricted to 140 chars. string
service Service endpoint name. string
serviceResources A list of service resources. string[]

ServiceEndpointPropertiesFormat

Name Description Value
locations A list of locations. string[]
service The type of the endpoint service. string

FrontendIPConfiguration

Name Description Value
id Resource ID. string
name The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource. string
properties Properties of Frontend IP Configuration of the load balancer. FrontendIPConfigurationPropertiesFormat
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]

FrontendIPConfigurationPropertiesFormat

Name Description Value
privateIPAddress The private IP address of the IP configuration. string
privateIPAddressVersion IP address version. 'IPv4'
'IPv6'
privateIPAllocationMethod IP address allocation method. 'Dynamic'
'Static'
publicIPAddress Public IP address resource. PublicIPAddress
publicIPPrefix Reference to another subresource. SubResource
subnet Subnet in a virtual network resource. Subnet

PublicIPAddress

Name Description Value
extendedLocation ExtendedLocation complex type. ExtendedLocation
id Resource ID. string
location Resource location. string
properties Public IP address properties. PublicIPAddressPropertiesFormat
sku SKU of a public IP address. PublicIPAddressSku
tags Resource tags. Dictionary of tag names and values. See Tags in templates
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]

PublicIPAddressPropertiesFormat

Name Description Value
ddosSettings Contains the DDoS protection settings of the public IP. DdosSettings
dnsSettings Contains FQDN of the DNS record associated with the public IP address. PublicIPAddressDnsSettings
idleTimeoutInMinutes The idle timeout of the public IP address. int
ipAddress The IP address associated with the public IP address resource. string
ipTags The list of tags associated with the public IP address. IpTag[]
linkedPublicIPAddress Public IP address resource. PublicIPAddress
migrationPhase Migration phase of Public IP Address. 'Abort'
'Commit'
'Committed'
'None'
'Prepare'
natGateway Nat Gateway resource. NatGateway
publicIPAddressVersion IP address version. 'IPv4'
'IPv6'
publicIPAllocationMethod IP address allocation method. 'Dynamic'
'Static'
publicIPPrefix Reference to another subresource. SubResource
servicePublicIPAddress Public IP address resource. PublicIPAddress

DdosSettings

Name Description Value
ddosCustomPolicy Reference to another subresource. SubResource
protectedIP Enables DDoS protection on the public IP. bool
protectionCoverage The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. 'Basic'
'Standard'

PublicIPAddressDnsSettings

Name Description Value
domainNameLabel The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. string
fqdn The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. string
reverseFqdn The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. string

IpTag

Name Description Value
ipTagType The IP tag type. Example: FirstPartyUsage. string
tag The value of the IP tag associated with the public IP. Example: SQL. string

NatGateway

Name Description Value
id Resource ID. string
location Resource location. string
properties Nat Gateway properties. NatGatewayPropertiesFormat
sku SKU of nat gateway. NatGatewaySku
tags Resource tags. Dictionary of tag names and values. See Tags in templates
zones A list of availability zones denoting the zone in which Nat Gateway should be deployed. string[]

NatGatewayPropertiesFormat

Name Description Value
idleTimeoutInMinutes The idle timeout of the nat gateway. int
publicIpAddresses An array of public ip addresses associated with the nat gateway resource. SubResource[]
publicIpPrefixes An array of public ip prefixes associated with the nat gateway resource. SubResource[]

NatGatewaySku

Name Description Value
name Name of Nat Gateway SKU. 'Standard'

PublicIPAddressSku

Name Description Value
name Name of a public IP address SKU. 'Basic'
'Standard'
tier Tier of a public IP address SKU. 'Global'
'Regional'

PrivateLinkServicePropertiesVisibility

Name Description Value
subscriptions The list of subscriptions. string[]

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Front Door Premium with VM and Private Link service

Deploy to Azure
This template creates a Front Door Premium (Preview) and a virtual machine configured as a web server. Front Door uses a private endpoint with Private Link service to send traffic to the VM.
Private Link service example

Deploy to Azure
This template shows how to create a private link service