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

Microsoft.Network privateEndpoints 2023-11-01

• 最新
• 2024-05-01
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01

言论

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

Bicep 资源定义

可以使用目标操作部署 privateEndpoints 资源类型：

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

resource symbolicname 'Microsoft.Network/privateEndpoints@2023-11-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    applicationSecurityGroups: [
      {
        id: 'string'
        location: 'string'
        properties: {}
        tags: {
          {customized property}: 'string'
        }
      }
    ]
    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: {
                        {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'
                  ]
                }
                type: 'string'
              }
            ]
          }
          tags: {
            {customized property}: 'string'
          }
        }
        privateEndpointNetworkPolicies: 'string'
        privateLinkServiceNetworkPolicies: 'string'
        routeTable: {
          id: 'string'
          location: 'string'
          properties: {
            disableBgpRoutePropagation: bool
            routes: [
              {
                id: 'string'
                name: 'string'
                properties: {
                  addressPrefix: 'string'
                  nextHopIpAddress: 'string'
                  nextHopType: 'string'
                }
                type: 'string'
              }
            ]
          }
          tags: {
            {customized property}: 'string'
          }
        }
        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: {
              {customized property}: 'string'
            }
          }
        ]
        serviceEndpoints: [
          {
            locations: [
              'string'
            ]
            service: 'string'
          }
        ]
        sharingScope: 'string'
      }
      type: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

ApplicationGatewayIPConfiguration

名字	描述	价值
id	资源 ID。	字符串
名字	应用程序网关中唯一的 IP 配置的名称。	字符串
性能	应用程序网关 IP 配置的属性。	ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationGatewayIPConfigurationPropertiesFormat

名字	描述	价值
子	对子网资源的引用。 应用程序网关从中获取其专用地址的子网。	SubResource

ApplicationSecurityGroup

名字	描述	价值
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	应用程序安全组的属性。	ApplicationSecurityGroupPropertiesFormat
标签	资源标记。	ResourceTags

ApplicationSecurityGroupPropertiesFormat

名字	描述	价值

CustomDnsConfigPropertiesFormat

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

代表团

名字	描述	价值
id	资源 ID。	字符串
名字	子网中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	子网的属性。	ServiceDelegationPropertiesFormat
类型	资源类型。	字符串

ExtendedLocation

名字	描述	价值
名字	扩展位置的名称。	字符串
类型	扩展位置的类型。	“EdgeZone”

Microsoft.Network/privateEndpoints

名字	描述	价值
extendedLocation	负载均衡器的扩展位置。	ExtendedLocation
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	专用终结点的属性。	PrivateEndpointProperties
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记

NetworkSecurityGroup

名字	描述	价值
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	网络安全组的属性。	NetworkSecurityGroupPropertiesFormat
标签	资源标记。	ResourceTags

NetworkSecurityGroupPropertiesFormat

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

PrivateEndpointIPConfiguration

名字	描述	价值
名字	资源组中唯一的资源的名称。	字符串
性能	专用终结点 IP 配置的属性。	PrivateEndpointIPConfigurationProperties

PrivateEndpointIPConfigurationProperties

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

PrivateEndpointProperties

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

PrivateLinkServiceConnection

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	专用链接服务连接的属性。	PrivateLinkServiceConnectionProperties

PrivateLinkServiceConnectionProperties

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

PrivateLinkServiceConnectionState

名字	描述	价值
actionsRequired	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。	字符串
描述	批准/拒绝连接的原因。	字符串
地位	指示连接是否已被服务的所有者批准/拒绝/删除。	字符串

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

路线

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	路由的属性。	RoutePropertiesFormat
类型	资源的类型。	字符串

RoutePropertiesFormat

名字	描述	价值
addressPrefix	路由应用到的目标 CIDR。	字符串
nextHopIpAddress	IP 地址数据包应转发到。 只有在下一跃点类型为 VirtualAppliance 的路由中才允许下一跃点值。	字符串
nextHopType	应将数据包发送到的 Azure 跃点的类型。	“Internet” “None” “VirtualAppliance” “VirtualNetworkGateway” “VnetLocal”（必需）

RouteTable

名字	描述	价值
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	路由表的属性。	RouteTablePropertiesFormat
标签	资源标记。	ResourceTags

RouteTablePropertiesFormat

