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

VirtualNetworkGateways interface

包:: @azure/arm-network

表示 VirtualNetworkGateways 的接口。

方法

beginCreateOrUpdate(string, string, VirtualNetworkGateway, VirtualNetworkGatewaysCreateOrUpdateOptionalParams)	在指定的资源组中创建或更新虚拟网络网关。
beginCreateOrUpdateAndWait(string, string, VirtualNetworkGateway, VirtualNetworkGatewaysCreateOrUpdateOptionalParams)	在指定的资源组中创建或更新虚拟网络网关。
beginDelete(string, string, VirtualNetworkGatewaysDeleteOptionalParams)	删除指定的虚拟网络网关。
beginDeleteAndWait(string, string, VirtualNetworkGatewaysDeleteOptionalParams)	删除指定的虚拟网络网关。
beginDisconnectVirtualNetworkGatewayVpnConnections(string, string, P2SVpnConnectionRequest, VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams)	断开指定资源组中虚拟网络网关的 VPN 连接。
beginDisconnectVirtualNetworkGatewayVpnConnectionsAndWait(string, string, P2SVpnConnectionRequest, VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams)	断开指定资源组中虚拟网络网关的 VPN 连接。
beginGeneratevpnclientpackage(string, string, VpnClientParameters, VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams)	为指定资源组中虚拟网络网关的 P2S 客户端生成 VPN 客户端包。
beginGeneratevpnclientpackageAndWait(string, string, VpnClientParameters, VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams)	为指定资源组中虚拟网络网关的 P2S 客户端生成 VPN 客户端包。
beginGenerateVpnProfile(string, string, VpnClientParameters, VirtualNetworkGatewaysGenerateVpnProfileOptionalParams)	为指定资源组中虚拟网络网关的 P2S 客户端生成 VPN 配置文件。用于 IKEV2 和基于半径的身份验证。
beginGenerateVpnProfileAndWait(string, string, VpnClientParameters, VirtualNetworkGatewaysGenerateVpnProfileOptionalParams)	为指定资源组中虚拟网络网关的 P2S 客户端生成 VPN 配置文件。用于 IKEV2 和基于半径的身份验证。
beginGetAdvertisedRoutes(string, string, string, VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams)	此操作检索虚拟网络网关向指定对等方播发的路由列表。
beginGetAdvertisedRoutesAndWait(string, string, string, VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams)	此操作检索虚拟网络网关向指定对等方播发的路由列表。
beginGetBgpPeerStatus(string, string, VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams)	GetBgpPeerStatus 操作检索所有 BGP 对等方的状态。
beginGetBgpPeerStatusAndWait(string, string, VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams)	GetBgpPeerStatus 操作检索所有 BGP 对等方的状态。
beginGetFailoverAllTestDetails(string, string, string, boolean, VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams)	此操作检索针对不同对等互连位置在网关上执行的所有故障转移测试的详细信息
beginGetFailoverAllTestDetailsAndWait(string, string, string, boolean, VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams)	此操作检索针对不同对等互连位置在网关上执行的所有故障转移测试的详细信息
beginGetFailoverSingleTestDetails(string, string, string, string, VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams)	此操作根据测试 Guid 检索在网关上执行的特定故障转移测试的详细信息
beginGetFailoverSingleTestDetailsAndWait(string, string, string, string, VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams)	此操作根据测试 Guid 检索在网关上执行的特定故障转移测试的详细信息
beginGetLearnedRoutes(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)	此操作检索虚拟网络网关已学习的路由列表，包括从 BGP 对等方学习的路由。
beginGetLearnedRoutesAndWait(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)	此操作检索虚拟网络网关已学习的路由列表，包括从 BGP 对等方学习的路由。
beginGetResiliencyInformation(string, string, VirtualNetworkGatewaysGetResiliencyInformationOptionalParams)	此作检索 Express Route 网关的弹性信息，包括网关的当前弹性分数和进一步提高分数的建议
beginGetResiliencyInformationAndWait(string, string, VirtualNetworkGatewaysGetResiliencyInformationOptionalParams)	此作检索 Express Route 网关的弹性信息，包括网关的当前弹性分数和进一步提高分数的建议
beginGetRoutesInformation(string, string, VirtualNetworkGatewaysGetRoutesInformationOptionalParams)	此作根据 Express Route 网关的弹性检索路由集信息
beginGetRoutesInformationAndWait(string, string, VirtualNetworkGatewaysGetRoutesInformationOptionalParams)	此作根据 Express Route 网关的弹性检索路由集信息
beginGetVpnclientConnectionHealth(string, string, VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams)	获取指定资源组中虚拟网络网关的每个 P2S 客户端连接的 VPN 客户端连接运行状况详细信息。
beginGetVpnclientConnectionHealthAndWait(string, string, VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams)	获取指定资源组中虚拟网络网关的每个 P2S 客户端连接的 VPN 客户端连接运行状况详细信息。
beginGetVpnclientIpsecParameters(string, string, VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams)	获取 VpnclientIpsecParameters 操作通过网络资源提供程序检索指定资源组中虚拟网络网关 P2S 客户端的 vpnclient ipsec 策略的相关信息。
beginGetVpnclientIpsecParametersAndWait(string, string, VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams)	获取 VpnclientIpsecParameters 操作通过网络资源提供程序检索指定资源组中虚拟网络网关 P2S 客户端的 vpnclient ipsec 策略的相关信息。
beginGetVpnProfilePackageUrl(string, string, VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams)	获取指定资源组中虚拟网络网关的 P2S 客户端的预生成的 VPN 配置文件。首先需要使用 generateVpnProfile 生成配置文件。
beginGetVpnProfilePackageUrlAndWait(string, string, VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams)	获取指定资源组中虚拟网络网关的 P2S 客户端的预生成的 VPN 配置文件。首先需要使用 generateVpnProfile 生成配置文件。
beginInvokeAbortMigration(string, string, VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams)	触发虚拟网络网关的中止迁移。
beginInvokeAbortMigrationAndWait(string, string, VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams)	触发虚拟网络网关的中止迁移。
beginInvokeCommitMigration(string, string, VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams)	触发虚拟网络网关的提交迁移。
beginInvokeCommitMigrationAndWait(string, string, VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams)	触发虚拟网络网关的提交迁移。
beginInvokeExecuteMigration(string, string, VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams)	触发虚拟网络网关的执行迁移。
beginInvokeExecuteMigrationAndWait(string, string, VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams)	触发虚拟网络网关的执行迁移。
beginInvokePrepareMigration(string, string, VirtualNetworkGatewayMigrationParameters, VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams)	触发 Virtual Network Gateway 的准备迁移。
beginInvokePrepareMigrationAndWait(string, string, VirtualNetworkGatewayMigrationParameters, VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams)	触发 Virtual Network Gateway 的准备迁移。
beginReset(string, string, VirtualNetworkGatewaysResetOptionalParams)	重置指定资源组中虚拟网络网关的主网关。
beginResetAndWait(string, string, VirtualNetworkGatewaysResetOptionalParams)	重置指定资源组中虚拟网络网关的主网关。
beginResetVpnClientSharedKey(string, string, VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams)	重置指定资源组中虚拟网络网关的 VPN 客户端共享密钥。
beginResetVpnClientSharedKeyAndWait(string, string, VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams)	重置指定资源组中虚拟网络网关的 VPN 客户端共享密钥。
beginSetVpnclientIpsecParameters(string, string, VpnClientIPsecParameters, VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams)	Set VpnclientIpsecParameters 操作通过网络资源提供程序为指定资源组中虚拟网络网关的 P2S 客户端设置 vpnclient ipsec 策略。
beginSetVpnclientIpsecParametersAndWait(string, string, VpnClientIPsecParameters, VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams)	Set VpnclientIpsecParameters 操作通过网络资源提供程序为指定资源组中虚拟网络网关的 P2S 客户端设置 vpnclient ipsec 策略。
beginStartExpressRouteSiteFailoverSimulation(string, string, string, VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams)	此操作在网关上为指定的对等互连位置启动故障转移模拟
beginStartExpressRouteSiteFailoverSimulationAndWait(string, string, string, VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams)	此操作在网关上为指定的对等互连位置启动故障转移模拟
beginStartPacketCapture(string, string, VirtualNetworkGatewaysStartPacketCaptureOptionalParams)	在指定的资源组中的虚拟网络网关上启动数据包捕获。
beginStartPacketCaptureAndWait(string, string, VirtualNetworkGatewaysStartPacketCaptureOptionalParams)	在指定的资源组中的虚拟网络网关上启动数据包捕获。
beginStopExpressRouteSiteFailoverSimulation(string, string, ExpressRouteFailoverStopApiParameters, VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams)	此操作在网关上停止指定对等互连位置的故障转移模拟
beginStopExpressRouteSiteFailoverSimulationAndWait(string, string, ExpressRouteFailoverStopApiParameters, VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams)	此操作在网关上停止指定对等互连位置的故障转移模拟
beginStopPacketCapture(string, string, VpnPacketCaptureStopParameters, VirtualNetworkGatewaysStopPacketCaptureOptionalParams)	停止在指定资源组中的虚拟网络网关上捕获数据包。
beginStopPacketCaptureAndWait(string, string, VpnPacketCaptureStopParameters, VirtualNetworkGatewaysStopPacketCaptureOptionalParams)	停止在指定资源组中的虚拟网络网关上捕获数据包。
beginUpdateTags(string, string, TagsObject, VirtualNetworkGatewaysUpdateTagsOptionalParams)	更新虚拟网络网关标记。
beginUpdateTagsAndWait(string, string, TagsObject, VirtualNetworkGatewaysUpdateTagsOptionalParams)	更新虚拟网络网关标记。
get(string, string, VirtualNetworkGatewaysGetOptionalParams)	按资源组获取指定的虚拟网络网关。
list(string, VirtualNetworkGatewaysListOptionalParams)	按资源组获取所有虚拟网络网关。
listConnections(string, string, VirtualNetworkGatewaysListConnectionsOptionalParams)	获取虚拟网络网关中的所有连接。
listRadiusSecrets(string, string, VirtualNetworkGatewaysListRadiusSecretsOptionalParams)	列出所有 Radius 服务器，其中包含来自虚拟网络网关 VpnClientConfiguration 的相应 RADIUS 机密。
supportedVpnDevices(string, string, VirtualNetworkGatewaysSupportedVpnDevicesOptionalParams)	获取支持的 VPN 设备的 xml 格式表示形式。
vpnDeviceConfigurationScript(string, string, VpnDeviceScriptParameters, VirtualNetworkGatewaysVpnDeviceConfigurationScriptOptionalParams)	获取 vpn 设备配置脚本的 xml 格式表示形式。

