通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Network privateEndpoints

  • 项目

Bicep 资源定义

可以使用面向以下操作部署 privateEndpoints 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

注解

有关创建专用终结点的指导，请参阅使用 Bicep Create虚拟网络资源。

资源格式

若要创建 Microsoft.Network/privateEndpoints 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Network/privateEndpoints@2023-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  extendedLocation: {
    name: 'string'
    type: 'EdgeZone'
  }
  properties: {
    applicationSecurityGroups: [
      {
        id: 'string'
        location: 'string'
        properties: {}
        tags: {}
      }
    ]
    customDnsConfigs: [
      {
        fqdn: 'string'
        ipAddresses: [
          'string'
        ]
      }
    ]
    customNetworkInterfaceName: 'string'
    ipConfigurations: [
      {
        name: 'string'
        properties: {
          groupId: 'string'
          memberName: 'string'
          privateIPAddress: 'string'
        }
      }
    ]
    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: {
      id: 'string'
      name: 'string'
      properties: {
        addressPrefix: 'string'
        addressPrefixes: [
          'string'
        ]
        applicationGatewayIPConfigurations: [
          {
            id: 'string'
            name: 'string'
            properties: {
              subnet: {
                id: 'string'
              }
            }
          }
        ]
        defaultOutboundAccess: bool
        delegations: [
          {
            id: 'string'
            name: 'string'
            properties: {
              serviceName: 'string'
            }
            type: 'string'
          }
        ]
        ipAllocations: [
          {
            id: 'string'
          }
        ]
        natGateway: {
          id: 'string'
        }
        networkSecurityGroup: {
          id: 'string'
          location: 'string'
          properties: {
            flushConnection: bool
            securityRules: [
              {
                id: 'string'
                name: 'string'
                properties: {
                  access: 'string'
                  description: 'string'
                  destinationAddressPrefix: 'string'
                  destinationAddressPrefixes: [
                    'string'
                  ]
                  destinationApplicationSecurityGroups: [
                    {
                      id: 'string'
                      location: 'string'
                      properties: {}
                      tags: {}
                    }
                  ]
                  destinationPortRange: 'string'
                  destinationPortRanges: [
                    'string'
                  ]
                  direction: 'string'
                  priority: int
                  protocol: 'string'
                  sourceAddressPrefix: 'string'
                  sourceAddressPrefixes: [
                    'string'
                  ]
                  sourceApplicationSecurityGroups: [
                    {
                      id: 'string'
                      location: 'string'
                      properties: {}
                      tags: {}
                    }
                  ]
                  sourcePortRange: 'string'
                  sourcePortRanges: [
                    'string'
                  ]
                }
                type: 'string'
              }
            ]
          }
          tags: {}
        }
        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: {}
        }
        serviceEndpointPolicies: [
          {
            id: 'string'
            location: 'string'
            properties: {
              contextualServiceEndpointPolicies: [
                'string'
              ]
              serviceAlias: 'string'
              serviceEndpointPolicyDefinitions: [
                {
                  id: 'string'
                  name: 'string'
                  properties: {
                    description: 'string'
                    service: 'string'
                    serviceResources: [
                      'string'
                    ]
                  }
                  type: 'string'
                }
              ]
            }
            tags: {}
          }
        ]
        serviceEndpoints: [
          {
            locations: [
              'string'
            ]
            service: 'string'
          }
        ]
        sharingScope: 'string'
      }
      type: 'string'
    }
  }
}

属性值

privateEndpoints

名称 说明 值
name 资源名称 字符串 (必需)

字符限制：2-64

有效字符：
字母数字、下划线字符、句点和连字符。

以字母数字开头。 以字母数字或下划线结尾。
location 资源位置。 字符串
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
extendedLocation 负载均衡器的扩展位置。 ExtendedLocation
properties 专用终结点的属性。 PrivateEndpointProperties

ExtendedLocation

名称 说明 值
name 扩展位置的名称。 字符串
type 扩展位置的类型。 “EdgeZone”

PrivateEndpointProperties

名称 说明 值
applicationSecurityGroups 包含专用终结点 IP 配置的应用程序安全组。 ApplicationSecurityGroup[]
customDnsConfigs 自定义 DNS 配置的数组。 CustomDnsConfigPropertiesFormat[]
customNetworkInterfaceName 附加到专用终结点的网络接口的自定义名称。 字符串
ipConfigurations 专用终结点的 IP 配置列表。 这将用于映射到第一方服务的终结点。 PrivateEndpointIPConfiguration[]
manualPrivateLinkServiceConnections 有关与远程资源的连接的信息分组。 当网络管理员无权批准与远程资源的连接时使用。 PrivateLinkServiceConnection[]
privateLinkServiceConnections 有关与远程资源的连接的信息分组。 PrivateLinkServiceConnection[]
子网 将从中分配专用 IP 的子网的 ID。 子网

ApplicationSecurityGroup

名称 说明 Value
id 资源 ID。 字符串
location 资源位置。 string
properties 应用程序安全组的属性。 ApplicationSecurityGroupPropertiesFormat
标记 资源标记。 对象 (object)

ApplicationSecurityGroupPropertiesFormat

此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。

CustomDnsConfigPropertiesFormat

名称 说明 值
fqdn 解析为专用终结点 IP 地址的 Fqdn。 字符串
ipAddresses 专用终结点的专用 IP 地址列表。 string[]

PrivateEndpointIPConfiguration

名称 说明 值
name 资源组中唯一的资源的名称。 string
properties 专用终结点 IP 配置的属性。 PrivateEndpointIPConfigurationProperties

PrivateEndpointIPConfigurationProperties

名称 说明 值
groupId 从此专用终结点应连接到的远程资源获取的组的 ID。 字符串
memberName 从此专用终结点应连接到的远程资源获取的组的成员名称。 字符串
privateIPAddress 从专用终结点的子网获取的专用 IP 地址。 字符串

PrivateLinkServiceConnection

名称 说明 Value
id 资源 ID。 字符串
name 资源组中唯一的资源的名称。 此名称可用于访问资源。 string
properties 专用链接服务连接的属性。 PrivateLinkServiceConnectionProperties

PrivateLinkServiceConnectionProperties

名称 说明 值
groupIds 组的 ID () () 从此专用终结点应连接到的远程资源获取。 string[]
privateLinkServiceConnectionState 有关与远程资源的连接状态的只读信息的集合。 PrivateLinkServiceConnectionState
privateLinkServiceId 专用链接服务的资源 ID。 字符串
requestMessage 使用此连接请求传递给远程资源所有者的消息。 限制为 140 个字符。 字符串

PrivateLinkServiceConnectionState

名称 说明 值
actionsRequired 一条消息，指示服务提供商的更改是否需要对使用者进行任何更新。 字符串
description 批准/拒绝连接的原因。 字符串
status 指示连接是否已由服务的所有者批准/拒绝/删除。 字符串

子网

名称 说明 Value
id 资源 ID。 字符串
name 资源组中唯一的资源的名称。 此名称可用于访问资源。 string
properties 子网的属性。 SubnetPropertiesFormat
类型 资源类型。 字符串

SubnetPropertiesFormat