名字	描述	价值
disableBgpRoutePropagation	是否禁用 BGP 在该路由表上学习的路由。 True 表示禁用。	bool
路线	路由表中包含的路由的集合。	路由[]

SecurityRule

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	安全规则的属性。	SecurityRulePropertiesFormat
类型	资源的类型。	字符串

SecurityRulePropertiesFormat

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

ServiceDelegationPropertiesFormat

名字	描述	价值
serviceName	应向其委托子网的服务的名称（例如Microsoft.Sql/servers）。	字符串

ServiceEndpointPolicy

名字	描述	价值
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	服务终结点策略的属性。	ServiceEndpointPolicyPropertiesFormat
标签	资源标记。	ResourceTags

ServiceEndpointPolicyDefinition

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	服务终结点策略定义的属性。	ServiceEndpointPolicyDefinitionPropertiesFormat
类型	资源的类型。	字符串

ServiceEndpointPolicyDefinitionPropertiesFormat

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

ServiceEndpointPolicyPropertiesFormat

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

ServiceEndpointPropertiesFormat

名字	描述	价值
地点	位置列表。	string[]
服务	终结点服务的类型。	字符串

子

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	子网的属性。	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	将此属性设置为“租户”，以允许与 AAD 租户中的其他订阅共享子网。 仅当 defaultOutboundAccess 设置为 false 时，才能设置此属性，仅当子网为空时，才能设置这两个属性。	“DelegatedServices” “Tenant”

SubResource

名字	描述	价值
id	资源 ID。	字符串

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
使用 NAT 网关和应用程序网关 AKS 群集	此示例演示如何使用 NAT 网关部署 AKS 群集进行出站连接，以及如何为入站连接部署应用程序网关。
使用应用程序网关入口控制器 AKS 群集	此示例演示如何使用应用程序网关、应用程序网关入口控制器、Azure 容器注册表、Log Analytics 和 Key Vault 部署 AKS 群集
使用内部 API 管理和 Web 应用 应用程序网关	应用程序网关将 Internet 流量路由到虚拟网络（内部模式）API 管理实例，该实例服务 Azure Web 应用中托管的 Web API。
Azure AI Studio 网络受限	此模板集演示如何使用禁用专用链接和出口设置 Azure AI Studio，并使用Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。
Azure AI Studio 网络受限	此模板集演示如何使用禁用专用链接和出口设置 Azure AI Studio，并使用Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。
不带公共 IP 地址的 Azure Batch 池	此模板创建没有公共 IP 地址的 Azure Batch 简化节点通信池。
Azure Cloud Shell - VNet	此模板将 Azure Cloud Shell 资源部署到 Azure 虚拟网络。
Azure Databricks 一体式模板 VNetInjection-Pvtendpt	使用此模板可以创建网络安全组、虚拟网络和包含虚拟网络的 Azure Databricks 工作区和专用终结点。
使用函数和专用链接服务 Azure 数字孪生	此模板创建一个配置有虚拟网络连接的 Azure 函数的 Azure 数字孪生服务，该服务可以通过专用链接终结点与数字孪生进行通信。 它还创建专用 DNS 区域，以允许从虚拟网络到专用终结点内部子网 IP 地址的数字孪生终结点无缝主机名解析。 主机名存储为名为“ADT_ENDPOINT”的 Azure 函数的设置。
Azure 机器学习端到端安全设置	此 Bicep 模板集演示如何在安全设置中端到端设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。
Azure 机器学习端到端安全设置（旧版）	此 Bicep 模板集演示如何在安全设置中端到端设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。
默认存储防火墙 的 AzureDatabricks 模板	使用此模板，可以使用虚拟网络和系统分配的访问连接器创建网络安全组、虚拟网络、专用终结点和启用默认存储防火墙的 Azure Databricks 工作区。
创建专用 AKS 群集	此示例演示如何在虚拟网络中创建专用 AKS 群集以及 jumpbox 虚拟机。
创建 Web 应用、PE 和应用程序网关 v2	此模板在 Azure 虚拟网络子网（应用程序网关 v2）中创建具有专用终结点的 Azure Web 应用。 应用程序网关部署在 vNet（子网）中。 Web 应用使用专用终结点限制对来自子网的流量的访问
使用 Prometheus 和 Grafana 和 privae 链接创建 AKS	这将在 Azure Kubernetes 服务（AKS）群集上创建 Azure grafana、AKS 并安装 Prometheus（开源监视和警报工具包）。 然后使用 Azure Managed Grafana 的托管专用终结点连接到此 Prometheus 服务器并在 Grafana 仪表板中显示 Prometheus 数据
使用专用终结点创建 API 管理服务	此模板将创建 API 管理服务、虚拟网络和专用终结点，向虚拟网络公开 API 管理服务。
使用专用终结点创建 Azure Cosmos DB 帐户	此模板将创建 Cosmos 帐户、虚拟网络以及向虚拟网络公开 Cosmos 帐户的专用终结点。
创建 Azure 机器学习服务工作区（旧版）	此部署模板指定 Azure 机器学习工作区及其关联的资源，包括 Azure Key Vault、Azure 存储、Azure Application Insights 和 Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。
创建 Azure 机器学习服务工作区（vnet）	此部署模板指定 Azure 机器学习工作区及其关联的资源，包括 Azure Key Vault、Azure 存储、Azure Application Insights 和 Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。
创建 Function App 和专用终结点保护的存储	使用此模板，可以部署通过专用终结点与 Azure 存储通信的 Azure Function App。
创建跨租户专用终结点资源	此模板允许你在相同或跨租户环境中创建 Priavate Endpoint 资源，并添加 dns 区域配置。
使用专用终结点部署 MySQL 灵活服务器	此模板提供了使用专用终结点部署 Azure Database for MySQL 灵活服务器的方法。
受 Azure Frontdoor 保护的 Function App	此模板允许部署受 Azure Frontdoor 高级版保护并发布的 Azure 高级函数。 Azure Frontdoor 和 Azure Functions 之间的连接受 Azure 专用链接的保护。
专用终结点示例	此模板演示如何创建指向 Azure SQL Server 的专用终结点
专用函数应用和专用终结点保护的存储	此模板在具有专用终结点的 Premium 计划中预配函数应用，并通过专用终结点与 Azure 存储通信。
专用链接服务示例	此模板演示如何创建专用链接服务
安全 N 层 Web 应用	使用此模板，可以使用具有过渡槽、前端和后端的两个 Web 应用创建安全的端到端解决方案，前端将通过 VNet 注入和专用终结点安全地使用后端
使用 Azure 防火墙作为中心 & 辐射型拓扑中的 DNS 代理	此示例演示如何使用 Azure 防火墙在 Azure 中部署中心辐射型拓扑。 中心虚拟网络充当通过虚拟网络对等互连连接到中心虚拟网络的许多辐射虚拟网络的中心点。
使用 VNet 注入和专用终结点 Web 应用	使用此模板，可以使用两个 Web 应用（前端和后端）创建安全的端到端解决方案，前端将通过 VNet 注入和专用终结点安全地使用后端