方法详细信息

beginCreateOrUpdate(string, string, VirtualNetworkGateway, VirtualNetworkGatewaysCreateOrUpdateOptionalParams)

在指定的资源组中创建或更新虚拟网络网关。

function beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: VirtualNetworkGatewaysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

parameters: VirtualNetworkGateway

提供用于创建或更新虚拟网络网关操作的参数。

options: VirtualNetworkGatewaysCreateOrUpdateOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>

beginCreateOrUpdateAndWait(string, string, VirtualNetworkGateway, VirtualNetworkGatewaysCreateOrUpdateOptionalParams)

在指定的资源组中创建或更新虚拟网络网关。

function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: VirtualNetworkGatewaysCreateOrUpdateOptionalParams): Promise<VirtualNetworkGateway>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

parameters: VirtualNetworkGateway

提供用于创建或更新虚拟网络网关操作的参数。

options: VirtualNetworkGatewaysCreateOrUpdateOptionalParams

选项参数。

Promise<VirtualNetworkGateway>

beginDelete(string, string, VirtualNetworkGatewaysDeleteOptionalParams)

删除指定的虚拟网络网关。

function beginDelete(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysDeleteOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, VirtualNetworkGatewaysDeleteOptionalParams)

删除指定的虚拟网络网关。

function beginDeleteAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysDeleteOptionalParams): Promise<void>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysDeleteOptionalParams

选项参数。

Promise<void>

beginDisconnectVirtualNetworkGatewayVpnConnections(string, string, P2SVpnConnectionRequest, VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams)

断开指定资源组中虚拟网络网关的 VPN 连接。

function beginDisconnectVirtualNetworkGatewayVpnConnections(resourceGroupName: string, virtualNetworkGatewayName: string, request: P2SVpnConnectionRequest, options?: VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

request: P2SVpnConnectionRequest

这些参数用于断开 VPN 连接的连接。

options: VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDisconnectVirtualNetworkGatewayVpnConnectionsAndWait(string, string, P2SVpnConnectionRequest, VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams)

断开指定资源组中虚拟网络网关的 VPN 连接。

function beginDisconnectVirtualNetworkGatewayVpnConnectionsAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, request: P2SVpnConnectionRequest, options?: VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams): Promise<void>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

request: P2SVpnConnectionRequest

这些参数用于断开 VPN 连接的连接。

options: VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams

选项参数。

Promise<void>

beginGeneratevpnclientpackage(string, string, VpnClientParameters, VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams)

为指定资源组中虚拟网络网关的 P2S 客户端生成 VPN 客户端包。

function beginGeneratevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>, VirtualNetworkGatewaysGeneratevpnclientpackageResponse>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

parameters: VpnClientParameters

提供给生成的虚拟网络网关 VPN 客户端包操作的参数。

options: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>, VirtualNetworkGatewaysGeneratevpnclientpackageResponse>>

beginGeneratevpnclientpackageAndWait(string, string, VpnClientParameters, VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams)

为指定资源组中虚拟网络网关的 P2S 客户端生成 VPN 客户端包。

function beginGeneratevpnclientpackageAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams): Promise<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

parameters: VpnClientParameters

提供给生成的虚拟网络网关 VPN 客户端包操作的参数。

options: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams

选项参数。

Promise<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>

beginGenerateVpnProfile(string, string, VpnClientParameters, VirtualNetworkGatewaysGenerateVpnProfileOptionalParams)

为指定资源组中虚拟网络网关的 P2S 客户端生成 VPN 配置文件。用于 IKEV2 和基于半径的身份验证。

function beginGenerateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGenerateVpnProfileOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGenerateVpnProfileResponse>, VirtualNetworkGatewaysGenerateVpnProfileResponse>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

parameters: VpnClientParameters

提供给生成的虚拟网络网关 VPN 客户端包操作的参数。

options: VirtualNetworkGatewaysGenerateVpnProfileOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysGenerateVpnProfileResponse>, VirtualNetworkGatewaysGenerateVpnProfileResponse>>

beginGenerateVpnProfileAndWait(string, string, VpnClientParameters, VirtualNetworkGatewaysGenerateVpnProfileOptionalParams)

为指定资源组中虚拟网络网关的 P2S 客户端生成 VPN 配置文件。用于 IKEV2 和基于半径的身份验证。

function beginGenerateVpnProfileAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGenerateVpnProfileOptionalParams): Promise<VirtualNetworkGatewaysGenerateVpnProfileResponse>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

parameters: VpnClientParameters

提供给生成的虚拟网络网关 VPN 客户端包操作的参数。

options: VirtualNetworkGatewaysGenerateVpnProfileOptionalParams

选项参数。

Promise<VirtualNetworkGatewaysGenerateVpnProfileResponse>

beginGetAdvertisedRoutes(string, string, string, VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams)

此操作检索虚拟网络网关向指定对等方播发的路由列表。

function beginGetAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams): Promise<SimplePollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

peer: string

对等方的 IP 地址。

options: VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>>

beginGetAdvertisedRoutesAndWait(string, string, string, VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams)

