Compartilhar via


Microsoft.Network privateLinkServices/privateEndpointConnections 2019-07-01

Bicep resource definition

The privateLinkServices/privateEndpointConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-07-01' = {
  name: 'string'
  properties: {
    privateEndpoint: {
      etag: 'string'
      id: 'string'
      location: 'string'
      properties: {
        manualPrivateLinkServiceConnections: [
          {
            id: 'string'
            name: 'string'
            properties: {
              groupIds: [
                'string'
              ]
              privateLinkServiceConnectionState: {
                actionsRequired: 'string'
                description: 'string'
                status: 'string'
              }
              privateLinkServiceId: 'string'
              requestMessage: 'string'
            }
          }
        ]
        privateLinkServiceConnections: [
          {
            id: 'string'
            name: 'string'
            properties: {
              groupIds: [
                'string'
              ]
              privateLinkServiceConnectionState: {
                actionsRequired: 'string'
                description: 'string'
                status: 'string'
              }
              privateLinkServiceId: 'string'
              requestMessage: 'string'
            }
          }
        ]
        subnet: {
          etag: 'string'
          id: 'string'
          name: 'string'
          properties: {
            addressPrefix: 'string'
            addressPrefixes: [
              'string'
            ]
            delegations: [
              {
                etag: 'string'
                id: 'string'
                name: 'string'
                properties: {
                  actions: [
                    'string'
                  ]
                  serviceName: 'string'
                }
              }
            ]
            natGateway: {
              id: 'string'
            }
            networkSecurityGroup: {
              etag: 'string'
              id: 'string'
              location: 'string'
              properties: {
                defaultSecurityRules: [
                  {
                    etag: 'string'
                    id: 'string'
                    name: 'string'
                    properties: {
                      access: 'string'
                      description: 'string'
                      destinationAddressPrefix: 'string'
                      destinationAddressPrefixes: [
                        'string'
                      ]
                      destinationApplicationSecurityGroups: [
                        {
                          id: 'string'
                          location: 'string'
                          properties: {}
                          tags: {
                            {customized property}: 'string'
                          }
                        }
                      ]
                      destinationPortRange: 'string'
                      destinationPortRanges: [
                        'string'
                      ]
                      direction: 'string'
                      priority: int
                      protocol: 'string'
                      sourceAddressPrefix: 'string'
                      sourceAddressPrefixes: [
                        'string'
                      ]
                      sourceApplicationSecurityGroups: [
                        {
                          id: 'string'
                          location: 'string'
                          properties: {}
                          tags: {
                            {customized property}: 'string'
                          }
                        }
                      ]
                      sourcePortRange: 'string'
                      sourcePortRanges: [
                        'string'
                      ]
                    }
                  }
                ]
                resourceGuid: 'string'
                securityRules: [
                  {
                    etag: 'string'
                    id: 'string'
                    name: 'string'
                    properties: {
                      access: 'string'
                      description: 'string'
                      destinationAddressPrefix: 'string'
                      destinationAddressPrefixes: [
                        'string'
                      ]
                      destinationApplicationSecurityGroups: [
                        {
                          id: 'string'
                          location: 'string'
                          properties: {}
                          tags: {
                            {customized property}: 'string'
                          }
                        }
                      ]
                      destinationPortRange: 'string'
                      destinationPortRanges: [
                        'string'
                      ]
                      direction: 'string'
                      priority: int
                      protocol: 'string'
                      sourceAddressPrefix: 'string'
                      sourceAddressPrefixes: [
                        'string'
                      ]
                      sourceApplicationSecurityGroups: [
                        {
                          id: 'string'
                          location: 'string'
                          properties: {}
                          tags: {
                            {customized property}: 'string'
                          }
                        }
                      ]
                      sourcePortRange: 'string'
                      sourcePortRanges: [
                        'string'
                      ]
                    }
                  }
                ]
              }
              tags: {
                {customized property}: 'string'
              }
            }
            privateEndpointNetworkPolicies: 'string'
            privateLinkServiceNetworkPolicies: 'string'
            resourceNavigationLinks: [
              {
                id: 'string'
                name: 'string'
                properties: {
                  link: 'string'
                  linkedResourceType: 'string'
                }
              }
            ]
            routeTable: {
              etag: 'string'
              id: 'string'
              location: 'string'
              properties: {
                disableBgpRoutePropagation: bool
                routes: [
                  {
                    etag: 'string'
                    id: 'string'
                    name: 'string'
                    properties: {
                      addressPrefix: 'string'
                      nextHopIpAddress: 'string'
                      nextHopType: 'string'
                    }
                  }
                ]
              }
              tags: {
                {customized property}: 'string'
              }
            }
            serviceAssociationLinks: [
              {
                id: 'string'
                name: 'string'
                properties: {
                  allowDelete: bool
                  link: 'string'
                  linkedResourceType: 'string'
                  locations: [
                    'string'
                  ]
                }
                type: 'string'
              }
            ]
            serviceEndpointPolicies: [
              {
                etag: 'string'
                id: 'string'
                location: 'string'
                properties: {
                  serviceEndpointPolicyDefinitions: [
                    {
                      etag: 'string'
                      id: 'string'
                      name: 'string'
                      properties: {
                        description: 'string'
                        service: 'string'
                        serviceResources: [
                          'string'
                        ]
                      }
                    }
                  ]
                }
                tags: {
                  {customized property}: 'string'
                }
              }
            ]
            serviceEndpoints: [
              {
                locations: [
                  'string'
                ]
                service: 'string'
              }
            ]
          }
        }
      }
      tags: {
        {customized property}: 'string'
      }
    }
    privateLinkServiceConnectionState: {
      actionsRequired: 'string'
      description: 'string'
      status: 'string'
    }
  }
}