ARM 模板资源定义

可以使用目标操作部署 privateEndpoints 资源类型：

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

{
  "type": "Microsoft.Network/privateEndpoints",
  "apiVersion": "2023-11-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "applicationSecurityGroups": [
      {
        "id": "string",
        "location": "string",
        "properties": {
        },
        "tags": {
          "{customized property}": "string"
        }
      }
    ],
    "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": {
                        "{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" ]
                },
                "type": "string"
              }
            ]
          },
          "tags": {
            "{customized property}": "string"
          }
        },
        "privateEndpointNetworkPolicies": "string",
        "privateLinkServiceNetworkPolicies": "string",
        "routeTable": {
          "id": "string",
          "location": "string",
          "properties": {
            "disableBgpRoutePropagation": "bool",
            "routes": [
              {
                "id": "string",
                "name": "string",
                "properties": {
                  "addressPrefix": "string",
                  "nextHopIpAddress": "string",
                  "nextHopType": "string"
                },
                "type": "string"
              }
            ]
          },
          "tags": {
            "{customized property}": "string"
          }
        },
        "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": {
              "{customized property}": "string"
            }
          }
        ],
        "serviceEndpoints": [
          {
            "locations": [ "string" ],
            "service": "string"
          }
        ],
        "sharingScope": "string"
      },
      "type": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

ApplicationGatewayIPConfiguration

名字	描述	价值
id	资源 ID。	字符串
名字	应用程序网关中唯一的 IP 配置的名称。	字符串
性能	应用程序网关 IP 配置的属性。	ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationGatewayIPConfigurationPropertiesFormat

