Vpn Connections - Create Or Update

リファレンス

サービス:: Virtual WAN

API バージョン:: 2024-05-01

スケーラブルな VPN ゲートウェイが存在しない場合は、VPN 接続を作成し、それ以外の場合は既存の接続を更新します。

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

URI パラメーター

名前	/	必須	型	説明
connectionName	path	True	string	接続の名前。
gatewayName	path	True	string	ゲートウェイの名前。
resourceGroupName	path	True	string	VpnGateway のリソースグループ名。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	型	説明
id	string	リソース ID。
name	string	リソースグループ内で一意であるリソースの名前。この名前は、リソースへのアクセスに使用できます。
properties.connectionBandwidth	integer	予想される帯域幅 (MBPS)。
properties.dpdTimeoutSeconds	integer	VPN 接続の DPD タイムアウト (秒単位)。
properties.enableBgp	boolean	EnableBgp フラグ。
properties.enableInternetSecurity	boolean	インターネットセキュリティを有効にします。
properties.enableRateLimiting	boolean	EnableBgp フラグ。
properties.ipsecPolicies	IpsecPolicy[]	この接続によって考慮される IPSec ポリシー。
properties.remoteVpnSite	SubResource	接続されている VPN サイトの ID。
properties.routingConfiguration	RoutingConfiguration	この接続に関連付けられた伝達されたルートテーブルを示すルーティング構成。
properties.routingWeight	integer	VPN 接続のルーティングの重み。
properties.sharedKey	string	VPN 接続の SharedKey。
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	この接続によって考慮されるトラフィックセレクターポリシー。
properties.useLocalAzureIpAddress	boolean	ローカル Azure IP を使用して接続を開始します。
properties.usePolicyBasedTrafficSelectors	boolean	ポリシーベースのトラフィックセレクターを有効にします。
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	この接続に使用される接続プロトコル。
properties.vpnLinkConnections	VpnSiteLinkConnection[]	ゲートウェイへのすべての VPN サイトリンク接続の一覧。

応答

名前	型	説明
200 OK	VpnConnection	要求が成功しました。作成または更新された VPN 接続の詳細を返します。
201 Created	VpnConnection	要求が成功しました。作成または更新された VPN 接続の詳細を返します。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

VpnConnectionPut

要求のサンプル

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


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

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

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

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

応答のサンプル

状態コード:: 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": []
  }
}

状態コード:: 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	初期 SA の IKE フェーズ 1 で使用される DH グループ。
GatewayCustomBgpIpAddressIpConfiguration	仮想ネットワークゲートウェイ接続の GatewayCustomBgpIpAddressIpConfiguration。
IkeEncryption	IKE 暗号化アルゴリズム (IKE フェーズ 2)。
IkeIntegrity	IKE 整合性アルゴリズム (IKE フェーズ 2)。
IpsecEncryption	IPSec 暗号化アルゴリズム (IKE フェーズ 1)。
IpsecIntegrity	IPSec 整合性アルゴリズム (IKE フェーズ 1)。
IpsecPolicy	仮想ネットワークゲートウェイ接続の IPSec ポリシー構成。
PfsGroup	IKE フェーズ 2 で新しい子 SA に使用される Pfs グループ。
PropagatedRouteTable	ルートをアドバタイズする RouteTable の一覧。
ProvisioningState	現在のプロビジョニング状態。
RoutingConfiguration	この接続に関連付けられているルートテーブルと伝達されたルートテーブルを示すルーティング構成。
StaticRoute	すべての静的ルートの一覧。
StaticRoutesConfig	この HubVnetConnection 上の静的ルートの静的ルートの構成。
SubResource	別のサブリソースへの参照。
TrafficSelectorPolicy	仮想ネットワークゲートウェイ接続のトラフィックセレクターポリシー。
VirtualNetworkGatewayConnectionProtocol	この接続に使用される接続プロトコル。
VnetLocalRouteOverrideCriteria	スポーク vnet 内の NVA が、スポーク vnet 内の宛先を持つトラフィックに対してバイパスされるかどうかを決定するパラメーター。
VnetRoute	VirtualHub から仮想ネットワーク接続へのルーティングを制御するルートの一覧。
VpnConnection	VpnConnection リソース。
VpnConnectionStatus	VPN 接続の現在の状態。
VpnLinkConnectionMode	VPN リンク接続モード。
VpnSiteLinkConnection	VpnSiteLinkConnection リソース。