名称 说明 值
addressPrefix 子网的地址前缀。 字符串
addressPrefixes 子网的地址前缀列表。 string[]
applicationGatewayIPConfigurations 虚拟网络资源的应用程序网关 IP 配置。 ApplicationGatewayIPConfiguration[]
defaultOutboundAccess 将此属性设置为 false 可禁用子网中所有 VM 的默认出站连接。 此属性只能在创建子网时设置，不能为现有子网更新。 bool
代表团 对子网上委托的引用数组。 委派[]
ipAllocations 引用此子网的 IpAllocation 数组。 SubResource[]
natGateway 与此子网关联的 Nat 网关。 SubResource
networkSecurityGroup 对 NetworkSecurityGroup 资源的引用。 NetworkSecurityGroup
privateEndpointNetworkPolicies 启用或禁用在子网中的专用终结点应用网络策略。 'Disabled'
'Enabled'
“NetworkSecurityGroupEnabled”
“RouteTableEnabled”
privateLinkServiceNetworkPolicies 启用或禁用对子网中的专用链接服务应用网络策略。 'Disabled'
'Enabled'
routeTable 对 RouteTable 资源的引用。 RouteTable
serviceEndpointPolicies 服务终结点策略的数组。 ServiceEndpointPolicy[]
serviceEndpoints 服务终结点的数组。 ServiceEndpointPropertiesFormat[]
sharingScope 将此属性设置为 Tenant 以允许与 AAD 租户中的其他订阅共享子网。 仅当 defaultOutboundAccess 设置为 false 时，才能设置此属性;仅当 subnet 为空时，才能设置这两个属性。 'DelegatedServices'
“Tenant”

ApplicationGatewayIPConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 IP 配置的名称。 string
properties 应用程序网关 IP 配置的属性。 ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationGatewayIPConfigurationPropertiesFormat

名称 说明 值
子网 对子网资源的引用。 应用程序网关从中获取其专用地址的子网。 SubResource

SubResource

名称 说明 Value
id 资源 ID。 字符串

委托

名称 说明 Value
id 资源 ID。 字符串
name 子网中唯一的资源的名称。 此名称可用于访问资源。 string
properties 子网的属性。 ServiceDelegationPropertiesFormat
类型 资源类型。 字符串

ServiceDelegationPropertiesFormat

名称 说明 值
serviceName 子网应委托给的服务的名称， (例如 Microsoft.Sql/servers) 。 字符串

NetworkSecurityGroup

名称 说明 Value
id 资源 ID。 字符串
location 资源位置。 string
properties 网络安全组的属性。 NetworkSecurityGroupPropertiesFormat
标记 资源标记。 对象 (object)

NetworkSecurityGroupPropertiesFormat

名称 说明 值
flushConnection 启用后，当规则更新时，将从网络安全组连接创建的流重新评估。 初始启用将触发重新评估。 bool
securityRules 网络安全组的安全规则的集合。 SecurityRule[]

SecurityRule

名称 说明 Value
id 资源 ID。 字符串
name 资源组中唯一的资源的名称。 此名称可用于访问资源。 string
properties 安全规则的属性。 SecurityRulePropertiesFormat
类型 资源类型。 字符串

SecurityRulePropertiesFormat

名称 说明 值
access 允许或拒绝网络流量。 “允许”
需要“拒绝” ()
description 此规则的说明。 限制为 140 个字符。 字符串
destinationAddressPrefix 目标地址前缀。 CIDR 或目标 IP 范围。 也可以使用星号“*”来匹配所有源 IP。 也可以使用默认标记，例如“VirtualNetwork”、“AzureLoadBalancer”和“Internet”。 字符串
destinationAddressPrefixes 目标地址前缀。 CIDR 或目标 IP 范围。 string[]
destinationApplicationSecurityGroups 指定为目标的应用程序安全组。 ApplicationSecurityGroup[]
destinationPortRange 目标端口或范围。 介于 0 和 65535 之间的整数或范围。 星号“*”也可用于匹配所有端口。 字符串
destinationPortRanges 目标端口范围。 string[]
direction 规则的方向。 direction 指定是要针对传入流量还是传出流量评估该规则。 'Inbound'
需要“出站” ()
priority 规则的优先级。 该值可以介于 100 和 4096 之间。 对于集合中的每个规则，优先级编号必须是唯一的。 优先级编号越低，规则优先级越高。 int (必需)
protocol 此规则应用到的网络协议。 '*'
'Ah'
'Esp'
'Icmp'
'Tcp'
“Udp” (必需)
sourceAddressPrefix CIDR 或源 IP 范围。 也可以使用星号“*”来匹配所有源 IP。 也可以使用默认标记，例如“VirtualNetwork”、“AzureLoadBalancer”和“Internet”。 如果这是入口规则，则指定网络流量的来源。 字符串
sourceAddressPrefixes CIDR 或源 IP 范围。 string[]
sourceApplicationSecurityGroups 指定为源的应用程序安全组。 ApplicationSecurityGroup[]
sourcePortRange 源端口或范围。 介于 0 和 65535 之间的整数或范围。 星号“*”也可用于匹配所有端口。 字符串
sourcePortRanges 源端口范围。 string[]

RouteTable

名称 说明 Value
id 资源 ID。 字符串
location 资源位置。 string
properties 路由表的属性。 RouteTablePropertiesFormat
标记 资源标记。 对象 (object)

RouteTablePropertiesFormat

名称 说明 值
disableBgpRoutePropagation 是否禁用 BGP 在该路由表上获知的路由。 True 表示禁用。 bool
routes 路由表中包含的路由的集合。 Route[]

路由

名称 说明 Value
id 资源 ID。 字符串
name 资源组中唯一的资源的名称。 此名称可用于访问资源。 string
properties 路由的属性。 RoutePropertiesFormat
类型 资源类型。 字符串

RoutePropertiesFormat

名称 说明 值
addressPrefix 路由应用到的目标 CIDR。 字符串
hasBgpOverride 一个 值，该值指示此路由是否替代重叠的 BGP 路由，而不考虑 LPM。 bool
nextHopIpAddress IP 地址数据包应转发到。 下一跃点值仅在下一跃点类型为 VirtualAppliance 的路由中被允许。 字符串
nextHopType 数据包应发送到的 Azure 跃点的类型。 “Internet”
“None”
“VirtualAppliance”
“VirtualNetworkGateway”
需要“VnetLocal” ()

ServiceEndpointPolicy

名称 说明 Value
id 资源 ID。 字符串
location 资源位置。 string
properties 服务终结点策略的属性。 ServiceEndpointPolicyPropertiesFormat
标记 资源标记。 对象 (object)

ServiceEndpointPolicyPropertiesFormat

名称 说明 值
contextualServiceEndpointPolicies 上下文服务终结点策略的集合。 string[]
serviceAlias 指示策略是否属于服务的别名 字符串
serviceEndpointPolicyDefinitions 服务终结点策略的服务终结点策略定义的集合。 ServiceEndpointPolicyDefinition[]

ServiceEndpointPolicyDefinition

名称 说明 Value
id 资源 ID。 字符串
name 资源组中唯一的资源的名称。 此名称可用于访问资源。 string
properties 服务终结点策略定义的属性。 ServiceEndpointPolicyDefinitionPropertiesFormat
类型 资源类型。 字符串