名字	描述	价值
子	对子网资源的引用。 应用程序网关从中获取其专用地址的子网。	SubResource

ApplicationSecurityGroup

名字	描述	价值
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	应用程序安全组的属性。	ApplicationSecurityGroupPropertiesFormat
标签	资源标记。	ResourceTags

ApplicationSecurityGroupPropertiesFormat

名字	描述	价值

CustomDnsConfigPropertiesFormat

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

代表团

名字	描述	价值
id	资源 ID。	字符串
名字	子网中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	子网的属性。	ServiceDelegationPropertiesFormat
类型	资源类型。	字符串

ExtendedLocation

名字	描述	价值
名字	扩展位置的名称。	字符串
类型	扩展位置的类型。	“EdgeZone”

Microsoft.Network/privateEndpoints

名字	描述	价值
apiVersion	API 版本	'2023-11-01'
extendedLocation	负载均衡器的扩展位置。	ExtendedLocation
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	专用终结点的属性。	PrivateEndpointProperties
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.Network/privateEndpoints”

NetworkSecurityGroup

名字	描述	价值
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	网络安全组的属性。	NetworkSecurityGroupPropertiesFormat
标签	资源标记。	ResourceTags

NetworkSecurityGroupPropertiesFormat

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

PrivateEndpointIPConfiguration

名字	描述	价值
名字	资源组中唯一的资源的名称。	字符串
性能	专用终结点 IP 配置的属性。	PrivateEndpointIPConfigurationProperties

PrivateEndpointIPConfigurationProperties

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

PrivateEndpointProperties

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

PrivateLinkServiceConnection

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	专用链接服务连接的属性。	PrivateLinkServiceConnectionProperties

PrivateLinkServiceConnectionProperties

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

PrivateLinkServiceConnectionState

名字	描述	价值
actionsRequired	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。	字符串
描述	批准/拒绝连接的原因。	字符串
地位	指示连接是否已被服务的所有者批准/拒绝/删除。	字符串

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

路线

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	路由的属性。	RoutePropertiesFormat
类型	资源的类型。	字符串

RoutePropertiesFormat

名字	描述	价值
addressPrefix	路由应用到的目标 CIDR。	字符串
nextHopIpAddress	IP 地址数据包应转发到。 只有在下一跃点类型为 VirtualAppliance 的路由中才允许下一跃点值。	字符串
nextHopType	应将数据包发送到的 Azure 跃点的类型。	“Internet” “None” “VirtualAppliance” “VirtualNetworkGateway” “VnetLocal”（必需）

RouteTable

名字	描述	价值
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	路由表的属性。	RouteTablePropertiesFormat
标签	资源标记。	ResourceTags

RouteTablePropertiesFormat

名字	描述	价值
disableBgpRoutePropagation	是否禁用 BGP 在该路由表上学习的路由。 True 表示禁用。	bool
路线	路由表中包含的路由的集合。	路由[]

SecurityRule

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	安全规则的属性。	SecurityRulePropertiesFormat
类型	资源的类型。	字符串

SecurityRulePropertiesFormat

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

ServiceDelegationPropertiesFormat

名字	描述	价值
serviceName	应向其委托子网的服务的名称（例如Microsoft.Sql/servers）。	字符串

ServiceEndpointPolicy

名字	描述	价值
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	服务终结点策略的属性。	ServiceEndpointPolicyPropertiesFormat
标签	资源标记。	ResourceTags

ServiceEndpointPolicyDefinition

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	服务终结点策略定义的属性。	ServiceEndpointPolicyDefinitionPropertiesFormat
类型	资源的类型。	字符串

ServiceEndpointPolicyDefinitionPropertiesFormat

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

ServiceEndpointPolicyPropertiesFormat

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

ServiceEndpointPropertiesFormat

名字	描述	价值
地点	位置列表。	string[]
服务	终结点服务的类型。	字符串

子

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	子网的属性。	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	将此属性设置为“租户”，以允许与 AAD 租户中的其他订阅共享子网。 仅当 defaultOutboundAccess 设置为 false 时，才能设置此属性，仅当子网为空时，才能设置这两个属性。	“DelegatedServices” “Tenant”

SubResource

名字	描述	价值
id	资源 ID。	字符串

快速入门模板

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

