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

VirtualNetworkGateway interface

常规资源信息的通用类。

扩展

属性

active

ActiveActive 标志。

adminState

指示 Express Route 网关在 vnet 中有多个 Express Route 网关时是否为流量提供服务的属性

allowRemoteVnetTraffic

将此网关配置为接受来自其他 Azure 虚拟网络的流量。 此配置不支持连接到 Azure 虚拟 WAN。

allowVirtualWanTraffic

将此网关配置为接受来自远程虚拟网络的流量。

autoScaleConfiguration

virutal 网络网关的自动缩放配置

bgpSettings

虚拟网络网关的 BGP 扬声器设置。

customRoutes

对地址空间资源的引用,该资源表示客户为虚拟网络网关和 VpnClient 指定的自定义路由地址空间。

disableIPSecReplayProtection

disableIPSecReplayProtection 标志。

enableBgp

是否为此虚拟网络网关启用了 BGP。

enableBgpRouteTranslationForNat

EnableBgpRouteTranslationForNat 标志。

enableDnsForwarding

是否启用 DNS 转发。

enableHighBandwidthVpnGateway

为 VPN 网关启用高级连接功能

enablePrivateIpAddress

是否需要在此网关上为连接启用专用 IP。

etag

一个唯一的只读字符串,每当更新资源时更改。 注意:此属性不会序列化。 它只能由服务器填充。

extendedLocation

本地虚拟网络网关类型的扩展位置。

gatewayDefaultSite

对 LocalNetworkGateway 资源的引用,该资源表示具有默认路由的本地网络站点。 如果删除现有的默认站点设置,请分配 Null 值。

gatewayType

此虚拟网络网关的类型。

identity

虚拟网络网关的标识(如果已配置)。

inboundDnsForwardingEndpoint

DNS 请求可以发送到的网关分配的 IP 地址。 注意:此属性不会序列化。 它只能由服务器填充。

ipConfigurations

虚拟网络网关的 IP 配置。

natRules

虚拟网络网关的 NatRules。

provisioningState

虚拟网络网关资源的预配状态。 注意:此属性不会序列化。 它只能由服务器填充。

resiliencyModel

指示 Express Route Gateway 是否具有 MultiHomed 或 SingleHomed 的复原模型的属性

resourceGuid

虚拟网络网关资源的资源 GUID 属性。 注意:此属性不会序列化。 它只能由服务器填充。

sku

对 VirtualNetworkGatewaySku 资源的引用,该资源表示为虚拟网络网关选择的 SKU。

virtualNetworkGatewayMigrationStatus

对 VirtualNetworkGatewayMigrationStatus 的引用,它表示迁移的状态。

virtualNetworkGatewayPolicyGroups

对 VirtualNetworkGatewayPolicyGroup 资源的引用,该资源表示网关的可用 VirtualNetworkGatewayPolicyGroup。

vNetExtendedLocationResourceId

客户 vnet 资源 ID。本地网关类型的 VirtualNetworkGateway 与客户 vnet 相关联。

vpnClientConfiguration

对表示 P2S VpnClient 配置的 VpnClientConfiguration 资源的引用。

vpnGatewayGeneration

此 VirtualNetworkGateway 的代系。 如果 gatewayType 不是 VPN,则必须为 None。

vpnType

此虚拟网络网关的类型。

继承属性

id

资源 ID。

location

资源位置。

name

资源名称。 注意:此属性不会序列化。 它只能由服务器填充。

tags

资源标记。

type

资源类型。 注意:此属性不会序列化。 它只能由服务器填充。

属性详细信息

active

ActiveActive 标志。

active?: boolean

属性值

boolean

adminState

指示 Express Route 网关在 vnet 中有多个 Express Route 网关时是否为流量提供服务的属性

adminState?: string

属性值

string

allowRemoteVnetTraffic

将此网关配置为接受来自其他 Azure 虚拟网络的流量。 此配置不支持连接到 Azure 虚拟 WAN。

allowRemoteVnetTraffic?: boolean

属性值

boolean

allowVirtualWanTraffic

将此网关配置为接受来自远程虚拟网络的流量。

allowVirtualWanTraffic?: boolean

属性值

boolean

autoScaleConfiguration

virutal 网络网关的自动缩放配置

autoScaleConfiguration?: VirtualNetworkGatewayAutoScaleConfiguration

属性值

bgpSettings

虚拟网络网关的 BGP 扬声器设置。

bgpSettings?: BgpSettings

属性值

customRoutes

