Vpn Gateways - Get

Служба:

Virtual WAN

Версия API:

2024-05-01

Извлекает сведения о VPN-шлюзе виртуальной глобальной сети.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
gatewayName	path	True	string	Имя шлюза.
resourceGroupName	path	True	string	Имя группы ресурсов VpnGateway.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия КЛИЕНТСКОго API.

Ответы

Имя	Тип	Описание
200 OK	VpnGateway	Запрос успешно выполнен. Возвращает сведения о полученном VPN-шлюзе виртуальной глобальной сети.
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

VpnGatewayGet

Образец запроса

HTTP

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

Java

/**
 * Samples for VpnGateways GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayGet.json
     */
    /**
     * Sample code: VpnGatewayGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnGatewayGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnGateways().getByResourceGroupWithResponse("rg1", "gateway1",
            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_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.vpn_gateways.get(
        resource_group_name="rg1",
        gateway_name="gateway1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayGet.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/VpnGatewayGet.json
func ExampleVPNGatewaysClient_Get() {
	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.NewVPNGatewaysClient().Get(ctx, "rg1", "gateway1", 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.VPNGateway = armnetwork.VPNGateway{
	// 	Name: to.Ptr("gateway1"),
	// 	Type: to.Ptr("Microsoft.Network/vpnGateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1"),
	// 	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/gateway1/vpnConnections/vpnConnection1"),
	// 										Name: to.Ptr("vpnConnection1"),
	// 										Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 										Properties: &armnetwork.VPNConnectionProperties{
	// 											EgressBytesTransferred: to.Ptr[int64](0),
	// 											EnableInternetSecurity: to.Ptr(false),
	// 											IngressBytesTransferred: to.Ptr[int64](0),
	// 											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{
	// 														},
	// 													},
	// 												},
	// 												VPNLinkConnections: []*armnetwork.VPNSiteLinkConnection{
	// 													{
	// 														ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1"),
	// 														Name: to.Ptr("Connection-Link1"),
	// 														Type: to.Ptr("Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"),
	// 														Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 														Properties: &armnetwork.VPNSiteLinkConnectionProperties{
	// 															ConnectionBandwidth: to.Ptr[int32](200),
	// 															EgressBytesTransferred: to.Ptr[int64](0),
	// 															EnableBgp: to.Ptr(false),
	// 															EnableRateLimiting: to.Ptr(false),
	// 															IngressBytesTransferred: to.Ptr[int64](0),
	// 															IngressNatRules: []*armnetwork.SubResource{
	// 																{
	// 																	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"),
	// 															}},
	// 															IPSecPolicies: []*armnetwork.IPSecPolicy{
	// 															},
	// 															ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 															RoutingWeight: to.Ptr[int32](0),
	// 															SharedKey: to.Ptr("key"),
	// 															UseLocalAzureIPAddress: to.Ptr(false),
	// 															UsePolicyBasedTrafficSelectors: to.Ptr(false),
	// 															VPNConnectionProtocolType: to.Ptr(armnetwork.VirtualNetworkGatewayConnectionProtocolIKEv2),
	// 															VPNSiteLink: &armnetwork.SubResource{
	// 																ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"),
	// 															},
	// 														},
	// 													},
	// 													{
	// 														ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2"),
	// 														Name: to.Ptr("Connection-Link2"),
	// 														Type: to.Ptr("Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"),
	// 														Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 														Properties: &armnetwork.VPNSiteLinkConnectionProperties{
	// 															ConnectionBandwidth: to.Ptr[int32](200),
	// 															EgressBytesTransferred: to.Ptr[int64](0),
	// 															EgressNatRules: []*armnetwork.SubResource{
	// 																{
	// 																	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04"),
	// 															}},
	// 															EnableBgp: to.Ptr(false),
	// 															EnableRateLimiting: to.Ptr(false),
	// 															IngressBytesTransferred: to.Ptr[int64](0),
	// 															IPSecPolicies: []*armnetwork.IPSecPolicy{
	// 															},
	// 															ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 															RoutingWeight: to.Ptr[int32](0),
	// 															SharedKey: to.Ptr("key"),
	// 															UseLocalAzureIPAddress: to.Ptr(false),
	// 															UsePolicyBasedTrafficSelectors: to.Ptr(false),
	// 															VPNConnectionProtocolType: to.Ptr(armnetwork.VirtualNetworkGatewayConnectionProtocolIKEv2),
	// 															VPNSiteLink: &armnetwork.SubResource{
	// 																ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"),
	// 															},
	// 														},
	// 												}},
	// 											},
	// 									}},
	// 									EnableBgpRouteTranslationForNat: to.Ptr(false),
	// 									IsRoutingPreferenceInternet: to.Ptr(false),
	// 									NatRules: []*armnetwork.VPNGatewayNatRule{
	// 										{
	// 											ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"),
	// 											Name: to.Ptr("nat03"),
	// 											Type: to.Ptr("Microsoft.Network/vpnGateways/natRules"),
	// 											Properties: &armnetwork.VPNGatewayNatRuleProperties{
	// 												Type: to.Ptr(armnetwork.VPNNatRuleTypeDynamic),
	// 												ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 													{
	// 														AddressSpace: to.Ptr("192.168.0.0/26"),
	// 												}},
	// 												IngressVPNSiteLinkConnections: []*armnetwork.SubResource{
	// 													{
	// 														ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1"),
	// 												}},
	// 												InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 													{
	// 														AddressSpace: to.Ptr("0.0.0.0/26"),
	// 												}},
	// 												Mode: to.Ptr(armnetwork.VPNNatRuleMode("IgressSnat")),
	// 											},
	// 										},
	// 										{
	// 											ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04"),
	// 											Name: to.Ptr("nat04"),
	// 											Type: to.Ptr("Microsoft.Network/vpnGateways/natRules"),
	// 											Properties: &armnetwork.VPNGatewayNatRuleProperties{
	// 												Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 												EgressVPNSiteLinkConnections: []*armnetwork.SubResource{
	// 													{
	// 														ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link2"),
	// 												}},
	// 												ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 													{
	// 														AddressSpace: to.Ptr("192.168.0.0/26"),
	// 												}},
	// 												InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 													{
	// 														AddressSpace: to.Ptr("0.0.0.0/26"),
	// 												}},
	// 												Mode: to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
	// 											},
	// 									}},
	// 									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 Retrieves the details of a virtual wan vpn gateway.
 *
 * @summary Retrieves the details of a virtual wan vpn gateway.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayGet.json
 */