模板	描述
使用 NAT 网关和应用程序网关 AKS 群集	此示例演示如何使用 NAT 网关部署 AKS 群集进行出站连接，以及如何为入站连接部署应用程序网关。
使用应用程序网关入口控制器 AKS 群集	此示例演示如何使用应用程序网关、应用程序网关入口控制器、Azure 容器注册表、Log Analytics 和 Key Vault 部署 AKS 群集
使用 Azure SQL 后端 应用服务环境	此模板创建具有 Azure SQL 后端的应用服务环境以及专用终结点以及通常用于专用/隔离环境中的关联资源。
使用内部 API 管理和 Web 应用 应用程序网关	应用程序网关将 Internet 流量路由到虚拟网络（内部模式）API 管理实例，该实例服务 Azure Web 应用中托管的 Web API。
Azure AI Studio 网络受限	此模板集演示如何使用禁用专用链接和出口设置 Azure AI Studio，并使用Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。
Azure AI Studio 网络受限	此模板集演示如何使用禁用专用链接和出口设置 Azure AI Studio，并使用Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。
不带公共 IP 地址的 Azure Batch 池	此模板创建没有公共 IP 地址的 Azure Batch 简化节点通信池。
Azure Cloud Shell - VNet	此模板将 Azure Cloud Shell 资源部署到 Azure 虚拟网络。
使用专用终结点 Azure 认知搜索服务	此模板使用专用终结点创建 Azure 认知搜索服务。
Azure Databricks 一体式模板 VNetInjection-Pvtendpt	使用此模板可以创建网络安全组、虚拟网络和包含虚拟网络的 Azure Databricks 工作区和专用终结点。
使用函数和专用链接服务 Azure 数字孪生	此模板创建一个配置有虚拟网络连接的 Azure 函数的 Azure 数字孪生服务，该服务可以通过专用链接终结点与数字孪生进行通信。 它还创建专用 DNS 区域，以允许从虚拟网络到专用终结点内部子网 IP 地址的数字孪生终结点无缝主机名解析。 主机名存储为名为“ADT_ENDPOINT”的 Azure 函数的设置。
Azure 机器学习端到端安全设置	此 Bicep 模板集演示如何在安全设置中端到端设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。
Azure 机器学习端到端安全设置（旧版）	此 Bicep 模板集演示如何在安全设置中端到端设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。
默认存储防火墙 的 AzureDatabricks 模板	使用此模板，可以使用虚拟网络和系统分配的访问连接器创建网络安全组、虚拟网络、专用终结点和启用默认存储防火墙的 Azure Databricks 工作区。
使用默认存储防火墙 AzureDatabricks 模板	使用此模板，可以使用 Privateendpoint、所有三种形式的 CMK 和 User-Assigned Access Connector 创建启用了默认存储防火墙的 Azure Databricks 工作区。
通过专用终结点连接到事件中心命名空间	此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问事件中心命名空间。
通过专用终结点连接到 Key Vault	此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问 Key Vault。
通过专用终结点连接到服务总线命名空间	此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问服务总线命名空间。
通过专用终结点从 VM 连接到存储帐户	此示例演示如何使用连接虚拟网络通过专用终结点访问 Blob 存储帐户。
通过专用终结点连接到 Azure 文件共享	此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问 Azure 文件共享。
创建专用 AKS 群集	此示例演示如何在虚拟网络中创建专用 AKS 群集以及 jumpbox 虚拟机。
使用公共 DNS 区域创建专用 AKS 群集	此示例演示如何使用公共 DNS 区域部署专用 AKS 群集。
创建 Web 应用、PE 和应用程序网关 v2	此模板在 Azure 虚拟网络子网（应用程序网关 v2）中创建具有专用终结点的 Azure Web 应用。 应用程序网关部署在 vNet（子网）中。 Web 应用使用专用终结点限制对来自子网的流量的访问
使用 Prometheus 和 Grafana 和 privae 链接创建 AKS	这将在 Azure Kubernetes 服务（AKS）群集上创建 Azure grafana、AKS 并安装 Prometheus（开源监视和警报工具包）。 然后使用 Azure Managed Grafana 的托管专用终结点连接到此 Prometheus 服务器并在 Grafana 仪表板中显示 Prometheus 数据
使用专用终结点创建 API 管理服务	此模板将创建 API 管理服务、虚拟网络和专用终结点，向虚拟网络公开 API 管理服务。
使用专用终结点创建 Azure Cosmos DB 帐户	此模板将创建 Cosmos 帐户、虚拟网络以及向虚拟网络公开 Cosmos 帐户的专用终结点。
创建 Azure 机器学习服务工作区（旧版）	此部署模板指定 Azure 机器学习工作区及其关联的资源，包括 Azure Key Vault、Azure 存储、Azure Application Insights 和 Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。
创建 Azure 机器学习服务工作区（vnet）	此部署模板指定 Azure 机器学习工作区及其关联的资源，包括 Azure Key Vault、Azure 存储、Azure Application Insights 和 Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。
创建 Function App 和专用终结点保护的存储	使用此模板，可以部署通过专用终结点与 Azure 存储通信的 Azure Function App。
创建跨租户专用终结点资源	此模板允许你在相同或跨租户环境中创建 Priavate Endpoint 资源，并添加 dns 区域配置。
使用 PE 部署 Azure Databricks 工作区，CMK 所有窗体	使用此模板，可以使用 PrivateEndpoint 和托管服务和 CMK 和 DBFS 加密创建 Azure Databricks 工作区。
使用专用终结点部署 MySQL 灵活服务器	此模板提供了使用专用终结点部署 Azure Database for MySQL 灵活服务器的方法。
受 Azure Frontdoor 保护的 Function App	此模板允许部署受 Azure Frontdoor 高级版保护并发布的 Azure 高级函数。 Azure Frontdoor 和 Azure Functions 之间的连接受 Azure 专用链接的保护。
min.io Azure 网关	完全专用 min.io Azure 网关部署，以提供受 Blob 存储支持的符合 S3 的存储 API
专用终结点示例	此模板演示如何创建指向 Azure SQL Server 的专用终结点
专用函数应用和专用终结点保护的存储	此模板在具有专用终结点的 Premium 计划中预配函数应用，并通过专用终结点与 Azure 存储通信。
专用链接服务示例	此模板演示如何创建专用链接服务
安全 N 层 Web 应用	使用此模板，可以使用具有过渡槽、前端和后端的两个 Web 应用创建安全的端到端解决方案，前端将通过 VNet 注入和专用终结点安全地使用后端
使用 Azure 防火墙作为中心 & 辐射型拓扑中的 DNS 代理	此示例演示如何使用 Azure 防火墙在 Azure 中部署中心辐射型拓扑。 中心虚拟网络充当通过虚拟网络对等互连连接到中心虚拟网络的许多辐射虚拟网络的中心点。
使用专用终结点 Web 应用	使用此模板可以创建 Web 应用并通过专用终结点公开它
使用 VNet 注入和专用终结点 Web 应用	使用此模板，可以使用两个 Web 应用（前端和后端）创建安全的端到端解决方案，前端将通过 VNet 注入和专用终结点安全地使用后端
使用 Azure SQL 专用终结点的 WebApp	此模板演示如何创建使用指向 Azure SQL Server 的专用终结点的 Web 应用

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 privateEndpoints 资源类型：

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/privateEndpoints@2023-11-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      applicationSecurityGroups = [
        {
          id = "string"
          location = "string"
          properties = {
          }
          tags = {
            {customized property} = "string"
          }
        }
      ]
      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 = {
                          {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"
                    ]
                  }
                  type = "string"
                }
              ]
            }
            tags = {
              {customized property} = "string"
            }
          }
          privateEndpointNetworkPolicies = "string"
          privateLinkServiceNetworkPolicies = "string"
          routeTable = {
            id = "string"
            location = "string"
            properties = {
              disableBgpRoutePropagation = bool
              routes = [
                {
                  id = "string"
                  name = "string"
                  properties = {
                    addressPrefix = "string"
                    nextHopIpAddress = "string"
                    nextHopType = "string"
                  }
                  type = "string"
                }
              ]
            }
            tags = {
              {customized property} = "string"
            }
          }
          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 = {
                {customized property} = "string"
              }
            }
          ]
          serviceEndpoints = [
            {
              locations = [
                "string"
              ]
              service = "string"
            }
          ]
          sharingScope = "string"
        }
        type = "string"
      }
    }
  })
}

