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

Vpn Gateways - Reset

服务:

Virtual WAN

API 版本:

2024-05-01

重置指定资源组中 VPN 网关的主网关。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/reset?api-version=2024-05-01

具有可选参数:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/reset?ipConfigurationId={ipConfigurationId}&api-version=2024-05-01

URI 参数

名称	在	必需	类型	说明
gatewayName	path	True	string	网关的名称。
resourceGroupName	path	True	string	VpnGateway 的资源组名称。
subscriptionId	path	True	string	唯一标识 Azure 订阅Microsoft的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。
ipConfigurationId	query		string	用于指定网关实例的 VpnGateway ipConfigurationId。

响应

名称	类型	说明
200 OK	VpnGateway	请求成功。 该操作重置 VpnGateway 的主节点。
202 Accepted		接受且操作将以异步方式完成。
Other Status Codes	CloudError	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ResetVpnGateway

示例请求

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw/reset?api-version=2024-05-01

Java

/**
 * Samples for VpnGateways Reset.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayReset.json
     */
    /**
     * Sample code: ResetVpnGateway.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void resetVpnGateway(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnGateways().reset("rg1", "vpngw", null,
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python vpn_gateway_reset.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.vpn_gateways.begin_reset(
        resource_group_name="rg1",
        gateway_name="vpngw",
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayReset.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayReset.json
func ExampleVPNGatewaysClient_BeginReset() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVPNGatewaysClient().BeginReset(ctx, "rg1", "vpngw", &armnetwork.VPNGatewaysClientBeginResetOptions{IPConfigurationID: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VPNGateway = armnetwork.VPNGateway{
	// 	Name: to.Ptr("vpngw"),
	// 	Type: to.Ptr("Microsoft.Network/vpnGateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw"),
	// 	Location: to.Ptr("West US"),
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.VPNGatewayProperties{
	// 		BgpSettings: &armnetwork.BgpSettings{
	// 			Asn: to.Ptr[int64](65514),
	// 			BgpPeeringAddress: to.Ptr("10.0.1.30"),
	// 			BgpPeeringAddresses: []*armnetwork.IPConfigurationBgpPeeringAddress{
	// 				{
	// 					CustomBgpIPAddresses: []*string{
	// 						to.Ptr("169.254.21.5")},
	// 						DefaultBgpIPAddresses: []*string{
	// 							to.Ptr("10.30.0.4")},
	// 							IPConfigurationID: to.Ptr("Instance0"),
	// 							TunnelIPAddresses: []*string{
	// 								to.Ptr("104.208.48.178")},
	// 							},
	// 							{
	// 								CustomBgpIPAddresses: []*string{
	// 									to.Ptr("169.254.21.10")},
	// 									DefaultBgpIPAddresses: []*string{
	// 										to.Ptr("10.30.0.5")},
	// 										IPConfigurationID: to.Ptr("Instance1"),
	// 										TunnelIPAddresses: []*string{
	// 											to.Ptr("104.208.48.179")},
	// 									}},
	// 									PeerWeight: to.Ptr[int32](0),
	// 								},
	// 								Connections: []*armnetwork.VPNConnection{
	// 									{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw/vpnConnections/vpnConnection1"),
	// 										Name: to.Ptr("vpnConnection1"),
	// 										Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 										Properties: &armnetwork.VPNConnectionProperties{
	// 											ConnectionBandwidth: to.Ptr[int32](100),
	// 											ConnectionStatus: to.Ptr(armnetwork.VPNConnectionStatusConnected),
	// 											EgressBytesTransferred: to.Ptr[int64](0),
	// 											EnableBgp: to.Ptr(false),
	// 											IngressBytesTransferred: to.Ptr[int64](0),
	// 											IPSecPolicies: []*armnetwork.IPSecPolicy{
	// 											},
	// 											ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 											RemoteVPNSite: &armnetwork.SubResource{
	// 												ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"),
	// 											},
	// 											RoutingConfiguration: &armnetwork.RoutingConfiguration{
	// 												AssociatedRouteTable: &armnetwork.SubResource{
	// 													ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"),
	// 												},
	// 												PropagatedRouteTables: &armnetwork.PropagatedRouteTable{
	// 													IDs: []*armnetwork.SubResource{
	// 														{
	// 															ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"),
	// 														},
	// 														{
	// 															ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2"),
	// 														},
	// 														{
	// 															ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3"),
	// 													}},
	// 													Labels: []*string{
	// 														to.Ptr("label1"),
	// 														to.Ptr("label2")},
	// 													},
	// 													VnetRoutes: &armnetwork.VnetRoute{
	// 														StaticRoutes: []*armnetwork.StaticRoute{
	// 														},
	// 													},
	// 												},
	// 												RoutingWeight: to.Ptr[int32](0),
	// 												SharedKey: to.Ptr("key"),
	// 												UseLocalAzureIPAddress: to.Ptr(false),
	// 											},
	// 									}},
	// 									EnableBgpRouteTranslationForNat: to.Ptr(false),
	// 									IsRoutingPreferenceInternet: to.Ptr(false),
	// 									NatRules: []*armnetwork.VPNGatewayNatRule{
	// 									},
	// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 									VirtualHub: &armnetwork.SubResource{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"),
	// 									},
	// 								},
	// 							}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Resets the primary of the vpn gateway in the specified resource group.
 *
 * @summary Resets the primary of the vpn gateway in the specified resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayReset.json
 */