ServiceEndpointPolicyDefinitionPropertiesFormat

名称 说明 值
description 此规则的说明。 限制为 140 个字符。 字符串
服务 服务终结点名称。 字符串
serviceResources 服务资源列表。 string[]

ServiceEndpointPropertiesFormat

名称 说明 值
locations 位置列表。 string[]
服务 终结点服务的类型。 字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
min.io Azure 网关

部署到 Azure		 完全专用 min.io Azure 网关部署，以提供由 Blob 存储支持的 S3 兼容存储 API
具有 NAT 网关和应用程序网关的 AKS 群集

部署到 Azure		 此示例演示如何使用 NAT 网关部署 AKS 群集进行出站连接，为入站连接部署应用程序网关。
Azure Cloud Shell - VNet

部署到 Azure		 此模板将 Azure Cloud Shell资源部署到 Azure 虚拟网络中。
Create专用 AKS 群集

部署到 Azure		 此示例演示如何在虚拟网络中创建专用 AKS 群集以及 jumpbox 虚拟机。
Create具有公共 DNS 区域的专用 AKS 群集

部署到 Azure		 此示例演示如何部署具有公共 DNS 区域的专用 AKS 群集。
使用Azure SQL专用终结点的 Web 应用

部署到 Azure		 此模板演示如何创建使用指向 Azure SQL 服务器的专用终结点的 Web 应用
使用专用终结点Create API 管理服务

部署到 Azure		 此模板将创建一个API 管理服务、一个虚拟网络和一个向虚拟网络公开API 管理服务的专用终结点。
没有公共 IP 地址的Azure Batch池

部署到 Azure		 此模板创建Azure Batch简化的节点通信池，而无需公共 IP 地址。
使用 PE、CMK 所有表单部署 Azure Databricks 工作区

部署到 Azure		 通过此模板，可以创建具有 PrivateEndpoint 和托管服务的 Azure Databricks 工作区，以及使用 DBFS 加密的 CMK。
Azure Databricks 一体式模板 VNetInjection-Pvtendpt

部署到 Azure		 使用此模板可以创建网络安全组、虚拟网络以及具有虚拟网络的 Azure Databricks 工作区以及专用终结点。
具有函数和专用链接服务的 Azure 数字孪生

部署到 Azure		 此模板创建一个 Azure 数字孪生服务，该服务配置了一个虚拟网络连接的 Azure 函数，该函数可以通过专用链接终结点与数字孪生进行通信。 它还创建一个专用 DNS区域，允许数字孪生终结点从虚拟网络无缝主机名解析到专用终结点内部子网 IP 地址。 主机名存储为名为“ADT_ENDPOINT”的 Azure 函数的设置。
使用专用终结点Create Azure Cosmos DB 帐户

部署到 Azure		 此模板将创建一个 Cosmos 帐户、一个虚拟网络和一个向虚拟网络公开 Cosmos 帐户的专用终结点。
通过专用终结点连接到事件中心命名空间

部署到 Azure		 此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问事件中心命名空间。
通过专用终结点连接到密钥保管库

部署到 Azure		 此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问密钥保管库。
Azure 机器学习端到端安全设置

部署到 Azure		 这组 Bicep 模板演示如何在安全设置中端到端设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。
Azure 机器学习端到端安全设置 (旧版)

部署到 Azure		 这组 Bicep 模板演示如何在安全设置中端到端设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。
(vnet) Create Azure 机器学习服务工作区

部署到 Azure		 此部署模板指定 Azure 机器学习工作区及其关联的资源，包括 Azure 密钥保管库、Azure 存储、Azure 应用程序 Insights 和 Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。
Create旧版) (Azure 机器学习服务工作区

部署到 Azure		 此部署模板指定 Azure 机器学习工作区及其关联的资源，包括 Azure 密钥保管库、Azure 存储、Azure 应用程序 Insights 和 Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。
具有 应用程序网关 入口控制器的 AKS 群集

部署到 Azure		 此示例演示如何使用 应用程序网关、应用程序网关 入口控制器、Azure 容器注册表、Log Analytics 和 密钥保管库 部署 AKS 群集
在中心 & 辐射型拓扑中使用 Azure 防火墙 作为 DNS 代理

部署到 Azure		 此示例演示如何使用 Azure 防火墙 在 Azure 中部署中心辐射型拓扑。 中心虚拟网络充当与通过虚拟网络对等互连连接到中心虚拟网络的许多辐射虚拟网络的中心连接点。
专用链接服务示例

部署到 Azure		 此模板演示如何创建专用链接服务
使用专用终结点Azure 认知搜索服务

部署到 Azure		 此模板使用专用终结点创建Azure 认知搜索服务。
通过专用终结点连接到服务总线命名空间

部署到 Azure		 此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问服务总线命名空间。
专用终结点示例

部署到 Azure		 此模板演示如何创建指向 Azure SQL 服务器的专用终结点
通过专用终结点从 VM 连接到存储帐户

部署到 Azure		 此示例演示如何使用连接虚拟网络通过专用终结点访问 Blob 存储帐户。
通过专用终结点连接到 Azure 文件共享

部署到 Azure		 此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问 Azure 文件共享。
使用Azure SQL后端应用服务环境

部署到 Azure		 此模板创建一个应用服务环境，其中包含Azure SQL后端、专用终结点以及通常在专用/隔离环境中使用的关联资源。
专用函数应用和专用终结点保护的存储

部署到 Azure		 此模板在具有专用终结点并通过专用终结点与 Azure 存储通信的高级计划上预配函数应用。
Create Function App 和专用终结点保护的存储

部署到 Azure		 此模板允许部署通过专用终结点与 Azure 存储通信的 Azure 函数应用。
受 Azure Frontdoor 保护的函数应用

部署到 Azure		 此模板允许部署受 Azure Frontdoor 高级版保护并发布的 Azure 高级函数。 Azure Frontdoor 与 Azure Functions 之间的连接受Azure 专用链接保护。
具有专用终结点的 Web 应用

部署到 Azure		 此模板允许你创建 Web 应用并通过专用终结点公开它
使用内部API 管理和 Web 应用应用程序网关

部署到 Azure		 应用程序网关将 Internet 流量路由到虚拟网络 (内部模式) API 管理 实例，该实例为 Azure Web 应用中托管的 Web API 提供服务。
具有 VNet 注入和专用终结点的 Web 应用

部署到 Azure		 通过此模板，可以使用两个 Web 应用（前端和后端）创建安全的端到端解决方案，前端将通过 VNet 注入和专用终结点安全地使用后端
保护 N 层 Web 应用

部署到 Azure		 此模板允许你创建一个安全的端到端解决方案，其中包含两个具有过渡槽的 Web 应用（前端和后端），前端将通过 VNet 注入和专用终结点安全地使用后端
Create Web 应用、PE 和 应用程序网关 v2

部署到 Azure		 此模板在 Azure 虚拟网络 子网 （应用程序网关 v2）中创建具有专用终结点的 Azure Web 应用。 应用程序网关部署在 vNet (子网) 中。 Web 应用使用专用终结点限制对来自子网的流量的访问

ARM 模板资源定义

可以使用针对以下操作部署 privateEndpoints 资源类型：

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

注解

有关创建专用终结点的指南，请参阅使用 Bicep Create虚拟网络资源。

资源格式

若要创建 Microsoft.Network/privateEndpoints 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Network/privateEndpoints",
  "apiVersion": "2023-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "extendedLocation": {
    "name": "string",
    "type": "EdgeZone"
  },
  "properties": {
    "applicationSecurityGroups": [
      {
        "id": "string",
        "location": "string",
        "properties": {},
        "tags": {}
      }
    ],
    "customDnsConfigs": [
      {
        "fqdn": "string",
        "ipAddresses": [ "string" ]
      }
    ],
    "customNetworkInterfaceName": "string",
    "ipConfigurations": [
      {
        "name": "string",
        "properties": {
          "groupId": "string",
          "memberName": "string",
          "privateIPAddress": "string"
        }
      }
    ],
    "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": {
      "id": "string",
      "name": "string",
      "properties": {
        "addressPrefix": "string",
        "addressPrefixes": [ "string" ],
        "applicationGatewayIPConfigurations": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "subnet": {
                "id": "string"
              }
            }
          }
        ],
        "defaultOutboundAccess": "bool",
        "delegations": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "serviceName": "string"
            },
            "type": "string"
          }
        ],
        "ipAllocations": [
          {
            "id": "string"
          }
        ],
        "natGateway": {
          "id": "string"
        },
        "networkSecurityGroup": {
          "id": "string",
          "location": "string",
          "properties": {
            "flushConnection": "bool",
            "securityRules": [
              {
                "id": "string",
                "name": "string",
                "properties": {
                  "access": "string",
                  "description": "string",
                  "destinationAddressPrefix": "string",
                  "destinationAddressPrefixes": [ "string" ],
                  "destinationApplicationSecurityGroups": [
                    {
                      "id": "string",
                      "location": "string",
                      "properties": {},
                      "tags": {}
                    }
                  ],
                  "destinationPortRange": "string",
                  "destinationPortRanges": [ "string" ],
                  "direction": "string",
                  "priority": "int",
                  "protocol": "string",
                  "sourceAddressPrefix": "string",
                  "sourceAddressPrefixes": [ "string" ],
                  "sourceApplicationSecurityGroups": [
                    {
                      "id": "string",
                      "location": "string",
                      "properties": {},
                      "tags": {}
                    }
                  ],
                  "sourcePortRange": "string",
                  "sourcePortRanges": [ "string" ]
                },
                "type": "string"
              }
            ]
          },
          "tags": {}
        },
        "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": {}
        },
        "serviceEndpointPolicies": [
          {
            "id": "string",
            "location": "string",
            "properties": {
              "contextualServiceEndpointPolicies": [ "string" ],
              "serviceAlias": "string",
              "serviceEndpointPolicyDefinitions": [
                {
                  "id": "string",
                  "name": "string",
                  "properties": {
                    "description": "string",
                    "service": "string",
                    "serviceResources": [ "string" ]
                  },
                  "type": "string"
                }
              ]
            },
            "tags": {}
          }
        ],
        "serviceEndpoints": [
          {
            "locations": [ "string" ],
            "service": "string"
          }
        ],
        "sharingScope": "string"
      },
      "type": "string"
    }
  }
}