属性值

ApplicationGatewayIPConfiguration

名字	描述	价值
id	资源 ID。	字符串
名字	应用程序网关中唯一的 IP 配置的名称。	字符串
性能	应用程序网关 IP 配置的属性。	ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationGatewayIPConfigurationPropertiesFormat

名字	描述	价值
子	对子网资源的引用。 应用程序网关从中获取其专用地址的子网。	SubResource

ApplicationSecurityGroup

名字	描述	价值
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	应用程序安全组的属性。	ApplicationSecurityGroupPropertiesFormat
标签	资源标记。	ResourceTags

ApplicationSecurityGroupPropertiesFormat

名字	描述	价值

CustomDnsConfigPropertiesFormat

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

代表团

名字	描述	价值
id	资源 ID。	字符串
名字	子网中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	子网的属性。	ServiceDelegationPropertiesFormat
类型	资源类型。	字符串

ExtendedLocation

名字	描述	价值
名字	扩展位置的名称。	字符串
类型	扩展位置的类型。	“EdgeZone”

Microsoft.Network/privateEndpoints

名字	描述	价值
extendedLocation	负载均衡器的扩展位置。	ExtendedLocation
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	专用终结点的属性。	PrivateEndpointProperties
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.Network/privateEndpoints@2023-11-01”

