你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.Network loadBalancers
Bicep 资源定义
可以使用面向以下操作部署 loadBalancers 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/loadBalancers 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Network/loadBalancers@2023-11-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
tier: 'string'
}
extendedLocation: {
name: 'string'
type: 'EdgeZone'
}
properties: {
backendAddressPools: [
{
id: 'string'
name: 'string'
properties: {
drainPeriodInSeconds: int
loadBalancerBackendAddresses: [
{
name: 'string'
properties: {
adminState: 'string'
ipAddress: 'string'
loadBalancerFrontendIPConfiguration: {
id: 'string'
}
subnet: {
id: 'string'
}
virtualNetwork: {
id: 'string'
}
}
}
]
location: 'string'
syncMode: 'string'
tunnelInterfaces: [
{
identifier: int
port: int
protocol: 'string'
type: 'string'
}
]
virtualNetwork: {
id: 'string'
}
}
}
]
frontendIPConfigurations: [
{
id: 'string'
name: 'string'
properties: {
gatewayLoadBalancer: {
id: 'string'
}
privateIPAddress: 'string'
privateIPAddressVersion: 'string'
privateIPAllocationMethod: 'string'
publicIPAddress: {
extendedLocation: {
name: 'string'
type: 'EdgeZone'
}
id: 'string'
location: 'string'
properties: {
ddosSettings: {
ddosProtectionPlan: {
id: 'string'
}
protectionMode: 'string'
}
deleteOption: 'string'
dnsSettings: {
domainNameLabel: 'string'
domainNameLabelScope: 'string'
fqdn: 'string'
reverseFqdn: 'string'
}
idleTimeoutInMinutes: int
ipAddress: 'string'
ipTags: [
{
ipTagType: 'string'
tag: 'string'
}
]
linkedPublicIPAddress: {
public-ip-address-object
}
migrationPhase: 'string'
natGateway: {
id: 'string'
location: 'string'
properties: {
idleTimeoutInMinutes: int
publicIpAddresses: [
{
id: 'string'
}
]
publicIpPrefixes: [
{
id: 'string'
}
]
}
sku: {
name: 'Standard'
}
tags: {}
zones: [
'string'
]
}
publicIPAddressVersion: 'string'
publicIPAllocationMethod: 'string'
publicIPPrefix: {
id: 'string'
}
servicePublicIPAddress: {
public-ip-address-object
}
}
sku: {
name: 'string'
tier: 'string'
}
tags: {}
zones: [
'string'
]
}
publicIPPrefix: {
id: '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'
}
}
zones: [
'string'
]
}
]
inboundNatPools: [
{
id: 'string'
name: 'string'
properties: {
backendPort: int
enableFloatingIP: bool
enableTcpReset: bool
frontendIPConfiguration: {
id: 'string'
}
frontendPortRangeEnd: int
frontendPortRangeStart: int
idleTimeoutInMinutes: int
protocol: 'string'
}
}
]
inboundNatRules: [
{
id: 'string'
name: 'string'
properties: {
backendAddressPool: {
id: 'string'
}
backendPort: int
enableFloatingIP: bool
enableTcpReset: bool
frontendIPConfiguration: {
id: 'string'
}
frontendPort: int
frontendPortRangeEnd: int
frontendPortRangeStart: int
idleTimeoutInMinutes: int
protocol: 'string'
}
}
]
loadBalancingRules: [
{
id: 'string'
name: 'string'
properties: {
backendAddressPool: {
id: 'string'
}
backendAddressPools: [
{
id: 'string'
}
]
backendPort: int
disableOutboundSnat: bool
enableFloatingIP: bool
enableTcpReset: bool
frontendIPConfiguration: {
id: 'string'
}
frontendPort: int
idleTimeoutInMinutes: int
loadDistribution: 'string'
probe: {
id: 'string'
}
protocol: 'string'
}
}
]
outboundRules: [
{
id: 'string'
name: 'string'
properties: {
allocatedOutboundPorts: int
backendAddressPool: {
id: 'string'
}
enableTcpReset: bool
frontendIPConfigurations: [
{
id: 'string'
}
]
idleTimeoutInMinutes: int
protocol: 'string'
}
}
]
probes: [
{
id: 'string'
name: 'string'
properties: {
intervalInSeconds: int
numberOfProbes: int
port: int
probeThreshold: int
protocol: 'string'
requestPath: 'string'
}
}
]
}
}
属性值
loadBalancers
名称 | 说明 | 值 |
---|---|---|
name | 资源名称 | 字符串 (必需) 字符限制:1-80 有效字符: 字母数字、下划线字符、句点和连字符。 以字母数字开头。 以字母数字或下划线结尾。 |
location | 资源位置。 | 字符串 |
标记 | 资源标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
sku | 负载均衡器 SKU。 | LoadBalancerSku |
extendedLocation | 负载均衡器的扩展位置。 | ExtendedLocation |
properties | 负载均衡器的属性。 | LoadBalancerPropertiesFormat |
ExtendedLocation
名称 | 说明 | 值 |
---|---|---|
name | 扩展位置的名称。 | 字符串 |
type | 扩展位置的类型。 | “EdgeZone” |
LoadBalancerPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
backendAddressPools | 负载均衡器使用的后端地址池的集合。 | BackendAddressPool[] |
frontendIPConfigurations | 表示要用于负载均衡器的前端 IP 的对象。 | FrontendIPConfiguration[] |
inboundNatPools | 为与负载均衡器关联的 NIC 上的单个后端端口的入站 NAT 定义外部端口范围。 使用此范围内的外部端口自动为与负载均衡器关联的每个 NIC 创建入站 NAT 规则。 在负载均衡器上定义入站 NAT 池与定义入站 NAT 规则是互斥的。 从虚拟机规模集引用入站 NAT 池。 与单个虚拟机关联的 NIC 不能引用入站 NAT 池。 它们必须引用单个入站 NAT 规则。 | InboundNatPool[] |
inboundNatRules | 负载均衡器使用的入站 NAT 规则的集合。 在负载均衡器上定义入站 NAT 规则与定义入站 NAT 池是互斥的。 从虚拟机规模集引用入站 NAT 池。 与单个虚拟机关联的 NIC 不能引用入站 NAT 池。 它们必须引用单个入站 NAT 规则。 | InboundNatRule[] |
loadBalancingRules | 表示负载均衡规则的对象集合 获取预配。 | LoadBalancingRule[] |
outboundRules | 出站规则。 | OutboundRule[] |
probes | 负载均衡器中使用的探测对象的集合。 | Probe[] |
BackendAddressPool
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的后端地址池集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器后端地址池的属性。 | BackendAddressPoolPropertiesFormat |
BackendAddressPoolPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
drainPeriodInSeconds | 负载均衡器在将 RESET 发送到客户端和后端地址之前等待的秒数。 | int |
loadBalancerBackendAddresses | 后端地址的数组。 | LoadBalancerBackendAddress[] |
location | 后端地址池的位置。 | 字符串 |
syncMode | 后端池的后端地址同步模式 | “自动” “手动” |
tunnelInterfaces | 网关负载均衡器隧道接口的数组。 | GatewayLoadBalancerTunnelInterface[] |
virtualNetwork | 对虚拟网络的引用。 | SubResource |
LoadBalancerBackendAddress
名称 | 说明 | 值 |
---|---|---|
name | 后端地址的名称。 | string |
properties | 负载均衡器后端地址池的属性。 | LoadBalancerBackendAddressPropertiesFormat |
LoadBalancerBackendAddressPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
adminState | 管理状态列表,一旦设置,即可覆盖运行状况探测,以便负载均衡器始终将新连接转发到后端,或拒绝新连接并重置现有连接。 | “Down” “None” “Up” |
ipAddress | 属于引用的虚拟网络的 IP 地址。 | 字符串 |
loadBalancerFrontendIPConfiguration | 对区域负载均衡器中定义的前端 IP 地址配置的引用。 | SubResource |
子网 | 对现有子网的引用。 | SubResource |
virtualNetwork | 对现有虚拟网络的引用。 | SubResource |
SubResource
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
GatewayLoadBalancerTunnelInterface
名称 | 说明 | 值 |
---|---|---|
标识符 | 网关负载均衡器隧道接口的标识符。 | int |
port | 网关负载均衡器隧道接口的端口。 | int |
protocol | 网关负载均衡器隧道接口的协议。 | “Native” “None” “VXLAN” |
类型 | 网关负载均衡器隧道接口的流量类型。 | “External” “Internal” “None” |
FrontendIPConfiguration
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的前端 IP 配置集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器探测的属性。 | FrontendIPConfigurationPropertiesFormat |
zones | 一个可用性区域列表,指示为资源分配的 IP 需要来自。 | string[] |
FrontendIPConfigurationPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
gatewayLoadBalancer | 对网关负载均衡器前端 IP 的引用。 | SubResource |
privateIPAddress | IP 配置的专用 IP 地址。 | 字符串 |
privateIPAddressVersion | 特定 ip 配置是 IPv4 还是 IPv6。 默认值为 IPv4。 | “IPv4” “IPv6” |
privateIPAllocationMethod | 专用 IP 分配方法。 | “Dynamic” “Static” |
publicIPAddress | 对公共 IP 资源的引用。 | PublicIPAddress |
publicIPPrefix | 对公共 IP 前缀资源的引用。 | SubResource |
子网 | 对子网资源的引用。 | 子网 |
PublicIPAddress
名称 | 说明 | 值 |
---|---|---|
extendedLocation | 公共 IP 地址的扩展位置。 | ExtendedLocation |
id | 资源 ID。 | 字符串 |
location | 资源位置。 | string |
properties | 公共 IP 地址属性。 | PublicIPAddressPropertiesFormat |
sku | 公共 IP 地址 SKU。 | PublicIPAddressSku |
标记 | 资源标记。 | 对象 (object) |
zones | 一个可用性区域列表,指示为资源分配的 IP 需要来自。 | string[] |
PublicIPAddressPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
ddosSettings | 与公共 IP 地址关联的 DDoS 防护自定义策略。 | DdosSettings |
deleteOption | 指定删除使用公共 IP 地址的 VM 时会发生什么情况 | “Delete” “分离” |
dnsSettings | 与公共 IP 地址关联的 DNS 记录的 FQDN。 | PublicIPAddressDnsSettings |
idleTimeoutInMinutes | 公共 IP 地址的空闲超时。 | int |
ipAddress | 与公共 IP 地址资源关联的 IP 地址。 | 字符串 |
ipTags | 与公共 IP 地址关联的标记列表。 | IpTag[] |
linkedPublicIPAddress | 公共 IP 地址资源的链接公共 IP 地址。 | PublicIPAddress |
migrationPhase | 公共 IP 地址的迁移阶段。 | “中止” “Commit” “Committed” “None” “准备” |
natGateway | 公共 IP 地址的 NatGateway。 | NatGateway |
publicIPAddressVersion | 公共 IP 地址版本。 | “IPv4” “IPv6” |
publicIPAllocationMethod | 公共 IP 地址分配方法。 | “Dynamic” “Static” |
publicIPPrefix | 应从中分配此公共 IP 地址的公共 IP 前缀。 | SubResource |
servicePublicIPAddress | 公共 IP 地址资源的服务公共 IP 地址。 | PublicIPAddress |
DdosSettings
名称 | 说明 | 值 |
---|---|---|
ddosProtectionPlan | 与公共 IP 关联的 DDoS 保护计划。 仅当 ProtectionMode 为“已启用”时,才能设置 | SubResource |
protectionMode | 公共 IP 的 DDoS 保护模式 | “Disabled” “已启用” “VirtualNetworkInherited” |
PublicIPAddressDnsSettings
名称 | 说明 | 值 |
---|---|---|
domainNameLabel | 域名标签。 域名标签与区域化 DNS 区域的串联形式构成了与公共 IP 地址关联的完全限定域名。 如果指定了域名标签,则会在 Microsoft Azure DNS 系统中为公共 IP 创建 DNS 记录。 | 字符串 |
domainNameLabelScope | 域名标签范围。 如果指定了域名标签和域名标签范围,则会在 Microsoft Azure DNS 系统中为公共 IP 创建一条 DNS 记录,并在 FQDN 中包含哈希值。 | “NoReuse” “ResourceGroupReuse” “SubscriptionReuse” “TenantReuse” |
fqdn | 与公共 IP 关联的 A DNS 记录的完全限定域名。 这是 domainNameLabel 和区域化 DNS 区域的串联。 | 字符串 |
reverseFqdn | 反向 FQDN。 解析为此公共 IP 地址的用户可见的完全限定域名。 如果指定了 reverseFqdn,则会创建从 in-addr.arpa 域中的 IP 地址指向反向 FQDN 的 DNS PTR 记录。 | 字符串 |
IpTag
名称 | 说明 | 值 |
---|---|---|
ipTagType | IP 标记类型。 示例:FirstPartyUsage。 | 字符串 |
标记 | 与公共 IP 关联的 IP 标记的值。 示例:SQL。 | 字符串 |
NatGateway
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
location | 资源位置。 | string |
properties | Nat 网关属性。 | NatGatewayPropertiesFormat |
sku | NAT 网关 SKU。 | NatGatewaySku |
标记 | 资源标记。 | 对象 (object) |
zones | 一个可用性区域列表,指示应在其中部署 Nat 网关的区域。 | string[] |
NatGatewayPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
idleTimeoutInMinutes | nat 网关的空闲超时。 | int |
publicIpAddresses | 与 nat 网关资源关联的公共 IP 地址数组。 | SubResource[] |
publicIpPrefixes | 与 nat 网关资源关联的公共 IP 前缀数组。 | SubResource[] |
NatGatewaySku
名称 | 说明 | 值 |
---|---|---|
name | Nat 网关 SKU 的名称。 | “Standard” |
PublicIPAddressSku
名称 | 说明 | 值 |
---|---|---|
name | 公共 IP 地址 SKU 的名称。 | “Basic” “Standard” |
层 | 公共 IP 地址 SKU 的层。 | “Global” “区域” |
子网
名称 | 说明 | 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 |
委托
名称 | 说明 | 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[] |
ApplicationSecurityGroup
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
location | 资源位置。 | string |
properties | 应用程序安全组的属性。 | ApplicationSecurityGroupPropertiesFormat |
标记 | 资源标记。 | 对象 (object) |
ApplicationSecurityGroupPropertiesFormat
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
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[] |
服务 | 终结点服务的类型。 | 字符串 |
InboundNatPool
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的入站 NAT 池集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器入站 nat 池的属性。 | InboundNatPoolPropertiesFormat |
InboundNatPoolPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
backendPort | 用于在终结点上建立内部连接的端口。 可接受的值介于 1 和 65535 之间。 | int (必需) |
enableFloatingIP | 为虚拟机的终结点配置配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能。 在 SQL Server 中使用 SQL AlwaysOn 可用性组时,需要此设置。 创建终结点后,无法更改此设置。 | bool |
enableTcpReset | 在 TCP 流空闲超时或意外连接终止时接收双向 TCP 重置。 仅在将协议设置为 TCP 后才使用此元素。 | bool |
frontendIPConfiguration | 对前端 IP 地址的引用。 | SubResource |
frontendPortRangeEnd | 外部端口范围中的最后一个端口号,用于向与负载均衡器关联的 NIC 提供入站 Nat。 可接受的值范围为 1 到 65535。 | int (必需) |
frontendPortRangeStart | 外部端口范围中的第一个端口号,用于向与负载均衡器关联的 NIC 提供入站 Nat。 可接受的值范围为 1 到 65534。 | int (必需) |
idleTimeoutInMinutes | TCP 空闲连接的超时。 该值可设置为介于 4 和 30 分钟之间。 默认值为 4 分钟。 仅在将协议设置为 TCP 后才使用此元素。 | int |
protocol | 对入站 NAT 池使用的传输协议的引用。 | “All” “Tcp” “Udp” (必需) |
InboundNatRule
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的入站 NAT 规则集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器入站 NAT 规则的属性。 | InboundNatRulePropertiesFormat |
InboundNatRulePropertiesFormat
名称 | 说明 | 值 |
---|---|---|
backendAddressPool | 对 backendAddressPool 资源的引用。 | SubResource |
backendPort | 用于内部终结点的端口。 可接受的值范围为 1 到 65535。 | int |
enableFloatingIP | 为虚拟机的终结点配置配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能。 在 SQL Server 中使用 SQL AlwaysOn 可用性组时,需要此设置。 创建终结点后,无法更改此设置。 | bool |
enableTcpReset | 在 TCP 流空闲超时或意外连接终止时接收双向 TCP 重置。 仅在将协议设置为 TCP 后才使用此元素。 | bool |
frontendIPConfiguration | 对前端 IP 地址的引用。 | SubResource |
frontendPort | 外部终结点的端口。 每个规则的端口号在负载均衡器中必须是唯一的。 可接受的值范围为 1 到 65534。 | int |
frontendPortRangeEnd | 外部终结点的端口范围结束。 此属性与 BackendAddressPool 和 FrontendPortRangeStart 一起使用。 将为 BackendAddressPool 中的每个后端地址创建单独的入站 NAT 规则端口映射。 可接受的值范围为 1 到 65534。 | int |
frontendPortRangeStart | 外部终结点的端口范围开始。 此属性与 BackendAddressPool 和 FrontendPortRangeEnd 一起使用。 将为 BackendAddressPool 中的每个后端地址创建单独的入站 NAT 规则端口映射。 可接受的值范围为 1 到 65534。 | int |
idleTimeoutInMinutes | TCP 空闲连接的超时。 该值可设置为介于 4 和 30 分钟之间。 默认值为 4 分钟。 仅在将协议设置为 TCP 后才使用此元素。 | int |
protocol | 对负载均衡规则使用的传输协议的引用。 | “All” “Tcp” “Udp” |
LoadBalancingRule
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的负载均衡规则集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器负载均衡规则的属性。 | LoadBalancingRulePropertiesFormat |
LoadBalancingRulePropertiesFormat
名称 | 说明 | 值 |
---|---|---|
backendAddressPool | 对 DIP 池的引用。 入站流量在后端 IP 中的 IP 之间随机进行负载均衡。 | SubResource |
backendAddressPools | 对 DIP 池的引用数组。 | SubResource[] |
backendPort | 用于在终结点上建立内部连接的端口。 可接受的值介于 0 和 65535 之间。 请注意,值 0 启用“任何端口”。 | int |
disableOutboundSnat | 为后端池中的 VM 配置 SNAT,以使用负载均衡规则前端中指定的 publicIP 地址。 | bool |
enableFloatingIP | 为虚拟机的终结点配置配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能。 在 SQL Server 中使用 SQL AlwaysOn 可用性组时,需要此设置。 创建终结点后,无法更改此设置。 | bool |
enableTcpReset | 在 TCP 流空闲超时或意外连接终止时接收双向 TCP 重置。 仅在将协议设置为 TCP 后才使用此元素。 | bool |
frontendIPConfiguration | 对前端 IP 地址的引用。 | SubResource |
frontendPort | 外部终结点的端口。 每个规则的端口号在负载均衡器中必须是唯一的。 可接受的值介于 0 和 65534 之间。 请注意,值 0 启用“任何端口”。 | int (必需) |
idleTimeoutInMinutes | TCP 空闲连接的超时。 该值可设置为介于 4 和 30 分钟之间。 默认值为 4 分钟。 仅在将协议设置为 TCP 后才使用此元素。 | int |
loadDistribution | 此规则的负载分配策略。 | 'Default' “SourceIP” “SourceIPProtocol” |
探测 | 对负载均衡规则使用的负载均衡器探测的引用。 | SubResource |
protocol | 对负载均衡规则使用的传输协议的引用。 | “All” “Tcp” “Udp” (必需) |
OutboundRule
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的出站规则集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器出站规则的属性。 | OutboundRulePropertiesFormat |
OutboundRulePropertiesFormat
名称 | 说明 | 值 |
---|---|---|
allocatedOutboundPorts | 要用于 NAT 的出站端口数。 | int |
backendAddressPool | 对 DIP 池的引用。 出站流量在后端 IP 中的 IP 之间随机进行负载均衡。 | 需要子资源 () |
enableTcpReset | 在 TCP 流空闲超时或意外连接终止时接收双向 TCP 重置。 仅在将协议设置为 TCP 后才使用此元素。 | bool |
frontendIPConfigurations | 负载均衡器的前端 IP 地址。 | SubResource[] (必需) |
idleTimeoutInMinutes | TCP 空闲连接的超时。 | int |
protocol | 负载均衡器中出站规则的协议。 | “All” 'Tcp' “Udp” (必需) |
探测
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的探测集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器探测的属性。 | ProbePropertiesFormat |
ProbePropertiesFormat
名称 | 说明 | 值 |
---|---|---|
intervalInSeconds | 探测终结点的运行状况的间隔(以秒为单位)。 通常,该间隔略小于所分配超时期限(以秒为单位)的一半,以便在退出轮转前执行两次完整的探测。 默认值为 15,最小值为 5。 | int |
numberOfProbes | 如果未响应,将导致停止将进一步的流量传递到终结点的探测数。 此值允许从旋转中取出终结点的速度比 Azure 中使用的典型时间更快或更慢。 | int |
port | 用于传达探测的端口。 可能的值介于 1 和 65535(含)之间。 | int (必需) |
probeThreshold | 允许或拒绝传递到此终结点的流量的连续成功或失败探测数。 在连续探测数等于此值失败后,终结点将从轮换中取出,并要求将相同数量的成功连续探测放回轮换。 | int |
protocol | 终结点的协议。 如果指定了“Tcp”,则需要接收的 ACK 才能成功探测。 如果指定了“Http”或“Https”,则需要指定 URI 的 200 OK 响应才能成功探测。 | 'Http' 'Https' 需要“Tcp” () |
requestPath | 用于从 VM 请求运行状况的 URI。 如果协议设置为 http,则需要路径。 否则,不允许使用该属性。 没有默认值。 | 字符串 |
LoadBalancerSku
名称 | 说明 | 值 |
---|---|---|
name | 负载均衡器 SKU 的名称。 | 'Basic' 'Gateway' 'Standard' |
层 | 负载均衡器 SKU 的层。 | 'Global' 'Regional' |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 说明 |
---|---|
链接到网关负载均衡器的公共负载均衡器 |
此模板允许部署链接到网关负载均衡器的公共标准负载均衡器。 从 Internet 传入的流量将路由到后端池中 linux VM (NVA) 网关负载均衡器。 |
Create具有多个 NIC 和 RDP 可访问的 VM |
通过此模板,可以创建具有多个 (2 个) 网络接口的虚拟机, (NIC) ,并且 RDP 可通过配置的负载均衡器和入站 NAT 规则进行连接。 可以使用此模板轻松添加更多 NIC。 此模板还 (前端和后端) 部署存储帐户、虚拟网络、公共 IP 地址和 2 个网络接口。 |
VNET 中的 2 个 VM - 内部负载均衡器和 LB 规则 |
此模板允许在 VNET 和内部负载均衡器下创建 2 个虚拟机,并在端口 80 上配置负载均衡规则。 此模板还会部署存储帐户、虚拟网络、公共 IP 地址、可用性集和网络接口。 |
负载均衡器中的 2 个 VM 和负载均衡规则 |
你可以使用此模板在一个负载平衡器上创建 2 个虚拟机,然后在端口 80 上配置负载平衡规则。 此模板还会部署存储帐户、虚拟网络、公共 IP 地址、可用性集和网络接口。 在此模板中,我们使用资源循环功能创建网络接口和虚拟机 |
负载均衡器中的 2 个 VM,在 LB 上配置 NAT 规则 |
此模板允许你在可用性集中创建 2 个虚拟机,并通过负载均衡器配置 NAT 规则。 此模板还部署存储帐户、虚拟网络、公共 IP 地址和网络接口。 在此模板中,我们使用资源循环功能创建网络接口和虚拟机 |
在 ILB 后面部署具有 Linux VM 的 VM 规模集 |
此模板允许使用最新修补版本的 Ubuntu Linux 15.10 或 14.04.4-LTS 部署 Linux VM 的 VM 规模集。 这些 VM 位于具有用于 SSH 连接的 NAT 规则的内部负载均衡器后面。 |
适用于 VNetInjection 和 负载均衡器 的 AzureDatabricks 模板 |
通过此模板,可以使用虚拟网络创建负载均衡器、网络安全组、虚拟网络和 Azure Databricks 工作区。 |
创建标准的内部负载均衡器 |
此模板使用规则负载均衡端口 80 创建标准内部Azure 负载均衡器 |
使用 HA 端口Create标准内部负载均衡器 |
此模板使用 HA 端口负载均衡规则创建标准内部Azure 负载均衡器 |
创建跨区域负载均衡器 |
此模板创建一个跨区域负载均衡器,其后端池包含两个区域负载均衡器。 跨区域负载均衡器目前在受限区域中可用。 跨区域负载均衡器后面的区域负载均衡器可以位于任何区域中。 |
使用后端池按 IP 地址标准负载均衡器 |
此模板用于演示如何使用 ARM 模板按 IP 地址配置负载均衡器的后端池,如后端池管理文档中所述。 |
Create具有公共 IPv6 地址的负载均衡器 |
此模板为后端池创建一个面向 Internet 的负载均衡器,其中包含一个公共 IPv6 地址、负载均衡规则和两个 VM。 |
创建标准负载均衡器 |
此模板为后端池创建面向 Internet 的负载均衡器、负载均衡规则和三个 VM,每个 VM 位于冗余区域中。 |
负载均衡器包含 2 个 VIP,每个 VIP 有一个 LB 规则 |
此模板允许你为负载均衡器创建一个负载均衡器 2 个公共 IP 地址, (多vip) ,虚拟网络网络接口虚拟网络 &网络接口使用的负载均衡器中的 LB 规则。 |
使用入站 NAT 规则负载均衡器 |
此模板允许你为负载均衡器创建负载均衡器公共 IP 地址,虚拟网络网络接口虚拟网络 &网络接口使用的负载均衡器中的 NAT 规则。 |
ARM 模板资源定义
loadBalancers 资源类型可以通过针对以下操作进行部署:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/loadBalancers 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.Network/loadBalancers",
"apiVersion": "2023-11-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string",
"tier": "string"
},
"extendedLocation": {
"name": "string",
"type": "EdgeZone"
},
"properties": {
"backendAddressPools": [
{
"id": "string",
"name": "string",
"properties": {
"drainPeriodInSeconds": "int",
"loadBalancerBackendAddresses": [
{
"name": "string",
"properties": {
"adminState": "string",
"ipAddress": "string",
"loadBalancerFrontendIPConfiguration": {
"id": "string"
},
"subnet": {
"id": "string"
},
"virtualNetwork": {
"id": "string"
}
}
}
],
"location": "string",
"syncMode": "string",
"tunnelInterfaces": [
{
"identifier": "int",
"port": "int",
"protocol": "string",
"type": "string"
}
],
"virtualNetwork": {
"id": "string"
}
}
}
],
"frontendIPConfigurations": [
{
"id": "string",
"name": "string",
"properties": {
"gatewayLoadBalancer": {
"id": "string"
},
"privateIPAddress": "string",
"privateIPAddressVersion": "string",
"privateIPAllocationMethod": "string",
"publicIPAddress": {
"extendedLocation": {
"name": "string",
"type": "EdgeZone"
},
"id": "string",
"location": "string",
"properties": {
"ddosSettings": {
"ddosProtectionPlan": {
"id": "string"
},
"protectionMode": "string"
},
"deleteOption": "string",
"dnsSettings": {
"domainNameLabel": "string",
"domainNameLabelScope": "string",
"fqdn": "string",
"reverseFqdn": "string"
},
"idleTimeoutInMinutes": "int",
"ipAddress": "string",
"ipTags": [
{
"ipTagType": "string",
"tag": "string"
}
],
"linkedPublicIPAddress": { public-ip-address-object },
"migrationPhase": "string",
"natGateway": {
"id": "string",
"location": "string",
"properties": {
"idleTimeoutInMinutes": "int",
"publicIpAddresses": [
{
"id": "string"
}
],
"publicIpPrefixes": [
{
"id": "string"
}
]
},
"sku": {
"name": "Standard"
},
"tags": {},
"zones": [ "string" ]
},
"publicIPAddressVersion": "string",
"publicIPAllocationMethod": "string",
"publicIPPrefix": {
"id": "string"
},
"servicePublicIPAddress": { public-ip-address-object }
},
"sku": {
"name": "string",
"tier": "string"
},
"tags": {},
"zones": [ "string" ]
},
"publicIPPrefix": {
"id": "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"
}
},
"zones": [ "string" ]
}
],
"inboundNatPools": [
{
"id": "string",
"name": "string",
"properties": {
"backendPort": "int",
"enableFloatingIP": "bool",
"enableTcpReset": "bool",
"frontendIPConfiguration": {
"id": "string"
},
"frontendPortRangeEnd": "int",
"frontendPortRangeStart": "int",
"idleTimeoutInMinutes": "int",
"protocol": "string"
}
}
],
"inboundNatRules": [
{
"id": "string",
"name": "string",
"properties": {
"backendAddressPool": {
"id": "string"
},
"backendPort": "int",
"enableFloatingIP": "bool",
"enableTcpReset": "bool",
"frontendIPConfiguration": {
"id": "string"
},
"frontendPort": "int",
"frontendPortRangeEnd": "int",
"frontendPortRangeStart": "int",
"idleTimeoutInMinutes": "int",
"protocol": "string"
}
}
],
"loadBalancingRules": [
{
"id": "string",
"name": "string",
"properties": {
"backendAddressPool": {
"id": "string"
},
"backendAddressPools": [
{
"id": "string"
}
],
"backendPort": "int",
"disableOutboundSnat": "bool",
"enableFloatingIP": "bool",
"enableTcpReset": "bool",
"frontendIPConfiguration": {
"id": "string"
},
"frontendPort": "int",
"idleTimeoutInMinutes": "int",
"loadDistribution": "string",
"probe": {
"id": "string"
},
"protocol": "string"
}
}
],
"outboundRules": [
{
"id": "string",
"name": "string",
"properties": {
"allocatedOutboundPorts": "int",
"backendAddressPool": {
"id": "string"
},
"enableTcpReset": "bool",
"frontendIPConfigurations": [
{
"id": "string"
}
],
"idleTimeoutInMinutes": "int",
"protocol": "string"
}
}
],
"probes": [
{
"id": "string",
"name": "string",
"properties": {
"intervalInSeconds": "int",
"numberOfProbes": "int",
"port": "int",
"probeThreshold": "int",
"protocol": "string",
"requestPath": "string"
}
}
]
}
}
属性值
loadBalancers
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.Network/loadBalancers” |
apiVersion | 资源 API 版本 | '2023-11-01' |
name | 资源名称 | 字符串 (必需) 字符限制:1-80 有效字符: 字母数字、下划线字符、句点和连字符。 以字母数字开头。 以字母数字或下划线结尾。 |
location | 资源位置。 | 字符串 |
标记 | 资源标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
sku | 负载均衡器 SKU。 | LoadBalancerSku |
extendedLocation | 负载均衡器的扩展位置。 | ExtendedLocation |
properties | 负载均衡器的属性。 | LoadBalancerPropertiesFormat |
ExtendedLocation
名称 | 说明 | 值 |
---|---|---|
name | 扩展位置的名称。 | 字符串 |
type | 扩展位置的类型。 | “EdgeZone” |
LoadBalancerPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
backendAddressPools | 负载均衡器使用的后端地址池的集合。 | BackendAddressPool[] |
frontendIPConfigurations | 表示要用于负载均衡器的前端 IP 的 对象。 | FrontendIPConfiguration[] |
inboundNatPools | 为与负载均衡器关联的 NIC 上的单个后端端口的入站 NAT 定义外部端口范围。 使用此范围中的外部端口自动为与负载均衡器关联的每个 NIC 创建入站 NAT 规则。 在负载均衡器上定义入站 NAT 池与定义入站 NAT 规则是互斥的。 入站 NAT 池从虚拟机规模集引用。 与单个虚拟机关联的 NIC 不能引用入站 NAT 池。 它们必须引用单个入站 NAT 规则。 | InboundNatPool[] |
inboundNatRules | 负载均衡器使用的入站 NAT 规则的集合。 在负载均衡器上定义入站 NAT 规则与定义入站 NAT 池是互斥的。 入站 NAT 池从虚拟机规模集引用。 与单个虚拟机关联的 NIC 不能引用入站 NAT 池。 它们必须引用单个入站 NAT 规则。 | InboundNatRule[] |
loadBalancingRules | 表示负载均衡规则的对象集合 获取预配。 | LoadBalancingRule[] |
outboundRules | 出站规则。 | OutboundRule[] |
probes | 负载均衡器中使用的探测对象的集合。 | Probe[] |
BackendAddressPool
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的后端地址池集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器后端地址池的属性。 | BackendAddressPoolPropertiesFormat |
BackendAddressPoolPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
drainPeriodInSeconds | 负载均衡器在将 RESET 发送到客户端和后端地址之前等待的秒数。 | int |
loadBalancerBackendAddresses | 后端地址的数组。 | LoadBalancerBackendAddress[] |
location | 后端地址池的位置。 | 字符串 |
syncMode | 后端池的后端地址同步模式 | “自动” “手动” |
tunnelInterfaces | 网关负载均衡器隧道接口的数组。 | GatewayLoadBalancerTunnelInterface[] |
virtualNetwork | 对虚拟网络的引用。 | SubResource |
LoadBalancerBackendAddress
名称 | 说明 | 值 |
---|---|---|
name | 后端地址的名称。 | string |
properties | 负载均衡器后端地址池的属性。 | LoadBalancerBackendAddressPropertiesFormat |
LoadBalancerBackendAddressPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
adminState | 管理状态列表,一旦设置,即可覆盖运行状况探测,以便负载均衡器始终将新连接转发到后端,或拒绝新连接并重置现有连接。 | “Down” “None” “Up” |
ipAddress | 属于引用的虚拟网络的 IP 地址。 | 字符串 |
loadBalancerFrontendIPConfiguration | 对区域负载均衡器中定义的前端 IP 地址配置的引用。 | SubResource |
子网 | 对现有子网的引用。 | SubResource |
virtualNetwork | 对现有虚拟网络的引用。 | SubResource |
SubResource
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
GatewayLoadBalancerTunnelInterface
名称 | 说明 | 值 |
---|---|---|
标识符 | 网关负载均衡器隧道接口的标识符。 | int |
port | 网关负载均衡器隧道接口的端口。 | int |
protocol | 网关负载均衡器隧道接口的协议。 | “Native” “None” “VXLAN” |
类型 | 网关负载均衡器隧道接口的流量类型。 | “External” “Internal” “None” |
FrontendIPConfiguration
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的前端 IP 配置集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器探测的属性。 | FrontendIPConfigurationPropertiesFormat |
zones | 一个可用性区域列表,指示为资源分配的 IP 需要来自。 | string[] |
FrontendIPConfigurationPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
gatewayLoadBalancer | 对网关负载均衡器前端 IP 的引用。 | SubResource |
privateIPAddress | IP 配置的专用 IP 地址。 | 字符串 |
privateIPAddressVersion | 特定 ip 配置是 IPv4 还是 IPv6。 默认值为 IPv4。 | “IPv4” “IPv6” |
privateIPAllocationMethod | 专用 IP 分配方法。 | “Dynamic” “Static” |
publicIPAddress | 对公共 IP 资源的引用。 | PublicIPAddress |
publicIPPrefix | 对公共 IP 前缀资源的引用。 | SubResource |
子网 | 对子网资源的引用。 | 子网 |
PublicIPAddress
名称 | 说明 | 值 |
---|---|---|
extendedLocation | 公共 IP 地址的扩展位置。 | ExtendedLocation |
id | 资源 ID。 | 字符串 |
location | 资源位置。 | string |
properties | 公共 IP 地址属性。 | PublicIPAddressPropertiesFormat |
sku | 公共 IP 地址 SKU。 | PublicIPAddressSku |
标记 | 资源标记。 | 对象 (object) |
zones | 一个可用性区域列表,指示为资源分配的 IP 需要来自。 | string[] |
PublicIPAddressPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
ddosSettings | 与公共 IP 地址关联的 DDoS 防护自定义策略。 | DdosSettings |
deleteOption | 指定删除使用公共 IP 地址的 VM 时会发生什么情况 | “Delete” “分离” |
dnsSettings | 与公共 IP 地址关联的 DNS 记录的 FQDN。 | PublicIPAddressDnsSettings |
idleTimeoutInMinutes | 公共 IP 地址的空闲超时。 | int |
ipAddress | 与公共 IP 地址资源关联的 IP 地址。 | 字符串 |
ipTags | 与公共 IP 地址关联的标记列表。 | IpTag[] |
linkedPublicIPAddress | 公共 IP 地址资源的链接公共 IP 地址。 | PublicIPAddress |
migrationPhase | 公共 IP 地址的迁移阶段。 | “中止” “Commit” “Committed” “None” “准备” |
natGateway | 公共 IP 地址的 NatGateway。 | NatGateway |
publicIPAddressVersion | 公共 IP 地址版本。 | “IPv4” “IPv6” |
publicIPAllocationMethod | 公共 IP 地址分配方法。 | “Dynamic” “Static” |
publicIPPrefix | 应从中分配此公共 IP 地址的公共 IP 前缀。 | SubResource |
servicePublicIPAddress | 公共 IP 地址资源的服务公共 IP 地址。 | PublicIPAddress |
DdosSettings
名称 | 说明 | 值 |
---|---|---|
ddosProtectionPlan | 与公共 IP 关联的 DDoS 保护计划。 仅当 ProtectionMode 为“已启用”时,才能设置 | SubResource |
protectionMode | 公共 IP 的 DDoS 保护模式 | “Disabled” “已启用” “VirtualNetworkInherited” |
PublicIPAddressDnsSettings
名称 | 说明 | 值 |
---|---|---|
domainNameLabel | 域名标签。 域名标签与区域化 DNS 区域的串联形式构成了与公共 IP 地址关联的完全限定域名。 如果指定了域名标签,则会在 Microsoft Azure DNS 系统中为公共 IP 创建 DNS 记录。 | 字符串 |
domainNameLabelScope | 域名标签范围。 如果指定了域名标签和域名标签范围,则会在 Microsoft Azure DNS 系统中为公共 IP 创建一条 DNS 记录,并在 FQDN 中包含哈希值。 | “NoReuse” “ResourceGroupReuse” “SubscriptionReuse” “TenantReuse” |
fqdn | 与公共 IP 关联的 A DNS 记录的完全限定域名。 这是 domainNameLabel 和区域化 DNS 区域的串联。 | 字符串 |
reverseFqdn | 反向 FQDN。 解析为此公共 IP 地址的用户可见的完全限定域名。 如果指定了 reverseFqdn,则会创建从 in-addr.arpa 域中的 IP 地址指向反向 FQDN 的 DNS PTR 记录。 | 字符串 |
IpTag
名称 | 说明 | 值 |
---|---|---|
ipTagType | IP 标记类型。 示例:FirstPartyUsage。 | 字符串 |
标记 | 与公共 IP 关联的 IP 标记的值。 示例:SQL。 | 字符串 |
NatGateway
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
location | 资源位置。 | string |
properties | Nat 网关属性。 | NatGatewayPropertiesFormat |
sku | NAT 网关 SKU。 | NatGatewaySku |
标记 | 资源标记。 | 对象 (object) |
zones | 一个可用性区域列表,指示应在其中部署 Nat 网关的区域。 | string[] |
NatGatewayPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
idleTimeoutInMinutes | nat 网关的空闲超时。 | int |
publicIpAddresses | 与 nat 网关资源关联的公共 IP 地址数组。 | SubResource[] |
publicIpPrefixes | 与 nat 网关资源关联的公共 IP 前缀数组。 | SubResource[] |
NatGatewaySku
名称 | 说明 | 值 |
---|---|---|
name | Nat 网关 SKU 的名称。 | “Standard” |
PublicIPAddressSku
名称 | 说明 | 值 |
---|---|---|
name | 公共 IP 地址 SKU 的名称。 | “Basic” “Standard” |
层 | 公共 IP 地址 SKU 的层。 | “Global” “区域” |
子网
名称 | 说明 | 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 |
委托
名称 | 说明 | 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[] |
ApplicationSecurityGroup
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
location | 资源位置。 | string |
properties | 应用程序安全组的属性。 | ApplicationSecurityGroupPropertiesFormat |
标记 | 资源标记。 | 对象 (object) |
ApplicationSecurityGroupPropertiesFormat
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
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[] |
服务 | 终结点服务的类型。 | 字符串 |
InboundNatPool
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的入站 NAT 池集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器入站 nat 池的属性。 | InboundNatPoolPropertiesFormat |
InboundNatPoolPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
backendPort | 用于在终结点上建立内部连接的端口。 可接受的值介于 1 和 65535 之间。 | int (必需) |
enableFloatingIP | 为配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能配置虚拟机的终结点。 在 SQL Server 中使用 SQL AlwaysOn 可用性组时,需要此设置。 创建终结点后,无法更改此设置。 | bool |
enableTcpReset | 在 TCP 流空闲超时或意外连接终止时接收双向 TCP 重置。 仅在将协议设置为 TCP 后才使用此元素。 | bool |
frontendIPConfiguration | 对前端 IP 地址的引用。 | SubResource |
frontendPortRangeEnd | 外部端口范围中的最后一个端口号,用于向与负载均衡器关联的 NIC 提供入站 Nat。 可接受的值范围为 1 到 65535。 | int (必需) |
frontendPortRangeStart | 外部端口范围中的第一个端口号,用于向与负载均衡器关联的 NIC 提供入站 Nat。 可接受的值范围为 1 到 65534。 | int (必需) |
idleTimeoutInMinutes | TCP 空闲连接的超时。 该值可设置为介于 4 和 30 分钟之间。 默认值为 4 分钟。 仅在将协议设置为 TCP 后才使用此元素。 | int |
protocol | 对入站 NAT 池使用的传输协议的引用。 | “All” 'Tcp' “Udp” (必需) |
InboundNatRule
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的入站 NAT 规则集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器入站 NAT 规则的属性。 | InboundNatRulePropertiesFormat |
InboundNatRulePropertiesFormat
名称 | 说明 | 值 |
---|---|---|
backendAddressPool | 对 backendAddressPool 资源的引用。 | SubResource |
backendPort | 用于内部终结点的端口。 可接受的值范围为 1 到 65535。 | int |
enableFloatingIP | 为虚拟机的终结点配置配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能。 在 SQL Server 中使用 SQL AlwaysOn 可用性组时,需要此设置。 创建终结点后,无法更改此设置。 | bool |
enableTcpReset | 在 TCP 流空闲超时或意外连接终止时接收双向 TCP 重置。 仅在将协议设置为 TCP 后才使用此元素。 | bool |
frontendIPConfiguration | 对前端 IP 地址的引用。 | SubResource |
frontendPort | 外部终结点的端口。 每个规则的端口号在负载均衡器中必须是唯一的。 可接受的值范围为 1 到 65534。 | int |
frontendPortRangeEnd | 外部终结点的端口范围结束。 此属性与 BackendAddressPool 和 FrontendPortRangeStart 一起使用。 将为 BackendAddressPool 中的每个后端地址创建单独的入站 NAT 规则端口映射。 可接受的值范围为 1 到 65534。 | int |
frontendPortRangeStart | 外部终结点的端口范围开始。 此属性与 BackendAddressPool 和 FrontendPortRangeEnd 一起使用。 将为 BackendAddressPool 中的每个后端地址创建单独的入站 NAT 规则端口映射。 可接受的值范围为 1 到 65534。 | int |
idleTimeoutInMinutes | TCP 空闲连接的超时。 该值可设置为介于 4 和 30 分钟之间。 默认值为 4 分钟。 仅在将协议设置为 TCP 后才使用此元素。 | int |
protocol | 对负载均衡规则使用的传输协议的引用。 | “All” “Tcp” “Udp” |
LoadBalancingRule
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的负载均衡规则集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器负载均衡规则的属性。 | LoadBalancingRulePropertiesFormat |
LoadBalancingRulePropertiesFormat
名称 | 说明 | 值 |
---|---|---|
backendAddressPool | 对 DIP 池的引用。 入站流量在后端 IP 中的 IP 之间随机进行负载均衡。 | SubResource |
backendAddressPools | 对 DIP 池的引用数组。 | SubResource[] |
backendPort | 用于在终结点上建立内部连接的端口。 可接受的值介于 0 和 65535 之间。 请注意,值 0 启用“任何端口”。 | int |
disableOutboundSnat | 为后端池中的 VM 配置 SNAT,以使用负载均衡规则前端中指定的 publicIP 地址。 | bool |
enableFloatingIP | 为虚拟机的终结点配置配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能。 在 SQL Server 中使用 SQL AlwaysOn 可用性组时,需要此设置。 创建终结点后,无法更改此设置。 | bool |
enableTcpReset | 在 TCP 流空闲超时或意外连接终止时接收双向 TCP 重置。 仅在将协议设置为 TCP 后才使用此元素。 | bool |
frontendIPConfiguration | 对前端 IP 地址的引用。 | SubResource |
frontendPort | 外部终结点的端口。 每个规则的端口号在负载均衡器中必须是唯一的。 可接受的值介于 0 和 65534 之间。 请注意,值 0 启用“任何端口”。 | int (必需) |
idleTimeoutInMinutes | TCP 空闲连接的超时。 该值可设置为介于 4 和 30 分钟之间。 默认值为 4 分钟。 仅在将协议设置为 TCP 后才使用此元素。 | int |
loadDistribution | 此规则的负载分配策略。 | 'Default' “SourceIP” “SourceIPProtocol” |
探测 | 对负载均衡规则使用的负载均衡器探测的引用。 | SubResource |
protocol | 对负载均衡规则使用的传输协议的引用。 | “All” “Tcp” “Udp” (必需) |
OutboundRule
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的出站规则集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器出站规则的属性。 | OutboundRulePropertiesFormat |
OutboundRulePropertiesFormat
名称 | 说明 | 值 |
---|---|---|
allocatedOutboundPorts | 要用于 NAT 的出站端口数。 | int |
backendAddressPool | 对 DIP 池的引用。 出站流量在后端 IP 中的 IP 之间随机进行负载均衡。 | 需要 SubResource () |
enableTcpReset | 在 TCP 流空闲超时或意外连接终止时接收双向 TCP 重置。 仅在将协议设置为 TCP 后才使用此元素。 | bool |
frontendIPConfigurations | 负载均衡器的前端 IP 地址。 | SubResource[] (必需的) |
idleTimeoutInMinutes | TCP 空闲连接的超时。 | int |
protocol | 负载均衡器中出站规则的协议。 | “All” “Tcp” “Udp” (必需) |
探测
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的探测集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器探测的属性。 | ProbePropertiesFormat |
ProbePropertiesFormat
名称 | 说明 | 值 |
---|---|---|
intervalInSeconds | 探测终结点的运行状况的间隔(以秒为单位)。 通常,该间隔略小于所分配超时期限(以秒为单位)的一半,以便在退出轮转前执行两次完整的探测。 默认值为 15,最小值为 5。 | int |
numberOfProbes | 探测数(如果没有响应)将导致停止将更多流量传递到终结点。 此值允许终结点退出旋转的速度比 Azure 中使用的典型时间更快或更慢。 | int |
port | 用于传达探测的端口。 可能的值介于 1 和 65535(含)之间。 | int (必需) |
probeThreshold | 允许或拒绝传递到此终结点的流量的连续成功或失败探测数。 在连续探测数等于此值失败后,终结点将从轮换中取出,并要求将相同数量的成功连续探测放回轮换。 | int |
protocol | 终结点的协议。 如果指定了“Tcp”,则需要接收的 ACK 才能成功探测。 如果指定了“Http”或“Https”,则需要指定 URI 的 200 OK 响应才能成功探测。 | 'Http' 'Https' 需要“Tcp” () |
requestPath | 用于从 VM 请求运行状况的 URI。 如果协议设置为 http,则需要路径。 否则,不允许使用该属性。 没有默认值。 | 字符串 |
LoadBalancerSku
名称 | 说明 | 值 |
---|---|---|
name | 负载均衡器 SKU 的名称。 | 'Basic' 'Gateway' 'Standard' |
层 | 负载均衡器 SKU 的层。 | 'Global' 'Regional' |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 说明 |
---|---|
链接到网关负载均衡器的公共负载均衡器 |
此模板允许部署链接到网关负载均衡器的公共标准负载均衡器。 从 Internet 传入的流量将路由到后端池中 linux VM (NVA) 网关负载均衡器。 |
Create具有多个 NIC 和 RDP 可访问的 VM |
此模板允许创建具有多个 (2) 网络接口的虚拟机, (NIC) ,并使用配置的负载均衡器和入站 NAT 规则进行 RDP 连接。 使用此模板可以轻松添加更多 NIC。 此模板还 (前端和后端) 部署存储帐户、虚拟网络、公共 IP 地址和 2 个网络接口。 |
VNET 中的 2 个 VM - 内部负载均衡器和 LB 规则 |
此模板允许在 VNET 和内部负载均衡器下创建 2 个虚拟机,并在端口 80 上配置负载均衡规则。 此模板还会部署存储帐户、虚拟网络、公共 IP 地址、可用性集和网络接口。 |
负载均衡器中的 2 个 VM 和负载均衡规则 |
你可以使用此模板在一个负载平衡器上创建 2 个虚拟机,然后在端口 80 上配置负载平衡规则。 此模板还会部署存储帐户、虚拟网络、公共 IP 地址、可用性集和网络接口。 在此模板中,我们使用资源循环功能创建网络接口和虚拟机 |
负载均衡器中的 2 个 VM,在 LB 上配置 NAT 规则 |
此模板允许在可用性集中创建 2 个虚拟机,并通过负载均衡器配置 NAT 规则。 此模板还部署存储帐户、虚拟网络、公共 IP 地址和网络接口。 在此模板中,我们使用资源循环功能创建网络接口和虚拟机 |
使用 ILB 后面的 Linux VM 部署 VM 规模集 |
此模板允许使用最新修补版本的 Ubuntu Linux 15.10 或 14.04.4-LTS 部署 Linux VM 的 VM 规模集。 这些 VM 位于具有用于 ssh 连接的 NAT 规则的内部负载均衡器后面。 |
适用于 VNet 的 AzureDatabricks 模板Injection 和 负载均衡器 |
通过此模板,可以使用虚拟网络创建负载均衡器、网络安全组、虚拟网络和 Azure Databricks 工作区。 |
创建标准的内部负载均衡器 |
此模板使用规则负载均衡端口 80 创建标准内部Azure 负载均衡器 |
使用 HA 端口Create标准内部负载均衡器 |
此模板使用 HA 端口负载均衡规则创建标准内部Azure 负载均衡器 |
创建跨区域负载均衡器 |
此模板创建一个跨区域负载均衡器,其后端池包含两个区域负载均衡器。 跨区域负载均衡器目前在有限区域中可用。 跨区域负载均衡器后面的区域负载均衡器可以位于任何区域。 |
通过后端池按 IP 地址标准负载均衡器 |
此模板用于演示如何使用 ARM 模板按 IP 地址配置负载均衡器的后端池,如后端池管理文档中所述。 |
Create具有公共 IPv6 地址的负载均衡器 |
此模板创建一个面向 Internet 的负载均衡器,其中包含一个公共 IPv6 地址、负载均衡规则和两个用于后端池的 VM。 |
创建标准负载均衡器 |
此模板为后端池创建面向 Internet 的负载均衡器、负载均衡规则和三个 VM,每个 VM 都位于冗余区域中。 |
负载均衡器具有 2 个 VIP,每个 VIP 都有一个 LB 规则 |
此模板允许你为负载均衡器创建一个负载均衡器 2 个公共 IP 地址, () 、虚拟网络、网络接口,虚拟网络 &网络接口使用的负载均衡器 LB 规则。 |
使用入站 NAT 规则负载均衡器 |
使用此模板可为负载均衡器创建负载均衡器公共 IP 地址,虚拟网络网络接口,虚拟网络 &网络接口使用的负载均衡器中的 NAT 规则。 |
Terraform (AzAPI 提供程序) 资源定义
可以使用面向以下操作部署 loadBalancers 资源类型:
- 资源组
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/loadBalancers 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/loadBalancers@2023-11-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
backendAddressPools = [
{
id = "string"
name = "string"
properties = {
drainPeriodInSeconds = int
loadBalancerBackendAddresses = [
{
name = "string"
properties = {
adminState = "string"
ipAddress = "string"
loadBalancerFrontendIPConfiguration = {
id = "string"
}
subnet = {
id = "string"
}
virtualNetwork = {
id = "string"
}
}
}
]
location = "string"
syncMode = "string"
tunnelInterfaces = [
{
identifier = int
port = int
protocol = "string"
type = "string"
}
]
virtualNetwork = {
id = "string"
}
}
}
]
frontendIPConfigurations = [
{
id = "string"
name = "string"
properties = {
gatewayLoadBalancer = {
id = "string"
}
privateIPAddress = "string"
privateIPAddressVersion = "string"
privateIPAllocationMethod = "string"
publicIPAddress = {
extendedLocation = {
name = "string"
type = "EdgeZone"
}
id = "string"
location = "string"
properties = {
ddosSettings = {
ddosProtectionPlan = {
id = "string"
}
protectionMode = "string"
}
deleteOption = "string"
dnsSettings = {
domainNameLabel = "string"
domainNameLabelScope = "string"
fqdn = "string"
reverseFqdn = "string"
}
idleTimeoutInMinutes = int
ipAddress = "string"
ipTags = [
{
ipTagType = "string"
tag = "string"
}
]
linkedPublicIPAddress = {
public-ip-address-object
}
migrationPhase = "string"
natGateway = {
id = "string"
location = "string"
properties = {
idleTimeoutInMinutes = int
publicIpAddresses = [
{
id = "string"
}
]
publicIpPrefixes = [
{
id = "string"
}
]
}
sku = {
name = "Standard"
}
tags = {}
zones = [
"string"
]
}
publicIPAddressVersion = "string"
publicIPAllocationMethod = "string"
publicIPPrefix = {
id = "string"
}
servicePublicIPAddress = {
public-ip-address-object
}
}
sku = {
name = "string"
tier = "string"
}
tags = {}
zones = [
"string"
]
}
publicIPPrefix = {
id = "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"
}
}
zones = [
"string"
]
}
]
inboundNatPools = [
{
id = "string"
name = "string"
properties = {
backendPort = int
enableFloatingIP = bool
enableTcpReset = bool
frontendIPConfiguration = {
id = "string"
}
frontendPortRangeEnd = int
frontendPortRangeStart = int
idleTimeoutInMinutes = int
protocol = "string"
}
}
]
inboundNatRules = [
{
id = "string"
name = "string"
properties = {
backendAddressPool = {
id = "string"
}
backendPort = int
enableFloatingIP = bool
enableTcpReset = bool
frontendIPConfiguration = {
id = "string"
}
frontendPort = int
frontendPortRangeEnd = int
frontendPortRangeStart = int
idleTimeoutInMinutes = int
protocol = "string"
}
}
]
loadBalancingRules = [
{
id = "string"
name = "string"
properties = {
backendAddressPool = {
id = "string"
}
backendAddressPools = [
{
id = "string"
}
]
backendPort = int
disableOutboundSnat = bool
enableFloatingIP = bool
enableTcpReset = bool
frontendIPConfiguration = {
id = "string"
}
frontendPort = int
idleTimeoutInMinutes = int
loadDistribution = "string"
probe = {
id = "string"
}
protocol = "string"
}
}
]
outboundRules = [
{
id = "string"
name = "string"
properties = {
allocatedOutboundPorts = int
backendAddressPool = {
id = "string"
}
enableTcpReset = bool
frontendIPConfigurations = [
{
id = "string"
}
]
idleTimeoutInMinutes = int
protocol = "string"
}
}
]
probes = [
{
id = "string"
name = "string"
properties = {
intervalInSeconds = int
numberOfProbes = int
port = int
probeThreshold = int
protocol = "string"
requestPath = "string"
}
}
]
}
sku = {
name = "string"
tier = "string"
}
extendedLocation = {
name = "string"
type = "EdgeZone"
}
})
}
属性值
loadBalancers
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.Network/loadBalancers@2023-11-01” |
name | 资源名称 | 字符串 (必需) 字符限制:1-80 有效字符: 字母数字、下划线字符、句点和连字符。 以字母数字开头。 以字母数字或下划线结尾。 |
location | 资源位置。 | 字符串 |
parent_id | 若要部署到资源组,请使用该资源组的 ID。 | 字符串 (必需) |
标记 | 资源标记。 | 标记名称和值的字典。 |
sku | 负载均衡器 SKU。 | LoadBalancerSku |
extendedLocation | 负载均衡器的扩展位置。 | ExtendedLocation |
properties | 负载均衡器的属性。 | LoadBalancerPropertiesFormat |
ExtendedLocation
名称 | 说明 | 值 |
---|---|---|
name | 扩展位置的名称。 | 字符串 |
type | 扩展位置的类型。 | “EdgeZone” |
LoadBalancerPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
backendAddressPools | 负载均衡器使用的后端地址池的集合。 | BackendAddressPool[] |
frontendIPConfigurations | 表示要用于负载均衡器的前端 IP 的对象。 | FrontendIPConfiguration[] |
inboundNatPools | 为与负载均衡器关联的 NIC 上的单个后端端口的入站 NAT 定义外部端口范围。 使用此范围内的外部端口自动为与负载均衡器关联的每个 NIC 创建入站 NAT 规则。 在负载均衡器上定义入站 NAT 池与定义入站 NAT 规则是互斥的。 从虚拟机规模集引用入站 NAT 池。 与单个虚拟机关联的 NIC 不能引用入站 NAT 池。 它们必须引用单个入站 NAT 规则。 | InboundNatPool[] |
inboundNatRules | 负载均衡器使用的入站 NAT 规则的集合。 在负载均衡器上定义入站 NAT 规则与定义入站 NAT 池是互斥的。 从虚拟机规模集引用入站 NAT 池。 与单个虚拟机关联的 NIC 不能引用入站 NAT 池。 它们必须引用单个入站 NAT 规则。 | InboundNatRule[] |
loadBalancingRules | 表示负载均衡规则的对象集合 获取预配。 | LoadBalancingRule[] |
outboundRules | 出站规则。 | OutboundRule[] |
probes | 负载均衡器中使用的探测对象的集合。 | Probe[] |
BackendAddressPool
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的后端地址池集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器后端地址池的属性。 | BackendAddressPoolPropertiesFormat |
BackendAddressPoolPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
drainPeriodInSeconds | 将 RESET 发送到客户端和后端地址之前,负载均衡器等待的秒数。 | int |
loadBalancerBackendAddresses | 后端地址数组。 | LoadBalancerBackendAddress[] |
location | 后端地址池的位置。 | 字符串 |
syncMode | 后端池的后端地址同步模式 | “自动” “手动” |
tunnelInterfaces | 网关负载均衡器隧道接口的数组。 | GatewayLoadBalancerTunnelInterface[] |
virtualNetwork | 对虚拟网络的引用。 | SubResource |
LoadBalancerBackendAddress
名称 | 说明 | 值 |
---|---|---|
name | 后端地址的名称。 | string |
properties | 负载均衡器后端地址池的属性。 | LoadBalancerBackendAddressPropertiesFormat |
LoadBalancerBackendAddressPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
adminState | 管理状态列表,一旦设置,即可覆盖运行状况探测,以便负载均衡器始终将新连接转发到后端,或拒绝新连接并重置现有连接。 | “Down” "None" “向上” |
ipAddress | 属于引用的虚拟网络的 IP 地址。 | 字符串 |
loadBalancerFrontendIPConfiguration | 对区域负载均衡器中定义的前端 IP 地址配置的引用。 | SubResource |
子网 | 对现有子网的引用。 | SubResource |
virtualNetwork | 对现有虚拟网络的引用。 | SubResource |
SubResource
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
GatewayLoadBalancerTunnelInterface
名称 | 说明 | 值 |
---|---|---|
标识符 | 网关负载均衡器隧道接口的标识符。 | int |
port | 网关负载均衡器隧道接口的端口。 | int |
protocol | 网关负载均衡器隧道接口的协议。 | “Native” "None" “VXLAN” |
类型 | 网关负载均衡器隧道接口的流量类型。 | “External” “Internal” "None" |
FrontendIPConfiguration
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的前端 IP 配置集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器探测的属性。 | FrontendIPConfigurationPropertiesFormat |
zones | 一个可用性区域列表,指示为资源分配的 IP 需要来自。 | string[] |
FrontendIPConfigurationPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
gatewayLoadBalancer | 对网关负载均衡器前端 IP 的引用。 | SubResource |
privateIPAddress | IP 配置的专用 IP 地址。 | 字符串 |
privateIPAddressVersion | 特定 ip 配置是 IPv4 还是 IPv6。 默认值为 IPv4。 | “IPv4” “IPv6” |
privateIPAllocationMethod | 专用 IP 分配方法。 | “动态” “Static” |
publicIPAddress | 对公共 IP 资源的引用。 | PublicIPAddress |
publicIPPrefix | 对公共 IP 前缀资源的引用。 | SubResource |
子网 | 对子网资源的引用。 | 子网 |
PublicIPAddress
名称 | 说明 | 值 |
---|---|---|
extendedLocation | 公共 IP 地址的扩展位置。 | ExtendedLocation |
id | 资源 ID。 | 字符串 |
location | 资源位置。 | string |
properties | 公共 IP 地址属性。 | PublicIPAddressPropertiesFormat |
sku | 公共 IP 地址 SKU。 | PublicIPAddressSku |
标记 | 资源标记。 | 对象 (object) |
zones | 一个可用性区域列表,指示为资源分配的 IP 需要来自。 | string[] |
PublicIPAddressPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
ddosSettings | 与公共 IP 地址关联的 DDoS 防护自定义策略。 | DdosSettings |
deleteOption | 指定删除使用公共 IP 地址的 VM 时会发生什么情况 | “Delete” “分离” |
dnsSettings | 与公共 IP 地址关联的 DNS 记录的 FQDN。 | PublicIPAddressDnsSettings |
idleTimeoutInMinutes | 公共 IP 地址的空闲超时。 | int |
ipAddress | 与公共 IP 地址资源关联的 IP 地址。 | 字符串 |
ipTags | 与公共 IP 地址关联的标记列表。 | IpTag[] |
linkedPublicIPAddress | 公共 IP 地址资源的链接公共 IP 地址。 | PublicIPAddress |
migrationPhase | 公共 IP 地址的迁移阶段。 | “Abort” “Commit” “Committed” "None" “准备” |
natGateway | 公共 IP 地址的 NatGateway。 | NatGateway |
publicIPAddressVersion | 公共 IP 地址版本。 | “IPv4” “IPv6” |
publicIPAllocationMethod | 公共 IP 地址分配方法。 | “动态” “Static” |
publicIPPrefix | 应从中分配此公共 IP 地址的公共 IP 前缀。 | SubResource |
servicePublicIPAddress | 公共 IP 地址资源的服务公共 IP 地址。 | PublicIPAddress |
DdosSettings
名称 | 说明 | 值 |
---|---|---|
ddosProtectionPlan | 与公共 IP 关联的 DDoS 保护计划。 仅当 ProtectionMode 为“已启用”时,才能设置 | SubResource |
protectionMode | 公共 IP 的 DDoS 保护模式 | “Disabled” “Enabled” “VirtualNetworkInherited” |
PublicIPAddressDnsSettings
名称 | 说明 | 值 |
---|---|---|
domainNameLabel | 域名标签。 域名标签与区域化 DNS 区域的串联形式构成了与公共 IP 地址关联的完全限定域名。 如果指定了域名标签,则会在 Microsoft Azure DNS 系统中为公共 IP 创建 DNS 记录。 | 字符串 |
domainNameLabelScope | 域名标签范围。 如果指定了域名标签和域名标签范围,则会为 Microsoft Azure DNS 系统中的公共 IP 创建 A DNS 记录,其哈希值包含在 FQDN 中。 | “NoReuse” “ResourceGroupReuse” “SubscriptionReuse” “TenantReuse” |
fqdn | 与公共 IP 关联的 A DNS 记录的完全限定的域名。 这是 domainNameLabel 和区域化 DNS 区域的串联。 | 字符串 |
reverseFqdn | 反向 FQDN。 用户可见的完全限定域名,解析为此公共 IP 地址。 如果指定了 reverseFqdn,则会创建从 in-addr.arpa 域中的 IP 地址指向反向 FQDN 的 DNS PTR 记录。 | 字符串 |
IpTag
名称 | 说明 | 值 |
---|---|---|
ipTagType | IP 标记类型。 示例:FirstPartyUsage。 | 字符串 |
标记 | 与公共 IP 关联的 IP 标记的值。 示例:SQL。 | 字符串 |
NatGateway
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
location | 资源位置。 | string |
properties | Nat 网关属性。 | NatGatewayPropertiesFormat |
sku | nat 网关 SKU。 | NatGatewaySku |
标记 | 资源标记。 | 对象 (object) |
zones | 指示应在其中部署 Nat 网关的区域的可用性区域列表。 | string[] |
NatGatewayPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
idleTimeoutInMinutes | nat 网关的空闲超时。 | int |
publicIpAddresses | 与 nat 网关资源关联的公共 IP 地址数组。 | SubResource[] |
publicIpPrefixes | 与 nat 网关资源关联的公共 IP 前缀数组。 | SubResource[] |
NatGatewaySku
名称 | 说明 | 值 |
---|---|---|
name | Nat 网关 SKU 的名称。 | “Standard” |
PublicIPAddressSku
名称 | 说明 | 值 |
---|---|---|
name | 公共 IP 地址 SKU 的名称。 | "Basic" “Standard” |
层 | 公共 IP 地址 SKU 的层。 | “Global” “区域” |
子网
名称 | 说明 | 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 |
委托
名称 | 说明 | 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[] |
ApplicationSecurityGroup
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
location | 资源位置。 | string |
properties | 应用程序安全组的属性。 | ApplicationSecurityGroupPropertiesFormat |
标记 | 资源标记。 | 对象 (object) |
ApplicationSecurityGroupPropertiesFormat
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
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[] |
服务 | 终结点服务的类型。 | 字符串 |
InboundNatPool
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的入站 NAT 池集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器入站 nat 池的属性。 | InboundNatPoolPropertiesFormat |
InboundNatPoolPropertiesFormat
名称 | 说明 | 值 |
---|---|---|
backendPort | 用于在终结点上建立内部连接的端口。 可接受的值介于 1 和 65535 之间。 | int (必需) |
enableFloatingIP | 为配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能配置虚拟机的终结点。 在 SQL Server 中使用 SQL AlwaysOn 可用性组时,需要此设置。 创建终结点后,无法更改此设置。 | bool |
enableTcpReset | 在 TCP 流空闲超时或意外连接终止时接收双向 TCP 重置。 仅在将协议设置为 TCP 后才使用此元素。 | bool |
frontendIPConfiguration | 对前端 IP 地址的引用。 | SubResource |
frontendPortRangeEnd | 外部端口范围中的最后一个端口号,用于向与负载均衡器关联的 NIC 提供入站 Nat。 可接受的值范围为 1 到 65535。 | int (必需) |
frontendPortRangeStart | 外部端口范围中的第一个端口号,用于向与负载均衡器关联的 NIC 提供入站 Nat。 可接受的值范围为 1 到 65534。 | int (必需) |
idleTimeoutInMinutes | TCP 空闲连接的超时。 该值可设置为介于 4 和 30 分钟之间。 默认值为 4 分钟。 仅在将协议设置为 TCP 后才使用此元素。 | int |
protocol | 对入站 NAT 池使用的传输协议的引用。 | “全部” “Tcp” “Udp” (必需) |
InboundNatRule
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的入站 NAT 规则集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器入站 NAT 规则的属性。 | InboundNatRulePropertiesFormat |
InboundNatRulePropertiesFormat
名称 | 说明 | 值 |
---|---|---|
backendAddressPool | 对 backendAddressPool 资源的引用。 | SubResource |
backendPort | 用于内部终结点的端口。 可接受的值范围为 1 到 65535。 | int |
enableFloatingIP | 为虚拟机的终结点配置配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能。 在 SQL Server 中使用 SQL AlwaysOn 可用性组时,需要此设置。 创建终结点后,无法更改此设置。 | bool |
enableTcpReset | 在 TCP 流空闲超时或意外连接终止时接收双向 TCP 重置。 仅在将协议设置为 TCP 后才使用此元素。 | bool |
frontendIPConfiguration | 对前端 IP 地址的引用。 | SubResource |
frontendPort | 外部终结点的端口。 每个规则的端口号在负载均衡器中必须是唯一的。 可接受的值范围为 1 到 65534。 | int |
frontendPortRangeEnd | 外部终结点的端口范围结束。 此属性与 BackendAddressPool 和 FrontendPortRangeStart 一起使用。 将为 BackendAddressPool 中的每个后端地址创建单独的入站 NAT 规则端口映射。 可接受的值范围为 1 到 65534。 | int |
frontendPortRangeStart | 外部终结点的端口范围开始。 此属性与 BackendAddressPool 和 FrontendPortRangeEnd 一起使用。 将为 BackendAddressPool 中的每个后端地址创建单独的入站 NAT 规则端口映射。 可接受的值范围为 1 到 65534。 | int |
idleTimeoutInMinutes | TCP 空闲连接的超时。 该值可设置为介于 4 和 30 分钟之间。 默认值为 4 分钟。 仅在将协议设置为 TCP 后才使用此元素。 | int |
protocol | 对负载均衡规则使用的传输协议的引用。 | “全部” “Tcp” “Udp” |
LoadBalancingRule
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的负载均衡规则集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器负载均衡规则的属性。 | LoadBalancingRulePropertiesFormat |
LoadBalancingRulePropertiesFormat
名称 | 说明 | 值 |
---|---|---|
backendAddressPool | 对 DIP 池的引用。 入站流量在后端 IP 中的 IP 之间随机进行负载均衡。 | SubResource |
backendAddressPools | 对 DIP 池的引用数组。 | SubResource[] |
backendPort | 用于在终结点上建立内部连接的端口。 可接受的值介于 0 和 65535 之间。 请注意,值 0 启用“任何端口”。 | int |
disableOutboundSnat | 为后端池中的 VM 配置 SNAT,以使用负载均衡规则前端中指定的 publicIP 地址。 | bool |
enableFloatingIP | 为虚拟机的终结点配置配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能。 在 SQL Server 中使用 SQL AlwaysOn 可用性组时,需要此设置。 创建终结点后,无法更改此设置。 | bool |
enableTcpReset | 在 TCP 流空闲超时或意外连接终止时接收双向 TCP 重置。 仅在将协议设置为 TCP 后才使用此元素。 | bool |
frontendIPConfiguration | 对前端 IP 地址的引用。 | SubResource |
frontendPort | 外部终结点的端口。 每个规则的端口号在负载均衡器中必须是唯一的。 可接受的值介于 0 和 65534 之间。 请注意,值 0 启用“任何端口”。 | int (必需) |
idleTimeoutInMinutes | TCP 空闲连接的超时。 该值可设置为介于 4 和 30 分钟之间。 默认值为 4 分钟。 仅在将协议设置为 TCP 后才使用此元素。 | int |
loadDistribution | 此规则的负载分配策略。 | “Default” “SourceIP” “SourceIPProtocol” |
探测 | 对负载均衡规则使用的负载均衡器探测的引用。 | SubResource |
protocol | 对负载均衡规则使用的传输协议的引用。 | “全部” “Tcp” “Udp” (必需) |
OutboundRule
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的出站规则集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器出站规则的属性。 | OutboundRulePropertiesFormat |
OutboundRulePropertiesFormat
名称 | 说明 | 值 |
---|---|---|
allocatedOutboundPorts | 要用于 NAT 的出站端口数。 | int |
backendAddressPool | 对 DIP 池的引用。 出站流量在后端 IP 中的 IP 之间随机进行负载均衡。 | 需要 SubResource () |
enableTcpReset | 在 TCP 流空闲超时或意外连接终止时接收双向 TCP 重置。 仅在将协议设置为 TCP 后才使用此元素。 | bool |
frontendIPConfigurations | 负载均衡器的前端 IP 地址。 | SubResource[] (必需的) |
idleTimeoutInMinutes | TCP 空闲连接的超时。 | int |
protocol | 负载均衡器中出站规则的协议。 | “全部” “Tcp” “Udp” (必需) |
探测
名称 | 说明 | Value |
---|---|---|
id | 资源 ID。 | 字符串 |
name | 负载均衡器使用的探测集中唯一的资源的名称。 此名称可用于访问资源。 | string |
properties | 负载均衡器探测的属性。 | ProbePropertiesFormat |
ProbePropertiesFormat
名称 | 说明 | 值 |
---|---|---|
intervalInSeconds | 探测终结点的运行状况的间隔(以秒为单位)。 通常,该间隔略小于所分配超时期限(以秒为单位)的一半,以便在退出轮转前执行两次完整的探测。 默认值为 15,最小值为 5。 | int |
numberOfProbes | 探测数(如果没有响应)将导致停止将更多流量传递到终结点。 此值允许终结点退出旋转的速度比 Azure 中使用的典型时间更快或更慢。 | int |
port | 用于传达探测的端口。 可能的值介于 1 和 65535(含)之间。 | int (必需) |
probeThreshold | 为了允许或拒绝将流量传递到此终结点而连续成功或失败的探测数。 在连续探测数等于此值失败后,终结点将从轮换中取出,并要求将相同数量的成功连续探测放回轮换。 | int |
protocol | 终结点的协议。 如果指定了“Tcp”,则需要接收的 ACK 才能使探测成功。 如果指定了“Http”或“Https”,则需要来自 指定 URI 的 200 OK 响应才能成功探测。 | “Http” “Https” “Tcp” (必需) |
requestPath | 用于从 VM 请求运行状况的 URI。 如果协议设置为 http,则需要路径。 否则,不允许使用该属性。 没有默认值。 | 字符串 |
LoadBalancerSku
名称 | 说明 | 值 |
---|---|---|
name | 负载均衡器 SKU 的名称。 | "Basic" “网关” “Standard” |
层 | 负载均衡器 SKU 的层。 | “Global” “区域” |