async function resetVpnGateway() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const gatewayName = "vpngw";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.vpnGateways.beginResetAndWait(resourceGroupName, gatewayName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayReset.json
// this example is just showing the usage of "VpnGateways_Reset" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VpnGatewayResource created on azure
// for more information of creating VpnGatewayResource, please refer to the document of VpnGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string gatewayName = "vpngw";
ResourceIdentifier vpnGatewayResourceId = VpnGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, gatewayName);
VpnGatewayResource vpnGateway = client.GetVpnGatewayResource(vpnGatewayResourceId);

// invoke the operation
ArmOperation<VpnGatewayResource> lro = await vpnGateway.ResetAsync(WaitUntil.Completed);
VpnGatewayResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
VpnGatewayData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

202

location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}

状态代码:

200

{
  "name": "vpngw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "type": "Microsoft.Network/vpnGateways",
  "properties": {
    "provisioningState": "Succeeded",
    "virtualHub": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
    },
    "connections": [
      {
        "name": "vpnConnection1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw/vpnConnections/vpnConnection1",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "properties": {
          "provisioningState": "Succeeded",
          "remoteVpnSite": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
          },
          "connectionStatus": "Connected",
          "ingressBytesTransferred": 0,
          "egressBytesTransferred": 0,
          "routingWeight": 0,
          "connectionBandwidth": 100,
          "sharedKey": "key",
          "enableBgp": false,
          "useLocalAzureIpAddress": false,
          "ipsecPolicies": [],
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
            },
            "propagatedRouteTables": {
              "labels": [
                "label1",
                "label2"
              ],
              "ids": [
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
                },
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2"
                },
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3"
                }
              ]
            },
            "vnetRoutes": {
              "staticRoutes": []
            }
          }
        }
      }
    ],
    "bgpSettings": {
      "asn": 65514,
      "bgpPeeringAddress": "10.0.1.30",
      "peerWeight": 0,
      "bgpPeeringAddresses": [
        {
          "ipconfigurationId": "Instance0",
          "defaultBgpIpAddresses": [
            "10.30.0.4"
          ],
          "customBgpIpAddresses": [
            "169.254.21.5"
          ],
          "tunnelIpAddresses": [
            "104.208.48.178"
          ]
        },
        {
          "ipconfigurationId": "Instance1",
          "defaultBgpIpAddresses": [
            "10.30.0.5"
          ],
          "customBgpIpAddresses": [
            "169.254.21.10"
          ],
          "tunnelIpAddresses": [
            "104.208.48.179"
          ]
        }
      ]
    },
    "natRules": [],
    "isRoutingPreferenceInternet": false,
    "enableBgpRouteTranslationForNat": false
  }
}

定义