Property values

ApplicationSecurityGroup

Name Description Value
id Resource ID. string
location Resource location. string
properties Properties of the application security group. ApplicationSecurityGroupPropertiesFormat
tags Resource tags. ResourceTags

ApplicationSecurityGroupPropertiesFormat

Name Description Value

Delegation

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
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 the subnet. ServiceDelegationPropertiesFormat

Microsoft.Network/privateLinkServices/privateEndpointConnections

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: privateLinkServices
properties Properties of the private end point connection. PrivateEndpointConnectionProperties

NetworkSecurityGroup

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
id Resource ID. string
location Resource location. string
properties Properties of the network security group. NetworkSecurityGroupPropertiesFormat
tags Resource tags. ResourceTags

NetworkSecurityGroupPropertiesFormat

Name Description Value
defaultSecurityRules The default security rules of network security group. SecurityRule[]
resourceGuid The resource GUID property of the network security group resource. string
securityRules A collection of security rules of the network security group. SecurityRule[]

PrivateEndpoint

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
id Resource ID. string
location Resource location. string
properties Properties of the private endpoint. PrivateEndpointProperties
tags Resource tags. ResourceTags

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint The resource of private end point. PrivateEndpoint
privateLinkServiceConnectionState A collection of information about the state of the connection between service consumer and provider. PrivateLinkServiceConnectionState

PrivateEndpointProperties

Name Description Value
manualPrivateLinkServiceConnections A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. PrivateLinkServiceConnection[]
privateLinkServiceConnections A grouping of information about the connection to the remote resource. PrivateLinkServiceConnection[]
subnet The ID of the subnet from which the private IP will be allocated. Subnet

PrivateLinkServiceConnection

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 private link service connection. PrivateLinkServiceConnectionProperties

PrivateLinkServiceConnectionProperties

Name Description Value
groupIds The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. string[]
privateLinkServiceConnectionState A collection of read-only information about the state of the connection to the remote resource. PrivateLinkServiceConnectionState
privateLinkServiceId The resource id of private link service. string
requestMessage A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. string

PrivateLinkServiceConnectionState

Name Description Value
actionsRequired A message indicating if changes on the service provider require any updates on the consumer. string
description The reason for approval/rejection of the connection. string
status Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. string
Name Description Value
id Resource ID. string
name Name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Resource navigation link properties format. ResourceNavigationLinkFormat

ResourceNavigationLinkFormat

