Vpn Connections - Create Or Update

Service:

Virtual WAN

API Version:

2023-09-01

Создает VPN-подключение к масштабируемому VPN-шлюзу, если он не существует, иначе обновляет существующее подключение.

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

Параметры URI

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

Текст запроса

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

Ответы

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

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

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

Примеры

VpnConnectionPut

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1?api-version=2023-09-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/2023-09-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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python vpn_connection_put.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.vpn_connections.begin_create_or_update(
        resource_group_name="rg1",
        gateway_name="gateway1",
        connection_name="vpnConnection1",
        vpn_connection_parameters={
            "properties": {
                "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",
                        "properties": {
                            "connectionBandwidth": 200,
                            "sharedKey": "key",
                            "usePolicyBasedTrafficSelectors": False,
                            "vpnConnectionProtocolType": "IKEv2",
                            "vpnLinkConnectionMode": "Default",
                            "vpnSiteLink": {
                                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
                            },
                        },
                    }
                ],
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnConnectionPut.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/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/2023-09-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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources.Models;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-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

Sample Response

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

Определения

Имя	Описание
CloudError	Ответ об ошибке от службы.
CloudErrorBody	Ответ об ошибке от службы.
DhGroup	Группы DH, используемые на этапе IKE 1 для начального sa.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration для подключения шлюза виртуальной сети.
IkeEncryption	Алгоритм шифрования IKE (этап 2 IKE).
IkeIntegrity	Алгоритм целостности IKE (этап 2 IKE).
IpsecEncryption	Алгоритм шифрования IPSec (этап 1 IKE).
IpsecIntegrity	Алгоритм целостности IPSec (этап 1 IKE).
IpsecPolicy	Конфигурация политики IPSec для подключения к шлюзу виртуальной сети.
PfsGroup	Группы Pfs, используемые на этапе 2 IKE для нового дочернего SA.
PropagatedRouteTable	Список таблиц RouteTable для объявления маршрутов.
ProvisioningState	Текущее состояние подготовки.
RoutingConfiguration	Конфигурация маршрутизации, указывающая связанные и распространяемые таблицы маршрутов для этого подключения.
StaticRoute	Список всех статических маршрутов.
StaticRoutesConfig	Конфигурация статических маршрутов в этом hubVnetConnectionConfiguration для статических маршрутов в этом HubVnetConnection.
SubResource	Ссылка на другой подресурс.
TrafficSelectorPolicy	Политика выбора трафика для подключения к шлюзу виртуальной сети.
VirtualNetworkGatewayConnectionProtocol	Протокол подключения, используемый для этого подключения.
VnetLocalRouteOverrideCriteria	Параметр, определяющий, пропускается ли сетевой модуль в периферийной виртуальной сети для трафика с назначением в периферийной виртуальной сети.
VnetRoute	Список маршрутов, управляющих маршрутизацией из VirtualHub в подключение к виртуальной сети.
VpnConnection	Ресурс VpnConnection.
VpnConnectionStatus	Текущее состояние VPN-подключения.
VpnLinkConnectionMode	Режим подключения vpn-канала.
VpnSiteLinkConnection	Ресурс VpnSiteLinkConnection.

CloudError

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

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

CloudErrorBody

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

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

DhGroup

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

Имя	Тип	Описание
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

GatewayCustomBgpIpAddressIpConfiguration

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

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

IkeEncryption

Алгоритм шифрования IKE (этап 2 IKE).

Имя	Тип	Описание
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

Алгоритм целостности IKE (этап 2 IKE).

Имя	Тип	Описание
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IpsecEncryption

Алгоритм шифрования IPSec (этап 1 IKE).

Имя	Тип	Описание
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

Алгоритм целостности IPSec (этап 1 IKE).

Имя	Тип	Описание
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

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

Имя	Тип	Описание
dhGroup	DhGroup	Группа DH, используемая на этапе IKE 1 для начального sa.
ikeEncryption	IkeEncryption	Алгоритм шифрования IKE (этап 2 IKE).
ikeIntegrity	IkeIntegrity	Алгоритм целостности IKE (этап 2 IKE).
ipsecEncryption	IpsecEncryption	Алгоритм шифрования IPSec (этап 1 IKE).
ipsecIntegrity	IpsecIntegrity	Алгоритм целостности IPSec (этап 1 IKE).
pfsGroup	PfsGroup	Группа Pfs, используемая на этапе 2 IKE для нового дочернего SA.
saDataSizeKilobytes	integer	Размер полезных данных сопоставления безопасности IPSec (также называемого быстрым режимом или этапом 2 SA) в КБ для vpn-туннеля типа "сеть — сеть".
saLifeTimeSeconds	integer	Время существования связи безопасности IPSec (также называемое быстрым режимом или этапом 2 SA) в секундах для vpn-туннеля типа "сеть — сеть".

PfsGroup

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

Имя	Тип	Описание
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

PropagatedRouteTable

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

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

ProvisioningState

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

Имя	Тип	Описание
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingConfiguration

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

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

StaticRoute

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

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

StaticRoutesConfig

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

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

SubResource

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

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

TrafficSelectorPolicy

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

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

VirtualNetworkGatewayConnectionProtocol

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

Имя	Тип	Описание
IKEv1	string
IKEv2	string

VnetLocalRouteOverrideCriteria

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

Имя	Тип	Описание
Contains	string
Equal	string

VnetRoute

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

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

VpnConnection

Ресурс VpnConnection.

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

VpnConnectionStatus

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

Имя	Тип	Описание
Connected	string
Connecting	string
NotConnected	string
Unknown	string

VpnLinkConnectionMode

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

Имя	Тип	Описание
Default	string
InitiatorOnly	string
ResponderOnly	string

VpnSiteLinkConnection

Ресурс VpnSiteLinkConnection.

Имя	Тип	Описание
etag	string	Уникальная строка, доступная только для чтения, которая изменяется при каждом обновлении ресурса.
id	string	Идентификатор ресурса.
name	string	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.
properties.connectionBandwidth	integer	Ожидаемая пропускная способность в Мбит/с.
properties.connectionStatus	VpnConnectionStatus	Состояние подключения.
properties.egressBytesTransferred	integer	Переданные байты исходящего трафика.
properties.egressNatRules	SubResource[]	Список исходящих NatRules.
properties.enableBgp	boolean	Флаг EnableBgp.
properties.enableRateLimiting	boolean	Флаг EnableBgp.
properties.ingressBytesTransferred	integer	Переданные байты входящего трафика.
properties.ingressNatRules	SubResource[]	Список NatRules входящего трафика.
properties.ipsecPolicies	IpsecPolicy[]	Политики IPSec, которые будут учитываться этим подключением.
properties.provisioningState	ProvisioningState	Состояние подготовки ресурса подключения к vpn-сайту.
properties.routingWeight	integer	Вес маршрутизации для VPN-подключения.
properties.sharedKey	string	SharedKey для VPN-подключения.
properties.useLocalAzureIpAddress	boolean	Используйте локальный IP-адрес Azure для запуска подключения.
properties.usePolicyBasedTrafficSelectors	boolean	Включите селекторы трафика на основе политик.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Протокол подключения, используемый для этого подключения.
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	vpnGatewayCustomBgpAddresses, используемые этим подключением.
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	Режим подключения vpn-канала.
properties.vpnSiteLink	SubResource	Идентификатор ссылки на подключенный vpn-сайт.
type	string	Тип ресурса.