Vpn Connections - Create Or Update

Service:

Virtual WAN

API-versie:

2024-05-01

Hiermee maakt u een VPN-verbinding met een schaalbare VPN-gateway als deze niet bestaat, wordt de bestaande verbinding bijgewerkt.

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

URI-parameters

Name	In	Vereist	Type	Description
connectionName	path	True	string	De naam van de verbinding.
gatewayName	path	True	string	De naam van de gateway.
resourceGroupName	path	True	string	De naam van de resourcegroep van de VpnGateway.
subscriptionId	path	True	string	De abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Type	Description
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.connectionBandwidth	integer (int32)	Verwachte bandbreedte in MBPS.
properties.dpdTimeoutSeconds	integer (int32)	DPD-time-out in seconden voor vpn-verbinding.
properties.enableBgp	boolean	EnableBgp-vlag.
properties.enableInternetSecurity	boolean	Internetbeveiliging inschakelen.
properties.enableRateLimiting	boolean	EnableBgp-vlag.
properties.ipsecPolicies	IpsecPolicy[]	Het IPSec-beleid dat door deze verbinding moet worden overwogen.
properties.remoteVpnSite	SubResource	Id van de verbonden VPN-site.
properties.routingConfiguration	RoutingConfiguration	De routeringsconfiguratie die de gekoppelde en doorgegeven routetabellen op deze verbinding aangeeft.
properties.routingWeight	integer (int32)	Routeringsgewicht voor vpn-verbinding.
properties.sharedKey	string	SharedKey voor de VPN-verbinding.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	Het beleid voor verkeersselector dat door deze verbinding moet worden overwogen.
properties.useLocalAzureIpAddress	boolean	Gebruik lokale Azure IP om verbinding te initiëren.
properties.usePolicyBasedTrafficSelectors	boolean	Schakel verkeerkiezers op basis van beleid in.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Verbindingsprotocol dat wordt gebruikt voor deze verbinding.
properties.vpnLinkConnections	VpnSiteLinkConnection[]	Lijst met alle vpn-sitekoppelingen naar de gateway.

Antwoorden

Name	Type	Description
200 OK	VpnConnection	Aanvraag is voltooid. Retourneert de details van de vpn-verbinding die is gemaakt of bijgewerkt.
201 Created	VpnConnection	Aanvraag is voltooid. Retourneert de details van de vpn-verbinding die is gemaakt of bijgewerkt.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

VpnConnectionPut

Voorbeeldaanvraag

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

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.Resources.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnConnectionPut.json
// this example is just showing the usage of "VpnConnections_CreateOrUpdate" 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);

// get the collection of this VpnConnectionResource
VpnConnectionCollection collection = vpnGateway.GetVpnConnections();

// invoke the operation
string connectionName = "vpnConnection1";
VpnConnectionData data = new VpnConnectionData
{
    RemoteVpnSiteId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"),
    TrafficSelectorPolicies = { },
    VpnLinkConnections = {new VpnSiteLinkConnectionData
    {
    VpnSiteLinkId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"),
    VpnLinkConnectionMode = VpnLinkConnectionMode.Default,
    VpnConnectionProtocolType = VirtualNetworkGatewayConnectionProtocol.IkeV2,
    ConnectionBandwidth = 200,
    SharedKey = "key",
    UsePolicyBasedTrafficSelectors = false,
    Name = "Connection-Link1",
    }},
    RoutingConfiguration = new RoutingConfiguration
    {
        AssociatedRouteTableId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"),
        PropagatedRouteTables = new PropagatedRouteTable
        {
            Labels = { "label1", "label2" },
            Ids = {new WritableSubResource
            {
            Id = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"),
            }, new WritableSubResource
            {
            Id = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"),
            }, new WritableSubResource
            {
            Id = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"),
            }},
        },
        InboundRouteMapId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"),
        OutboundRouteMapId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"),
    },
};
ArmOperation<VpnConnectionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, connectionName, data);
VpnConnectionResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
VpnConnectionData 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

Voorbeeldrespons

Statuscode:

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": []
  }
}

Statuscode:

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": []
  }
}

Definities