Name Description Value
link Link to the external resource. string
linkedResourceType Resource type of the linked resource. string

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

Route

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
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 route. RoutePropertiesFormat

RoutePropertiesFormat

Name Description Value
addressPrefix The destination CIDR to which the route applies. string
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' (required)

RouteTable

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
id Resource ID. string
location Resource location. string
properties Properties of the route table. RouteTablePropertiesFormat
tags Resource tags. ResourceTags

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[]

SecurityRule

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
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 security rule. SecurityRulePropertiesFormat

SecurityRulePropertiesFormat

Name Description Value
access The network traffic is allowed or denied. 'Allow'
'Deny' (required)
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' (required)
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. '*'
'Esp'
'Icmp'
'Tcp'
'Udp' (required)
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[]
Name Description Value
id Resource ID. string
name Name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Resource navigation link properties format. ServiceAssociationLinkPropertiesFormat
type Resource type. string

ServiceAssociationLinkPropertiesFormat

Name Description Value
allowDelete If true, the resource can be deleted. bool
link Link to the external resource. string
linkedResourceType Resource type of the linked resource. string
locations A list of locations. string[]

ServiceDelegationPropertiesFormat

Name Description Value
actions Describes the actions permitted to the service upon delegation. string[]
serviceName The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). string

ServiceEndpointPolicy

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
id Resource ID. string
location Resource location. string
properties Properties of the service end point policy. ServiceEndpointPolicyPropertiesFormat
tags Resource tags. ResourceTags

ServiceEndpointPolicyDefinition

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
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 service endpoint policy definition. 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[]

ServiceEndpointPolicyPropertiesFormat

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

ServiceEndpointPropertiesFormat

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

Subnet

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
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

SubnetPropertiesFormat

Name Description Value
addressPrefix The address prefix for the subnet. string
addressPrefixes List of address prefixes for the subnet. string[]
delegations An array of references to the delegations on the subnet. Delegation[]
natGateway Nat gateway associated with this subnet. SubResource
networkSecurityGroup The reference of the NetworkSecurityGroup resource. NetworkSecurityGroup
privateEndpointNetworkPolicies Enable or Disable apply network policies on private end point in the subnet. string
privateLinkServiceNetworkPolicies Enable or Disable apply network policies on private link service in the subnet. string
resourceNavigationLinks An array of references to the external resources using subnet. ResourceNavigationLink[]
routeTable The reference of the RouteTable resource. RouteTable
serviceAssociationLinks An array of references to services injecting into this subnet. ServiceAssociationLink[]
serviceEndpointPolicies An array of service endpoint policies. ServiceEndpointPolicy[]
serviceEndpoints An array of service endpoints. ServiceEndpointPropertiesFormat[]

SubResource

Name Description Value
id Resource ID. string

ARM template resource definition

