Vpn Connections - Create Or Update

Servizio:

Virtual WAN

Versione API:

2024-05-01

Crea una connessione VPN a un gateway VPN scalabile, se non esiste, aggiorna la connessione esistente.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
connectionName	path	True	string	Nome della connessione.
gatewayName	path	True	string	Nome del gateway.
resourceGroupName	path	True	string	Nome del gruppo di risorse di VpnGateway.
subscriptionId	path	True	string	Credenziali della sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string	Versione dell'API client.

Corpo della richiesta

Nome	Tipo	Descrizione
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.connectionBandwidth	integer	Larghezza di banda prevista in MBPS.
properties.dpdTimeoutSeconds	integer	Timeout DPD in secondi per la connessione VPN.
properties.enableBgp	boolean	Flag EnableBgp.
properties.enableInternetSecurity	boolean	Abilitare la sicurezza Internet.
properties.enableRateLimiting	boolean	Flag EnableBgp.
properties.ipsecPolicies	IpsecPolicy[]	Criteri IPSec da considerare da questa connessione.
properties.remoteVpnSite	SubResource	ID del sito VPN connesso.
properties.routingConfiguration	RoutingConfiguration	Configurazione di routing che indica le tabelle di route associate e propagate in questa connessione.
properties.routingWeight	integer	Peso del routing per la connessione VPN.
properties.sharedKey	string	SharedKey per la connessione VPN.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	Criteri del selettore di traffico da considerare da questa connessione.
properties.useLocalAzureIpAddress	boolean	Usare l'indirizzo IP di Azure locale per avviare la connessione.
properties.usePolicyBasedTrafficSelectors	boolean	Abilitare i selettori di traffico basati su criteri.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Protocollo di connessione usato per questa connessione.
properties.vpnLinkConnections	VpnSiteLinkConnection[]	Elenco di tutte le connessioni al collegamento al sito VPN al gateway.

Risposte

Nome	Tipo	Descrizione
200 OK	VpnConnection	Richiesta riuscita. Restituisce i dettagli della connessione VPN creata o aggiornata.
201 Created	VpnConnection	Richiesta riuscita. Restituisce i dettagli della connessione VPN creata o aggiornata.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

VpnConnectionPut

Esempio di richiesta

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 VpnConnectionResource created on azure
// for more information of creating VpnConnectionResource, please refer to the document of VpnConnectionResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string gatewayName = "gateway1";
string connectionName = "vpnConnection1";
ResourceIdentifier vpnConnectionResourceId = VpnConnectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, gatewayName, connectionName);
VpnConnectionResource vpnConnection = client.GetVpnConnectionResource(vpnConnectionResourceId);