CloudError

サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	クラウドエラー本文。

CloudErrorBody

サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

DhGroup

初期 SA の IKE フェーズ 1 で使用される DH グループ。

名前	型	説明
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

GatewayCustomBgpIpAddressIpConfiguration

仮想ネットワークゲートウェイ接続の GatewayCustomBgpIpAddressIpConfiguration。

名前	型	説明
customBgpIpAddress	string	IpconfigurationId に属するカスタム BgpPeeringAddress。
ipConfigurationId	string	ゲートウェイに属する ipconfiguration の IpconfigurationId。

IkeEncryption

IKE 暗号化アルゴリズム (IKE フェーズ 2)。

名前	型	説明
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

IKE 整合性アルゴリズム (IKE フェーズ 2)。

名前	型	説明
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IpsecEncryption

IPSec 暗号化アルゴリズム (IKE フェーズ 1)。

名前	型	説明
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

IPSec 整合性アルゴリズム (IKE フェーズ 1)。

名前	型	説明
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

仮想ネットワークゲートウェイ接続の IPSec ポリシー構成。

名前	型	説明
dhGroup	DhGroup	初期 SA に IKE フェーズ 1 で使用される DH グループ。
ikeEncryption	IkeEncryption	IKE 暗号化アルゴリズム (IKE フェーズ 2)。
ikeIntegrity	IkeIntegrity	IKE 整合性アルゴリズム (IKE フェーズ 2)。
ipsecEncryption	IpsecEncryption	IPSec 暗号化アルゴリズム (IKE フェーズ 1)。
ipsecIntegrity	IpsecIntegrity	IPSec 整合性アルゴリズム (IKE フェーズ 1)。
pfsGroup	PfsGroup	IKE フェーズ 2 で新しい子 SA に使用される Pfs グループ。
saDataSizeKilobytes	integer	サイト間 VPN トンネルの IPSec セキュリティアソシエーション (クイックモードまたはフェーズ 2 SA とも呼ばれます) ペイロードサイズ (KB)。
saLifeTimeSeconds	integer	サイト間 VPN トンネルの IPSec セキュリティアソシエーション (クイックモードまたはフェーズ 2 SA とも呼ばれます) の有効期間 (秒単位)。

PfsGroup

IKE フェーズ 2 で新しい子 SA に使用される Pfs グループ。

名前	型	説明
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

PropagatedRouteTable

ルートをアドバタイズする RouteTable の一覧。

名前	型	説明
ids	SubResource[]	すべての RouteTable のリソース ID の一覧。
labels	string[]	ラベルの一覧。

ProvisioningState

現在のプロビジョニング状態。

名前	型	説明
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingConfiguration

この接続に関連付けられているルートテーブルと伝達されたルートテーブルを示すルーティング構成。

名前	型	説明
associatedRouteTable	SubResource	この RoutingConfiguration に関連付けられているリソース ID RouteTable。
inboundRouteMap	SubResource	受信学習ルートのこの RoutingConfiguration に関連付けられている RouteMap のリソース ID。
outboundRouteMap	SubResource	送信アドバタイズされたルートのこの RoutingConfiguration に関連付けられているRouteMap のリソース ID。
propagatedRouteTables	PropagatedRouteTable	ルートをアドバタイズする RouteTable の一覧。
vnetRoutes	VnetRoute	VirtualHub から仮想ネットワーク接続へのルーティングを制御するルートの一覧。

StaticRoute

すべての静的ルートの一覧。

名前	型	説明
addressPrefixes	string[]	すべてのアドレスプレフィックスの一覧。
name	string	VnetRoute 内で一意である StaticRoute の名前。
nextHopIpAddress	string	次ホップの IP アドレス。

StaticRoutesConfig

この HubVnetConnection 上の静的ルートの静的ルートの構成。