The privateLinkServices/privateEndpointConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections",
  "apiVersion": "2019-07-01",
  "name": "string",
  "properties": {
    "privateEndpoint": {
      "etag": "string",
      "id": "string",
      "location": "string",
      "properties": {
        "manualPrivateLinkServiceConnections": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "groupIds": [ "string" ],
              "privateLinkServiceConnectionState": {
                "actionsRequired": "string",
                "description": "string",
                "status": "string"
              },
              "privateLinkServiceId": "string",
              "requestMessage": "string"
            }
          }
        ],
        "privateLinkServiceConnections": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "groupIds": [ "string" ],
              "privateLinkServiceConnectionState": {
                "actionsRequired": "string",
                "description": "string",
                "status": "string"
              },
              "privateLinkServiceId": "string",
              "requestMessage": "string"
            }
          }
        ],
        "subnet": {
          "etag": "string",
          "id": "string",
          "name": "string",
          "properties": {
            "addressPrefix": "string",
            "addressPrefixes": [ "string" ],
            "delegations": [
              {
                "etag": "string",
                "id": "string",
                "name": "string",
                "properties": {
                  "actions": [ "string" ],
                  "serviceName": "string"
                }
              }
            ],
            "natGateway": {
              "id": "string"
            },
            "networkSecurityGroup": {
              "etag": "string",
              "id": "string",
              "location": "string",
              "properties": {
                "defaultSecurityRules": [
                  {
                    "etag": "string",
                    "id": "string",
                    "name": "string",
                    "properties": {
                      "access": "string",
                      "description": "string",
                      "destinationAddressPrefix": "string",
                      "destinationAddressPrefixes": [ "string" ],
                      "destinationApplicationSecurityGroups": [
                        {
                          "id": "string",
                          "location": "string",
                          "properties": {
                          },
                          "tags": {
                            "{customized property}": "string"
                          }
                        }
                      ],
                      "destinationPortRange": "string",
                      "destinationPortRanges": [ "string" ],
                      "direction": "string",
                      "priority": "int",
                      "protocol": "string",
                      "sourceAddressPrefix": "string",
                      "sourceAddressPrefixes": [ "string" ],
                      "sourceApplicationSecurityGroups": [
                        {
                          "id": "string",
                          "location": "string",
                          "properties": {
                          },
                          "tags": {
                            "{customized property}": "string"
                          }
                        }
                      ],
                      "sourcePortRange": "string",
                      "sourcePortRanges": [ "string" ]
                    }
                  }
                ],
                "resourceGuid": "string",
                "securityRules": [
                  {
                    "etag": "string",
                    "id": "string",
                    "name": "string",
                    "properties": {
                      "access": "string",
                      "description": "string",
                      "destinationAddressPrefix": "string",
                      "destinationAddressPrefixes": [ "string" ],
                      "destinationApplicationSecurityGroups": [
                        {
                          "id": "string",
                          "location": "string",
                          "properties": {
                          },
                          "tags": {
                            "{customized property}": "string"
                          }
                        }
                      ],
                      "destinationPortRange": "string",
                      "destinationPortRanges": [ "string" ],
                      "direction": "string",
                      "priority": "int",
                      "protocol": "string",
                      "sourceAddressPrefix": "string",
                      "sourceAddressPrefixes": [ "string" ],
                      "sourceApplicationSecurityGroups": [
                        {
                          "id": "string",
                          "location": "string",
                          "properties": {
                          },
                          "tags": {
                            "{customized property}": "string"
                          }
                        }
                      ],
                      "sourcePortRange": "string",
                      "sourcePortRanges": [ "string" ]
                    }
                  }
                ]
              },
              "tags": {
                "{customized property}": "string"
              }
            },
            "privateEndpointNetworkPolicies": "string",
            "privateLinkServiceNetworkPolicies": "string",
            "resourceNavigationLinks": [
              {
                "id": "string",
                "name": "string",
                "properties": {
                  "link": "string",
                  "linkedResourceType": "string"
                }
              }
            ],
            "routeTable": {
              "etag": "string",
              "id": "string",
              "location": "string",
              "properties": {
                "disableBgpRoutePropagation": "bool",
                "routes": [
                  {
                    "etag": "string",
                    "id": "string",
                    "name": "string",
                    "properties": {
                      "addressPrefix": "string",
                      "nextHopIpAddress": "string",
                      "nextHopType": "string"
                    }
                  }
                ]
              },
              "tags": {
                "{customized property}": "string"
              }
            },
            "serviceAssociationLinks": [
              {
                "id": "string",
                "name": "string",
                "properties": {
                  "allowDelete": "bool",
                  "link": "string",
                  "linkedResourceType": "string",
                  "locations": [ "string" ]
                },
                "type": "string"
              }
            ],
            "serviceEndpointPolicies": [
              {
                "etag": "string",
                "id": "string",
                "location": "string",
                "properties": {
                  "serviceEndpointPolicyDefinitions": [
                    {
                      "etag": "string",
                      "id": "string",
                      "name": "string",
                      "properties": {
                        "description": "string",
                        "service": "string",
                        "serviceResources": [ "string" ]
                      }
                    }
                  ]
                },
                "tags": {
                  "{customized property}": "string"
                }
              }
            ],
            "serviceEndpoints": [
              {
                "locations": [ "string" ],
                "service": "string"
              }
            ]
          }
        }
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "privateLinkServiceConnectionState": {
      "actionsRequired": "string",
      "description": "string",
      "status": "string"
    }
  }
}