对地址空间资源的引用,该资源表示客户为虚拟网络网关和 VpnClient 指定的自定义路由地址空间。

customRoutes?: AddressSpace

属性值

disableIPSecReplayProtection

disableIPSecReplayProtection 标志。

disableIPSecReplayProtection?: boolean

属性值

boolean

enableBgp

是否为此虚拟网络网关启用了 BGP。

enableBgp?: boolean

属性值

boolean

enableBgpRouteTranslationForNat

EnableBgpRouteTranslationForNat 标志。

enableBgpRouteTranslationForNat?: boolean

属性值

boolean

enableDnsForwarding

是否启用 DNS 转发。

enableDnsForwarding?: boolean

属性值

boolean

enableHighBandwidthVpnGateway

为 VPN 网关启用高级连接功能

enableHighBandwidthVpnGateway?: boolean

属性值

boolean

enablePrivateIpAddress

是否需要在此网关上为连接启用专用 IP。

enablePrivateIpAddress?: boolean

属性值

boolean

etag

一个唯一的只读字符串,每当更新资源时更改。 注意:此属性不会序列化。 它只能由服务器填充。

etag?: string

属性值

string

extendedLocation

本地虚拟网络网关类型的扩展位置。

extendedLocation?: ExtendedLocation

属性值

gatewayDefaultSite

对 LocalNetworkGateway 资源的引用,该资源表示具有默认路由的本地网络站点。 如果删除现有的默认站点设置,请分配 Null 值。

gatewayDefaultSite?: SubResource

属性值

gatewayType

此虚拟网络网关的类型。

gatewayType?: string

属性值

string

identity

虚拟网络网关的标识(如果已配置)。

identity?: ManagedServiceIdentity

属性值

inboundDnsForwardingEndpoint

DNS 请求可以发送到的网关分配的 IP 地址。 注意:此属性不会序列化。 它只能由服务器填充。

inboundDnsForwardingEndpoint?: string

属性值

string

ipConfigurations

虚拟网络网关的 IP 配置。

ipConfigurations?: VirtualNetworkGatewayIPConfiguration[]

属性值

natRules

虚拟网络网关的 NatRules。

natRules?: VirtualNetworkGatewayNatRule[]

属性值

provisioningState

虚拟网络网关资源的预配状态。 注意:此属性不会序列化。 它只能由服务器填充。

provisioningState?: string

属性值

string

resiliencyModel

指示 Express Route Gateway 是否具有 MultiHomed 或 SingleHomed 的复原模型的属性

resiliencyModel?: string

属性值

string

resourceGuid

虚拟网络网关资源的资源 GUID 属性。 注意:此属性不会序列化。 它只能由服务器填充。

resourceGuid?: string

属性值

string

sku

对 VirtualNetworkGatewaySku 资源的引用,该资源表示为虚拟网络网关选择的 SKU。

sku?: VirtualNetworkGatewaySku

属性值

virtualNetworkGatewayMigrationStatus

对 VirtualNetworkGatewayMigrationStatus 的引用,它表示迁移的状态。

virtualNetworkGatewayMigrationStatus?: VirtualNetworkGatewayMigrationStatus

属性值

virtualNetworkGatewayPolicyGroups

对 VirtualNetworkGatewayPolicyGroup 资源的引用,该资源表示网关的可用 VirtualNetworkGatewayPolicyGroup。

virtualNetworkGatewayPolicyGroups?: VirtualNetworkGatewayPolicyGroup[]

属性值

vNetExtendedLocationResourceId

客户 vnet 资源 ID。本地网关类型的 VirtualNetworkGateway 与客户 vnet 相关联。

vNetExtendedLocationResourceId?: string

属性值

string

vpnClientConfiguration

对表示 P2S VpnClient 配置的 VpnClientConfiguration 资源的引用。

vpnClientConfiguration?: VpnClientConfiguration

属性值

vpnGatewayGeneration

此 VirtualNetworkGateway 的代系。 如果 gatewayType 不是 VPN,则必须为 None。

vpnGatewayGeneration?: string

属性值

string

vpnType

此虚拟网络网关的类型。

vpnType?: string

属性值

string

继承属性详细信息

id

资源 ID。

id?: string

属性值

string

继承自Resource.id

location

资源位置。

location?: string

属性值

string

继承自Resource.location

name

资源名称。 注意:此属性不会序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自Resource.name

tags

资源标记。

tags?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

继承自Resource.tags

type

资源类型。 注意:此属性不会序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自resource.type