// invoke the operation
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 vpnConnection.UpdateAsync(WaitUntil.Completed, 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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Definizioni

Nome	Descrizione
CloudError	Risposta di errore dal servizio.
CloudErrorBody	Risposta di errore dal servizio.
DhGroup	I gruppi DH usati nella fase 1 IKE per l'amministratore di sicurezza iniziale.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration per una connessione gateway di rete virtuale.
IkeEncryption	Algoritmo di crittografia IKE (fase 2 IKE).
IkeIntegrity	Algoritmo di integrità IKE (fase 2 IKE).
IpsecEncryption	Algoritmo di crittografia IPSec (fase 1 IKE).
IpsecIntegrity	Algoritmo di integrità IPSec (fase 1 IKE).
IpsecPolicy	Configurazione dei criteri IPSec per una connessione gateway di rete virtuale.
PfsGroup	I gruppi Pfs usati nella fase 2 di IKE per il nuovo sa figlio.
PropagatedRouteTable	Elenco di RouteTables a cui annunciare le route.
ProvisioningState	Stato di provisioning corrente.
RoutingConfiguration	Configurazione di routing che indica le tabelle di route associate e propagate per questa connessione.
StaticRoute	Elenco di tutte le route statiche.
StaticRoutesConfig	Configurazione per le route statiche in questo hubVnetConnectionConfiguration per le route statiche in questo hubVnetConnection.
SubResource	Riferimento a un'altra sottorisorsa.
TrafficSelectorPolicy	Criteri del selettore di traffico per una connessione gateway di rete virtuale.
VirtualNetworkGatewayConnectionProtocol	Protocollo di connessione usato per questa connessione.
VnetLocalRouteOverrideCriteria	Parametro che determina se l'appliance virtuale di rete virtuale in spoke viene ignorata per il traffico con destinazione nella rete virtuale spoke.
VnetRoute	Elenco di route che controllano il routing da VirtualHub in una connessione di rete virtuale.
VpnConnection	Risorsa VpnConnection.
VpnConnectionStatus	Stato corrente della connessione VPN.
VpnLinkConnectionMode	Modalità di connessione del collegamento VPN.
VpnSiteLinkConnection	Risorsa VpnSiteLinkConnection.

CloudError

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	CloudErrorBody	Corpo dell'errore cloud.

CloudErrorBody

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in errore.

DhGroup

I gruppi DH usati nella fase 1 IKE per l'amministratore di sicurezza iniziale.

Nome	Tipo	Descrizione
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration per una connessione gateway di rete virtuale.

Nome	Tipo	Descrizione
customBgpIpAddress	string	BgpPeeringAddress personalizzato che appartiene a IpconfigurationId.
ipConfigurationId	string	IpconfigurationId di ipconfiguration che appartiene al gateway.

IkeEncryption

Algoritmo di crittografia IKE (fase 2 IKE).

Nome	Tipo	Descrizione
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

Algoritmo di integrità IKE (fase 2 IKE).

Nome	Tipo	Descrizione
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IpsecEncryption

Algoritmo di crittografia IPSec (fase 1 IKE).

Nome	Tipo	Descrizione
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

Algoritmo di integrità IPSec (fase 1 IKE).

Nome	Tipo	Descrizione
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

Configurazione dei criteri IPSec per una connessione gateway di rete virtuale.

Nome	Tipo	Descrizione
dhGroup	DhGroup	Gruppo DH usato nella fase 1 IKE per l'amministratore di sicurezza iniziale.
ikeEncryption	IkeEncryption	Algoritmo di crittografia IKE (fase 2 IKE).
ikeIntegrity	IkeIntegrity	Algoritmo di integrità IKE (fase 2 IKE).
ipsecEncryption	IpsecEncryption	Algoritmo di crittografia IPSec (fase 1 IKE).
ipsecIntegrity	IpsecIntegrity	Algoritmo di integrità IPSec (fase 1 IKE).
pfsGroup	PfsGroup	Gruppo Pfs usato nella fase 2 di IKE per il nuovo sa figlio.
saDataSizeKilobytes	integer	Dimensioni del payload dell'associazione di sicurezza IPSec (detta anche modalità rapida o sa fase 2) in KB per un tunnel VPN da sito a sito.
saLifeTimeSeconds	integer	Durata dell'associazione di sicurezza IPSec (detta anche modalità rapida o sa fase 2) in secondi per un tunnel VPN da sito a sito.

PfsGroup

I gruppi Pfs usati nella fase 2 di IKE per il nuovo sa figlio.

Nome	Tipo	Descrizione
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

PropagatedRouteTable

Elenco di RouteTables a cui annunciare le route.

Nome	Tipo	Descrizione
ids	SubResource[]	Elenco di ID risorsa di tutte le tabelle RouteTable.
labels	string[]	Elenco di etichette.

ProvisioningState

Stato di provisioning corrente.

Nome	Tipo	Descrizione
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingConfiguration

Configurazione di routing che indica le tabelle di route associate e propagate per questa connessione.

Nome	Tipo	Descrizione
associatedRouteTable	SubResource	Id risorsa RouteTable associato a questo RoutingConfiguration.
inboundRouteMap	SubResource	ID risorsa dell'oggetto RouteMap associato a questo RoutingConfiguration per le route apprese in ingresso.
outboundRouteMap	SubResource	ID risorsa dell'oggettoRouteMap associato a questo RoutingConfiguration per le route annunciate in uscita.
propagatedRouteTables	PropagatedRouteTable	Elenco di RouteTables a cui annunciare le route.
vnetRoutes	VnetRoute	Elenco di route che controllano il routing da VirtualHub in una connessione di rete virtuale.

StaticRoute

Elenco di tutte le route statiche.

Nome	Tipo	Descrizione
addressPrefixes	string[]	Elenco di tutti i prefissi di indirizzo.
name	string	Nome dell'oggetto StaticRoute univoco all'interno di una rete virtuale.
nextHopIpAddress	string	Indirizzo IP dell'hop successivo.

StaticRoutesConfig

Configurazione per le route statiche in questo hubVnetConnectionConfiguration per le route statiche in questo hubVnetConnection.

Nome	Tipo	Descrizione
propagateStaticRoutes	boolean	Valore booleano che indica se le route statiche in questa connessione vengono propagate automaticamente alle tabelle di route a cui viene propagata la connessione.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Parametro che determina se l'appliance virtuale di rete nella rete virtuale spoke viene ignorata per il traffico con destinazione in spoke.

SubResource

Riferimento a un'altra sottorisorsa.

Nome	Tipo	Descrizione
id	string	ID risorsa.

TrafficSelectorPolicy

Criteri del selettore di traffico per una connessione gateway di rete virtuale.

Nome	Tipo	Descrizione
localAddressRanges	string[]	Raccolta di spazi indirizzi locali in formato CIDR.
remoteAddressRanges	string[]	Raccolta di spazi indirizzi remoti in formato CIDR.

VirtualNetworkGatewayConnectionProtocol

Protocollo di connessione usato per questa connessione.

Nome	Tipo	Descrizione
IKEv1	string
IKEv2	string

VnetLocalRouteOverrideCriteria

Parametro che determina se l'appliance virtuale di rete virtuale in spoke viene ignorata per il traffico con destinazione nella rete virtuale spoke.

Nome	Tipo	Descrizione
Contains	string
Equal	string

VnetRoute

Elenco di route che controllano il routing da VirtualHub in una connessione di rete virtuale.

Nome	Tipo	Descrizione
bgpConnections	SubResource[]	Elenco di riferimenti agli oggetti HubBgpConnection.
staticRoutes	StaticRoute[]	Elenco di tutte le route statiche.
staticRoutesConfig	StaticRoutesConfig	Configurazione per le route statiche in questo hubVnetConnection.

VpnConnection

Risorsa VpnConnection.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.connectionBandwidth	integer	Larghezza di banda prevista in MBPS.
properties.connectionStatus	VpnConnectionStatus	Stato della connessione.
properties.dpdTimeoutSeconds	integer	Timeout DPD in secondi per la connessione VPN.
properties.egressBytesTransferred	integer	Byte in uscita trasferiti.
properties.enableBgp	boolean	Flag EnableBgp.
properties.enableInternetSecurity	boolean	Abilitare la sicurezza Internet.
properties.enableRateLimiting	boolean	Flag EnableBgp.
properties.ingressBytesTransferred	integer	Byte in ingresso trasferiti.
properties.ipsecPolicies	IpsecPolicy[]	Criteri IPSec da considerare da questa connessione.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa di connessione VPN.
properties.remoteVpnSite	SubResource	ID del sito VPN connesso.
properties.routingConfiguration	RoutingConfiguration	Configurazione di routing che indica le tabelle di route associate e propagate in questa connessione.
properties.routingWeight	integer	Peso del routing per la connessione VPN.
properties.sharedKey	string	SharedKey per la connessione VPN.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	Criteri del selettore di traffico da considerare da questa connessione.
properties.useLocalAzureIpAddress	boolean	Usare l'indirizzo IP di Azure locale per avviare la connessione.
properties.usePolicyBasedTrafficSelectors	boolean	Abilitare i selettori di traffico basati su criteri.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Protocollo di connessione usato per questa connessione.
properties.vpnLinkConnections	VpnSiteLinkConnection[]	Elenco di tutte le connessioni al collegamento al sito VPN al gateway.

VpnConnectionStatus

Stato corrente della connessione VPN.

Nome	Tipo	Descrizione
Connected	string
Connecting	string
NotConnected	string
Unknown	string

VpnLinkConnectionMode

Modalità di connessione del collegamento VPN.

Nome	Tipo	Descrizione
Default	string
InitiatorOnly	string
ResponderOnly	string

VpnSiteLinkConnection

Risorsa VpnSiteLinkConnection.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.connectionBandwidth	integer	Larghezza di banda prevista in MBPS.
properties.connectionStatus	VpnConnectionStatus	Stato della connessione.
properties.dpdTimeoutSeconds	integer	Timeout di rilevamento peer non recapitabili in secondi per la connessione VpnLink.
properties.egressBytesTransferred	integer	Byte in uscita trasferiti.
properties.egressNatRules	SubResource[]	Elenco di NatRules in uscita.
properties.enableBgp	boolean	Flag EnableBgp.
properties.enableRateLimiting	boolean	Flag EnableBgp.
properties.ingressBytesTransferred	integer	Byte in ingresso trasferiti.
properties.ingressNatRules	SubResource[]	Elenco di NatRules in ingresso.
properties.ipsecPolicies	IpsecPolicy[]	Criteri IPSec da considerare da questa connessione.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa di connessione al collegamento al sito VPN.
properties.routingWeight	integer	Peso del routing per la connessione VPN.
properties.sharedKey	string	SharedKey per la connessione VPN.
properties.useLocalAzureIpAddress	boolean	Usare l'indirizzo IP di Azure locale per avviare la connessione.
properties.usePolicyBasedTrafficSelectors	boolean	Abilitare i selettori di traffico basati su criteri.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Protocollo di connessione usato per questa connessione.
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	vpnGatewayCustomBgpAddresses usato da questa connessione.
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	Modalità di connessione del collegamento VPN.
properties.vpnSiteLink	SubResource	ID del collegamento al sito VPN connesso.
type	string	Tipo di risorsa.