async function vpnGatewayGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const gatewayName = "gateway1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.vpnGateways.get(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/VpnGatewayGet.json
// this example is just showing the usage of "VpnGateways_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 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 = "gateway1";
ResourceIdentifier vpnGatewayResourceId = VpnGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, gatewayName);
VpnGatewayResource vpnGateway = client.GetVpnGatewayResource(vpnGatewayResourceId);

// invoke the operation
VpnGatewayResource result = await vpnGateway.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
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

Пример ответа

Код состояния:

200

{
  "name": "gateway1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1",
  "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/gateway1/vpnConnections/vpnConnection1",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "properties": {
          "provisioningState": "Succeeded",
          "remoteVpnSite": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
          },
          "enableInternetSecurity": false,
          "ingressBytesTransferred": 0,
          "egressBytesTransferred": 0,
          "vpnLinkConnections": [
            {
              "name": "Connection-Link1",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
              "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
              "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
              "properties": {
                "provisioningState": "Succeeded",
                "vpnSiteLink": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
                },
                "connectionBandwidth": 200,
                "ipsecPolicies": [],
                "vpnConnectionProtocolType": "IKEv2",
                "sharedKey": "key",
                "ingressBytesTransferred": 0,
                "egressBytesTransferred": 0,
                "enableBgp": false,
                "enableRateLimiting": false,
                "useLocalAzureIpAddress": false,
                "usePolicyBasedTrafficSelectors": false,
                "routingWeight": 0,
                "ingressNatRules": [
                  {
                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"
                  }
                ]
              }
            },
            {
              "name": "Connection-Link2",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2",
              "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
              "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
              "properties": {
                "provisioningState": "Succeeded",
                "vpnSiteLink": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"
                },
                "connectionBandwidth": 200,
                "ipsecPolicies": [],
                "vpnConnectionProtocolType": "IKEv2",
                "sharedKey": "key",
                "ingressBytesTransferred": 0,
                "egressBytesTransferred": 0,
                "enableBgp": false,
                "enableRateLimiting": false,
                "useLocalAzureIpAddress": false,
                "usePolicyBasedTrafficSelectors": false,
                "routingWeight": 0,
                "egressNatRules": [
                  {
                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04"
                  }
                ]
              }
            }
          ],
          "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": [
      {
        "name": "nat03",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03",
        "properties": {
          "type": "Dynamic",
          "mode": "IgressSnat",
          "internalMappings": [
            {
              "addressSpace": "0.0.0.0/26"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "192.168.0.0/26"
            }
          ],
          "ingressVpnSiteLinkConnections": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1"
            }
          ]
        },
        "type": "Microsoft.Network/vpnGateways/natRules"
      },
      {
        "name": "nat04",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04",
        "properties": {
          "type": "Static",
          "mode": "EgressSnat",
          "internalMappings": [
            {
              "addressSpace": "0.0.0.0/26"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "192.168.0.0/26"
            }
          ],
          "egressVpnSiteLinkConnections": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link2"
            }
          ]
        },
        "type": "Microsoft.Network/vpnGateways/natRules"
      }
    ],
    "isRoutingPreferenceInternet": false,
    "enableBgpRouteTranslationForNat": false
  }
}