Name	Description
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
DhGroup	De DH-groepen die worden gebruikt in IKE Fase 1 voor de eerste SA.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration voor een virtuele netwerkgatewayverbinding.
IkeEncryption	Het IKE-versleutelingsalgoritmen (IKE-fase 2).
IkeIntegrity	Het IKE-integriteitsalgoritmen (IKE-fase 2).
IpsecEncryption	Het IPSec-versleutelingsalgoritmen (IKE-fase 1).
IpsecIntegrity	Het IPSec-integriteitsalgoritmen (IKE-fase 1).
IpsecPolicy	Een IPSec-beleidsconfiguratie voor een virtuele netwerkgatewayverbinding.
PfsGroup	De Pfs-groepen die worden gebruikt in IKE Fase 2 voor nieuwe onderliggende SA.
PropagatedRouteTable	De lijst met RouteTables om de routes naar te adverteren.
ProvisioningState	De huidige inrichtingsstatus.
RoutingConfiguration	Routeringsconfiguratie die de gekoppelde en doorgegeven routetabellen voor deze verbinding aangeeft.
StaticRoute	Lijst met alle statische routes.
StaticRoutesConfig	Configuratie voor statische routes op deze HubVnetConnectionConfiguration voor statische routes op deze HubVnetConnection.
SubResource	Verwijzing naar een andere subresource.
TrafficSelectorPolicy	Een verkeersselectorbeleid voor een gatewayverbinding met een virtueel netwerk.
VirtualNetworkGatewayConnectionProtocol	Verbindingsprotocol dat wordt gebruikt voor deze verbinding.
VnetLocalRouteOverrideCriteria	Parameter die bepaalt of NVA in spoke-vnet wordt omzeild voor verkeer met bestemming in spoke-vnet.
VnetRoute	Lijst met routes die routering van VirtualHub naar een virtuele netwerkverbinding beheren.
VpnConnection	VpnConnection-resource.
VpnConnectionStatus	De huidige status van de VPN-verbinding.
VpnLinkConnectionMode	Vpn-koppelingsverbindingsmodus.
VpnSiteLinkConnection	VpnSiteLinkConnection-resource.

CloudError

Object

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Hoofdtekst van cloudfout.

CloudErrorBody

Object

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

DhGroup

Inventarisatie

De DH-groepen die worden gebruikt in IKE Fase 1 voor de eerste SA.

Waarde	Description
DHGroup1
DHGroup14
DHGroup2
DHGroup2048
DHGroup24
ECP256
ECP384
None

GatewayCustomBgpIpAddressIpConfiguration

Object

GatewayCustomBgpIpAddressIpConfiguration voor een virtuele netwerkgatewayverbinding.

Name	Type	Description
customBgpIpAddress	string	Het aangepaste BgpPeeringAddress dat deel uitmaakt van IpconfigurationId.
ipConfigurationId	string	De IpconfigurationId van ipconfiguration die deel uitmaakt van de gateway.

IkeEncryption

Inventarisatie

Het IKE-versleutelingsalgoritmen (IKE-fase 2).

Waarde	Description
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES256

IkeIntegrity

Inventarisatie

Het IKE-integriteitsalgoritmen (IKE-fase 2).

Waarde	Description
GCMAES128
GCMAES256
MD5
SHA1
SHA256
SHA384

IpsecEncryption

Inventarisatie

Het IPSec-versleutelingsalgoritmen (IKE-fase 1).

Waarde	Description
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES192
GCMAES256
None

IpsecIntegrity

Inventarisatie

Het IPSec-integriteitsalgoritmen (IKE-fase 1).

Waarde	Description
GCMAES128
GCMAES192
GCMAES256
MD5
SHA1
SHA256

IpsecPolicy

Object

Een IPSec-beleidsconfiguratie voor een virtuele netwerkgatewayverbinding.

