你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
VirtualNetworkGateways interface
表示 VirtualNetworkGateways 的接口。
方法
方法详细信息
beginCreateOrUpdate(string, string, VirtualNetworkGateway, VirtualNetworkGatewaysCreateOrUpdateOptionalParams)
创建或更新指定资源组中的虚拟网络网关。
function beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: VirtualNetworkGatewaysCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
- parameters
- VirtualNetworkGateway
提供用于创建或更新虚拟网络网关操作的参数。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<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
提供用于创建或更新虚拟网络网关操作的参数。
选项参数。
返回
Promise<VirtualNetworkGateway>
beginDelete(string, string, VirtualNetworkGatewaysDeleteOptionalParams)
删除指定的虚拟网络网关。
function beginDelete(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, VirtualNetworkGatewaysDeleteOptionalParams)
删除指定的虚拟网络网关。
function beginDeleteAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
选项参数。
返回
Promise<void>
beginGeneratevpnclientpackage(string, string, VpnClientParameters, VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams)
为指定资源组中虚拟网络网关的 P2S 客户端生成 VPN 客户端包。
function beginGeneratevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams): Promise<PollerLike<PollOperationState<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>, VirtualNetworkGatewaysGeneratevpnclientpackageResponse>>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
- parameters
- VpnClientParameters
提供给生成虚拟网络网关 VPN 客户端包操作的参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<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 客户端包操作的参数。
返回
beginGenerateVpnProfile(string, string, VpnClientParameters, VirtualNetworkGatewaysGenerateVpnProfileOptionalParams)
为指定资源组中虚拟网络网关的 P2S 客户端生成 VPN 配置文件。 用于基于 IKEV2 和半径的身份验证。
function beginGenerateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGenerateVpnProfileOptionalParams): Promise<PollerLike<PollOperationState<VirtualNetworkGatewaysGenerateVpnProfileResponse>, VirtualNetworkGatewaysGenerateVpnProfileResponse>>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
- parameters
- VpnClientParameters
提供给生成虚拟网络网关 VPN 客户端包操作的参数。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<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 客户端包操作的参数。
选项参数。
返回
beginGetAdvertisedRoutes(string, string, string, VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams)
此操作检索虚拟网络网关播发到指定对等方的路由列表。
function beginGetAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams): Promise<PollerLike<PollOperationState<GatewayRouteListResult>, GatewayRouteListResult>>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
- peer
-
string
对等方的 IP 地址
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<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 地址
选项参数。
返回
Promise<GatewayRouteListResult>
beginGetBgpPeerStatus(string, string, VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams)
GetBgpPeerStatus 操作检索所有 BGP 对等方的状态。
function beginGetBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams): Promise<PollerLike<PollOperationState<BgpPeerStatusListResult>, BgpPeerStatusListResult>>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<BgpPeerStatusListResult>, BgpPeerStatusListResult>>
beginGetBgpPeerStatusAndWait(string, string, VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams)
GetBgpPeerStatus 操作检索所有 BGP 对等方的状态。
function beginGetBgpPeerStatusAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams): Promise<BgpPeerStatusListResult>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
选项参数。
返回
Promise<BgpPeerStatusListResult>
beginGetLearnedRoutes(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)
此操作检索虚拟网络网关已学习的路由列表，包括从 BGP 对等方学习的路由。
function beginGetLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams): Promise<PollerLike<PollOperationState<GatewayRouteListResult>, GatewayRouteListResult>>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<GatewayRouteListResult>, GatewayRouteListResult>>
beginGetLearnedRoutesAndWait(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)
此操作检索虚拟网络网关已学习的路由列表，包括从 BGP 对等方学习的路由。
function beginGetLearnedRoutesAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams): Promise<GatewayRouteListResult>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
选项参数。
返回
Promise<GatewayRouteListResult>
beginGetVpnclientIpsecParameters(string, string, VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams)
获取 VpnclientIpsecParameters 操作通过网络资源提供程序检索有关指定资源组中虚拟网络网关 P2S 客户端的 vpnclient ipsec 策略的信息。
function beginGetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams): Promise<PollerLike<PollOperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关名称。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>
beginGetVpnclientIpsecParametersAndWait(string, string, VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams)
获取 VpnclientIpsecParameters 操作通过网络资源提供程序检索有关指定资源组中虚拟网络网关 P2S 客户端的 vpnclient ipsec 策略的信息。
function beginGetVpnclientIpsecParametersAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams): Promise<VpnClientIPsecParameters>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关名称。
返回
Promise<VpnClientIPsecParameters>
beginGetVpnProfilePackageUrl(string, string, VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams)
获取指定资源组中虚拟网络网关的 P2S 客户端的预生成的 VPN 配置文件。 首先需要使用 generateVpnProfile 生成配置文件。
function beginGetVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams): Promise<PollerLike<PollOperationState<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>, VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>, VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>>
beginGetVpnProfilePackageUrlAndWait(string, string, VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams)
获取指定资源组中虚拟网络网关的 P2S 客户端的预生成的 VPN 配置文件。 首先需要使用 generateVpnProfile 生成配置文件。
function beginGetVpnProfilePackageUrlAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams): Promise<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
返回
beginReset(string, string, VirtualNetworkGatewaysResetOptionalParams)
重置指定资源组中虚拟网络网关的主网关。
function beginReset(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetOptionalParams): Promise<PollerLike<PollOperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>
beginResetAndWait(string, string, VirtualNetworkGatewaysResetOptionalParams)
重置指定资源组中虚拟网络网关的主网关。
function beginResetAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetOptionalParams): Promise<VirtualNetworkGateway>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
选项参数。
返回
Promise<VirtualNetworkGateway>
beginResetVpnClientSharedKey(string, string, VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams)
重置指定资源组中虚拟网络网关的 VPN 客户端共享密钥。
function beginResetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginResetVpnClientSharedKeyAndWait(string, string, VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams)
重置指定资源组中虚拟网络网关的 VPN 客户端共享密钥。
function beginResetVpnClientSharedKeyAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
返回
Promise<void>
beginSetVpnclientIpsecParameters(string, string, VpnClientIPsecParameters, VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams)
设置 VpnclientIpsecParameters 操作通过网络资源提供程序为指定资源组中虚拟网络网关的 P2S 客户端设置 vpnclient ipsec 策略。
function beginSetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: VpnClientIPsecParameters, options?: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams): Promise<PollerLike<PollOperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
- vpnclientIpsecParams
- VpnClientIPsecParameters
提供给通过网络资源提供程序虚拟网络网关 P2S 客户端操作的开始设置 vpnclient ipsec 参数的参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>
beginSetVpnclientIpsecParametersAndWait(string, string, VpnClientIPsecParameters, VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams)
设置 VpnclientIpsecParameters 操作通过网络资源提供程序为指定资源组中虚拟网络网关的 P2S 客户端设置 vpnclient ipsec 策略。
function beginSetVpnclientIpsecParametersAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: VpnClientIPsecParameters, options?: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams): Promise<VpnClientIPsecParameters>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
- vpnclientIpsecParams
- VpnClientIPsecParameters
提供给通过网络资源提供程序虚拟网络网关 P2S 客户端操作的开始设置 vpnclient ipsec 参数的参数。
返回
Promise<VpnClientIPsecParameters>
beginUpdateTags(string, string, TagsObject, VirtualNetworkGatewaysUpdateTagsOptionalParams)
汇报虚拟网络网关标记。
function beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: VirtualNetworkGatewaysUpdateTagsOptionalParams): Promise<PollerLike<PollOperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
- parameters
- TagsObject
提供用于更新虚拟网络网关标记的参数。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<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
提供用于更新虚拟网络网关标记的参数。
选项参数。
返回
Promise<VirtualNetworkGateway>
get(string, string, VirtualNetworkGatewaysGetOptionalParams)
按资源组获取指定的虚拟网络网关。
function get(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetOptionalParams): Promise<VirtualNetworkGateway>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
选项参数。
返回
Promise<VirtualNetworkGateway>
list(string, VirtualNetworkGatewaysListOptionalParams)
按资源组获取所有虚拟网络网关。
function list(resourceGroupName: string, options?: VirtualNetworkGatewaysListOptionalParams): PagedAsyncIterableIterator<VirtualNetworkGateway, VirtualNetworkGateway[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。
选项参数。
返回
listConnections(string, string, VirtualNetworkGatewaysListConnectionsOptionalParams)
获取虚拟网络网关中的所有连接。
function listConnections(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysListConnectionsOptionalParams): PagedAsyncIterableIterator<VirtualNetworkGatewayConnectionListEntity, VirtualNetworkGatewayConnectionListEntity[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
选项参数。
返回
supportedVpnDevices(string, string, VirtualNetworkGatewaysSupportedVpnDevicesOptionalParams)
获取支持的 vpn 设备的 xml 格式表示形式。
function supportedVpnDevices(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysSupportedVpnDevicesOptionalParams): Promise<VirtualNetworkGatewaysSupportedVpnDevicesResponse>参数
- resourceGroupName
-
string
资源组的名称。
- virtualNetworkGatewayName
-
string
虚拟网络网关的名称。
选项参数。
返回
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 设备脚本操作的参数。