Определения

Имя	Описание
BgpSettings	Сведения о параметрах BGP.
CloudError	Ответ на ошибку службы.
CloudErrorBody	Ответ на ошибку службы.
DhGroup	Группы DH, используемые на этапе IKE 1 для начального sa.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration для подключения шлюза виртуальной сети.
IkeEncryption	Алгоритм шифрования IKE (этап IKE 2).
IkeIntegrity	Алгоритм целостности IKE (этап IKE 2).
IPConfigurationBgpPeeringAddress	Свойства IPConfigurationBgpPeeringAddress.
IpsecEncryption	Алгоритм шифрования IPSec (этап IKE 1).
IpsecIntegrity	Алгоритм целостности IPSec (этап IKE 1).
IpsecPolicy	Конфигурация политики IPSec для подключения шлюза виртуальной сети.
PfsGroup	Группы Pfs, используемые на этапе IKE 2 для нового дочернего SA.
PropagatedRouteTable	Список маршрутов для объявления маршрутов.
ProvisioningState	Текущее состояние подготовки.
RoutingConfiguration	Конфигурация маршрутизации, указывающая связанные и распространяемые таблицы маршрутов для этого подключения.
StaticRoute	Список всех статических маршрутов.
StaticRoutesConfig	Настройка статических маршрутов в этой конфигурации HubVnetConnectionConfiguration для статических маршрутов в этом HubVnetConnection.
SubResource	Ссылка на другой подресурс.
TrafficSelectorPolicy	Политика селектора трафика для подключения шлюза виртуальной сети.
VirtualNetworkGatewayConnectionProtocol	Протокол подключения, используемый для этого подключения.
VnetLocalRouteOverrideCriteria	Параметр определяет, пропускается ли NVA в периферийной виртуальной сети для трафика с назначением в периферийной виртуальной сети.
VnetRoute	Список маршрутов, которые управляют маршрутизацией из VirtualHub в подключение к виртуальной сети.
VpnConnection	Ресурс VpnConnection.
VpnConnectionStatus	Текущее состояние vpn-подключения.
VpnGateway	Ресурс VpnGateway.
VpnGatewayIpConfiguration	IP-конфигурация ресурса VPN-шлюза.
VpnGatewayNatRule	Ресурс VpnGatewayNatRule.
VpnLinkConnectionMode	Режим подключения vpn-канала.
VpnNatRuleMapping	Сопоставление Vpn NatRule.
VpnNatRuleMode	Направление исходного NAT ДЛЯ VPN-NAT.
VpnNatRuleType	Тип правила NAT для VPN NAT.
VpnSiteLinkConnection	Ресурс VpnSiteLinkConnection.

BgpSettings

Object

Сведения о параметрах BGP.