NetworkSecurityGroup

名字	描述	价值
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	网络安全组的属性。	NetworkSecurityGroupPropertiesFormat
标签	资源标记。	ResourceTags

NetworkSecurityGroupPropertiesFormat

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

PrivateEndpointIPConfiguration

名字	描述	价值
名字	资源组中唯一的资源的名称。	字符串
性能	专用终结点 IP 配置的属性。	PrivateEndpointIPConfigurationProperties

PrivateEndpointIPConfigurationProperties

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

PrivateEndpointProperties

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

PrivateLinkServiceConnection

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	专用链接服务连接的属性。	PrivateLinkServiceConnectionProperties

PrivateLinkServiceConnectionProperties

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

PrivateLinkServiceConnectionState

名字	描述	价值
actionsRequired	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。	字符串
描述	批准/拒绝连接的原因。	字符串
地位	指示连接是否已被服务的所有者批准/拒绝/删除。	字符串

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

路线

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	路由的属性。	RoutePropertiesFormat
类型	资源的类型。	字符串

RoutePropertiesFormat

名字	描述	价值
addressPrefix	路由应用到的目标 CIDR。	字符串
nextHopIpAddress	IP 地址数据包应转发到。 只有在下一跃点类型为 VirtualAppliance 的路由中才允许下一跃点值。	字符串
nextHopType	应将数据包发送到的 Azure 跃点的类型。	“Internet” “None” “VirtualAppliance” “VirtualNetworkGateway” “VnetLocal”（必需）

RouteTable

名字	描述	价值
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	路由表的属性。	RouteTablePropertiesFormat
标签	资源标记。	ResourceTags

RouteTablePropertiesFormat

名字	描述	价值
disableBgpRoutePropagation	是否禁用 BGP 在该路由表上学习的路由。 True 表示禁用。	bool
路线	路由表中包含的路由的集合。	路由[]

SecurityRule

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	安全规则的属性。	SecurityRulePropertiesFormat
类型	资源的类型。	字符串

SecurityRulePropertiesFormat

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

ServiceDelegationPropertiesFormat

名字	描述	价值
serviceName	应向其委托子网的服务的名称（例如Microsoft.Sql/servers）。	字符串

ServiceEndpointPolicy

名字	描述	价值
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	服务终结点策略的属性。	ServiceEndpointPolicyPropertiesFormat
标签	资源标记。	ResourceTags

ServiceEndpointPolicyDefinition

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	服务终结点策略定义的属性。	ServiceEndpointPolicyDefinitionPropertiesFormat
类型	资源的类型。	字符串

ServiceEndpointPolicyDefinitionPropertiesFormat

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

ServiceEndpointPolicyPropertiesFormat

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

ServiceEndpointPropertiesFormat

名字	描述	价值
地点	位置列表。	string[]
服务	终结点服务的类型。	字符串

子

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	子网的属性。	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	将此属性设置为“租户”，以允许与 AAD 租户中的其他订阅共享子网。 仅当 defaultOutboundAccess 设置为 false 时，才能设置此属性，仅当子网为空时，才能设置这两个属性。	“DelegatedServices” “Tenant”

SubResource

名字	描述	价值
id	资源 ID。	字符串