Property values

ApplicationSecurityGroup

Name Description Value
id Resource ID. string
location Resource location. string
properties Properties of the application security group. ApplicationSecurityGroupPropertiesFormat
tags Resource tags. ResourceTags

ApplicationSecurityGroupPropertiesFormat

Name Description Value

Delegation

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
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 the subnet. ServiceDelegationPropertiesFormat

Microsoft.Network/privateLinkServices/privateEndpointConnections

Name Description Value
apiVersion The api version '2019-07-01'
name The resource name string (required)
properties Properties of the private end point connection. PrivateEndpointConnectionProperties
type The resource type 'Microsoft.Network/privateLinkServices/privateEndpointConnections'

NetworkSecurityGroup

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
id Resource ID. string
location Resource location. string
properties Properties of the network security group. NetworkSecurityGroupPropertiesFormat
tags Resource tags. ResourceTags

NetworkSecurityGroupPropertiesFormat

Name Description Value
defaultSecurityRules The default security rules of network security group. SecurityRule[]
resourceGuid The resource GUID property of the network security group resource. string
securityRules A collection of security rules of the network security group. SecurityRule[]

PrivateEndpoint

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
id Resource ID. string
location Resource location. string
properties Properties of the private endpoint. PrivateEndpointProperties
tags Resource tags. ResourceTags

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint The resource of private end point. PrivateEndpoint
privateLinkServiceConnectionState A collection of information about the state of the connection between service consumer and provider. PrivateLinkServiceConnectionState

PrivateEndpointProperties

Name Description Value
manualPrivateLinkServiceConnections A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. PrivateLinkServiceConnection[]
privateLinkServiceConnections A grouping of information about the connection to the remote resource. PrivateLinkServiceConnection[]
subnet The ID of the subnet from which the private IP will be allocated. Subnet

PrivateLinkServiceConnection

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 private link service connection. PrivateLinkServiceConnectionProperties

PrivateLinkServiceConnectionProperties

Name Description Value
groupIds The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. string[]
privateLinkServiceConnectionState A collection of read-only information about the state of the connection to the remote resource. PrivateLinkServiceConnectionState
privateLinkServiceId The resource id of private link service. string
requestMessage A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. string

PrivateLinkServiceConnectionState

Name Description Value
actionsRequired A message indicating if changes on the service provider require any updates on the consumer. string
description The reason for approval/rejection of the connection. string
status Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. string
Name Description Value
id Resource ID. string
name Name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Resource navigation link properties format. ResourceNavigationLinkFormat

ResourceNavigationLinkFormat

Name Description Value
link Link to the external resource. string
linkedResourceType Resource type of the linked resource. string

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

Route

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
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 route. RoutePropertiesFormat

RoutePropertiesFormat

Name Description Value
addressPrefix The destination CIDR to which the route applies. string
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' (required)

RouteTable

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
id Resource ID. string
location Resource location. string
properties Properties of the route table. RouteTablePropertiesFormat
tags Resource tags. ResourceTags

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[]

SecurityRule

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
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 security rule. SecurityRulePropertiesFormat

SecurityRulePropertiesFormat

Name Description Value
access The network traffic is allowed or denied. 'Allow'
'Deny' (required)
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' (required)
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. '*'
'Esp'
'Icmp'
'Tcp'
'Udp' (required)
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[]
Name Description Value
id Resource ID. string
name Name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Resource navigation link properties format. ServiceAssociationLinkPropertiesFormat
type Resource type. string

ServiceAssociationLinkPropertiesFormat

Name Description Value
allowDelete If true, the resource can be deleted. bool
link Link to the external resource. string
linkedResourceType Resource type of the linked resource. string
locations A list of locations. string[]

ServiceDelegationPropertiesFormat

Name Description Value
actions Describes the actions permitted to the service upon delegation. string[]
serviceName The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). string

