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

Virtual Network Gateways - Get

Service:

Network Gateway

API Version:

2023-09-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}?api-version=2023-09-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。
subscriptionId	path	True	string	可以唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
virtualNetworkGatewayName	path	True	string	虚拟网络网关的名称。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	VirtualNetworkGateway	请求成功。 该操作返回 VirtualNetworkGateway 资源。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

GetVirtualNetworkGateway

GetVirtualNetworkScalableGateway

GetVirtualNetworkGateway

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw?api-version=2023-09-01

Java

/**
 * Samples for VirtualNetworkGateways GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGet.json
     */
    /**
     * Sample code: GetVirtualNetworkGateway.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVirtualNetworkGateway(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualNetworkGateways().getByResourceGroupWithResponse("rg1",
            "vpngw", 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 virtual_network_gateway_get.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.virtual_network_gateways.get(
        resource_group_name="rg1",
        virtual_network_gateway_name="vpngw",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGet.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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGet.json
func ExampleVirtualNetworkGatewaysClient_Get_getVirtualNetworkGateway() {
	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)
	}
	res, err := clientFactory.NewVirtualNetworkGatewaysClient().Get(ctx, "rg1", "vpngw", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.VirtualNetworkGateway = armnetwork.VirtualNetworkGateway{
	// 	Name: to.Ptr("vpngw"),
	// 	Type: to.Ptr("Microsoft.Network/virtualNetworkGateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw"),
	// 	Location: to.Ptr("centralus"),
	// 	Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 	Properties: &armnetwork.VirtualNetworkGatewayPropertiesFormat{
	// 		Active: to.Ptr(false),
	// 		AllowRemoteVnetTraffic: to.Ptr(false),
	// 		AllowVirtualWanTraffic: to.Ptr(false),
	// 		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.10")},
	// 						DefaultBgpIPAddresses: []*string{
	// 							to.Ptr("10.3.1.254")},
	// 							IPConfigurationID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1"),
	// 							TunnelIPAddresses: []*string{
	// 								to.Ptr("52.161.10.135")},
	// 						}},
	// 						PeerWeight: to.Ptr[int32](0),
	// 					},
	// 					CustomRoutes: &armnetwork.AddressSpace{
	// 						AddressPrefixes: []*string{
	// 							to.Ptr("101.168.0.6/32")},
	// 						},
	// 						DisableIPSecReplayProtection: to.Ptr(false),
	// 						EnableBgp: to.Ptr(false),
	// 						EnableBgpRouteTranslationForNat: to.Ptr(false),
	// 						EnablePrivateIPAddress: to.Ptr(false),
	// 						GatewayType: to.Ptr(armnetwork.VirtualNetworkGatewayTypeVPN),
	// 						IPConfigurations: []*armnetwork.VirtualNetworkGatewayIPConfiguration{
	// 							{
	// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1"),
	// 								Name: to.Ptr("gwipconfig1"),
	// 								Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 								Properties: &armnetwork.VirtualNetworkGatewayIPConfigurationPropertiesFormat{
	// 									PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
	// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 									PublicIPAddress: &armnetwork.SubResource{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"),
	// 									},
	// 									Subnet: &armnetwork.SubResource{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"),
	// 									},
	// 								},
	// 						}},
	// 						NatRules: []*armnetwork.VirtualNetworkGatewayNatRule{
	// 							{
	// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1"),
	// 								Name: to.Ptr("natRule1"),
	// 								Etag: to.Ptr("W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\""),
	// 								Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
	// 									Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 									ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 										{
	// 											AddressSpace: to.Ptr("50.0.0.0/24"),
	// 									}},
	// 									InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 										{
	// 											AddressSpace: to.Ptr("10.10.0.0/24"),
	// 									}},
	// 									Mode: to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
	// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 								},
	// 							},
	// 							{
	// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2"),
	// 								Name: to.Ptr("natRule2"),
	// 								Etag: to.Ptr("W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\""),
	// 								Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
	// 									Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 									ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 										{
	// 											AddressSpace: to.Ptr("30.0.0.0/24"),
	// 									}},
	// 									InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 										{
	// 											AddressSpace: to.Ptr("20.10.0.0/24"),
	// 									}},
	// 									Mode: to.Ptr(armnetwork.VPNNatRuleModeIngressSnat),
	// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 								},
	// 						}},
	// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 						ResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 						SKU: &armnetwork.VirtualNetworkGatewaySKU{
	// 							Name: to.Ptr(armnetwork.VirtualNetworkGatewaySKUNameVPNGw1),
	// 							Capacity: to.Ptr[int32](0),
	// 							Tier: to.Ptr(armnetwork.VirtualNetworkGatewaySKUTierVPNGw1),
	// 						},
	// 						VPNClientConfiguration: &armnetwork.VPNClientConfiguration{
	// 							RadiusServers: []*armnetwork.RadiusServer{
	// 								{
	// 									RadiusServerAddress: to.Ptr("10.1.0.0"),
	// 									RadiusServerScore: to.Ptr[int64](20),
	// 							}},
	// 							VPNClientProtocols: []*armnetwork.VPNClientProtocol{
	// 								to.Ptr(armnetwork.VPNClientProtocolOpenVPN)},
	// 								VPNClientRevokedCertificates: []*armnetwork.VPNClientRevokedCertificate{
	// 								},
	// 								VPNClientRootCertificates: []*armnetwork.VPNClientRootCertificate{
	// 								},
	// 							},
	// 							VPNGatewayGeneration: to.Ptr(armnetwork.VPNGatewayGenerationNone),
	// 							VPNType: to.Ptr(armnetwork.VPNTypeRouteBased),
	// 						},
	// 					}
}

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 Gets the specified virtual network gateway by resource group.
 *
 * @summary Gets the specified virtual network gateway by resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGet.json
 */