Имя	Тип	Описание
asn	integer	ASN докладчика BGP.
bgpPeeringAddress	string	Адрес пиринга BGP и идентификатор BGP этого докладчика BGP.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	Адрес пиринга BGP с идентификатором IP-конфигурации для шлюза виртуальной сети.
peerWeight	integer	Вес, добавленный к маршрутам, извлеченным из этого докладчика BGP.

CloudError

Object

Ответ на ошибку службы.

Имя	Тип	Описание
error	CloudErrorBody	Текст ошибки облака.

CloudErrorBody

Object

Ответ на ошибку службы.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

DhGroup

Enumeration

Группы DH, используемые на этапе IKE 1 для начального sa.

Значение	Описание
DHGroup1
DHGroup14
DHGroup2
DHGroup2048
DHGroup24
ECP256
ECP384
None

GatewayCustomBgpIpAddressIpConfiguration

Object

GatewayCustomBgpIpAddressIpConfiguration для подключения шлюза виртуальной сети.

Имя	Тип	Описание
customBgpIpAddress	string	Пользовательский объект BgpPeeringAddress, принадлежащий IpconfigurationId.
ipConfigurationId	string	IpconfigurationId ipconfiguration, который принадлежит шлюзу.

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[]	Список пользовательских адресов пиринга BGP, принадлежащих ip-конфигурации.
defaultBgpIpAddresses	string[]	Список адресов пиринга BGP по умолчанию, принадлежащих к IP-конфигурации.
ipconfigurationId	string	Идентификатор конфигурации IP-адресов, принадлежавшей шлюзу.
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	Группа DH, используемая на этапе IKE 1 для начального sa.
ikeEncryption	IkeEncryption	Алгоритм шифрования IKE (этап IKE 2).
ikeIntegrity	IkeIntegrity	Алгоритм целостности IKE (этап IKE 2).
ipsecEncryption	IpsecEncryption	Алгоритм шифрования IPSec (этап IKE 1).
ipsecIntegrity	IpsecIntegrity	Алгоритм целостности IPSec (этап IKE 1).
pfsGroup	PfsGroup	Группа Pfs, используемая на этапе IKE 2 для нового дочернего SA.
saDataSizeKilobytes	integer	Размер полезных данных IPSec (также называемый быстрым режимом или этапом 2 SA) в КБ для сайта vpn-туннеля.
saLifeTimeSeconds	integer	Связь безопасности IPSec (также называемая быстрым режимом или этапом 2 SA) в секундах для сайта vpn-туннеля сайта.

PfsGroup

Enumeration

Группы Pfs, используемые на этапе IKE 2 для нового дочернего SA.

Значение	Описание
ECP256
ECP384
None
PFS1
PFS14
PFS2
PFS2048
PFS24
PFSMM

PropagatedRouteTable

Object

Список маршрутов для объявления маршрутов.

Имя	Тип	Описание
ids	SubResource[]	Список идентификаторов ресурсов всех маршрутов.
labels	string[]	Список меток.

ProvisioningState

Enumeration

Текущее состояние подготовки.

Значение	Описание
Deleting
Failed
Succeeded
Updating

RoutingConfiguration

Object

Конфигурация маршрутизации, указывающая связанные и распространяемые таблицы маршрутов для этого подключения.

Имя	Тип	Описание
associatedRouteTable	SubResource	Идентификатор ресурса RouteTable, связанный с этой конфигурацией маршрутизации.
inboundRouteMap	SubResource	Идентификатор ресурса RouteMap, связанный с этой маршрутизациейConfiguration для входящих наученных маршрутов.
outboundRouteMap	SubResource	Идентификатор ресурса объектаRouteMap, связанного с этой маршрутизациейConfiguration для исходящих объявленных маршрутов.
propagatedRouteTables	PropagatedRouteTable	Список маршрутов для объявления маршрутов.
vnetRoutes	VnetRoute	Список маршрутов, которые управляют маршрутизацией из VirtualHub в подключение к виртуальной сети.

StaticRoute

Object

Список всех статических маршрутов.

Имя	Тип	Описание
addressPrefixes	string[]	Список всех префиксов адресов.
name	string	Имя staticRoute, уникальное в виртуальной сети.
nextHopIpAddress	string	Ip-адрес следующего прыжка.

StaticRoutesConfig

Object

Настройка статических маршрутов в этой конфигурации HubVnetConnectionConfiguration для статических маршрутов в этом HubVnetConnection.

Имя	Тип	Описание
propagateStaticRoutes	boolean	Логическое значение, указывающее, распространяются ли статические маршруты в этом соединении автоматически в таблицы маршрутов, к которым распространяется это соединение.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Параметр, определяющий, пропускается ли NVA в периферийной виртуальной сети для трафика с назначением в периферийной сети.

SubResource

Object

Ссылка на другой подресурс.

Имя	Тип	Описание
id	string	Идентификатор ресурса.

TrafficSelectorPolicy

Object

Политика селектора трафика для подключения шлюза виртуальной сети.

Имя	Тип	Описание
localAddressRanges	string[]	Коллекция локальных адресных пространств в формате CIDR.
remoteAddressRanges	string[]	Коллекция удаленных адресных пространств в формате CIDR.

VirtualNetworkGatewayConnectionProtocol

Enumeration

Протокол подключения, используемый для этого подключения.

Значение	Описание
IKEv1
IKEv2

VnetLocalRouteOverrideCriteria

Enumeration

Параметр определяет, пропускается ли NVA в периферийной виртуальной сети для трафика с назначением в периферийной виртуальной сети.

Значение	Описание
Contains
Equal

VnetRoute

Object

Список маршрутов, которые управляют маршрутизацией из VirtualHub в подключение к виртуальной сети.

Имя	Тип	Описание
bgpConnections	SubResource[]	Список ссылок на объекты HubBgpConnection.
staticRoutes	StaticRoute[]	Список всех статических маршрутов.
staticRoutesConfig	StaticRoutesConfig	Конфигурация статических маршрутов в этом HubVnetConnection.

VpnConnection

Object

Ресурс VpnConnection.

Имя	Тип	Описание
etag	string	Уникальная строка только для чтения, которая изменяется при обновлении ресурса.
id	string	Идентификатор ресурса.
name	string	Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу.
properties.connectionBandwidth	integer	Ожидаемая пропускная способность в МБPS.
properties.connectionStatus	VpnConnectionStatus	Состояние подключения.
properties.dpdTimeoutSeconds	integer	Время ожидания DPD в секундах для vpn-подключения.
properties.egressBytesTransferred	integer	Передаваемые исходящие байты.
properties.enableBgp	boolean	Флаг EnableBgp.
properties.enableInternetSecurity	boolean	Включите интернет-безопасность.
properties.enableRateLimiting	boolean	Флаг EnableBgp.
properties.ingressBytesTransferred	integer	Переданные байты входящего трафика.
properties.ipsecPolicies	IpsecPolicy[]	Политики IPSec, которые будут рассматриваться этим подключением.
properties.provisioningState	ProvisioningState	Состояние подготовки ресурса VPN-подключения.
properties.remoteVpnSite	SubResource	Идентификатор подключенного VPN-сайта.
properties.routingConfiguration	RoutingConfiguration	Конфигурация маршрутизации, указывающая связанные и распространяемые таблицы маршрутов для этого подключения.
properties.routingWeight	integer	Вес маршрутизации для VPN-подключения.
properties.sharedKey	string	SharedKey для vpn-подключения.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	Политики селектора трафика, которые будут рассматриваться этим подключением.
properties.useLocalAzureIpAddress	boolean	Используйте локальный IP-адрес Azure для инициирования подключения.
properties.usePolicyBasedTrafficSelectors	boolean	Включите селекторы трафика на основе политик.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Протокол подключения, используемый для этого подключения.
properties.vpnLinkConnections	VpnSiteLinkConnection[]	Список всех подключений vpn-сайта к шлюзу.

VpnConnectionStatus

Enumeration

Текущее состояние vpn-подключения.

Значение	Описание
Connected
Connecting
NotConnected
Unknown

VpnGateway

Object

Ресурс VpnGateway.