属性值

privateEndpoints

名称 说明 Value
type 资源类型 “Microsoft.Network/privateEndpoints”
apiVersion 资源 API 版本 '2023-11-01'
name 资源名称 字符串 (必需)

字符限制：2-64

有效字符：
字母数字、下划线字符、句点和连字符。

以字母数字开头。 以字母数字或下划线结尾。
location 资源位置。 字符串
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
extendedLocation 负载均衡器的扩展位置。 ExtendedLocation
properties 专用终结点的属性。 PrivateEndpointProperties

ExtendedLocation

名称 说明 值
name 扩展位置的名称。 字符串
type 扩展位置的类型。 “EdgeZone”

PrivateEndpointProperties

名称 说明 值
applicationSecurityGroups 包含专用终结点 IP 配置的应用程序安全组。 ApplicationSecurityGroup[]
customDnsConfigs 自定义 dns 配置的数组。 CustomDnsConfigPropertiesFormat[]
customNetworkInterfaceName 附加到专用终结点的网络接口的自定义名称。 字符串
ipConfigurations 专用终结点的 IP 配置列表。 这将用于映射到第一方服务的终结点。 PrivateEndpointIPConfiguration[]
manualPrivateLinkServiceConnections 与远程资源的连接相关的信息的分组。 当网络管理员无权批准与远程资源的连接时使用。 PrivateLinkServiceConnection[]
privateLinkServiceConnections 与远程资源的连接相关的信息的分组。 PrivateLinkServiceConnection[]
子网 将从中分配专用 IP 的子网的 ID。 子网

ApplicationSecurityGroup

名称 说明 Value
id 资源 ID。 字符串
location 资源位置。 string
properties 应用程序安全组的属性。 ApplicationSecurityGroupPropertiesFormat
标记 资源标记。 对象 (object)

ApplicationSecurityGroupPropertiesFormat

此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。

CustomDnsConfigPropertiesFormat

名称 说明 值
fqdn 解析为专用终结点 IP 地址的 Fqdn。 字符串
ipAddresses 专用终结点的专用 IP 地址列表。 string[]

PrivateEndpointIPConfiguration

名称 说明 值
name 资源组中唯一的资源的名称。 string
properties 专用终结点 IP 配置的属性。 PrivateEndpointIPConfigurationProperties

PrivateEndpointIPConfigurationProperties

名称 说明 值
groupId 从此专用终结点应连接到的远程资源获取的组的 ID。 字符串
memberName 从此专用终结点应连接到的远程资源获取的组的成员名称。 字符串
privateIPAddress 从专用终结点的子网获取的专用 IP 地址。 字符串

PrivateLinkServiceConnection

名称 说明 Value
id 资源 ID。 字符串
name 资源组中唯一的资源的名称。 此名称可用于访问资源。 string
properties 专用链接服务连接的属性。 PrivateLinkServiceConnectionProperties

PrivateLinkServiceConnectionProperties

名称 说明 值
groupIds 组的 ID ( () 从此专用终结点应连接到的远程资源获取的组) 。 string[]
privateLinkServiceConnectionState 有关与远程资源的连接状态的只读信息的集合。 PrivateLinkServiceConnectionState
privateLinkServiceId 专用链接服务的资源 ID。 字符串
requestMessage 使用此连接请求传递给远程资源所有者的消息。 限制为 140 个字符。 字符串

PrivateLinkServiceConnectionState

名称 说明 值
actionsRequired 一条消息，指示服务提供商的更改是否需要对使用者进行任何更新。 字符串
description 批准/拒绝连接的原因。 字符串
status 指示连接是否已由服务的所有者批准/拒绝/删除。 字符串

子网

名称 说明 Value
id 资源 ID。 字符串
name 资源组中唯一的资源的名称。 此名称可用于访问资源。 string
properties 子网的属性。 SubnetPropertiesFormat
类型 资源类型。 字符串

SubnetPropertiesFormat