名称	说明
BgpSettings	BGP 设置详细信息。
CloudError	服务的错误响应。
CloudErrorBody	服务的错误响应。
DhGroup	IKE 阶段 1 中使用的 DH 组用于初始 SA。
GatewayCustomBgpIpAddressIpConfiguration	虚拟网络网关连接的 GatewayCustomBgpIpAddressIpConfiguration。
IkeEncryption	IKE 加密算法（IKE 阶段 2）。
IkeIntegrity	IKE 完整性算法（IKE 阶段 2）。
IPConfigurationBgpPeeringAddress	IPConfigurationBgpPeeringAddress 的属性。
IpsecEncryption	IPSec 加密算法（IKE 阶段 1）。
IpsecIntegrity	IPSec 完整性算法（IKE 阶段 1）。
IpsecPolicy	虚拟网络网关连接的 IPSec 策略配置。
PfsGroup	IKE 阶段 2 中用于新子 SA 的 Pfs 组。
PropagatedRouteTable	要向其播发路由的 RouteTable 列表。
ProvisioningState	当前预配状态。
RoutingConfiguration	路由配置，指示此连接的关联路由表和传播的路由表。
StaticRoute	所有静态路由的列表。
StaticRoutesConfig	此 HubVnetConnectionConfiguration 上静态路由的配置，用于此 HubVnetConnection 上的静态路由。
SubResource	对另一个子资源的引用。
TrafficSelectorPolicy	虚拟网络网关连接的流量选择器策略。
VirtualNetworkGatewayConnectionProtocol	用于此连接的连接协议。
VnetLocalRouteOverrideCriteria	确定辐射 vnet 中的 NVA 是否为辐射 vnet 中的流量绕过参数。
VnetRoute	控制从 VirtualHub 到虚拟网络连接的路由的路由列表。
VpnConnection	VpnConnection 资源。
VpnConnectionStatus	VPN 连接的当前状态。
VpnGateway	VpnGateway 资源。
VpnGatewayIpConfiguration	VPN 网关资源的 IP 配置。
VpnGatewayNatRule	VpnGatewayNatRule 资源。
VpnLinkConnectionMode	Vpn 链接连接模式。
VpnNatRuleMapping	Vpn NatRule 映射。
VpnNatRuleMode	VPN NAT 的源 NAT 方向。
VpnNatRuleType	VPN NAT 的 NAT 规则的类型。
VpnSiteLinkConnection	VpnSiteLinkConnection 资源。

BgpSettings

Object

BGP 设置详细信息。

名称	类型	说明
asn	integer	BGP 扬声器的 ASN。
bgpPeeringAddress	string	此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	具有虚拟网络网关 IP 配置 ID 的 BGP 对等互连地址。
peerWeight	integer	添加到从此 BGP 扬声器中学习的路由的权重。

CloudError

Object

服务的错误响应。

名称	类型	说明
error	CloudErrorBody	云错误正文。

CloudErrorBody

Object

服务的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。 例如，错误属性的名称。

DhGroup

Enumeration

IKE 阶段 1 中使用的 DH 组用于初始 SA。

值	说明
DHGroup1
DHGroup14
DHGroup2
DHGroup2048
DHGroup24
ECP256
ECP384
None

GatewayCustomBgpIpAddressIpConfiguration

Object

虚拟网络网关连接的 GatewayCustomBgpIpAddressIpConfiguration。

名称	类型	说明
customBgpIpAddress	string	属于 IpconfigurationId 的自定义 BgpPeeringAddress。
ipConfigurationId	string	属于网关的 ipconfiguration 的 IpconfigurationId。

IkeEncryption

Enumeration

IKE 加密算法（IKE 阶段 2）。

值	说明
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES256

IkeIntegrity

Enumeration

IKE 完整性算法（IKE 阶段 2）。

值	说明
GCMAES128
GCMAES256
MD5
SHA1
SHA256
SHA384

IPConfigurationBgpPeeringAddress

Object

IPConfigurationBgpPeeringAddress 的属性。

名称	类型	说明
customBgpIpAddresses	string[]	属于 IP 配置的自定义 BGP 对等互连地址的列表。
defaultBgpIpAddresses	string[]	属于 IP 配置的默认 BGP 对等互连地址的列表。
ipconfigurationId	string	属于网关的 IP 配置的 ID。
tunnelIpAddresses	string[]	属于 IP 配置的隧道公共 IP 地址的列表。

IpsecEncryption

Enumeration

IPSec 加密算法（IKE 阶段 1）。

值	说明
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES192
GCMAES256
None

IpsecIntegrity

Enumeration

IPSec 完整性算法（IKE 阶段 1）。

值	说明
GCMAES128
GCMAES192
GCMAES256
MD5
SHA1
SHA256

IpsecPolicy

Object

虚拟网络网关连接的 IPSec 策略配置。

名称	类型	说明
dhGroup	DhGroup	IKE 阶段 1 中用于初始 SA 的 DH 组。
ikeEncryption	IkeEncryption	IKE 加密算法（IKE 阶段 2）。
ikeIntegrity	IkeIntegrity	IKE 完整性算法（IKE 阶段 2）。
ipsecEncryption	IpsecEncryption	IPSec 加密算法（IKE 阶段 1）。
ipsecIntegrity	IpsecIntegrity	IPSec 完整性算法（IKE 阶段 1）。
pfsGroup	PfsGroup	IKE 阶段 2 中使用的 Pfs 组用于新的子 SA。
saDataSizeKilobytes	integer	IPSec 安全关联（也称为快速模式或阶段 2 SA）有效负载大小（以 KB 为单位），用于站点到站点 VPN 隧道。
saLifeTimeSeconds	integer	站点到站点 VPN 隧道的 IPSec 安全关联（也称为快速模式或阶段 2 SA）生存期（以秒为单位）。