async function getVirtualNetworkGateway() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkGatewayName = "vpngw";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualNetworkGateways.get(
    resourceGroupName,
    virtualNetworkGatewayName,
  );
  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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGet.json
// this example is just showing the usage of "VirtualNetworkGateways_Get" 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 VirtualNetworkGatewayResource created on azure
// for more information of creating VirtualNetworkGatewayResource, please refer to the document of VirtualNetworkGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string virtualNetworkGatewayName = "vpngw";
ResourceIdentifier virtualNetworkGatewayResourceId = VirtualNetworkGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualNetworkGatewayName);
VirtualNetworkGatewayResource virtualNetworkGateway = client.GetVirtualNetworkGatewayResource(virtualNetworkGatewayResourceId);

// invoke the operation
VirtualNetworkGatewayResource result = await virtualNetworkGateway.GetAsync();

// 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
VirtualNetworkGatewayData 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

Sample Response

Status code:

200

{
  "name": "vpngw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "type": "Microsoft.Network/virtualNetworkGateways",
  "location": "centralus",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000",
    "ipConfigurations": [
      {
        "name": "gwipconfig1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1",
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Dynamic",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"
          },
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"
          }
        }
      }
    ],
    "natRules": [
      {
        "name": "natRule1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "EgressSnat",
          "internalMappings": [
            {
              "addressSpace": "10.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "50.0.0.0/24"
            }
          ]
        }
      },
      {
        "name": "natRule2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "IngressSnat",
          "internalMappings": [
            {
              "addressSpace": "20.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "30.0.0.0/24"
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": false,
    "sku": {
      "name": "VpnGw1",
      "tier": "VpnGw1",
      "capacity": 0
    },
    "gatewayType": "Vpn",
    "vpnType": "RouteBased",
    "vpnGatewayGeneration": "None",
    "enableBgp": false,
    "enablePrivateIpAddress": false,
    "activeActive": false,
    "disableIPSecReplayProtection": false,
    "vpnClientConfiguration": {
      "vpnClientProtocols": [
        "OpenVPN"
      ],
      "vpnClientRootCertificates": [],
      "vpnClientRevokedCertificates": [],
      "radiusServers": [
        {
          "radiusServerAddress": "10.1.0.0",
          "radiusServerScore": 20
        }
      ]
    },
    "bgpSettings": {
      "asn": 65514,
      "bgpPeeringAddress": "10.0.1.30",
      "peerWeight": 0,
      "bgpPeeringAddresses": [
        {
          "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1",
          "defaultBgpIpAddresses": [
            "10.3.1.254"
          ],
          "customBgpIpAddresses": [
            "169.254.21.10"
          ],
          "tunnelIpAddresses": [
            "52.161.10.135"
          ]
        }
      ]
    },
    "customRoutes": {
      "addressPrefixes": [
        "101.168.0.6/32"
      ]
    },
    "allowVirtualWanTraffic": false,
    "allowRemoteVnetTraffic": false
  }
}

GetVirtualNetworkScalableGateway

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw?api-version=2023-09-01

Java

/**
 * Samples for VirtualNetworkGateways GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * VirtualNetworkScalableGatewayGet.json
     */
    /**
     * Sample code: GetVirtualNetworkScalableGateway.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVirtualNetworkScalableGateway(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualNetworkGateways().getByResourceGroupWithResponse("rg1",
            "ergw", 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 virtual_network_scalable_gateway_get.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.virtual_network_gateways.get(
        resource_group_name="rg1",
        virtual_network_gateway_name="ergw",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkScalableGatewayGet.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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkScalableGatewayGet.json
func ExampleVirtualNetworkGatewaysClient_Get_getVirtualNetworkScalableGateway() {
	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)
	}
	res, err := clientFactory.NewVirtualNetworkGatewaysClient().Get(ctx, "rg1", "ergw", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.VirtualNetworkGateway = armnetwork.VirtualNetworkGateway{
	// 	Name: to.Ptr("ergw"),
	// 	Type: to.Ptr("Microsoft.Network/virtualNetworkGateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw"),
	// 	Location: to.Ptr("centralus"),
	// 	Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 	Properties: &armnetwork.VirtualNetworkGatewayPropertiesFormat{
	// 		Active: to.Ptr(false),
	// 		AllowRemoteVnetTraffic: to.Ptr(false),
	// 		AllowVirtualWanTraffic: to.Ptr(false),
	// 		AutoScaleConfiguration: &armnetwork.VirtualNetworkGatewayAutoScaleConfiguration{
	// 			Bounds: &armnetwork.VirtualNetworkGatewayAutoScaleBounds{
	// 				Max: to.Ptr[int32](3),
	// 				Min: to.Ptr[int32](2),
	// 			},
	// 		},
	// 		DisableIPSecReplayProtection: to.Ptr(false),
	// 		EnableBgp: to.Ptr(false),
	// 		EnableBgpRouteTranslationForNat: to.Ptr(false),
	// 		EnablePrivateIPAddress: to.Ptr(false),
	// 		GatewayType: to.Ptr(armnetwork.VirtualNetworkGatewayTypeExpressRoute),
	// 		IPConfigurations: []*armnetwork.VirtualNetworkGatewayIPConfiguration{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/ipConfigurations/default"),
	// 				Name: to.Ptr("gwipconfig1"),
	// 				Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 				Properties: &armnetwork.VirtualNetworkGatewayIPConfigurationPropertiesFormat{
	// 					PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodStatic),
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					PublicIPAddress: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"),
	// 					},
	// 					Subnet: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"),
	// 					},
	// 				},
	// 		}},
	// 		NatRules: []*armnetwork.VirtualNetworkGatewayNatRule{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1"),
	// 				Name: to.Ptr("natRule1"),
	// 				Etag: to.Ptr("W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\""),
	// 				Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
	// 					Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 					ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 						{
	// 							AddressSpace: to.Ptr("50.0.0.0/24"),
	// 					}},
	// 					InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 						{
	// 							AddressSpace: to.Ptr("10.10.0.0/24"),
	// 					}},
	// 					Mode: to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				},
	// 			},
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2"),
	// 				Name: to.Ptr("natRule2"),
	// 				Etag: to.Ptr("W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\""),
	// 				Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
	// 					Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 					ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 						{
	// 							AddressSpace: to.Ptr("30.0.0.0/24"),
	// 					}},
	// 					InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 						{
	// 							AddressSpace: to.Ptr("20.10.0.0/24"),
	// 					}},
	// 					Mode: to.Ptr(armnetwork.VPNNatRuleModeIngressSnat),
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		ResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		SKU: &armnetwork.VirtualNetworkGatewaySKU{
	// 			Name: to.Ptr(armnetwork.VirtualNetworkGatewaySKUNameErGwScale),
	// 			Capacity: to.Ptr[int32](2),
	// 			Tier: to.Ptr(armnetwork.VirtualNetworkGatewaySKUTierErGwScale),
	// 		},
	// 		VPNGatewayGeneration: to.Ptr(armnetwork.VPNGatewayGenerationNone),
	// 		VPNType: to.Ptr(armnetwork.VPNTypePolicyBased),
	// 	},
	// }
}

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 Gets the specified virtual network gateway by resource group.
 *
 * @summary Gets the specified virtual network gateway by resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkScalableGatewayGet.json
 */
async function getVirtualNetworkScalableGateway() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkGatewayName = "ergw";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualNetworkGateways.get(
    resourceGroupName,
    virtualNetworkGatewayName,
  );
  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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkScalableGatewayGet.json
// this example is just showing the usage of "VirtualNetworkGateways_Get" 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 VirtualNetworkGatewayResource created on azure
// for more information of creating VirtualNetworkGatewayResource, please refer to the document of VirtualNetworkGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string virtualNetworkGatewayName = "ergw";
ResourceIdentifier virtualNetworkGatewayResourceId = VirtualNetworkGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualNetworkGatewayName);
VirtualNetworkGatewayResource virtualNetworkGateway = client.GetVirtualNetworkGatewayResource(virtualNetworkGatewayResourceId);