名称 说明 值
addressPrefix 子网的地址前缀。 字符串
addressPrefixes 子网的地址前缀列表。 string[]
applicationGatewayIPConfigurations 虚拟网络资源的应用程序网关 IP 配置。 ApplicationGatewayIPConfiguration[]
defaultOutboundAccess 将此属性设置为 false 可禁用子网中所有 VM 的默认出站连接。 此属性只能在创建子网时设置，不能为现有子网更新。 bool
代表团 对子网上委托的引用数组。 委派[]
ipAllocations 引用此子网的 IpAllocation 数组。 SubResource[]
natGateway 与此子网关联的 Nat 网关。 SubResource
networkSecurityGroup 对 NetworkSecurityGroup 资源的引用。 NetworkSecurityGroup
privateEndpointNetworkPolicies 启用或禁用在子网中的专用终结点应用网络策略。 “Disabled”
“已启用”
“NetworkSecurityGroupEnabled”
“RouteTableEnabled”
privateLinkServiceNetworkPolicies 启用或禁用对子网中的专用链接服务应用网络策略。 “Disabled”
“已启用”
routeTable 对 RouteTable 资源的引用。 RouteTable
serviceEndpointPolicies 服务终结点策略的数组。 ServiceEndpointPolicy[]
serviceEndpoints 服务终结点的数组。 ServiceEndpointPropertiesFormat[]
sharingScope 将此属性设置为 Tenant 以允许与 AAD 租户中的其他订阅共享子网。 仅当 defaultOutboundAccess 设置为 false 时，才能设置此属性;仅当子网为空时，才能设置这两个属性。 “DelegatedServices”
“Tenant”

ApplicationGatewayIPConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 IP 配置的名称。 string
properties 应用程序网关 IP 配置的属性。 ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationGatewayIPConfigurationPropertiesFormat

名称 说明 值
子网 对子网资源的引用。 应用程序网关从中获取其专用地址的子网。 SubResource

SubResource

名称 说明 Value
id 资源 ID。 字符串

委托

名称 说明 Value
id 资源 ID。 字符串
name 子网中唯一的资源的名称。 此名称可用于访问资源。 string
properties 子网的属性。 ServiceDelegationPropertiesFormat
类型 资源类型。 字符串

ServiceDelegationPropertiesFormat

名称 说明 值
serviceName 子网应委托给的服务的名称， (例如 Microsoft.Sql/servers) 。 字符串

NetworkSecurityGroup

名称 说明 Value
id 资源 ID。 字符串
location 资源位置。 string
properties 网络安全组的属性。 NetworkSecurityGroupPropertiesFormat
标记 资源标记。 对象 (object)

NetworkSecurityGroupPropertiesFormat

名称 说明 值
flushConnection 启用后，将在规则更新时重新评估从网络安全组连接创建的流。 初始启用将触发重新评估。 bool
securityRules 网络安全组的安全规则集合。 SecurityRule[]

SecurityRule

名称 说明 Value
id 资源 ID。 字符串
name 资源组中唯一的资源的名称。 此名称可用于访问资源。 string
properties 安全规则的属性。 SecurityRulePropertiesFormat
类型 资源类型。 字符串

SecurityRulePropertiesFormat

名称 说明 值
access 允许或拒绝网络流量。 “允许”
需要“拒绝” ()
description 此规则的说明。 限制为 140 个字符。 字符串
destinationAddressPrefix 目标地址前缀。 CIDR 或目标 IP 范围。 也可以使用星号“*”来匹配所有源 IP。 也可以使用默认标记，例如“VirtualNetwork”、“AzureLoadBalancer”和“Internet”。 字符串
destinationAddressPrefixes 目标地址前缀。 CIDR 或目标 IP 范围。 string[]
destinationApplicationSecurityGroups 指定为目标的应用程序安全组。 ApplicationSecurityGroup[]
destinationPortRange 目标端口或范围。 介于 0 和 65535 之间的整数或范围。 星号“*”也可用于匹配所有端口。 字符串
destinationPortRanges 目标端口范围。 string[]
direction 规则的方向。 direction 指定是要针对传入流量还是传出流量评估该规则。 'Inbound'
需要“出站” ()
priority 规则的优先级。 该值可以介于 100 和 4096 之间。 对于集合中的每个规则，优先级编号必须是唯一的。 优先级编号越低，规则优先级越高。 int (必需)
protocol 此规则应用到的网络协议。 '*'
'Ah'
'Esp'
'Icmp'
'Tcp'
“Udp” (必需)
sourceAddressPrefix CIDR 或源 IP 范围。 也可以使用星号“*”来匹配所有源 IP。 也可以使用默认标记，例如“VirtualNetwork”、“AzureLoadBalancer”和“Internet”。 如果这是入口规则，则指定网络流量的来源。 字符串
sourceAddressPrefixes CIDR 或源 IP 范围。 string[]
sourceApplicationSecurityGroups 指定为源的应用程序安全组。 ApplicationSecurityGroup[]
sourcePortRange 源端口或范围。 介于 0 和 65535 之间的整数或范围。 星号“*”也可用于匹配所有端口。 字符串
sourcePortRanges 源端口范围。 string[]

RouteTable

名称 说明 Value
id 资源 ID。 字符串
location 资源位置。 string
properties 路由表的属性。 RouteTablePropertiesFormat
标记 资源标记。 对象 (object)

RouteTablePropertiesFormat

名称 说明 值
disableBgpRoutePropagation 是否禁用 BGP 在该路由表上获知的路由。 True 表示禁用。 bool
routes 路由表中包含的路由的集合。 Route[]

路由

名称 说明 Value
id 资源 ID。 字符串
name 资源组中唯一的资源的名称。 此名称可用于访问资源。 string
properties 路由的属性。 RoutePropertiesFormat
类型 资源类型。 字符串

RoutePropertiesFormat

名称 说明 值
addressPrefix 路由应用到的目标 CIDR。 字符串
hasBgpOverride 一个 值，该值指示此路由是否替代重叠的 BGP 路由，而不考虑 LPM。 bool
nextHopIpAddress IP 地址数据包应转发到。 下一跃点值仅在下一跃点类型为 VirtualAppliance 的路由中被允许。 字符串
nextHopType 数据包应发送到的 Azure 跃点的类型。 “Internet”
“None”
“VirtualAppliance”
“VirtualNetworkGateway”
需要“VnetLocal” ()

ServiceEndpointPolicy

名称 说明 Value
id 资源 ID。 字符串
location 资源位置。 string
properties 服务终结点策略的属性。 ServiceEndpointPolicyPropertiesFormat
标记 资源标记。 对象 (object)

ServiceEndpointPolicyPropertiesFormat

名称 说明 值
contextualServiceEndpointPolicies 上下文服务终结点策略的集合。 string[]
serviceAlias 指示策略是否属于某个服务的别名 字符串
serviceEndpointPolicyDefinitions 服务终结点策略的服务终结点策略定义的集合。 ServiceEndpointPolicyDefinition[]

ServiceEndpointPolicyDefinition

名称 说明 Value
id 资源 ID。 字符串
name 资源组中唯一的资源的名称。 此名称可用于访问资源。 string
properties 服务终结点策略定义的属性。 ServiceEndpointPolicyDefinitionPropertiesFormat
类型 资源类型。 字符串

ServiceEndpointPolicyDefinitionPropertiesFormat