Name	Type	Description
dhGroup	DhGroup	De DH-groep die wordt gebruikt in IKE Fase 1 voor de eerste SA.
ikeEncryption	IkeEncryption	Het IKE-versleutelingsalgoritmen (IKE-fase 2).
ikeIntegrity	IkeIntegrity	Het IKE-integriteitsalgoritmen (IKE-fase 2).
ipsecEncryption	IpsecEncryption	Het IPSec-versleutelingsalgoritmen (IKE-fase 1).
ipsecIntegrity	IpsecIntegrity	Het IPSec-integriteitsalgoritmen (IKE-fase 1).
pfsGroup	PfsGroup	De Pfs-groep die wordt gebruikt in IKE Fase 2 voor nieuwe onderliggende SA.
saDataSizeKilobytes	integer (int32)	De nettoladinggrootte IPSec-beveiligingskoppeling (ook wel snelle modus of fase 2 SA genoemd) in KB voor een site-naar-site-VPN-tunnel.
saLifeTimeSeconds	integer (int32)	De LEVENSDUUR van de IPSec-beveiligingskoppeling (ook wel snelle modus of fase 2 SA genoemd) in seconden voor een site-naar-site-VPN-tunnel.

PfsGroup

Inventarisatie

De Pfs-groepen die worden gebruikt in IKE Fase 2 voor nieuwe onderliggende SA.

Waarde	Description
ECP256
ECP384
None
PFS1
PFS14
PFS2
PFS2048
PFS24
PFSMM

PropagatedRouteTable

Object

De lijst met RouteTables om de routes naar te adverteren.

Name	Type	Description
ids	SubResource[]	De lijst met resource-id's van alle RouteTables.
labels	string[]	De lijst met labels.

ProvisioningState

Inventarisatie

De huidige inrichtingsstatus.

Waarde	Description
Deleting
Failed
Succeeded
Updating

RoutingConfiguration

Object

Routeringsconfiguratie die de gekoppelde en doorgegeven routetabellen voor deze verbinding aangeeft.

Name	Type	Description
associatedRouteTable	SubResource	De resource-id RouteTable die is gekoppeld aan deze RoutingConfiguration.
inboundRouteMap	SubResource	De resource-id van de RouteMap die is gekoppeld aan deze RoutingConfiguration voor binnenkomende geleerde routes.
outboundRouteMap	SubResource	De resource-id van deRouteMap die is gekoppeld aan deze RoutingConfiguration voor uitgaande geadverteerde routes.
propagatedRouteTables	PropagatedRouteTable	De lijst met RouteTables om de routes naar te adverteren.
vnetRoutes	VnetRoute	Lijst met routes die routering van VirtualHub naar een virtuele netwerkverbinding beheren.

StaticRoute

Object

Lijst met alle statische routes.

Name	Type	Description
addressPrefixes	string[]	Lijst met alle adresvoorvoegsels.
name	string	De naam van de StaticRoute die uniek is binnen een VnetRoute.
nextHopIpAddress	string	Het IP-adres van de volgende hop.

StaticRoutesConfig

Object

Configuratie voor statische routes op deze HubVnetConnectionConfiguration voor statische routes op deze HubVnetConnection.

Name	Type	Description
propagateStaticRoutes	boolean	Booleaanse waarde die aangeeft of statische routes op deze verbinding automatisch worden doorgegeven aan routetabellen waarnaar deze verbinding wordt doorgegeven.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Parameter die bepaalt of NVA in spoke-vnet wordt omzeild voor verkeer met bestemming in spoke.

SubResource

Object

Verwijzing naar een andere subresource.

Name	Type	Description
id	string	Resource-id.

TrafficSelectorPolicy

Object

Een verkeersselectorbeleid voor een gatewayverbinding met een virtueel netwerk.

Name	Type	Description
localAddressRanges	string[]	Een verzameling lokale adresruimten in CIDR-indeling.
remoteAddressRanges	string[]	Een verzameling externe adresruimten in CIDR-indeling.

VirtualNetworkGatewayConnectionProtocol

Inventarisatie

Verbindingsprotocol dat wordt gebruikt voor deze verbinding.

Waarde	Description
IKEv1
IKEv2

VnetLocalRouteOverrideCriteria

Inventarisatie

Parameter die bepaalt of NVA in spoke-vnet wordt omzeild voor verkeer met bestemming in spoke-vnet.

Waarde	Description
Contains
Equal

VnetRoute

Object

Lijst met routes die routering van VirtualHub naar een virtuele netwerkverbinding beheren.