ServiceEndpointPolicy

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
id Resource ID. string
location Resource location. string
properties Properties of the service end point policy. ServiceEndpointPolicyPropertiesFormat
tags Resource tags. ResourceTags

ServiceEndpointPolicyDefinition

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
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 service endpoint policy definition. 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[]

ServiceEndpointPolicyPropertiesFormat

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

ServiceEndpointPropertiesFormat

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

Subnet

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
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

SubnetPropertiesFormat

Name Description Value
addressPrefix The address prefix for the subnet. string
addressPrefixes List of address prefixes for the subnet. string[]
delegations An array of references to the delegations on the subnet. Delegation[]
natGateway Nat gateway associated with this subnet. SubResource
networkSecurityGroup The reference of the NetworkSecurityGroup resource. NetworkSecurityGroup
privateEndpointNetworkPolicies Enable or Disable apply network policies on private end point in the subnet. string
privateLinkServiceNetworkPolicies Enable or Disable apply network policies on private link service in the subnet. string
resourceNavigationLinks An array of references to the external resources using subnet. ResourceNavigationLink[]
routeTable The reference of the RouteTable resource. RouteTable
serviceAssociationLinks An array of references to services injecting into this subnet. ServiceAssociationLink[]
serviceEndpointPolicies An array of service endpoint policies. ServiceEndpointPolicy[]
serviceEndpoints An array of service endpoints. ServiceEndpointPropertiesFormat[]

SubResource

Name Description Value
id Resource ID. string

Terraform (AzAPI provider) resource definition