此操作检索虚拟网络网关向指定对等方播发的路由列表。

function beginGetAdvertisedRoutesAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams): Promise<GatewayRouteListResult>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

peer: string

对等方的 IP 地址。

options: VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams

选项参数。

Promise<GatewayRouteListResult>

beginGetBgpPeerStatus(string, string, VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams)

GetBgpPeerStatus 操作检索所有 BGP 对等方的状态。

function beginGetBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams): Promise<SimplePollerLike<OperationState<BgpPeerStatusListResult>, BgpPeerStatusListResult>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<BgpPeerStatusListResult>, BgpPeerStatusListResult>>

beginGetBgpPeerStatusAndWait(string, string, VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams)

GetBgpPeerStatus 操作检索所有 BGP 对等方的状态。

function beginGetBgpPeerStatusAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams): Promise<BgpPeerStatusListResult>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams

选项参数。

Promise<BgpPeerStatusListResult>

beginGetFailoverAllTestDetails(string, string, string, boolean, VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams)

此操作检索针对不同对等互连位置在网关上执行的所有故障转移测试的详细信息

function beginGetFailoverAllTestDetails(resourceGroupName: string, virtualNetworkGatewayName: string, typeParam: string, fetchLatest: boolean, options?: VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGetFailoverAllTestDetailsResponse>, VirtualNetworkGatewaysGetFailoverAllTestDetailsResponse>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

typeParam: string

故障转移测试的类型

fetchLatest: boolean

仅提取每个对等互连位置的最新测试

options: VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysGetFailoverAllTestDetailsResponse>, VirtualNetworkGatewaysGetFailoverAllTestDetailsResponse>>

beginGetFailoverAllTestDetailsAndWait(string, string, string, boolean, VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams)

此操作检索针对不同对等互连位置在网关上执行的所有故障转移测试的详细信息

function beginGetFailoverAllTestDetailsAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, typeParam: string, fetchLatest: boolean, options?: VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams): Promise<VirtualNetworkGatewaysGetFailoverAllTestDetailsResponse>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

typeParam: string

故障转移测试的类型

fetchLatest: boolean

仅提取每个对等互连位置的最新测试

options: VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams

选项参数。

Promise<VirtualNetworkGatewaysGetFailoverAllTestDetailsResponse>

beginGetFailoverSingleTestDetails(string, string, string, string, VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams)

此操作根据测试 Guid 检索在网关上执行的特定故障转移测试的详细信息

function beginGetFailoverSingleTestDetails(resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, failoverTestId: string, options?: VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGetFailoverSingleTestDetailsResponse>, VirtualNetworkGatewaysGetFailoverSingleTestDetailsResponse>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

peeringLocation: string

测试的对等互连位置

failoverTestId: string

标识测试的唯一 Guid 值

options: VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysGetFailoverSingleTestDetailsResponse>, VirtualNetworkGatewaysGetFailoverSingleTestDetailsResponse>>

beginGetFailoverSingleTestDetailsAndWait(string, string, string, string, VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams)

此操作根据测试 Guid 检索在网关上执行的特定故障转移测试的详细信息

function beginGetFailoverSingleTestDetailsAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, failoverTestId: string, options?: VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams): Promise<VirtualNetworkGatewaysGetFailoverSingleTestDetailsResponse>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

peeringLocation: string

测试的对等互连位置

failoverTestId: string

标识测试的唯一 Guid 值

options: VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams

选项参数。

Promise<VirtualNetworkGatewaysGetFailoverSingleTestDetailsResponse>

beginGetLearnedRoutes(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)

此操作检索虚拟网络网关已学习的路由列表，包括从 BGP 对等方学习的路由。

function beginGetLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams): Promise<SimplePollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>>

beginGetLearnedRoutesAndWait(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)

此操作检索虚拟网络网关已学习的路由列表，包括从 BGP 对等方学习的路由。

function beginGetLearnedRoutesAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams): Promise<GatewayRouteListResult>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams

选项参数。

Promise<GatewayRouteListResult>

beginGetResiliencyInformation(string, string, VirtualNetworkGatewaysGetResiliencyInformationOptionalParams)

此作检索 Express Route 网关的弹性信息，包括网关的当前弹性分数和进一步提高分数的建议

function beginGetResiliencyInformation(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetResiliencyInformationOptionalParams): Promise<SimplePollerLike<OperationState<GatewayResiliencyInformation>, GatewayResiliencyInformation>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysGetResiliencyInformationOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<GatewayResiliencyInformation>, GatewayResiliencyInformation>>

beginGetResiliencyInformationAndWait(string, string, VirtualNetworkGatewaysGetResiliencyInformationOptionalParams)

此作检索 Express Route 网关的弹性信息，包括网关的当前弹性分数和进一步提高分数的建议

function beginGetResiliencyInformationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetResiliencyInformationOptionalParams): Promise<GatewayResiliencyInformation>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysGetResiliencyInformationOptionalParams

选项参数。

Promise<GatewayResiliencyInformation>

beginGetRoutesInformation(string, string, VirtualNetworkGatewaysGetRoutesInformationOptionalParams)

此作根据 Express Route 网关的弹性检索路由集信息

function beginGetRoutesInformation(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetRoutesInformationOptionalParams): Promise<SimplePollerLike<OperationState<GatewayRouteSetsInformation>, GatewayRouteSetsInformation>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysGetRoutesInformationOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<GatewayRouteSetsInformation>, GatewayRouteSetsInformation>>