PfsGroup

Enumeration

IKE 阶段 2 中用于新子 SA 的 Pfs 组。

值	说明
ECP256
ECP384
None
PFS1
PFS14
PFS2
PFS2048
PFS24
PFSMM

PropagatedRouteTable

Object

要向其播发路由的 RouteTable 列表。

名称	类型	说明
ids	SubResource[]	所有 RouteTable 的资源 ID 列表。
labels	string[]	标签列表。

ProvisioningState

Enumeration

当前预配状态。

值	说明
Deleting
Failed
Succeeded
Updating

RoutingConfiguration

Object

路由配置，指示此连接的关联路由表和传播的路由表。

名称	类型	说明
associatedRouteTable	SubResource	与此 RoutingConfiguration 关联的资源 ID RouteTable。
inboundRouteMap	SubResource	与此 RoutingConfiguration 关联的 RouteMap 的资源 ID，用于入站学习的路由。
outboundRouteMap	SubResource	与此 RoutingConfiguration 关联的RouteMap 的资源 ID，用于出站播发路由。
propagatedRouteTables	PropagatedRouteTable	要向其播发路由的 RouteTable 列表。
vnetRoutes	VnetRoute	控制从 VirtualHub 到虚拟网络连接的路由的路由列表。

StaticRoute

Object

所有静态路由的列表。

名称	类型	说明
addressPrefixes	string[]	所有地址前缀的列表。
name	string	在 VnetRoute 中唯一的 StaticRoute 的名称。
nextHopIpAddress	string	下一跃点的 IP 地址。

StaticRoutesConfig

Object

此 HubVnetConnectionConfiguration 上静态路由的配置，用于此 HubVnetConnection 上的静态路由。

名称	类型	说明
propagateStaticRoutes	boolean	指示此连接上的静态路由是否自动传播到此连接传播到的路由表的布尔值。
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	参数，用于确定辐射 vnet 中的 NVA 是否为辐射中具有目标的流量绕过。

SubResource

Object

对另一个子资源的引用。

名称	类型	说明
id	string	资源 ID。

TrafficSelectorPolicy

Object

虚拟网络网关连接的流量选择器策略。

名称	类型	说明
localAddressRanges	string[]	CIDR 格式的本地地址空间的集合。
remoteAddressRanges	string[]	采用 CIDR 格式的远程地址空间集合。

VirtualNetworkGatewayConnectionProtocol

Enumeration

用于此连接的连接协议。

值	说明
IKEv1
IKEv2

VnetLocalRouteOverrideCriteria

Enumeration

确定辐射 vnet 中的 NVA 是否为辐射 vnet 中的流量绕过参数。

值	说明
Contains
Equal

VnetRoute

Object

控制从 VirtualHub 到虚拟网络连接的路由的路由列表。

名称	类型	说明
bgpConnections	SubResource[]	对 HubBgpConnection 对象的引用列表。
staticRoutes	StaticRoute[]	所有静态路由的列表。
staticRoutesConfig	StaticRoutesConfig	此 HubVnetConnection 上的静态路由的配置。

VpnConnection

Object

VpnConnection 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。 此名称可用于访问资源。
properties.connectionBandwidth	integer	预期带宽（以 MBPS 为单位）。
properties.connectionStatus	VpnConnectionStatus	连接状态。
properties.dpdTimeoutSeconds	integer	VPN 连接的 DPD 超时（以秒为单位）。
properties.egressBytesTransferred	integer	传输的出口字节数。
properties.enableBgp	boolean	EnableBgp 标志。
properties.enableInternetSecurity	boolean	启用 Internet 安全性。
properties.enableRateLimiting	boolean	EnableBgp 标志。
properties.ingressBytesTransferred	integer	传输的入口字节数。
properties.ipsecPolicies	IpsecPolicy[]	此连接要考虑的 IPSec 策略。
properties.provisioningState	ProvisioningState	VPN 连接资源的预配状态。
properties.remoteVpnSite	SubResource	连接的 VPN 站点的 ID。
properties.routingConfiguration	RoutingConfiguration	路由配置，指示此连接上关联的路由表和传播的路由表。
properties.routingWeight	integer	VPN 连接的路由权重。
properties.sharedKey	string	用于 VPN 连接的 SharedKey。
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	此连接要考虑的流量选择器策略。
properties.useLocalAzureIpAddress	boolean	使用本地 Azure IP 启动连接。
properties.usePolicyBasedTrafficSelectors	boolean	启用基于策略的流量选择器。
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	用于此连接的连接协议。
properties.vpnLinkConnections	VpnSiteLinkConnection[]	指向网关的所有 VPN 站点链接连接的列表。