The privateLinkServices/privateEndpointConnections resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/privateLinkServices/privateEndpointConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-07-01"
  name = "string"
  body = jsonencode({
    properties = {
      privateEndpoint = {
        etag = "string"
        id = "string"
        location = "string"
        properties = {
          manualPrivateLinkServiceConnections = [
            {
              id = "string"
              name = "string"
              properties = {
                groupIds = [
                  "string"
                ]
                privateLinkServiceConnectionState = {
                  actionsRequired = "string"
                  description = "string"
                  status = "string"
                }
                privateLinkServiceId = "string"
                requestMessage = "string"
              }
            }
          ]
          privateLinkServiceConnections = [
            {
              id = "string"
              name = "string"
              properties = {
                groupIds = [
                  "string"
                ]
                privateLinkServiceConnectionState = {
                  actionsRequired = "string"
                  description = "string"
                  status = "string"
                }
                privateLinkServiceId = "string"
                requestMessage = "string"
              }
            }
          ]
          subnet = {
            etag = "string"
            id = "string"
            name = "string"
            properties = {
              addressPrefix = "string"
              addressPrefixes = [
                "string"
              ]
              delegations = [
                {
                  etag = "string"
                  id = "string"
                  name = "string"
                  properties = {
                    actions = [
                      "string"
                    ]
                    serviceName = "string"
                  }
                }
              ]
              natGateway = {
                id = "string"
              }
              networkSecurityGroup = {
                etag = "string"
                id = "string"
                location = "string"
                properties = {
                  defaultSecurityRules = [
                    {
                      etag = "string"
                      id = "string"
                      name = "string"
                      properties = {
                        access = "string"
                        description = "string"
                        destinationAddressPrefix = "string"
                        destinationAddressPrefixes = [
                          "string"
                        ]
                        destinationApplicationSecurityGroups = [
                          {
                            id = "string"
                            location = "string"
                            properties = {
                            }
                            tags = {
                              {customized property} = "string"
                            }
                          }
                        ]
                        destinationPortRange = "string"
                        destinationPortRanges = [
                          "string"
                        ]
                        direction = "string"
                        priority = int
                        protocol = "string"
                        sourceAddressPrefix = "string"
                        sourceAddressPrefixes = [
                          "string"
                        ]
                        sourceApplicationSecurityGroups = [
                          {
                            id = "string"
                            location = "string"
                            properties = {
                            }
                            tags = {
                              {customized property} = "string"
                            }
                          }
                        ]
                        sourcePortRange = "string"
                        sourcePortRanges = [
                          "string"
                        ]
                      }
                    }
                  ]
                  resourceGuid = "string"
                  securityRules = [
                    {
                      etag = "string"
                      id = "string"
                      name = "string"
                      properties = {
                        access = "string"
                        description = "string"
                        destinationAddressPrefix = "string"
                        destinationAddressPrefixes = [
                          "string"
                        ]
                        destinationApplicationSecurityGroups = [
                          {
                            id = "string"
                            location = "string"
                            properties = {
                            }
                            tags = {
                              {customized property} = "string"
                            }
                          }
                        ]
                        destinationPortRange = "string"
                        destinationPortRanges = [
                          "string"
                        ]
                        direction = "string"
                        priority = int
                        protocol = "string"
                        sourceAddressPrefix = "string"
                        sourceAddressPrefixes = [
                          "string"
                        ]
                        sourceApplicationSecurityGroups = [
                          {
                            id = "string"
                            location = "string"
                            properties = {
                            }
                            tags = {
                              {customized property} = "string"
                            }
                          }
                        ]
                        sourcePortRange = "string"
                        sourcePortRanges = [
                          "string"
                        ]
                      }
                    }
                  ]
                }
                tags = {
                  {customized property} = "string"
                }
              }
              privateEndpointNetworkPolicies = "string"
              privateLinkServiceNetworkPolicies = "string"
              resourceNavigationLinks = [
                {
                  id = "string"
                  name = "string"
                  properties = {
                    link = "string"
                    linkedResourceType = "string"
                  }
                }
              ]
              routeTable = {
                etag = "string"
                id = "string"
                location = "string"
                properties = {
                  disableBgpRoutePropagation = bool
                  routes = [
                    {
                      etag = "string"
                      id = "string"
                      name = "string"
                      properties = {
                        addressPrefix = "string"
                        nextHopIpAddress = "string"
                        nextHopType = "string"
                      }
                    }
                  ]
                }
                tags = {
                  {customized property} = "string"
                }
              }
              serviceAssociationLinks = [
                {
                  id = "string"
                  name = "string"
                  properties = {
                    allowDelete = bool
                    link = "string"
                    linkedResourceType = "string"
                    locations = [
                      "string"
                    ]
                  }
                  type = "string"
                }
              ]
              serviceEndpointPolicies = [
                {
                  etag = "string"
                  id = "string"
                  location = "string"
                  properties = {
                    serviceEndpointPolicyDefinitions = [
                      {
                        etag = "string"
                        id = "string"
                        name = "string"
                        properties = {
                          description = "string"
                          service = "string"
                          serviceResources = [
                            "string"
                          ]
                        }
                      }
                    ]
                  }
                  tags = {
                    {customized property} = "string"
                  }
                }
              ]
              serviceEndpoints = [
                {
                  locations = [
                    "string"
                  ]
                  service = "string"
                }
              ]
            }
          }
        }
        tags = {
          {customized property} = "string"
        }
      }
      privateLinkServiceConnectionState = {
        actionsRequired = "string"
        description = "string"
        status = "string"
      }
    }
  })
}

Property values

ApplicationSecurityGroup

Name Description Value
id Resource ID. string
location Resource location. string
properties Properties of the application security group. ApplicationSecurityGroupPropertiesFormat
tags Resource tags. ResourceTags

ApplicationSecurityGroupPropertiesFormat

Name Description Value

Delegation

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
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 the subnet. ServiceDelegationPropertiesFormat

Microsoft.Network/privateLinkServices/privateEndpointConnections

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: privateLinkServices
properties Properties of the private end point connection. PrivateEndpointConnectionProperties
type The resource type "Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-07-01"

NetworkSecurityGroup

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
id Resource ID. string
location Resource location. string
properties Properties of the network security group. NetworkSecurityGroupPropertiesFormat
tags Resource tags. ResourceTags

NetworkSecurityGroupPropertiesFormat

Name Description Value
defaultSecurityRules The default security rules of network security group. SecurityRule[]
resourceGuid The resource GUID property of the network security group resource. string
securityRules A collection of security rules of the network security group. SecurityRule[]