beginGetRoutesInformationAndWait(string, string, VirtualNetworkGatewaysGetRoutesInformationOptionalParams)

此作根据 Express Route 网关的弹性检索路由集信息

function beginGetRoutesInformationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetRoutesInformationOptionalParams): Promise<GatewayRouteSetsInformation>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysGetRoutesInformationOptionalParams

选项参数。

Promise<GatewayRouteSetsInformation>

beginGetVpnclientConnectionHealth(string, string, VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams)

获取指定资源组中虚拟网络网关的每个 P2S 客户端连接的 VPN 客户端连接运行状况详细信息。

function beginGetVpnclientConnectionHealth(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams): Promise<SimplePollerLike<OperationState<VpnClientConnectionHealthDetailListResult>, VpnClientConnectionHealthDetailListResult>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VpnClientConnectionHealthDetailListResult>, VpnClientConnectionHealthDetailListResult>>

beginGetVpnclientConnectionHealthAndWait(string, string, VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams)

获取指定资源组中虚拟网络网关的每个 P2S 客户端连接的 VPN 客户端连接运行状况详细信息。

function beginGetVpnclientConnectionHealthAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams): Promise<VpnClientConnectionHealthDetailListResult>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams

选项参数。

Promise<VpnClientConnectionHealthDetailListResult>

beginGetVpnclientIpsecParameters(string, string, VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams)

获取 VpnclientIpsecParameters 操作通过网络资源提供程序检索指定资源组中虚拟网络网关 P2S 客户端的 vpnclient ipsec 策略的相关信息。

function beginGetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams): Promise<SimplePollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关名称。

options: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>

beginGetVpnclientIpsecParametersAndWait(string, string, VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams)

获取 VpnclientIpsecParameters 操作通过网络资源提供程序检索指定资源组中虚拟网络网关 P2S 客户端的 vpnclient ipsec 策略的相关信息。

function beginGetVpnclientIpsecParametersAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams): Promise<VpnClientIPsecParameters>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关名称。

options: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams

选项参数。

Promise<VpnClientIPsecParameters>

beginGetVpnProfilePackageUrl(string, string, VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams)

获取指定资源组中虚拟网络网关的 P2S 客户端的预生成的 VPN 配置文件。首先需要使用 generateVpnProfile 生成配置文件。

function beginGetVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>, VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>, VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>>

beginGetVpnProfilePackageUrlAndWait(string, string, VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams)

获取指定资源组中虚拟网络网关的 P2S 客户端的预生成的 VPN 配置文件。首先需要使用 generateVpnProfile 生成配置文件。

function beginGetVpnProfilePackageUrlAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams): Promise<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams

选项参数。

Promise<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>

beginInvokeAbortMigration(string, string, VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams)

触发虚拟网络网关的中止迁移。

function beginInvokeAbortMigration(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokeAbortMigrationHeaders>, VirtualNetworkGatewaysInvokeAbortMigrationHeaders>>

参数

resourceGroupName: string

虚拟网络网关的资源组名称。

virtualNetworkGatewayName: string

网关的名称。

options: VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokeAbortMigrationHeaders>, VirtualNetworkGatewaysInvokeAbortMigrationHeaders>>

beginInvokeAbortMigrationAndWait(string, string, VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams)

触发虚拟网络网关的中止迁移。

function beginInvokeAbortMigrationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams): Promise<VirtualNetworkGatewaysInvokeAbortMigrationHeaders>

参数

resourceGroupName: string

虚拟网络网关的资源组名称。

virtualNetworkGatewayName: string

网关的名称。

options: VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams

选项参数。

Promise<VirtualNetworkGatewaysInvokeAbortMigrationHeaders>

beginInvokeCommitMigration(string, string, VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams)

触发虚拟网络网关的提交迁移。

function beginInvokeCommitMigration(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokeCommitMigrationHeaders>, VirtualNetworkGatewaysInvokeCommitMigrationHeaders>>

参数

resourceGroupName: string

虚拟网络网关的资源组名称。

virtualNetworkGatewayName: string

网关的名称。

options: VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokeCommitMigrationHeaders>, VirtualNetworkGatewaysInvokeCommitMigrationHeaders>>

beginInvokeCommitMigrationAndWait(string, string, VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams)

触发虚拟网络网关的提交迁移。

function beginInvokeCommitMigrationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams): Promise<VirtualNetworkGatewaysInvokeCommitMigrationHeaders>

参数

resourceGroupName: string

虚拟网络网关的资源组名称。

virtualNetworkGatewayName: string

网关的名称。

options: VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams

选项参数。

Promise<VirtualNetworkGatewaysInvokeCommitMigrationHeaders>

beginInvokeExecuteMigration(string, string, VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams)

触发虚拟网络网关的执行迁移。

function beginInvokeExecuteMigration(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokeExecuteMigrationHeaders>, VirtualNetworkGatewaysInvokeExecuteMigrationHeaders>>

参数

resourceGroupName: string

虚拟网络网关的资源组名称。

virtualNetworkGatewayName: string

网关的名称。

options: VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokeExecuteMigrationHeaders>, VirtualNetworkGatewaysInvokeExecuteMigrationHeaders>>

beginInvokeExecuteMigrationAndWait(string, string, VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams)

触发虚拟网络网关的执行迁移。

function beginInvokeExecuteMigrationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams): Promise<VirtualNetworkGatewaysInvokeExecuteMigrationHeaders>