// invoke the operation
VirtualNetworkGatewayResource result = await virtualNetworkGateway.GetAsync();

// 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
VirtualNetworkGatewayData 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

Sample Response

Status code:

200

{
  "name": "ergw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "type": "Microsoft.Network/virtualNetworkGateways",
  "location": "centralus",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000",
    "ipConfigurations": [
      {
        "name": "gwipconfig1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/ipConfigurations/default",
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Static",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"
          },
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"
          }
        }
      }
    ],
    "natRules": [
      {
        "name": "natRule1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "EgressSnat",
          "internalMappings": [
            {
              "addressSpace": "10.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "50.0.0.0/24"
            }
          ]
        }
      },
      {
        "name": "natRule2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "IngressSnat",
          "internalMappings": [
            {
              "addressSpace": "20.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "30.0.0.0/24"
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": false,
    "sku": {
      "name": "ErGwScale",
      "tier": "ErGwScale",
      "capacity": 2
    },
    "autoScaleConfiguration": {
      "bounds": {
        "min": 2,
        "max": 3
      }
    },
    "gatewayType": "ExpressRoute",
    "vpnType": "PolicyBased",
    "vpnGatewayGeneration": "None",
    "enableBgp": false,
    "enablePrivateIpAddress": false,
    "activeActive": false,
    "disableIPSecReplayProtection": false,
    "vpnClientConfiguration": null,
    "bgpSettings": null,
    "customRoutes": null,
    "allowVirtualWanTraffic": false,
    "allowRemoteVnetTraffic": false
  }
}

定义

名称	说明
AddressSpace	AddressSpace 包含虚拟网络子网可以使用的 IP 地址范围的数组。
adminState	指示当 vnet 中有多个 Express Route 网关时，Express Route Gateway 是否为流量提供服务的属性
BgpSettings	BGP 设置详细信息。
CloudError	来自服务的错误响应。
CloudErrorBody	来自服务的错误响应。
DhGroup	初始 SA 的 IKE 阶段 1 中使用的 DH 组。
ExtendedLocation	ExtendedLocation 复杂类型。
ExtendedLocationTypes	扩展位置的类型。
IkeEncryption	IKE 加密算法 (IKE 阶段 2) 。
IkeIntegrity	IKE 第 2 阶段) (IKE 完整性算法。
IPAllocationMethod	IP 地址分配方法。
IPConfigurationBgpPeeringAddress	IPConfigurationBgpPeeringAddress 的属性。
IpsecEncryption	IPSec 加密算法 (IKE 阶段 1) 。
IpsecIntegrity	IPSec 完整性算法 (IKE 阶段 1) 。
IpsecPolicy	虚拟网络网关连接的 IPSec 策略配置。
PfsGroup	用于新子 SA 的 IKE 阶段 2 中使用的 Pfs 组。
ProvisioningState	当前预配状态。
RadiusServer	Radius 服务器设置。
SubResource	对另一个子资源的引用。
VirtualNetworkGateway	常规资源信息的通用类。
VirtualNetworkGatewayAutoScaleBounds
VirtualNetworkGatewayAutoScaleConfiguration	虚拟网络网关自动缩放配置详细信息
VirtualNetworkGatewayIPConfiguration	虚拟网络网关的 IP 配置。
VirtualNetworkGatewayNatRule	VirtualNetworkGatewayNatRule 资源。
VirtualNetworkGatewayPolicyGroup	VirtualNetworkGatewayPolicyGroup 的参数。
VirtualNetworkGatewayPolicyGroupMember	Vpn 客户端连接配置 PolicyGroup 成员
VirtualNetworkGatewaySku	VirtualNetworkGatewaySku 详细信息。
VirtualNetworkGatewaySkuName	网关 SKU 名称。
VirtualNetworkGatewaySkuTier	网关 SKU 层。
VirtualNetworkGatewayType	此虚拟网络网关的类型。
VngClientConnectionConfiguration	用于客户端连接配置的 VPN 客户端连接配置。
VpnAuthenticationType	虚拟网络网关的 VPN 身份验证类型。
VpnClientConfiguration	适用于 P2S 客户端的 VpnClientConfiguration。
VpnClientProtocol	虚拟网络网关的 VpnClientProtocols。
VpnClientRevokedCertificate	VPN 客户端吊销了虚拟网络网关的证书。
VpnClientRootCertificate	虚拟网络网关的 VPN 客户端根证书。
VpnGatewayGeneration	此 VirtualNetworkGateway 的生成。 如果 gatewayType 不是 VPN，则必须为 None。
VpnNatRuleMapping	Vpn NatRule 映射。
VpnNatRuleMode	VPN NAT 的源 NAT 方向。
VpnNatRuleType	VPN NAT 的 NAT 规则类型。
VpnPolicyMemberAttributeType	Vpn Policy 成员属性类型。
VpnType	此虚拟网络网关的类型。

AddressSpace

AddressSpace 包含虚拟网络子网可以使用的 IP 地址范围的数组。

名称	类型	说明
addressPrefixes	string[]	以 CIDR 表示法为此虚拟网络保留的地址块列表。

adminState

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

名称	类型	说明
Disabled	string
Enabled	string

BgpSettings

BGP 设置详细信息。

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

CloudError

来自服务的错误响应。

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

CloudErrorBody

来自服务的错误响应。

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

DhGroup

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

名称	类型	说明
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

ExtendedLocation

ExtendedLocation 复杂类型。

名称	类型	说明
name	string	扩展位置的名称。
type	ExtendedLocationTypes	扩展位置的类型。

ExtendedLocationTypes

扩展位置的类型。

名称	类型	说明
EdgeZone	string

IkeEncryption

IKE 加密算法 (IKE 阶段 2) 。

名称	类型	说明
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

IKE 第 2 阶段) (IKE 完整性算法。

名称	类型	说明
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IPAllocationMethod

IP 地址分配方法。

名称	类型	说明
Dynamic	string
Static	string

IPConfigurationBgpPeeringAddress

IPConfigurationBgpPeeringAddress 的属性。

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

IpsecEncryption

IPSec 加密算法 (IKE 阶段 1) 。

名称	类型	说明
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

IPSec 完整性算法 (IKE 阶段 1) 。

名称	类型	说明
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

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

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

PfsGroup

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

名称	类型	说明
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

ProvisioningState

当前预配状态。

名称	类型	说明
Deleting	string
Failed	string
Succeeded	string
Updating	string

RadiusServer

Radius 服务器设置。

名称	类型	说明
radiusServerAddress	string	此 radius 服务器的地址。
radiusServerScore	integer	分配给此 radius 服务器的初始分数。
radiusServerSecret	string	用于此 radius 服务器的机密。

SubResource

对另一个子资源的引用。

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

VirtualNetworkGateway

常规资源信息的通用类。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当资源更新时都会更改。
extendedLocation	ExtendedLocation	本地虚拟网络网关类型的扩展位置。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.activeActive	boolean	ActiveActive 标志。
properties.adminState	adminState	指示在 vnet 中有多个 Express Route 网关时，Express Route Gateway 是否提供流量的属性
properties.allowRemoteVnetTraffic	boolean	配置此网关以接受来自其他 Azure 虚拟网络的流量。 此配置不支持连接到 Azure 虚拟 WAN。
properties.allowVirtualWanTraffic	boolean	将此网关配置为接受来自远程虚拟 WAN网络的流量。
properties.autoScaleConfiguration	VirtualNetworkGatewayAutoScaleConfiguration	virutal 网络网关的自动缩放配置
properties.bgpSettings	BgpSettings	虚拟网络网关的 BGP 扬声器设置。
properties.customRoutes	AddressSpace	对地址空间资源的引用，该资源表示客户为虚拟网络网关和 VpnClient 指定的自定义路由地址空间。
properties.disableIPSecReplayProtection	boolean	disableIPSecReplayProtection 标志。
properties.enableBgp	boolean	是否已为此虚拟网络网关启用 BGP。
properties.enableBgpRouteTranslationForNat	boolean	EnableBgpRouteTranslationForNat 标志。
properties.enableDnsForwarding	boolean	是否启用 dns 转发。
properties.enablePrivateIpAddress	boolean	是否需要在此网关上启用专用 IP 进行连接。
properties.gatewayDefaultSite	SubResource	对 LocalNetworkGateway 资源的引用，该资源表示具有默认路由的本地网络站点。 如果删除现有的默认站点设置，请分配 Null 值。
properties.gatewayType	VirtualNetworkGatewayType	此虚拟网络网关的类型。
properties.inboundDnsForwardingEndpoint	string	网关分配的 IP 地址，DNS 请求可以发送到该地址。
properties.ipConfigurations	VirtualNetworkGatewayIPConfiguration[]	虚拟网络网关的 IP 配置。
properties.natRules	VirtualNetworkGatewayNatRule[]	虚拟网络网关的 NatRules。
properties.provisioningState	ProvisioningState	虚拟网络网关资源的预配状态。
properties.resourceGuid	string	虚拟网络网关资源的资源 GUID 属性。
properties.sku	VirtualNetworkGatewaySku	对 VirtualNetworkGatewaySku 资源的引用，该资源表示为虚拟网络网关选择的 SKU。
properties.vNetExtendedLocationResourceId	string	客户 vnet 资源 ID。本地网关类型的 VirtualNetworkGateway 与客户 vnet 相关联。
properties.virtualNetworkGatewayPolicyGroups	VirtualNetworkGatewayPolicyGroup[]	对 VirtualNetworkGatewayPolicyGroup 资源的引用，该资源表示网关的可用 VirtualNetworkGatewayPolicyGroup。
properties.vpnClientConfiguration	VpnClientConfiguration	对 VpnClientConfiguration 资源的引用，该资源表示 P2S VpnClient 配置。
properties.vpnGatewayGeneration	VpnGatewayGeneration	此 VirtualNetworkGateway 的生成。 如果 gatewayType 不是 VPN，则必须为 None。
properties.vpnType	VpnType	此虚拟网络网关的类型。
tags	object	资源标记。
type	string	资源类型。

VirtualNetworkGatewayAutoScaleBounds

名称	类型	说明
max	integer	自动缩放配置的最大缩放单位数
min	integer	自动缩放配置的最小缩放单位数

VirtualNetworkGatewayAutoScaleConfiguration

虚拟网络网关自动缩放配置详细信息

名称	类型	说明
bounds	VirtualNetworkGatewayAutoScaleBounds	自动缩放配置的边界

VirtualNetworkGatewayIPConfiguration

虚拟网络网关的 IP 配置。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当资源更新时都会更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。 此名称可用于访问资源。
properties.privateIPAddress	string	此网关的专用 IP 地址。
properties.privateIPAllocationMethod	IPAllocationMethod	专用 IP 地址分配方法。
properties.provisioningState	ProvisioningState	虚拟网络网关 IP 配置资源的预配状态。
properties.publicIPAddress	SubResource	对公共 IP 资源的引用。
properties.subnet	SubResource	对子网资源的引用。

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayNatRule 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当资源更新时都会更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。 此名称可用于访问资源。
properties.externalMappings	VpnNatRuleMapping[]	NAT 的专用 IP 地址外部映射。
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	资源类型。

VirtualNetworkGatewayPolicyGroup

VirtualNetworkGatewayPolicyGroup 的参数。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当资源更新时都会更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。 此名称可用于访问资源。
properties.isDefault	boolean	显示这是否是默认 VirtualNetworkGatewayPolicyGroup。
properties.policyMembers	VirtualNetworkGatewayPolicyGroupMember[]	VirtualNetworkGatewayPolicyGroup 的多个 PolicyMembers。
properties.priority	integer	VirtualNetworkGatewayPolicyGroup 的优先级。
properties.provisioningState	ProvisioningState	VirtualNetworkGatewayPolicyGroup 资源的预配状态。
properties.vngClientConnectionConfigurations	SubResource[]	对 vngClientConnectionConfigurations 的引用列表。

VirtualNetworkGatewayPolicyGroupMember

Vpn 客户端连接配置 PolicyGroup 成员

名称	类型	说明
attributeType	VpnPolicyMemberAttributeType	Vpn Policy 成员属性类型。
attributeValue	string	用于此 VirtualNetworkGatewayPolicyGroupMember 的 Attribute 值。
name	string	VirtualNetworkGatewayPolicyGroupMember 的名称。

VirtualNetworkGatewaySku

VirtualNetworkGatewaySku 详细信息。

名称	类型	说明
capacity	integer	容量。
name	VirtualNetworkGatewaySkuName	网关 SKU 名称。
tier	VirtualNetworkGatewaySkuTier	网关 SKU 层。

VirtualNetworkGatewaySkuName

网关 SKU 名称。

名称	类型	说明
Basic	string
ErGw1AZ	string
ErGw2AZ	string
ErGw3AZ	string
ErGwScale	string
HighPerformance	string
Standard	string
UltraPerformance	string
VpnGw1	string
VpnGw1AZ	string
VpnGw2	string
VpnGw2AZ	string
VpnGw3	string
VpnGw3AZ	string
VpnGw4	string
VpnGw4AZ	string
VpnGw5	string
VpnGw5AZ	string

VirtualNetworkGatewaySkuTier

网关 SKU 层。

名称	类型	说明
Basic	string
ErGw1AZ	string
ErGw2AZ	string
ErGw3AZ	string
ErGwScale	string
HighPerformance	string
Standard	string
UltraPerformance	string
VpnGw1	string
VpnGw1AZ	string
VpnGw2	string
VpnGw2AZ	string
VpnGw3	string
VpnGw3AZ	string
VpnGw4	string
VpnGw4AZ	string
VpnGw5	string
VpnGw5AZ	string

VirtualNetworkGatewayType

此虚拟网络网关的类型。

名称	类型	说明
ExpressRoute	string
LocalGateway	string
Vpn	string

VngClientConnectionConfiguration

用于客户端连接配置的 VPN 客户端连接配置。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当资源更新时都会更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。 此名称可用于访问资源。
properties.provisioningState	ProvisioningState	VngClientConnectionConfiguration 资源的预配状态。
properties.virtualNetworkGatewayPolicyGroups	SubResource[]	对 virtualNetworkGatewayPolicyGroups 的引用列表
properties.vpnClientAddressPool	AddressSpace	对表示 P2S VpnClient 的地址空间的地址空间资源的引用。

VpnAuthenticationType

虚拟网络网关的 VPN 身份验证类型。

名称	类型	说明
AAD	string
Certificate	string
Radius	string

VpnClientConfiguration

适用于 P2S 客户端的 VpnClientConfiguration。

名称	类型	说明
aadAudience	string	用于用于 AAD 身份验证的 VPN 客户端连接的 VirtualNetworkGateway 资源的 AADAudience 属性。
aadIssuer	string	用于用于 AAD 身份验证的 vpn 客户端连接的 VirtualNetworkGateway 资源的 AADIssuer 属性。
aadTenant	string	用于用于 AAD 身份验证的 vpn 客户端连接的 VirtualNetworkGateway 资源的 AADTenant 属性。
radiusServerAddress	string	用于 vpn 客户端连接的 VirtualNetworkGateway 资源的 radius 服务器地址属性。
radiusServerSecret	string	用于 vpn 客户端连接的 VirtualNetworkGateway 资源的 radius 机密属性。
radiusServers	RadiusServer[]	多半径服务器配置的 radiusServers 属性。
vngClientConnectionConfigurations	VngClientConnectionConfiguration[]	虚拟网络网关 P2S 客户端的每个 IP 地址池连接策略。
vpnAuthenticationTypes	VpnAuthenticationType[]	虚拟网络网关的 VPN 身份验证类型。
vpnClientAddressPool	AddressSpace	对地址空间资源的引用，该资源表示 P2S VpnClient 的地址空间。
vpnClientIpsecPolicies	IpsecPolicy[]	虚拟网络网关 P2S 客户端的 VpnClientIpsecPolicies。
vpnClientProtocols	VpnClientProtocol[]	用于虚拟网络网关的 VpnClientProtocols。
vpnClientRevokedCertificates	VpnClientRevokedCertificate[]	适用于虚拟网络网关的 VpnClientRevokedCertificate。
vpnClientRootCertificates	VpnClientRootCertificate[]	用于虚拟网络网关的 VpnClientRootCertificate。

VpnClientProtocol

虚拟网络网关的 VpnClientProtocols。

名称	类型	说明
IkeV2	string
OpenVPN	string
SSTP	string

VpnClientRevokedCertificate

VPN 客户端吊销了虚拟网络网关的证书。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当资源更新时都会更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。 此名称可用于访问资源。
properties.provisioningState	ProvisioningState	VPN 客户端已吊销证书资源的预配状态。
properties.thumbprint	string	吊销的 VPN 客户端证书指纹。

VpnClientRootCertificate

虚拟网络网关的 VPN 客户端根证书。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当资源更新时都会更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。 此名称可用于访问资源。
properties.provisioningState	ProvisioningState	VPN 客户端根证书资源的预配状态。
properties.publicCertData	string	证书公共数据。

VpnGatewayGeneration

此 VirtualNetworkGateway 的生成。 如果 gatewayType 不是 VPN，则必须为 None。

名称	类型	说明
Generation1	string
Generation2	string
None	string

VpnNatRuleMapping

Vpn NatRule 映射。

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

VpnNatRuleMode

VPN NAT 的源 NAT 方向。

名称	类型	说明
EgressSnat	string
IngressSnat	string

VpnNatRuleType

VPN NAT 的 NAT 规则类型。

名称	类型	说明
Dynamic	string
Static	string

VpnPolicyMemberAttributeType

Vpn Policy 成员属性类型。

名称	类型	说明
AADGroupId	string
CertificateGroupId	string
RadiusAzureGroupId	string

VpnType

此虚拟网络网关的类型。

名称	类型	说明
PolicyBased	string
RouteBased	string