PrivateEndpoint

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
id Resource ID. string
location Resource location. string
properties Properties of the private endpoint. PrivateEndpointProperties
tags Resource tags. ResourceTags

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint The resource of private end point. PrivateEndpoint
privateLinkServiceConnectionState A collection of information about the state of the connection between service consumer and provider. PrivateLinkServiceConnectionState

PrivateEndpointProperties

Name Description Value
manualPrivateLinkServiceConnections A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. PrivateLinkServiceConnection[]
privateLinkServiceConnections A grouping of information about the connection to the remote resource. PrivateLinkServiceConnection[]
subnet The ID of the subnet from which the private IP will be allocated. Subnet

PrivateLinkServiceConnection

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 private link service connection. PrivateLinkServiceConnectionProperties

PrivateLinkServiceConnectionProperties

Name Description Value
groupIds The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. string[]
privateLinkServiceConnectionState A collection of read-only information about the state of the connection to the remote resource. PrivateLinkServiceConnectionState
privateLinkServiceId The resource id of private link service. string
requestMessage A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. string

PrivateLinkServiceConnectionState

Name Description Value
actionsRequired A message indicating if changes on the service provider require any updates on the consumer. string
description The reason for approval/rejection of the connection. string
status Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. string
Name Description Value
id Resource ID. string
name Name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Resource navigation link properties format. ResourceNavigationLinkFormat

ResourceNavigationLinkFormat

Name Description Value
link Link to the external resource. string
linkedResourceType Resource type of the linked resource. string

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

Route

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
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 route. RoutePropertiesFormat

RoutePropertiesFormat

Name Description Value
addressPrefix The destination CIDR to which the route applies. string
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' (required)

RouteTable

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
id Resource ID. string
location Resource location. string
properties Properties of the route table. RouteTablePropertiesFormat
tags Resource tags. ResourceTags

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[]

SecurityRule

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
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 security rule. SecurityRulePropertiesFormat

SecurityRulePropertiesFormat

Name Description Value
access The network traffic is allowed or denied. 'Allow'
'Deny' (required)
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' (required)
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. '*'
'Esp'
'Icmp'
'Tcp'
'Udp' (required)
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[]
Name Description Value
id Resource ID. string
name Name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Resource navigation link properties format. ServiceAssociationLinkPropertiesFormat
type Resource type. string

ServiceAssociationLinkPropertiesFormat

Name Description Value
allowDelete If true, the resource can be deleted. bool
link Link to the external resource. string
linkedResourceType Resource type of the linked resource. string
locations A list of locations. string[]

ServiceDelegationPropertiesFormat

Name Description Value
actions Describes the actions permitted to the service upon delegation. string[]
serviceName The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). string

ServiceEndpointPolicy

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
id Resource ID. string
location Resource location. string
properties Properties of the service end point policy. ServiceEndpointPolicyPropertiesFormat
tags Resource tags. ResourceTags

ServiceEndpointPolicyDefinition

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
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 service endpoint policy definition. 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[]

ServiceEndpointPolicyPropertiesFormat

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

ServiceEndpointPropertiesFormat

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

Subnet

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
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

SubnetPropertiesFormat

Name Description Value
addressPrefix The address prefix for the subnet. string
addressPrefixes List of address prefixes for the subnet. string[]
delegations An array of references to the delegations on the subnet. Delegation[]
natGateway Nat gateway associated with this subnet. SubResource
networkSecurityGroup The reference of the NetworkSecurityGroup resource. NetworkSecurityGroup
privateEndpointNetworkPolicies Enable or Disable apply network policies on private end point in the subnet. string
privateLinkServiceNetworkPolicies Enable or Disable apply network policies on private link service in the subnet. string
resourceNavigationLinks An array of references to the external resources using subnet. ResourceNavigationLink[]
routeTable The reference of the RouteTable resource. RouteTable
serviceAssociationLinks An array of references to services injecting into this subnet. ServiceAssociationLink[]
serviceEndpointPolicies An array of service endpoint policies. ServiceEndpointPolicy[]
serviceEndpoints An array of service endpoints. ServiceEndpointPropertiesFormat[]

SubResource

Name Description Value
id Resource ID. string