Vpn Gateways - Get

Service:

Virtual WAN

API Version:

2023-09-01

Recupera los detalles de una puerta de enlace de VPN wan virtual.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
gatewayName	path	True	string	El nombre de la puerta de enlace.
resourceGroupName	path	True	string	Nombre del grupo de recursos de VpnGateway.
subscriptionId	path	True	string	Las credenciales de suscripción que identifican de forma exclusiva la suscripción a Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de API del cliente.

Respuestas

Nombre	Tipo	Description
200 OK	VpnGateway	Solicite correctamente. Devuelve los detalles de la puerta de enlace vpn de virtual wan recuperada.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

VpnGatewayGet

Sample Request

HTTP

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

Java

/**
 * Samples for VpnGateways GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-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/2023-09-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/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/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/2023-09-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 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;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this VpnGatewayResource
VpnGatewayCollection collection = resourceGroupResource.GetVpnGateways();

// invoke the operation
string gatewayName = "gateway1";
NullableResponse<VpnGatewayResource> response = await collection.GetIfExistsAsync(gatewayName);
VpnGatewayResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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

Sample Response

Status code:

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
  }
}

Definiciones

Nombre	Description
BgpSettings	Detalles de configuración de BGP.
CloudError	Respuesta de error del servicio.
CloudErrorBody	Respuesta de error del servicio.
DhGroup	Los grupos de DH usados en la fase 1 de IKE para la SA inicial.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration para una conexión de puerta de enlace de red virtual.
IkeEncryption	Algoritmo de cifrado de IKE (fase 2 de IKE).
IkeIntegrity	El algoritmo de integridad de IKE (fase 2 de IKE).
IPConfigurationBgpPeeringAddress	Propiedades de IPConfigurationBgpPeeringAddress.
IpsecEncryption	Algoritmo de cifrado IPSec (fase 1 de IKE).
IpsecIntegrity	Algoritmo de integridad de IPSec (fase 1 de IKE).
IpsecPolicy	Una configuración de directiva IPSec para una conexión de puerta de enlace de red virtual.
PfsGroup	Los grupos pfs usados en la fase 2 de IKE para la nueva SA secundaria.
PropagatedRouteTable	Lista de RouteTables a la que anunciar las rutas.
ProvisioningState	Estado de aprovisionamiento actual.
RoutingConfiguration	Configuración de enrutamiento que indica las tablas de rutas asociadas y propagadas para esta conexión.
StaticRoute	Lista de todas las rutas estáticas.
StaticRoutesConfig	Configuración de rutas estáticas en hubVnetConnectionConfiguration para rutas estáticas en este hubVnetConnection.
SubResource	Referencia a otro subrecurso.
TrafficSelectorPolicy	Una directiva de selector de tráfico para una conexión de puerta de enlace de red virtual.
VirtualNetworkGatewayConnectionProtocol	Protocolo de conexión usado para esta conexión.
VnetLocalRouteOverrideCriteria	Parámetro que determina si la NVA en la red virtual de radio se omite para el tráfico con destino en la red virtual de radio.
VnetRoute	Lista de rutas que controlan el enrutamiento desde VirtualHub a una conexión de red virtual.
VpnConnection	Recurso VpnConnection.
VpnConnectionStatus	Estado actual de la conexión VPN.
VpnGateway	Recurso vpnGateway.
VpnGatewayIpConfiguration	Configuración de IP de un recurso de VPN Gateway.
VpnGatewayNatRule	Recurso VpnGatewayNatRule.
VpnLinkConnectionMode	Modo de conexión de vínculo vpn.
VpnNatRuleMapping	Asignación de NatRule de VPN.
VpnNatRuleMode	Dirección NAT de origen de una NAT de VPN.
VpnNatRuleType	Tipo de regla NAT para VPN NAT.
VpnSiteLinkConnection	Recurso VpnSiteLinkConnection.

BgpSettings

Detalles de configuración de BGP.

Nombre	Tipo	Description
asn	integer	ASN del altavoz BGP.
bgpPeeringAddress	string	La dirección de emparejamiento BGP y el identificador BGP de este altavoz BGP.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	Dirección de emparejamiento BGP con identificador de configuración ip para la puerta de enlace de red virtual.
peerWeight	integer	El peso agregado a las rutas aprendidas de este altavoz BGP.

CloudError

Respuesta de error del servicio.

Nombre	Tipo	Description
error	CloudErrorBody	Cuerpo del error en la nube.

CloudErrorBody

Respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

DhGroup

Los grupos de DH usados en la fase 1 de IKE para la SA inicial.

Nombre	Tipo	Description
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration para una conexión de puerta de enlace de red virtual.

Nombre	Tipo	Description
customBgpIpAddress	string	El BgpPeeringAddress personalizado que pertenece a IpconfigurationId.
ipConfigurationId	string	IpconfigurationId de ipconfiguration que pertenece a la puerta de enlace.

IkeEncryption

Algoritmo de cifrado de IKE (fase 2 de IKE).

Nombre	Tipo	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

El algoritmo de integridad de IKE (fase 2 de IKE).

Nombre	Tipo	Description
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IPConfigurationBgpPeeringAddress

Propiedades de IPConfigurationBgpPeeringAddress.

Nombre	Tipo	Description
customBgpIpAddresses	string[]	Lista de direcciones de emparejamiento BGP personalizadas que pertenecen a la configuración de IP.
defaultBgpIpAddresses	string[]	Lista de direcciones de emparejamiento BGP predeterminadas que pertenecen a la configuración de IP.
ipconfigurationId	string	Identificador de la configuración de IP que pertenece a la puerta de enlace.
tunnelIpAddresses	string[]	Lista de direcciones IP públicas de túnel que pertenecen a la configuración de IP.

IpsecEncryption

Algoritmo de cifrado IPSec (fase 1 de IKE).

Nombre	Tipo	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

Algoritmo de integridad de IPSec (fase 1 de IKE).

Nombre	Tipo	Description
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

Una configuración de directiva IPSec para una conexión de puerta de enlace de red virtual.

Nombre	Tipo	Description
dhGroup	DhGroup	El grupo de DH usado en la fase 1 de IKE para la SA inicial.
ikeEncryption	IkeEncryption	El algoritmo de cifrado de IKE (fase 2 de IKE).
ikeIntegrity	IkeIntegrity	El algoritmo de integridad de IKE (fase 2 de IKE).
ipsecEncryption	IpsecEncryption	El algoritmo de cifrado IPSec (fase 1 de IKE).
ipsecIntegrity	IpsecIntegrity	El algoritmo de integridad de IPSec (fase 1 de IKE).
pfsGroup	PfsGroup	Grupo Pfs usado en la fase 2 de IKE para la nueva SA secundaria.
saDataSizeKilobytes	integer	El tamaño de carga de la asociación de seguridad IPSec (también denominado modo rápido o SA de fase 2) en KB para un túnel VPN de sitio a sitio.
saLifeTimeSeconds	integer	La duración de la asociación de seguridad IPSec (también denominada Modo rápido o SA de fase 2) en segundos para un túnel VPN de sitio a sitio.

PfsGroup

Los grupos pfs usados en la fase 2 de IKE para la nueva SA secundaria.

Nombre	Tipo	Description
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

PropagatedRouteTable

Lista de RouteTables a la que anunciar las rutas.

Nombre	Tipo	Description
ids	SubResource[]	Lista de identificadores de recursos de todas las RouteTables.
labels	string[]	Lista de etiquetas.

ProvisioningState

Estado de aprovisionamiento actual.

Nombre	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingConfiguration

Configuración de enrutamiento que indica las tablas de rutas asociadas y propagadas para esta conexión.

Nombre	Tipo	Description
associatedRouteTable	SubResource	Id. de recurso RouteTable asociado a este RoutingConfiguration.
inboundRouteMap	SubResource	El identificador de recurso de RouteMap asociado a este RoutingConfiguration para las rutas aprendidas entrantes.
outboundRouteMap	SubResource	El identificador de recurso derouteMap asociado a este RoutingConfiguration para las rutas anunciadas salientes.
propagatedRouteTables	PropagatedRouteTable	Lista de RouteTables a la que anunciar las rutas.
vnetRoutes	VnetRoute	Lista de rutas que controlan el enrutamiento desde VirtualHub a una conexión de red virtual.

StaticRoute

Lista de todas las rutas estáticas.

Nombre	Tipo	Description
addressPrefixes	string[]	Lista de todos los prefijos de dirección.
name	string	Nombre de StaticRoute que es único dentro de una red virtual.
nextHopIpAddress	string	Dirección IP del próximo salto.

StaticRoutesConfig

Configuración de rutas estáticas en hubVnetConnectionConfiguration para rutas estáticas en este hubVnetConnection.

Nombre	Tipo	Description
propagateStaticRoutes	boolean	Boolean que indica si las rutas estáticas de esta conexión se propagan automáticamente a las tablas de rutas a las que se propaga esta conexión.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Parámetro que determina si la NVA en la red virtual de radio se omite para el tráfico con destino en radio.

SubResource

Referencia a otro subrecurso.

Nombre	Tipo	Description
id	string	Identificador del recurso.

TrafficSelectorPolicy

Una directiva de selector de tráfico para una conexión de puerta de enlace de red virtual.

Nombre	Tipo	Description
localAddressRanges	string[]	Colección de espacios de direcciones locales en formato CIDR.
remoteAddressRanges	string[]	Colección de espacios de direcciones remotas en formato CIDR.

VirtualNetworkGatewayConnectionProtocol

Protocolo de conexión usado para esta conexión.

Nombre	Tipo	Description
IKEv1	string
IKEv2	string

VnetLocalRouteOverrideCriteria

Parámetro que determina si la NVA en la red virtual de radio se omite para el tráfico con destino en la red virtual de radio.

Nombre	Tipo	Description
Contains	string
Equal	string

VnetRoute

Lista de rutas que controlan el enrutamiento desde VirtualHub a una conexión de red virtual.

Nombre	Tipo	Description
bgpConnections	SubResource[]	Lista de referencias a objetos HubBgpConnection.
staticRoutes	StaticRoute[]	Lista de todas las rutas estáticas.
staticRoutesConfig	StaticRoutesConfig	Configuración de rutas estáticas en este hubVnetConnection.

VpnConnection

Recurso VpnConnection.

Nombre	Tipo	Description
etag	string	Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string	Identificador del recurso.
name	string	Nombre del recurso que es único dentro de un grupo de recursos. Este nombre se puede usar para acceder al recurso.
properties.connectionBandwidth	integer	Ancho de banda esperado en MBPS.
properties.connectionStatus	VpnConnectionStatus	Estado de conexión.
properties.dpdTimeoutSeconds	integer	Tiempo de espera de DPD en segundos para la conexión VPN.
properties.egressBytesTransferred	integer	Bytes de salida transferidos.
properties.enableBgp	boolean	Marca EnableBgp.
properties.enableInternetSecurity	boolean	Habilite la seguridad de Internet.
properties.enableRateLimiting	boolean	Marca EnableBgp.
properties.ingressBytesTransferred	integer	Bytes de entrada transferidos.
properties.ipsecPolicies	IpsecPolicy[]	Las directivas ipsec que debe tener en cuenta esta conexión.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso de conexión VPN.
properties.remoteVpnSite	SubResource	Identificador del sitio vpn conectado.
properties.routingConfiguration	RoutingConfiguration	Configuración de enrutamiento que indica las tablas de rutas asociadas y propagadas en esta conexión.
properties.routingWeight	integer	Peso del enrutamiento para la conexión VPN.
properties.sharedKey	string	SharedKey para la conexión VPN.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	Las directivas del selector de tráfico que debe tener en cuenta esta conexión.
properties.useLocalAzureIpAddress	boolean	Use azure ip local para iniciar la conexión.
properties.usePolicyBasedTrafficSelectors	boolean	Habilite los selectores de tráfico basados en directivas.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Protocolo de conexión usado para esta conexión.
properties.vpnLinkConnections	VpnSiteLinkConnection[]	Lista de todas las conexiones de vínculo de sitio vpn a la puerta de enlace.

VpnConnectionStatus

Estado actual de la conexión VPN.

Nombre	Tipo	Description
Connected	string
Connecting	string
NotConnected	string
Unknown	string

VpnGateway

Recurso vpnGateway.

Nombre	Tipo	Description
etag	string	Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string	Identificador del recurso.
location	string	Ubicación del recurso
name	string	Nombre del recurso.
properties.bgpSettings	BgpSettings	Configuración del altavoz BGP de la puerta de enlace de red local.
properties.connections	VpnConnection[]	Lista de todas las conexiones VPN a la puerta de enlace.
properties.enableBgpRouteTranslationForNat	boolean	Habilite la traducción de rutas BGP para NAT en este VpnGateway.
properties.ipConfigurations	VpnGatewayIpConfiguration[]	Lista de todas las direcciones IP configuradas en la puerta de enlace.
properties.isRoutingPreferenceInternet	boolean	Habilite la propiedad Preferencia de enrutamiento para la interfaz IP pública de VpnGateway.
properties.natRules	VpnGatewayNatRule[]	Lista de todas las reglas nat asociadas a la puerta de enlace.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso de VPN Gateway.
properties.virtualHub	SubResource	El centro virtual al que pertenece la puerta de enlace.
properties.vpnGatewayScaleUnit	integer	Unidad de escalado de esta puerta de enlace de VPN.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso.

VpnGatewayIpConfiguration

Configuración de IP de un recurso de VPN Gateway.

Nombre	Tipo	Description
id	string	Identificador de la configuración de IP de un VPN Gateway.
privateIpAddress	string	La dirección IP privada de esta configuración de IP.
publicIpAddress	string	La dirección IP pública de esta configuración de IP.

VpnGatewayNatRule

Recurso VpnGatewayNatRule.

Nombre	Tipo	Description
etag	string	Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string	Identificador del recurso.
name	string	Nombre del recurso que es único dentro de un grupo de recursos. Este nombre se puede usar para acceder al recurso.
properties.egressVpnSiteLinkConnections	SubResource[]	Lista de salidas VpnSiteLinkConnections.
properties.externalMappings	VpnNatRuleMapping[]	Asignación externa de dirección IP privada para NAT.
properties.ingressVpnSiteLinkConnections	SubResource[]	Lista de entradas VpnSiteLinkConnections.
properties.internalMappings	VpnNatRuleMapping[]	Asignación interna de direcciones IP privadas para NAT.
properties.ipConfigurationId	string	El identificador de configuración de IP al que se aplica esta regla NAT.
properties.mode	VpnNatRuleMode	Dirección NAT de origen de una NAT de VPN.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso de regla NAT.
properties.type	VpnNatRuleType	Tipo de regla NAT para VPN NAT.
type	string	Tipo de recurso.

VpnLinkConnectionMode

Modo de conexión de vínculo vpn.

Nombre	Tipo	Description
Default	string
InitiatorOnly	string
ResponderOnly	string

VpnNatRuleMapping

Asignación de NatRule de VPN.

Nombre	Tipo	Description
addressSpace	string	Espacio de direcciones para la asignación de NatRule de Vpn.
portRange	string	Intervalo de puertos para la asignación de NatRule de Vpn.

VpnNatRuleMode

Dirección NAT de origen de una NAT de VPN.

Nombre	Tipo	Description
EgressSnat	string
IngressSnat	string

VpnNatRuleType

Tipo de regla NAT para VPN NAT.

Nombre	Tipo	Description
Dynamic	string
Static	string

VpnSiteLinkConnection

Recurso VpnSiteLinkConnection.

Nombre	Tipo	Description
etag	string	Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string	Identificador del recurso.
name	string	Nombre del recurso que es único dentro de un grupo de recursos. Este nombre se puede usar para acceder al recurso.
properties.connectionBandwidth	integer	Ancho de banda esperado en MBPS.
properties.connectionStatus	VpnConnectionStatus	Estado de conexión.
properties.egressBytesTransferred	integer	Bytes de salida transferidos.
properties.egressNatRules	SubResource[]	Lista de natrules de salida.
properties.enableBgp	boolean	Marca EnableBgp.
properties.enableRateLimiting	boolean	Marca EnableBgp.
properties.ingressBytesTransferred	integer	Bytes de entrada transferidos.
properties.ingressNatRules	SubResource[]	Lista de natRules de entrada.
properties.ipsecPolicies	IpsecPolicy[]	Las directivas IPSec que debe tener en cuenta esta conexión.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso de conexión de vínculo de sitio VPN.
properties.routingWeight	integer	Peso del enrutamiento para la conexión VPN.
properties.sharedKey	string	SharedKey para la conexión VPN.
properties.useLocalAzureIpAddress	boolean	Use azure ip local para iniciar la conexión.
properties.usePolicyBasedTrafficSelectors	boolean	Habilite los selectores de tráfico basados en directivas.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Protocolo de conexión usado para esta conexión.
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	vpnGatewayCustomBgpAddresses usado por esta conexión.
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	Modo de conexión de vínculo vpn.
properties.vpnSiteLink	SubResource	Identificador del vínculo del sitio vpn conectado.
type	string	Tipo de recurso.