参数

resourceGroupName: string

虚拟网络网关的资源组名称。

virtualNetworkGatewayName: string

网关的名称。

options: VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams

选项参数。

Promise<VirtualNetworkGatewaysInvokeExecuteMigrationHeaders>

beginInvokePrepareMigration(string, string, VirtualNetworkGatewayMigrationParameters, VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams)

触发 Virtual Network Gateway 的准备迁移。

function beginInvokePrepareMigration(resourceGroupName: string, virtualNetworkGatewayName: string, migrationParams: VirtualNetworkGatewayMigrationParameters, options?: VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokePrepareMigrationHeaders>, VirtualNetworkGatewaysInvokePrepareMigrationHeaders>>

参数

resourceGroupName: string

虚拟网络网关的资源组名称。

virtualNetworkGatewayName: string

网关的名称。

migrationParams: VirtualNetworkGatewayMigrationParameters

通过网络资源提供程序提供给 Begin Prepare migration on basic vpn gateway（在基本 VPN 网关上开始准备迁移）的参数。

options: VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokePrepareMigrationHeaders>, VirtualNetworkGatewaysInvokePrepareMigrationHeaders>>

beginInvokePrepareMigrationAndWait(string, string, VirtualNetworkGatewayMigrationParameters, VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams)

触发 Virtual Network Gateway 的准备迁移。

function beginInvokePrepareMigrationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, migrationParams: VirtualNetworkGatewayMigrationParameters, options?: VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams): Promise<VirtualNetworkGatewaysInvokePrepareMigrationHeaders>

参数

resourceGroupName: string

虚拟网络网关的资源组名称。

virtualNetworkGatewayName: string

网关的名称。

migrationParams: VirtualNetworkGatewayMigrationParameters

通过网络资源提供程序提供给 Begin Prepare migration on basic vpn gateway（在基本 VPN 网关上开始准备迁移）的参数。

options: VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams

选项参数。

Promise<VirtualNetworkGatewaysInvokePrepareMigrationHeaders>

beginReset(string, string, VirtualNetworkGatewaysResetOptionalParams)

重置指定资源组中虚拟网络网关的主网关。

function beginReset(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysResetOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>

beginResetAndWait(string, string, VirtualNetworkGatewaysResetOptionalParams)

重置指定资源组中虚拟网络网关的主网关。

function beginResetAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetOptionalParams): Promise<VirtualNetworkGateway>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysResetOptionalParams

选项参数。

Promise<VirtualNetworkGateway>

beginResetVpnClientSharedKey(string, string, VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams)

重置指定资源组中虚拟网络网关的 VPN 客户端共享密钥。

function beginResetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginResetVpnClientSharedKeyAndWait(string, string, VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams)

重置指定资源组中虚拟网络网关的 VPN 客户端共享密钥。

function beginResetVpnClientSharedKeyAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams): Promise<void>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams

选项参数。

Promise<void>

beginSetVpnclientIpsecParameters(string, string, VpnClientIPsecParameters, VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams)

Set VpnclientIpsecParameters 操作通过网络资源提供程序为指定资源组中虚拟网络网关的 P2S 客户端设置 vpnclient ipsec 策略。

function beginSetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: VpnClientIPsecParameters, options?: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams): Promise<SimplePollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

vpnclientIpsecParams: VpnClientIPsecParameters

通过网络资源提供程序提供给虚拟网络网关 P2S 客户端操作的 Begin Set vpnclient ipsec 参数的参数。

options: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>

beginSetVpnclientIpsecParametersAndWait(string, string, VpnClientIPsecParameters, VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams)

Set VpnclientIpsecParameters 操作通过网络资源提供程序为指定资源组中虚拟网络网关的 P2S 客户端设置 vpnclient ipsec 策略。

function beginSetVpnclientIpsecParametersAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: VpnClientIPsecParameters, options?: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams): Promise<VpnClientIPsecParameters>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

vpnclientIpsecParams: VpnClientIPsecParameters

通过网络资源提供程序提供给虚拟网络网关 P2S 客户端操作的 Begin Set vpnclient ipsec 参数的参数。

options: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams

选项参数。

Promise<VpnClientIPsecParameters>

beginStartExpressRouteSiteFailoverSimulation(string, string, string, VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams)

此操作在网关上为指定的对等互连位置启动故障转移模拟

function beginStartExpressRouteSiteFailoverSimulation(resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, options?: VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

peeringLocation: string

测试的对等互连位置

options: VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>>

beginStartExpressRouteSiteFailoverSimulationAndWait(string, string, string, VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams)

此操作在网关上为指定的对等互连位置启动故障转移模拟

function beginStartExpressRouteSiteFailoverSimulationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, options?: VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams): Promise<VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

peeringLocation: string

测试的对等互连位置

options: VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams

选项参数。

Promise<VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>

beginStartPacketCapture(string, string, VirtualNetworkGatewaysStartPacketCaptureOptionalParams)

在指定的资源组中的虚拟网络网关上启动数据包捕获。