名前	型	説明
propagateStaticRoutes	boolean	この接続の静的ルートが、この接続が伝達されるルートテーブルに自動的に伝達されるかどうかを示すブール値。
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	スポーク vnet 内の NVA が、スポーク内の宛先を持つトラフィックに対してバイパスされるかどうかを決定するパラメーター。

SubResource

別のサブリソースへの参照。

名前	型	説明
id	string	リソース ID。

TrafficSelectorPolicy

仮想ネットワークゲートウェイ接続のトラフィックセレクターポリシー。

名前	型	説明
localAddressRanges	string[]	CIDR 形式のローカルアドレス空間のコレクション。
remoteAddressRanges	string[]	CIDR 形式のリモートアドレス空間のコレクション。

VirtualNetworkGatewayConnectionProtocol

この接続に使用される接続プロトコル。

名前	型	説明
IKEv1	string
IKEv2	string

VnetLocalRouteOverrideCriteria

スポーク vnet 内の NVA が、スポーク vnet 内の宛先を持つトラフィックに対してバイパスされるかどうかを決定するパラメーター。

名前	型	説明
Contains	string
Equal	string

VnetRoute

VirtualHub から仮想ネットワーク接続へのルーティングを制御するルートの一覧。

名前	型	説明
bgpConnections	SubResource[]	HubBgpConnection オブジェクトへの参照の一覧。
staticRoutes	StaticRoute[]	すべての静的ルートの一覧。
staticRoutesConfig	StaticRoutesConfig	この HubVnetConnection 上の静的ルートの構成。

VpnConnection

VpnConnection リソース。

名前	型	説明
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソース ID。
name	string	リソースグループ内で一意であるリソースの名前。この名前は、リソースへのアクセスに使用できます。
properties.connectionBandwidth	integer	予想される帯域幅 (MBPS)。
properties.connectionStatus	VpnConnectionStatus	接続の状態。
properties.dpdTimeoutSeconds	integer	VPN 接続の DPD タイムアウト (秒単位)。
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 サイトの ID。
properties.routingConfiguration	RoutingConfiguration	この接続に関連付けられた伝達されたルートテーブルを示すルーティング構成。
properties.routingWeight	integer	VPN 接続のルーティングの重み。
properties.sharedKey	string	VPN 接続の SharedKey。
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	この接続によって考慮されるトラフィックセレクターポリシー。
properties.useLocalAzureIpAddress	boolean	ローカル Azure IP を使用して接続を開始します。
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	リソース ID。
name	string	リソースグループ内で一意であるリソースの名前。この名前は、リソースへのアクセスに使用できます。
properties.connectionBandwidth	integer	予想される帯域幅 (MBPS)。
properties.connectionStatus	VpnConnectionStatus	接続の状態。
properties.dpdTimeoutSeconds	integer	VpnLink 接続のデッドピア検出タイムアウト (秒単位)。
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	VPN 接続の SharedKey。
properties.useLocalAzureIpAddress	boolean	ローカル Azure IP を使用して接続を開始します。
properties.usePolicyBasedTrafficSelectors	boolean	ポリシーベースのトラフィックセレクターを有効にします。
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	この接続に使用される接続プロトコル。
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	この接続で使用される vpnGatewayCustomBgpAddresses。
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	VPN リンク接続モード。
properties.vpnSiteLink	SubResource	接続されている VPN サイトリンクの ID。
type	string	リソースの種類。

次の方法で共有

Vpn Connections - Create Or Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

VpnConnectionPut

要求のサンプル

応答のサンプル

定義

CloudError

CloudErrorBody

DhGroup

GatewayCustomBgpIpAddressIpConfiguration

IkeEncryption

IkeIntegrity

IpsecEncryption

IpsecIntegrity

IpsecPolicy

PfsGroup

PropagatedRouteTable

ProvisioningState

RoutingConfiguration

StaticRoute

StaticRoutesConfig

SubResource

TrafficSelectorPolicy

VirtualNetworkGatewayConnectionProtocol

VnetLocalRouteOverrideCriteria

VnetRoute

VpnConnection

VpnConnectionStatus

VpnLinkConnectionMode

VpnSiteLinkConnection

その他のリソース