名称 说明 值
description 此规则的说明。 限制为 140 个字符。 字符串
服务 服务终结点名称。 字符串
serviceResources 服务资源列表。 string[]

ServiceEndpointPropertiesFormat

名称 说明 值
locations 位置列表。 string[]
服务 终结点服务的类型。 字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
min.io Azure 网关

部署到 Azure		 完全专用 min.io Azure 网关部署，以提供由 Blob 存储支持的 S3 兼容存储 API
具有 NAT 网关和应用程序网关的 AKS 群集

部署到 Azure		 此示例演示如何使用 NAT 网关部署 AKS 群集进行出站连接，为入站连接部署应用程序网关。
Azure Cloud Shell - VNet

部署到 Azure		 此模板将 Azure Cloud Shell资源部署到 Azure 虚拟网络中。
Create专用 AKS 群集

部署到 Azure		 此示例演示如何在虚拟网络中创建专用 AKS 群集以及 jumpbox 虚拟机。
Create具有公共 DNS 区域的专用 AKS 群集

部署到 Azure		 此示例演示如何部署具有公共 DNS 区域的专用 AKS 群集。
使用Azure SQL专用终结点的 Web 应用

部署到 Azure		 此模板演示如何创建使用指向 Azure SQL 服务器的专用终结点的 Web 应用
使用专用终结点Create API 管理服务

部署到 Azure		 此模板将创建一个API 管理服务、一个虚拟网络和一个向虚拟网络公开API 管理服务的专用终结点。
没有公共 IP 地址的Azure Batch池

部署到 Azure		 此模板创建Azure Batch简化的节点通信池，而无需公共 IP 地址。
使用 PE、CMK 所有表单部署 Azure Databricks 工作区

部署到 Azure		 通过此模板，可以创建具有 PrivateEndpoint 和托管服务的 Azure Databricks 工作区，以及使用 DBFS 加密的 CMK。
Azure Databricks 一体式模板 VNetInjection-Pvtendpt

部署到 Azure		 使用此模板可以创建网络安全组、虚拟网络以及具有虚拟网络的 Azure Databricks 工作区以及专用终结点。
具有函数和专用链接服务的 Azure 数字孪生

部署到 Azure		 此模板创建一个 Azure 数字孪生服务，该服务配置了一个虚拟网络连接的 Azure 函数，该函数可以通过专用链接终结点与数字孪生进行通信。 它还创建一个专用 DNS区域，允许数字孪生终结点从虚拟网络无缝主机名解析到专用终结点内部子网 IP 地址。 主机名存储为名为“ADT_ENDPOINT”的 Azure 函数的设置。
使用专用终结点Create Azure Cosmos DB 帐户

部署到 Azure		 此模板将创建一个 Cosmos 帐户、一个虚拟网络和一个向虚拟网络公开 Cosmos 帐户的专用终结点。
通过专用终结点连接到事件中心命名空间

部署到 Azure		 此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问事件中心命名空间。
通过专用终结点连接到密钥保管库

部署到 Azure		 此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问密钥保管库。
Azure 机器学习端到端安全设置

部署到 Azure		 这组 Bicep 模板演示如何在安全设置中端到端设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。
Azure 机器学习端到端安全设置 (旧版)

部署到 Azure		 这组 Bicep 模板演示如何在安全设置中端到端设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。
(vnet) Create Azure 机器学习服务工作区

部署到 Azure		 此部署模板指定 Azure 机器学习工作区及其关联的资源，包括 Azure 密钥保管库、Azure 存储、Azure 应用程序 Insights 和 Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。
Create旧版) (Azure 机器学习服务工作区

部署到 Azure		 此部署模板指定 Azure 机器学习工作区及其关联的资源，包括 Azure 密钥保管库、Azure 存储、Azure 应用程序 Insights 和 Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。
具有 应用程序网关 入口控制器的 AKS 群集

部署到 Azure		 此示例演示如何使用 应用程序网关、应用程序网关 入口控制器、Azure 容器注册表、Log Analytics 和 密钥保管库 部署 AKS 群集
在中心 & 辐射型拓扑中使用 Azure 防火墙 作为 DNS 代理

部署到 Azure		 此示例演示如何使用 Azure 防火墙 在 Azure 中部署中心辐射型拓扑。 中心虚拟网络充当与通过虚拟网络对等互连连接到中心虚拟网络的许多辐射虚拟网络的中心连接点。
专用链接服务示例

部署到 Azure		 此模板演示如何创建专用链接服务
使用专用终结点Azure 认知搜索服务

部署到 Azure		 此模板使用专用终结点创建Azure 认知搜索服务。
通过专用终结点连接到服务总线命名空间

部署到 Azure		 此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问服务总线命名空间。
专用终结点示例

部署到 Azure		 此模板演示如何创建指向 Azure SQL 服务器的专用终结点
通过专用终结点从 VM 连接到存储帐户

部署到 Azure		 此示例演示如何使用连接虚拟网络通过专用终结点访问 Blob 存储帐户。
通过专用终结点连接到 Azure 文件共享

部署到 Azure		 此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问 Azure 文件共享。
使用 Azure SQL 后端应用服务环境

部署到 Azure		 此模板创建一个应用服务环境，其中包含Azure SQL后端、专用终结点以及通常在专用/隔离环境中使用的关联资源。
专用函数应用和专用终结点保护的存储

部署到 Azure		 此模板在具有专用终结点并通过专用终结点与 Azure 存储通信的高级计划上预配函数应用。
Create Function App 和受专用终结点保护的存储

部署到 Azure		 此模板允许部署通过专用终结点与 Azure 存储通信的 Azure 函数应用。
受 Azure Frontdoor 保护的函数应用

部署到 Azure		 此模板允许部署由 Azure Frontdoor 高级版保护并发布的 Azure 高级函数。 Azure Frontdoor 与 Azure Functions 之间的连接受Azure 专用链接保护。
具有专用终结点的 Web 应用

部署到 Azure		 此模板允许创建 Web 应用并通过专用终结点公开它
使用内部API 管理和 Web 应用应用程序网关

部署到 Azure		 应用程序网关将 Internet 流量路由到虚拟网络 (内部模式) API 管理 实例，该实例为 Azure Web 应用中托管的 Web API 提供服务。
具有 VNet 注入和专用终结点的 Web 应用

部署到 Azure		 此模板允许创建包含两个 Web 应用（前端和后端）的安全端到端解决方案，前端将通过 VNet 注入和专用终结点安全地使用后端
保护 N 层 Web 应用

部署到 Azure		 此模板允许创建一个安全的端到端解决方案，其中包含两个具有过渡槽的 Web 应用（前端和后端），前端将通过 VNet 注入和专用终结点安全地使用后端
Create Web 应用、PE 和 应用程序网关 v2

部署到 Azure		 此模板在 Azure 虚拟网络 子网 （应用程序网关 v2）中创建具有专用终结点的 Azure Web 应用。 应用程序网关部署在 vNet (子网) 中。 Web 应用使用专用终结点限制对来自子网的流量的访问

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 privateEndpoints 资源类型：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Network/privateEndpoints 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/privateEndpoints@2023-11-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      applicationSecurityGroups = [
        {
          id = "string"
          location = "string"
          properties = {}
          tags = {}
        }
      ]
      customDnsConfigs = [
        {
          fqdn = "string"
          ipAddresses = [
            "string"
          ]
        }
      ]
      customNetworkInterfaceName = "string"
      ipConfigurations = [
        {
          name = "string"
          properties = {
            groupId = "string"
            memberName = "string"
            privateIPAddress = "string"
          }
        }
      ]
      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 = {
        id = "string"
        name = "string"
        properties = {
          addressPrefix = "string"
          addressPrefixes = [
            "string"
          ]
          applicationGatewayIPConfigurations = [
            {
              id = "string"
              name = "string"
              properties = {
                subnet = {
                  id = "string"
                }
              }
            }
          ]
          defaultOutboundAccess = bool
          delegations = [
            {
              id = "string"
              name = "string"
              properties = {
                serviceName = "string"
              }
              type = "string"
            }
          ]
          ipAllocations = [
            {
              id = "string"
            }
          ]
          natGateway = {
            id = "string"
          }
          networkSecurityGroup = {
            id = "string"
            location = "string"
            properties = {
              flushConnection = bool
              securityRules = [
                {
                  id = "string"
                  name = "string"
                  properties = {
                    access = "string"
                    description = "string"
                    destinationAddressPrefix = "string"
                    destinationAddressPrefixes = [
                      "string"
                    ]
                    destinationApplicationSecurityGroups = [
                      {
                        id = "string"
                        location = "string"
                        properties = {}
                        tags = {}
                      }
                    ]
                    destinationPortRange = "string"
                    destinationPortRanges = [
                      "string"
                    ]
                    direction = "string"
                    priority = int
                    protocol = "string"
                    sourceAddressPrefix = "string"
                    sourceAddressPrefixes = [
                      "string"
                    ]
                    sourceApplicationSecurityGroups = [
                      {
                        id = "string"
                        location = "string"
                        properties = {}
                        tags = {}
                      }
                    ]
                    sourcePortRange = "string"
                    sourcePortRanges = [
                      "string"
                    ]
                  }
                  type = "string"
                }
              ]
            }
            tags = {}
          }
          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 = {}
          }
          serviceEndpointPolicies = [
            {
              id = "string"
              location = "string"
              properties = {
                contextualServiceEndpointPolicies = [
                  "string"
                ]
                serviceAlias = "string"
                serviceEndpointPolicyDefinitions = [
                  {
                    id = "string"
                    name = "string"
                    properties = {
                      description = "string"
                      service = "string"
                      serviceResources = [
                        "string"
                      ]
                    }
                    type = "string"
                  }
                ]
              }
              tags = {}
            }
          ]
          serviceEndpoints = [
            {
              locations = [
                "string"
              ]
              service = "string"
            }
          ]
          sharingScope = "string"
        }
        type = "string"
      }
    }
    extendedLocation = {
      name = "string"
      type = "EdgeZone"
    }
  })
}