VpnConnectionStatus

Enumeration

VPN 连接的当前状态。

值	说明
Connected
Connecting
NotConnected
Unknown

VpnGateway

Object

VpnGateway 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.bgpSettings	BgpSettings	本地网络网关的 BGP 扬声器设置。
properties.connections	VpnConnection[]	指向网关的所有 VPN 连接的列表。
properties.enableBgpRouteTranslationForNat	boolean	在此 VpnGateway 上为 NAT 启用 BGP 路由转换。
properties.ipConfigurations	VpnGatewayIpConfiguration[]	网关上配置的所有 IP 的列表。
properties.isRoutingPreferenceInternet	boolean	为 VpnGateway 的公共 IP 接口启用路由首选项属性。
properties.natRules	VpnGatewayNatRule[]	与网关关联的所有 nat 规则的列表。
properties.provisioningState	ProvisioningState	VPN 网关资源的预配状态。
properties.virtualHub	SubResource	网关所属的 VirtualHub。
properties.vpnGatewayScaleUnit	integer	此 VPN 网关的缩放单元。
tags	object	资源标记。
type	string	资源类型。

VpnGatewayIpConfiguration

Object

VPN 网关资源的 IP 配置。

名称	类型	说明
id	string	VPN 网关的 IP 配置的标识符。
privateIpAddress	string	此 IP 配置的专用 IP 地址。
publicIpAddress	string	此 IP 配置的公共 IP 地址。

VpnGatewayNatRule

Object

VpnGatewayNatRule 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。 此名称可用于访问资源。
properties.egressVpnSiteLinkConnections	SubResource[]	出口 VpnSiteLinkConnections 的列表。
properties.externalMappings	VpnNatRuleMapping[]	NAT 的专用 IP 地址外部映射。
properties.ingressVpnSiteLinkConnections	SubResource[]	入口 VpnSiteLinkConnections 的列表。
properties.internalMappings	VpnNatRuleMapping[]	NAT 的专用 IP 地址内部映射。
properties.ipConfigurationId	string	此 NAT 规则适用的 IP 配置 ID。
properties.mode	VpnNatRuleMode	VPN NAT 的源 NAT 方向。
properties.provisioningState	ProvisioningState	NAT 规则资源的预配状态。
properties.type	VpnNatRuleType	VPN NAT 的 NAT 规则的类型。
type	string	资源类型。

VpnLinkConnectionMode

Enumeration

Vpn 链接连接模式。

值	说明
Default
InitiatorOnly
ResponderOnly

VpnNatRuleMapping

Object

Vpn NatRule 映射。

名称	类型	说明
addressSpace	string	Vpn NatRule 映射的地址空间。
portRange	string	Vpn NatRule 映射的端口范围。

VpnNatRuleMode

Enumeration

VPN NAT 的源 NAT 方向。

值	说明
EgressSnat
IngressSnat

VpnNatRuleType

Enumeration

VPN NAT 的 NAT 规则的类型。

值	说明
Dynamic
Static

VpnSiteLinkConnection

Object

VpnSiteLinkConnection 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。 此名称可用于访问资源。
properties.connectionBandwidth	integer	预期带宽（以 MBPS 为单位）。
properties.connectionStatus	VpnConnectionStatus	连接状态。
properties.dpdTimeoutSeconds	integer	VpnLink 连接的死对等检测超时（以秒为单位）。
properties.egressBytesTransferred	integer	传输的出口字节数。
properties.egressNatRules	SubResource[]	出口 NatRules 列表。
properties.enableBgp	boolean	EnableBgp 标志。
properties.enableRateLimiting	boolean	EnableBgp 标志。
properties.ingressBytesTransferred	integer	传输的入口字节数。
properties.ingressNatRules	SubResource[]	入口 NatRules 列表。
properties.ipsecPolicies	IpsecPolicy[]	此连接要考虑的 IPSec 策略。
properties.provisioningState	ProvisioningState	VPN 站点链接连接资源的预配状态。
properties.routingWeight	integer	VPN 连接的路由权重。
properties.sharedKey	string	用于 VPN 连接的 SharedKey。
properties.useLocalAzureIpAddress	boolean	使用本地 Azure IP 启动连接。
properties.usePolicyBasedTrafficSelectors	boolean	启用基于策略的流量选择器。
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	用于此连接的连接协议。
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	此连接使用的 vpnGatewayCustomBgpAddresses。
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	Vpn 链接连接模式。
properties.vpnSiteLink	SubResource	连接的 VPN 站点链接的 ID。
type	string	资源类型。