Имя	Тип	Описание
etag	string	Уникальная строка только для чтения, которая изменяется при обновлении ресурса.
id	string	Идентификатор ресурса.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.bgpSettings	BgpSettings	Параметры динамиков BGP шлюза локальной сети.
properties.connections	VpnConnection[]	Список всех vpn-подключений к шлюзу.
properties.enableBgpRouteTranslationForNat	boolean	Включите преобразование маршрутов BGP для NAT в этом VPNGateway.
properties.ipConfigurations	VpnGatewayIpConfiguration[]	Список всех IP-адресов, настроенных на шлюзе.
properties.isRoutingPreferenceInternet	boolean	Включите свойство параметра маршрутизации для общедоступного IP-интерфейса VpnGateway.
properties.natRules	VpnGatewayNatRule[]	Список всех правил NAT, связанных с шлюзом.
properties.provisioningState	ProvisioningState	Состояние подготовки ресурса VPN-шлюза.
properties.virtualHub	SubResource	VirtualHub, к которому принадлежит шлюз.
properties.vpnGatewayScaleUnit	integer	Единица масштабирования для этого VPN-шлюза.
tags	object	Теги ресурсов.
type	string	Тип ресурса.

VpnGatewayIpConfiguration

Object

IP-конфигурация ресурса VPN-шлюза.

Имя	Тип	Описание
id	string	Идентификатор конфигурации IP-адресов для VPN-шлюза.
privateIpAddress	string	Частный IP-адрес этой ip-конфигурации.
publicIpAddress	string	Общедоступный IP-адрес этой конфигурации IP-адресов.

VpnGatewayNatRule

Object

Ресурс VpnGatewayNatRule.

Имя	Тип	Описание
etag	string	Уникальная строка только для чтения, которая изменяется при обновлении ресурса.
id	string	Идентификатор ресурса.
name	string	Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу.
properties.egressVpnSiteLinkConnections	SubResource[]	Список исходящих данных VpnSiteLinkConnections.
properties.externalMappings	VpnNatRuleMapping[]	Внешнее сопоставление частных IP-адресов для NAT.
properties.ingressVpnSiteLinkConnections	SubResource[]	Список ingress VpnSiteLinkConnections.
properties.internalMappings	VpnNatRuleMapping[]	Внутреннее сопоставление частных IP-адресов для NAT.
properties.ipConfigurationId	string	Идентификатор конфигурации IP-адресов, к этому правилу NAT применяется.
properties.mode	VpnNatRuleMode	Направление исходного NAT ДЛЯ VPN-NAT.
properties.provisioningState	ProvisioningState	Состояние подготовки ресурса правила NAT.
properties.type	VpnNatRuleType	Тип правила NAT для VPN NAT.
type	string	Тип ресурса.

VpnLinkConnectionMode

Enumeration

Режим подключения vpn-канала.

Значение	Описание
Default
InitiatorOnly
ResponderOnly

VpnNatRuleMapping

Object

Сопоставление Vpn NatRule.

Имя	Тип	Описание
addressSpace	string	Адресное пространство для сопоставления Vpn NatRule.
portRange	string	Диапазон портов для сопоставления Vpn NatRule.

VpnNatRuleMode

Enumeration

Направление исходного NAT ДЛЯ VPN-NAT.

Значение	Описание
EgressSnat
IngressSnat

VpnNatRuleType

Enumeration

Тип правила NAT для VPN NAT.

Значение	Описание
Dynamic
Static

VpnSiteLinkConnection

Object

Ресурс VpnSiteLinkConnection.

Имя	Тип	Описание
etag	string	Уникальная строка только для чтения, которая изменяется при обновлении ресурса.
id	string	Идентификатор ресурса.
name	string	Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу.
properties.connectionBandwidth	integer	Ожидаемая пропускная способность в МБPS.
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	SharedKey для vpn-подключения.
properties.useLocalAzureIpAddress	boolean	Используйте локальный IP-адрес Azure для инициирования подключения.
properties.usePolicyBasedTrafficSelectors	boolean	Включите селекторы трафика на основе политик.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Протокол подключения, используемый для этого подключения.
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	vpnGatewayCustomBgpAddresses, используемый этим подключением.
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	Режим подключения vpn-канала.
properties.vpnSiteLink	SubResource	Идентификатор ссылки подключенного VPN-сайта.
type	string	Тип ресурса.