Name	Type	Description
bgpConnections	SubResource[]	De lijst met verwijzingen naar HubBgpConnection-objecten.
staticRoutes	StaticRoute[]	Lijst met alle statische routes.
staticRoutesConfig	StaticRoutesConfig	Configuratie voor statische routes op deze HubVnetConnection.

VpnConnection

Object

VpnConnection-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.connectionBandwidth	integer (int32)	Verwachte bandbreedte in MBPS.
properties.connectionStatus	VpnConnectionStatus	De verbindingsstatus.
properties.dpdTimeoutSeconds	integer (int32)	DPD-time-out in seconden voor vpn-verbinding.
properties.egressBytesTransferred	integer (int64)	Uitgaande bytes overgedragen.
properties.enableBgp	boolean	EnableBgp-vlag.
properties.enableInternetSecurity	boolean	Internetbeveiliging inschakelen.
properties.enableRateLimiting	boolean	EnableBgp-vlag.
properties.ingressBytesTransferred	integer (int64)	Binnenkomende bytes overgedragen.
properties.ipsecPolicies	IpsecPolicy[]	Het IPSec-beleid dat door deze verbinding moet worden overwogen.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de VPN-verbindingsresource.
properties.remoteVpnSite	SubResource	Id van de verbonden VPN-site.
properties.routingConfiguration	RoutingConfiguration	De routeringsconfiguratie die de gekoppelde en doorgegeven routetabellen op deze verbinding aangeeft.
properties.routingWeight	integer (int32)	Routeringsgewicht voor vpn-verbinding.
properties.sharedKey	string	SharedKey voor de VPN-verbinding.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	Het beleid voor verkeersselector dat door deze verbinding moet worden overwogen.
properties.useLocalAzureIpAddress	boolean	Gebruik lokale Azure IP om verbinding te initiëren.
properties.usePolicyBasedTrafficSelectors	boolean	Schakel verkeerkiezers op basis van beleid in.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Verbindingsprotocol dat wordt gebruikt voor deze verbinding.
properties.vpnLinkConnections	VpnSiteLinkConnection[]	Lijst met alle vpn-sitekoppelingen naar de gateway.

VpnConnectionStatus

Inventarisatie

De huidige status van de VPN-verbinding.

Waarde	Description
Connected
Connecting
NotConnected
Unknown

VpnLinkConnectionMode

Inventarisatie

Vpn-koppelingsverbindingsmodus.

Waarde	Description
Default
InitiatorOnly
ResponderOnly

VpnSiteLinkConnection

Object

VpnSiteLinkConnection-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.connectionBandwidth	integer (int32)	Verwachte bandbreedte in MBPS.
properties.connectionStatus	VpnConnectionStatus	De verbindingsstatus.
properties.dpdTimeoutSeconds	integer (int32)	Time-out voor dead peer detection in seconden voor VpnLink-verbinding.
properties.egressBytesTransferred	integer (int64)	Uitgaande bytes overgedragen.
properties.egressNatRules	SubResource[]	Lijst met uitgaande NatRules.
properties.enableBgp	boolean	EnableBgp-vlag.
properties.enableRateLimiting	boolean	EnableBgp-vlag.
properties.ingressBytesTransferred	integer (int64)	Binnenkomende bytes overgedragen.
properties.ingressNatRules	SubResource[]	Lijst met inkomend verkeer NatRules.
properties.ipsecPolicies	IpsecPolicy[]	Het IPSec-beleid dat door deze verbinding moet worden overwogen.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de verbindingsresource van de VPN-sitekoppeling.
properties.routingWeight	integer (int32)	Routeringsgewicht voor vpn-verbinding.
properties.sharedKey	string	SharedKey voor de VPN-verbinding.
properties.useLocalAzureIpAddress	boolean	Gebruik lokale Azure IP om verbinding te initiëren.
properties.usePolicyBasedTrafficSelectors	boolean	Schakel verkeerkiezers op basis van beleid in.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Verbindingsprotocol dat wordt gebruikt voor deze verbinding.
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	vpnGatewayCustomBgpAddresses die door deze verbinding worden gebruikt.
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	Vpn-koppelingsverbindingsmodus.
properties.vpnSiteLink	SubResource	Id van de gekoppelde vpn-sitekoppeling.
type	string	Resourcetype.