属性值

privateEndpoints

名称 说明 Value
type 资源类型 “Microsoft.Network/privateEndpoints@2023-11-01”
name 资源名称 字符串 (必需)

字符限制：2-64

有效字符：
字母数字、下划线字符、句点和连字符。

以字母数字开头。 以字母数字或下划线结尾。
location 资源位置。 字符串
parent_id 若要部署到资源组，请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
extendedLocation 负载均衡器的扩展位置。 ExtendedLocation
properties 专用终结点的属性。 PrivateEndpointProperties

ExtendedLocation

名称 说明 值
name 扩展位置的名称。 字符串
type 扩展位置的类型。 “EdgeZone”

PrivateEndpointProperties

名称 说明 值
applicationSecurityGroups 包含专用终结点 IP 配置的应用程序安全组。 ApplicationSecurityGroup[]
customDnsConfigs 自定义 DNS 配置的数组。 CustomDnsConfigPropertiesFormat[]
customNetworkInterfaceName 附加到专用终结点的网络接口的自定义名称。 字符串
ipConfigurations 专用终结点的 IP 配置列表。 这将用于映射到第一方服务的终结点。 PrivateEndpointIPConfiguration[]
manualPrivateLinkServiceConnections 有关与远程资源的连接的信息分组。 当网络管理员无权批准与远程资源的连接时使用。 PrivateLinkServiceConnection[]
privateLinkServiceConnections 有关与远程资源的连接的信息分组。 PrivateLinkServiceConnection[]
子网 将从中分配专用 IP 的子网的 ID。 子网

ApplicationSecurityGroup

名称 说明 Value
id 资源 ID。 字符串
location 资源位置。 string
properties 应用程序安全组的属性。 ApplicationSecurityGroupPropertiesFormat
标记 资源标记。 对象 (object)

ApplicationSecurityGroupPropertiesFormat

此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。

CustomDnsConfigPropertiesFormat

名称 说明 值
fqdn 解析为专用终结点 IP 地址的 Fqdn。 字符串
ipAddresses 专用终结点的专用 IP 地址列表。 string[]

PrivateEndpointIPConfiguration

名称 说明 值
name 资源组中唯一的资源的名称。 string
properties 专用终结点 IP 配置的属性。 PrivateEndpointIPConfigurationProperties

PrivateEndpointIPConfigurationProperties

名称 说明 值
groupId 从此专用终结点应连接到的远程资源获取的组的 ID。 字符串
memberName 从此专用终结点应连接到的远程资源获取的组的成员名称。 字符串
privateIPAddress 从专用终结点的子网获取的专用 IP 地址。 字符串

PrivateLinkServiceConnection

名称 说明 Value
id 资源 ID。 字符串
name 资源组中唯一的资源的名称。 此名称可用于访问资源。 string
properties 专用链接服务连接的属性。 PrivateLinkServiceConnectionProperties

PrivateLinkServiceConnectionProperties

名称 说明 值
groupIds 组的 ID ( () 从此专用终结点应连接到的远程资源获取的组) 。 string[]
privateLinkServiceConnectionState 有关与远程资源的连接状态的只读信息的集合。 PrivateLinkServiceConnectionState
privateLinkServiceId 专用链接服务的资源 ID。 字符串
requestMessage 使用此连接请求传递给远程资源所有者的消息。 限制为 140 个字符。 字符串

PrivateLinkServiceConnectionState

名称 说明 值
actionsRequired 一条消息，指示服务提供商的更改是否需要对使用者进行任何更新。 字符串
description 批准/拒绝连接的原因。 字符串
status 指示连接是否已由服务的所有者批准/拒绝/删除。 字符串

子网

名称 说明 Value
id 资源 ID。 字符串
name 资源组中唯一的资源的名称。 此名称可用于访问资源。 string
properties 子网的属性。 SubnetPropertiesFormat
类型 资源类型。 字符串

SubnetPropertiesFormat