function beginStartPacketCapture(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysStartPacketCaptureOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStartPacketCaptureResponse>, VirtualNetworkGatewaysStartPacketCaptureResponse>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysStartPacketCaptureOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysStartPacketCaptureResponse>, VirtualNetworkGatewaysStartPacketCaptureResponse>>

beginStartPacketCaptureAndWait(string, string, VirtualNetworkGatewaysStartPacketCaptureOptionalParams)

在指定的资源组中的虚拟网络网关上启动数据包捕获。

function beginStartPacketCaptureAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysStartPacketCaptureOptionalParams): Promise<VirtualNetworkGatewaysStartPacketCaptureResponse>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysStartPacketCaptureOptionalParams

选项参数。

Promise<VirtualNetworkGatewaysStartPacketCaptureResponse>

beginStopExpressRouteSiteFailoverSimulation(string, string, ExpressRouteFailoverStopApiParameters, VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams)

此操作在网关上停止指定对等互连位置的故障转移模拟

function beginStopExpressRouteSiteFailoverSimulation(resourceGroupName: string, virtualNetworkGatewayName: string, stopParameters: ExpressRouteFailoverStopApiParameters, options?: VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

stopParameters: ExpressRouteFailoverStopApiParameters

虚拟网络网关停止提供的模拟参数，用于停止网关上的故障转移模拟。

options: VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>>

beginStopExpressRouteSiteFailoverSimulationAndWait(string, string, ExpressRouteFailoverStopApiParameters, VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams)

此操作在网关上停止指定对等互连位置的故障转移模拟

function beginStopExpressRouteSiteFailoverSimulationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, stopParameters: ExpressRouteFailoverStopApiParameters, options?: VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams): Promise<VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

stopParameters: ExpressRouteFailoverStopApiParameters

虚拟网络网关停止提供的模拟参数，用于停止网关上的故障转移模拟。

options: VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams

选项参数。

Promise<VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>

beginStopPacketCapture(string, string, VpnPacketCaptureStopParameters, VirtualNetworkGatewaysStopPacketCaptureOptionalParams)

停止在指定资源组中的虚拟网络网关上捕获数据包。

function beginStopPacketCapture(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewaysStopPacketCaptureOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStopPacketCaptureResponse>, VirtualNetworkGatewaysStopPacketCaptureResponse>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

parameters: VpnPacketCaptureStopParameters

提供的虚拟网络网关数据包捕获参数，用于停止网关上的数据包捕获。

options: VirtualNetworkGatewaysStopPacketCaptureOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysStopPacketCaptureResponse>, VirtualNetworkGatewaysStopPacketCaptureResponse>>

beginStopPacketCaptureAndWait(string, string, VpnPacketCaptureStopParameters, VirtualNetworkGatewaysStopPacketCaptureOptionalParams)

停止在指定资源组中的虚拟网络网关上捕获数据包。

function beginStopPacketCaptureAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewaysStopPacketCaptureOptionalParams): Promise<VirtualNetworkGatewaysStopPacketCaptureResponse>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

parameters: VpnPacketCaptureStopParameters

提供的虚拟网络网关数据包捕获参数，用于停止网关上的数据包捕获。

options: VirtualNetworkGatewaysStopPacketCaptureOptionalParams

选项参数。

Promise<VirtualNetworkGatewaysStopPacketCaptureResponse>

beginUpdateTags(string, string, TagsObject, VirtualNetworkGatewaysUpdateTagsOptionalParams)

更新虚拟网络网关标记。

function beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: VirtualNetworkGatewaysUpdateTagsOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

parameters: TagsObject

提供用于更新虚拟网络网关标记的参数。

options: VirtualNetworkGatewaysUpdateTagsOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>

beginUpdateTagsAndWait(string, string, TagsObject, VirtualNetworkGatewaysUpdateTagsOptionalParams)

更新虚拟网络网关标记。

function beginUpdateTagsAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: VirtualNetworkGatewaysUpdateTagsOptionalParams): Promise<VirtualNetworkGateway>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

parameters: TagsObject

提供用于更新虚拟网络网关标记的参数。

options: VirtualNetworkGatewaysUpdateTagsOptionalParams

选项参数。

Promise<VirtualNetworkGateway>

get(string, string, VirtualNetworkGatewaysGetOptionalParams)

按资源组获取指定的虚拟网络网关。

function get(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetOptionalParams): Promise<VirtualNetworkGateway>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysGetOptionalParams

选项参数。

Promise<VirtualNetworkGateway>

list(string, VirtualNetworkGatewaysListOptionalParams)

按资源组获取所有虚拟网络网关。

function list(resourceGroupName: string, options?: VirtualNetworkGatewaysListOptionalParams): PagedAsyncIterableIterator<VirtualNetworkGateway, VirtualNetworkGateway[], PageSettings>

参数

resourceGroupName: string

资源组的名称。

options: VirtualNetworkGatewaysListOptionalParams

选项参数。

PagedAsyncIterableIterator<VirtualNetworkGateway, VirtualNetworkGateway[], PageSettings>

listConnections(string, string, VirtualNetworkGatewaysListConnectionsOptionalParams)

获取虚拟网络网关中的所有连接。

function listConnections(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysListConnectionsOptionalParams): PagedAsyncIterableIterator<VirtualNetworkGatewayConnectionListEntity, VirtualNetworkGatewayConnectionListEntity[], PageSettings>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysListConnectionsOptionalParams

选项参数。

PagedAsyncIterableIterator<VirtualNetworkGatewayConnectionListEntity, VirtualNetworkGatewayConnectionListEntity[], PageSettings>

listRadiusSecrets(string, string, VirtualNetworkGatewaysListRadiusSecretsOptionalParams)

列出所有 Radius 服务器，其中包含来自虚拟网络网关 VpnClientConfiguration 的相应 RADIUS 机密。

function listRadiusSecrets(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysListRadiusSecretsOptionalParams): Promise<RadiusAuthServerListResult>

参数

resourceGroupName: string

资源组的名称。此名称不区分大小写。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysListRadiusSecretsOptionalParams

选项参数。

Promise<RadiusAuthServerListResult>

supportedVpnDevices(string, string, VirtualNetworkGatewaysSupportedVpnDevicesOptionalParams)

获取支持的 VPN 设备的 xml 格式表示形式。

function supportedVpnDevices(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysSupportedVpnDevicesOptionalParams): Promise<VirtualNetworkGatewaysSupportedVpnDevicesResponse>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayName: string

虚拟网络网关的名称。

options: VirtualNetworkGatewaysSupportedVpnDevicesOptionalParams

选项参数。

Promise<VirtualNetworkGatewaysSupportedVpnDevicesResponse>

vpnDeviceConfigurationScript(string, string, VpnDeviceScriptParameters, VirtualNetworkGatewaysVpnDeviceConfigurationScriptOptionalParams)

获取 vpn 设备配置脚本的 xml 格式表示形式。

function vpnDeviceConfigurationScript(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VpnDeviceScriptParameters, options?: VirtualNetworkGatewaysVpnDeviceConfigurationScriptOptionalParams): Promise<VirtualNetworkGatewaysVpnDeviceConfigurationScriptResponse>

参数

resourceGroupName: string

资源组的名称。

virtualNetworkGatewayConnectionName: string

为其生成配置脚本的虚拟网络网关连接的名称。

parameters: VpnDeviceScriptParameters

提供给生成的 VPN 设备脚本操作的参数。

options: VirtualNetworkGatewaysVpnDeviceConfigurationScriptOptionalParams

选项参数。

Promise<VirtualNetworkGatewaysVpnDeviceConfigurationScriptResponse>

通过

VirtualNetworkGateways interface

方法

方法详细信息

beginCreateOrUpdate(string, string, VirtualNetworkGateway, VirtualNetworkGatewaysCreateOrUpdateOptionalParams)

参数

返回

beginCreateOrUpdateAndWait(string, string, VirtualNetworkGateway, VirtualNetworkGatewaysCreateOrUpdateOptionalParams)

参数

返回

beginDelete(string, string, VirtualNetworkGatewaysDeleteOptionalParams)

参数

返回

beginDeleteAndWait(string, string, VirtualNetworkGatewaysDeleteOptionalParams)

参数

返回

beginDisconnectVirtualNetworkGatewayVpnConnections(string, string, P2SVpnConnectionRequest, VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams)

参数

返回

beginDisconnectVirtualNetworkGatewayVpnConnectionsAndWait(string, string, P2SVpnConnectionRequest, VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams)

参数

返回

beginGeneratevpnclientpackage(string, string, VpnClientParameters, VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams)

参数

返回

beginGeneratevpnclientpackageAndWait(string, string, VpnClientParameters, VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams)

参数

返回

beginGenerateVpnProfile(string, string, VpnClientParameters, VirtualNetworkGatewaysGenerateVpnProfileOptionalParams)

参数

返回

beginGenerateVpnProfileAndWait(string, string, VpnClientParameters, VirtualNetworkGatewaysGenerateVpnProfileOptionalParams)

参数

返回

beginGetAdvertisedRoutes(string, string, string, VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams)

参数

返回

beginGetAdvertisedRoutesAndWait(string, string, string, VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams)

参数

返回

beginGetBgpPeerStatus(string, string, VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams)

参数

返回

beginGetBgpPeerStatusAndWait(string, string, VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams)

参数

返回

beginGetFailoverAllTestDetails(string, string, string, boolean, VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams)

参数

返回

beginGetFailoverAllTestDetailsAndWait(string, string, string, boolean, VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams)

参数

返回

beginGetFailoverSingleTestDetails(string, string, string, string, VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams)

参数

返回

beginGetFailoverSingleTestDetailsAndWait(string, string, string, string, VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams)

参数

返回

beginGetLearnedRoutes(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)

参数

返回

beginGetLearnedRoutesAndWait(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)

参数

返回

beginGetResiliencyInformation(string, string, VirtualNetworkGatewaysGetResiliencyInformationOptionalParams)

参数

返回

beginGetResiliencyInformationAndWait(string, string, VirtualNetworkGatewaysGetResiliencyInformationOptionalParams)

参数

返回

beginGetRoutesInformation(string, string, VirtualNetworkGatewaysGetRoutesInformationOptionalParams)

参数

返回

beginGetRoutesInformationAndWait(string, string, VirtualNetworkGatewaysGetRoutesInformationOptionalParams)

参数

返回

beginGetVpnclientConnectionHealth(string, string, VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams)

参数

返回

beginGetVpnclientConnectionHealthAndWait(string, string, VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams)