Vpn Connections - Create Or Update

Servicio:

Virtual WAN

Versión de la API:

2024-05-01

Crea una conexión VPN a una puerta de enlace de VPN escalable si no existe, actualiza la conexión existente.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
connectionName	path	True	string	Nombre de la conexión.
gatewayName	path	True	string	Nombre de la puerta de enlace.
resourceGroupName	path	True	string	Nombre del grupo de recursos de VpnGateway.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string	Versión de la API de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
id	string	Identificador de 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.dpdTimeoutSeconds	integer	Tiempo de espera de DPD en segundos para la conexión vpn.
properties.enableBgp	boolean	Marca EnableBgp.
properties.enableInternetSecurity	boolean	Habilite la seguridad de Internet.
properties.enableRateLimiting	boolean	Marca EnableBgp.
properties.ipsecPolicies	IpsecPolicy[]	Las directivas IPSec que debe tener en cuenta esta conexión.
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.

Respuestas

Nombre	Tipo	Description
200 OK	VpnConnection	Solicitud correcta. Devuelve los detalles de la conexión VPN creada o actualizada.
201 Created	VpnConnection	Solicitud correcta. Devuelve los detalles de la conexión VPN creada o actualizada.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

VpnConnectionPut

Solicitud de ejemplo

HTTP

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

{
  "properties": {
    "remoteVpnSite": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
    },
    "vpnLinkConnections": [
      {
        "name": "Connection-Link1",
        "properties": {
          "vpnSiteLink": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
          },
          "connectionBandwidth": 200,
          "vpnConnectionProtocolType": "IKEv2",
          "sharedKey": "key",
          "vpnLinkConnectionMode": "Default",
          "usePolicyBasedTrafficSelectors": false
        }
      }
    ],
    "routingConfiguration": {
      "associatedRouteTable": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
      },
      "propagatedRouteTables": {
        "labels": [
          "label1",
          "label2"
        ],
        "ids": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
          },
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"
          },
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"
          }
        ]
      },
      "inboundRouteMap": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"
      },
      "outboundRouteMap": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"
      }
    },
    "trafficSelectorPolicies": []
  }
}

Java

import com.azure.core.management.SubResource;
import com.azure.resourcemanager.network.fluent.models.VpnConnectionInner;
import com.azure.resourcemanager.network.fluent.models.VpnSiteLinkConnectionInner;
import com.azure.resourcemanager.network.models.PropagatedRouteTable;
import com.azure.resourcemanager.network.models.RoutingConfiguration;
import com.azure.resourcemanager.network.models.VirtualNetworkGatewayConnectionProtocol;
import com.azure.resourcemanager.network.models.VpnLinkConnectionMode;
import java.util.Arrays;

/**
 * Samples for VpnConnections CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnConnectionPut.json
     */
    /**
     * Sample code: VpnConnectionPut.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnConnectionPut(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnConnections()
            .createOrUpdate("rg1", "gateway1", "vpnConnection1", new VpnConnectionInner()
                .withRemoteVpnSite(new SubResource()
                    .withId("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"))
                .withTrafficSelectorPolicies(Arrays.asList())
                .withVpnLinkConnections(Arrays.asList(new VpnSiteLinkConnectionInner().withName("Connection-Link1")
                    .withVpnSiteLink(new SubResource().withId(
                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"))
                    .withVpnLinkConnectionMode(VpnLinkConnectionMode.DEFAULT)
                    .withVpnConnectionProtocolType(VirtualNetworkGatewayConnectionProtocol.IKEV2)
                    .withConnectionBandwidth(200).withSharedKey("fakeTokenPlaceholder")
                    .withUsePolicyBasedTrafficSelectors(false)))
                .withRoutingConfiguration(new RoutingConfiguration().withAssociatedRouteTable(new SubResource().withId(
                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"))
                    .withPropagatedRouteTables(new PropagatedRouteTable().withLabels(Arrays.asList("label1", "label2"))
                        .withIds(Arrays.asList(new SubResource().withId(
                            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"),
                            new SubResource().withId(
                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"),
                            new SubResource().withId(
                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"))))
                    .withInboundRouteMap(new SubResource().withId(
                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"))
                    .withOutboundRouteMap(new SubResource().withId(
                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"))),
                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

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/VpnConnectionPut.json
func ExampleVPNConnectionsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVPNConnectionsClient().BeginCreateOrUpdate(ctx, "rg1", "gateway1", "vpnConnection1", armnetwork.VPNConnection{
		Properties: &armnetwork.VPNConnectionProperties{
			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/hub1/hubRouteTables/hubRouteTable1"),
				},
				InboundRouteMap: &armnetwork.SubResource{
					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"),
				},
				OutboundRouteMap: &armnetwork.SubResource{
					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"),
				},
				PropagatedRouteTables: &armnetwork.PropagatedRouteTable{
					IDs: []*armnetwork.SubResource{
						{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"),
						},
						{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"),
						},
						{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"),
						}},
					Labels: []*string{
						to.Ptr("label1"),
						to.Ptr("label2")},
				},
			},
			TrafficSelectorPolicies: []*armnetwork.TrafficSelectorPolicy{},
			VPNLinkConnections: []*armnetwork.VPNSiteLinkConnection{
				{
					Name: to.Ptr("Connection-Link1"),
					Properties: &armnetwork.VPNSiteLinkConnectionProperties{
						ConnectionBandwidth:            to.Ptr[int32](200),
						SharedKey:                      to.Ptr("key"),
						UsePolicyBasedTrafficSelectors: to.Ptr(false),
						VPNConnectionProtocolType:      to.Ptr(armnetwork.VirtualNetworkGatewayConnectionProtocolIKEv2),
						VPNLinkConnectionMode:          to.Ptr(armnetwork.VPNLinkConnectionModeDefault),
						VPNSiteLink: &armnetwork.SubResource{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"),
						},
					},
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VPNConnection = 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/hub1/hubRouteTables/hubRouteTable1"),
	// 			},
	// 			InboundRouteMap: &armnetwork.SubResource{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"),
	// 			},
	// 			OutboundRouteMap: &armnetwork.SubResource{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"),
	// 			},
	// 			PropagatedRouteTables: &armnetwork.PropagatedRouteTable{
	// 				IDs: []*armnetwork.SubResource{
	// 					{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"),
	// 					},
	// 					{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"),
	// 					},
	// 					{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"),
	// 				}},
	// 				Labels: []*string{
	// 					to.Ptr("label1"),
	// 					to.Ptr("label2")},
	// 				},
	// 			},
	// 			TrafficSelectorPolicies: []*armnetwork.TrafficSelectorPolicy{
	// 			},
	// 			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),
	// 						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),
	// 						VPNLinkConnectionMode: to.Ptr(armnetwork.VPNLinkConnectionModeDefault),
	// 						VPNSiteLink: &armnetwork.SubResource{
	// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"),
	// 						},
	// 					},
	// 			}},
	// 		},
	// 	}
}

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 Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.
 *
 * @summary Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnConnectionPut.json
 */
async function vpnConnectionPut() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const gatewayName = "gateway1";
  const connectionName = "vpnConnection1";
  const vpnConnectionParameters = {
    remoteVpnSite: {
      id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
    },
    routingConfiguration: {
      associatedRouteTable: {
        id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1",
      },
      inboundRouteMap: {
        id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1",
      },
      outboundRouteMap: {
        id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2",
      },
      propagatedRouteTables: {
        ids: [
          {
            id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1",
          },
          {
            id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2",
          },
          {
            id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3",
          },
        ],
        labels: ["label1", "label2"],
      },
    },
    trafficSelectorPolicies: [],
    vpnLinkConnections: [
      {
        name: "Connection-Link1",
        connectionBandwidth: 200,
        sharedKey: "key",
        usePolicyBasedTrafficSelectors: false,
        vpnConnectionProtocolType: "IKEv2",
        vpnLinkConnectionMode: "Default",
        vpnSiteLink: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1",
        },
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.vpnConnections.beginCreateOrUpdateAndWait(
    resourceGroupName,
    gatewayName,
    connectionName,
    vpnConnectionParameters,
  );
  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

Respuesta de muestra

status code:

200

{
  "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",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
        "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,
          "vpnLinkConnectionMode": "Default"
        }
      }
    ],
    "routingConfiguration": {
      "associatedRouteTable": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
      },
      "propagatedRouteTables": {
        "labels": [
          "label1",
          "label2"
        ],
        "ids": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
          },
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"
          },
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"
          }
        ]
      },
      "inboundRouteMap": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"
      },
      "outboundRouteMap": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"
      }
    },
    "trafficSelectorPolicies": []
  }
}

status code:

201

{
  "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",
        "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,
          "vpnLinkConnectionMode": "Default"
        }
      }
    ],
    "routingConfiguration": {
      "associatedRouteTable": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
      },
      "propagatedRouteTables": {
        "labels": [
          "label1",
          "label2"
        ],
        "ids": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
          },
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"
          },
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"
          }
        ]
      },
      "inboundRouteMap": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"
      },
      "outboundRouteMap": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"
      }
    },
    "trafficSelectorPolicies": []
  }
}

Definiciones

Nombre	Description
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	El algoritmo de cifrado IKE (fase 2 de IKE).
IkeIntegrity	El algoritmo de integridad de IKE (fase 2 de IKE).
IpsecEncryption	El algoritmo de cifrado IPSec (fase 1 de IKE).
IpsecIntegrity	El 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 las 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 este 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 se omite la NVA en la red virtual radial 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.
VpnLinkConnectionMode	Modo de conexión de vínculo vpn.
VpnSiteLinkConnection	Recurso VpnSiteLinkConnection.

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

El algoritmo de cifrado 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

IpsecEncryption

El 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

El 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 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	El 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 las 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	El identificador de recurso RouteTable asociado a este RoutingConfiguration.
inboundRouteMap	SubResource	El identificador de recurso del objeto RouteMap asociado a este Objeto RoutingConfiguration para las rutas aprendidas de entrada.
outboundRouteMap	SubResource	El identificador de recurso derouteMap asociado a este routingConfiguration para las rutas anunciadas salientes.
propagatedRouteTables	PropagatedRouteTable	Lista de RouteTables a las 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 instancia de VnetRoute.
nextHopIpAddress	string	Dirección IP del próximo salto.

StaticRoutesConfig

Configuración de rutas estáticas en este 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 se omite la NVA en la red virtual de radio para el tráfico con destino en radio.

SubResource

Referencia a otro subrecurso.

Nombre	Tipo	Description
id	string	Identificador de 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 se omite la NVA en la red virtual radial 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 de 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

VpnLinkConnectionMode

Modo de conexión de vínculo vpn.

Nombre	Tipo	Description
Default	string
InitiatorOnly	string
ResponderOnly	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 de 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 detección del mismo nivel inactivo en segundos para la conexión VpnLink.
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 entradas NatRules.
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.