名称 说明 值
addressPrefix 子网的地址前缀。 字符串
addressPrefixes 子网的地址前缀列表。 string[]
applicationGatewayIPConfigurations 虚拟网络资源的应用程序网关 IP 配置。 ApplicationGatewayIPConfiguration[]
defaultOutboundAccess 将此属性设置为 false 可禁用子网中所有 VM 的默认出站连接。 此属性只能在创建子网时设置，不能为现有子网更新。 bool
代表团 对子网上的委派的引用数组。 委派[]
ipAllocations 引用此子网的 IpAllocation 数组。 SubResource[]
natGateway 与此子网关联的 Nat 网关。 SubResource
networkSecurityGroup 对 NetworkSecurityGroup 资源的引用。 NetworkSecurityGroup
privateEndpointNetworkPolicies 在子网的专用终结点上启用或禁用应用网络策略。 “Disabled”
“已启用”
“NetworkSecurityGroupEnabled”
“RouteTableEnabled”
privateLinkServiceNetworkPolicies 启用或禁用对子网中的专用链接服务应用网络策略。 “Disabled”
“已启用”
routeTable 对 RouteTable 资源的引用。 RouteTable
serviceEndpointPolicies 服务终结点策略的数组。 ServiceEndpointPolicy[]
serviceEndpoints 服务终结点的数组。 ServiceEndpointPropertiesFormat[]
sharingScope 将此属性设置为 Tenant 以允许与 AAD 租户中的其他订阅共享子网。 仅当 defaultOutboundAccess 设置为 false 时，才能设置此属性;仅当子网为空时，才能设置这两个属性。 “DelegatedServices”
“Tenant”

ApplicationGatewayIPConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 IP 配置的名称。 string
properties 应用程序网关 IP 配置的属性。 ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationGatewayIPConfigurationPropertiesFormat

名称 说明 值
子网 对子网资源的引用。 应用程序网关从中获取其专用地址的子网。 SubResource

SubResource

名称 说明 Value
id 资源 ID。 字符串

委托

名称 说明 Value
id 资源 ID。 字符串
name 子网中唯一的资源的名称。 此名称可用于访问资源。 string
properties 子网的属性。 ServiceDelegationPropertiesFormat
类型 资源类型。 字符串

ServiceDelegationPropertiesFormat

名称 说明 值
serviceName 子网应委托给的服务的名称， (例如 Microsoft.Sql/servers) 。 字符串

NetworkSecurityGroup

名称 说明 Value
id 资源 ID。 字符串
location 资源位置。 string
properties 网络安全组的属性。 NetworkSecurityGroupPropertiesFormat
标记 资源标记。 对象 (object)

NetworkSecurityGroupPropertiesFormat

名称 说明 值
flushConnection 启用后，将在规则更新时重新评估从网络安全组连接创建的流。 初始启用将触发重新评估。 bool
securityRules 网络安全组的安全规则集合。 SecurityRule[]

SecurityRule

名称 说明 Value
id 资源 ID。 字符串
name 资源组中唯一的资源的名称。 此名称可用于访问资源。 string
properties 安全规则的属性。 SecurityRulePropertiesFormat
类型 资源类型。 字符串

SecurityRulePropertiesFormat

名称 说明 值
access 允许或拒绝网络流量。 “允许”
需要“拒绝” ()
description 此规则的说明。 限制为 140 个字符。 字符串
destinationAddressPrefix 目标地址前缀。 CIDR 或目标 IP 范围。 也可以使用星号“*”来匹配所有源 IP。 也可以使用“VirtualNetwork”、“AzureLoadBalancer”和“Internet”等默认标记。 字符串
destinationAddressPrefixes 目标地址前缀。 CIDR 或目标 IP 范围。 string[]
destinationApplicationSecurityGroups 指定为目标的应用程序安全组。 ApplicationSecurityGroup[]
destinationPortRange 目标端口或范围。 介于 0 和 65535 之间的整数或范围。 星号“*”也可用于匹配所有端口。 字符串
destinationPortRanges 目标端口范围。 string[]
direction 规则的方向。 direction 指定是要针对传入流量还是传出流量评估该规则。 “入站”
需要“出站” ()
priority 规则的优先级。 该值可以介于 100 和 4096 之间。 对于集合中的每个规则，优先级编号必须是唯一的。 优先级编号越低，规则优先级越高。 int (必需)
protocol 此规则应用到的网络协议。 "*"
“啊”
“Esp”
“Icmp”
“Tcp”
需要“Udp” ()
sourceAddressPrefix CIDR 或源 IP 范围。 也可以使用星号“*”来匹配所有源 IP。 也可以使用默认标记，例如“VirtualNetwork”、“AzureLoadBalancer”和“Internet”。 如果这是入口规则，则指定网络流量的来源。 字符串
sourceAddressPrefixes CIDR 或源 IP 范围。 string[]
sourceApplicationSecurityGroups 指定为源的应用程序安全组。 ApplicationSecurityGroup[]
sourcePortRange 源端口或范围。 介于 0 和 65535 之间的整数或范围。 星号“*”也可用于匹配所有端口。 字符串
sourcePortRanges 源端口范围。 string[]

RouteTable

名称 说明 Value
id 资源 ID。 字符串
location 资源位置。 string
properties 路由表的属性。 RouteTablePropertiesFormat
标记 资源标记。 对象 (object)

RouteTablePropertiesFormat

名称 说明 值
disableBgpRoutePropagation 是否禁用 BGP 在该路由表上获知的路由。 True 表示禁用。 bool
routes 路由表中包含的路由的集合。 Route[]

路由

名称 说明 Value
id 资源 ID。 字符串
name 资源组中唯一的资源的名称。 此名称可用于访问资源。 string
properties 路由的属性。 RoutePropertiesFormat
类型 资源类型。 字符串

RoutePropertiesFormat

名称 说明 值
addressPrefix 路由应用到的目标 CIDR。 字符串
hasBgpOverride 一个 值，该值指示此路由是否替代重叠的 BGP 路由，而不考虑 LPM。 bool
nextHopIpAddress IP 地址数据包应转发到。 下一跃点值仅在下一跃点类型为 VirtualAppliance 的路由中被允许。 字符串
nextHopType 数据包应发送到的 Azure 跃点的类型。 “Internet”
"None"
“VirtualAppliance”
“VirtualNetworkGateway”
“VnetLocal” (必需)

ServiceEndpointPolicy

名称 说明 Value
id 资源 ID。 字符串
location 资源位置。 string
properties 服务终结点策略的属性。 ServiceEndpointPolicyPropertiesFormat
标记 资源标记。 对象 (object)

ServiceEndpointPolicyPropertiesFormat

名称 说明 值
contextualServiceEndpointPolicies 上下文服务终结点策略的集合。 string[]
serviceAlias 指示策略是否属于某个服务的别名 字符串
serviceEndpointPolicyDefinitions 服务终结点策略的服务终结点策略定义的集合。 ServiceEndpointPolicyDefinition[]

ServiceEndpointPolicyDefinition

名称 说明 Value
id 资源 ID。 字符串
name 资源组中唯一的资源的名称。 此名称可用于访问资源。 string
properties 服务终结点策略定义的属性。 ServiceEndpointPolicyDefinitionPropertiesFormat
类型 资源类型。 字符串

ServiceEndpointPolicyDefinitionPropertiesFormat

名称 说明 值
description 此规则的说明。 限制为 140 个字符。 字符串
服务 服务终结点名称。 字符串
serviceResources 服务资源的列表。 string[]

ServiceEndpointPropertiesFormat

名称 说明 值
locations 位置列表。 string[]
服务 终结点服务的类型。 字符串