Vpn Connections - Get

Service:

Virtual WAN

API Version:

2023-09-01

VPN 接続の詳細を取得します。

GET 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	VPN 接続の名前。
gatewayName	path	True	string	ゲートウェイの名前。
resourceGroupName	path	True	string	VpnGateway のリソース グループ名。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプションの資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API バージョン。

応答

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

VpnConnectionGet

Sample Request

HTTP

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

Java

/**
 * Samples for VpnConnections Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnConnectionGet.json
     */
    /**
     * Sample code: VpnConnectionGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnConnectionGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnConnections().getWithResponse("rg1", "gateway1",
            "vpnConnection1", 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_get.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.get(
        resource_group_name="rg1",
        gateway_name="gateway1",
        connection_name="vpnConnection1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnConnectionGet.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/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/VpnConnectionGet.json
func ExampleVPNConnectionsClient_Get() {
	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)
	}
	res, err := clientFactory.NewVPNConnectionsClient().Get(ctx, "rg1", "gateway1", "vpnConnection1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.VPNLinkConnectionModeResponderOnly),
	// 						VPNSiteLink: &armnetwork.SubResource{
	// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"),
	// 						},
	// 					},
	// 				},
	// 				{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2"),
	// 					Name: to.Ptr("Connection-Link2"),
	// 					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.VPNLinkConnectionModeInitiatorOnly),
	// 						VPNSiteLink: &armnetwork.SubResource{
	// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"),
	// 						},
	// 					},
	// 			}},
	// 		},
	// 	}
}

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 Retrieves the details of a vpn connection.
 *
 * @summary Retrieves the details of a vpn connection.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnConnectionGet.json
 */
async function vpnConnectionGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const gatewayName = "gateway1";
  const connectionName = "vpnConnection1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.vpnConnections.get(resourceGroupName, gatewayName, connectionName);
  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/VpnConnectionGet.json
// this example is just showing the usage of "VpnConnections_Get" 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";
NullableResponse<VpnConnectionResource> response = await collection.GetIfExistsAsync(connectionName);
VpnConnectionResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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,
    "trafficSelectorPolicies": [],
    "vpnLinkConnections": [
      {
        "name": "Connection-Link1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
        "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
        "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": "ResponderOnly"
        }
      },
      {
        "name": "Connection-Link2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2",
        "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "properties": {
          "provisioningState": "Succeeded",
          "vpnSiteLink": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"
          },
          "connectionBandwidth": 200,
          "ipsecPolicies": [],
          "vpnConnectionProtocolType": "IKEv2",
          "sharedKey": "key",
          "ingressBytesTransferred": 0,
          "egressBytesTransferred": 0,
          "enableBgp": false,
          "enableRateLimiting": false,
          "useLocalAzureIpAddress": false,
          "usePolicyBasedTrafficSelectors": false,
          "routingWeight": 0,
          "vpnLinkConnectionMode": "InitiatorOnly"
        }
      }
    ],
    "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"
      }
    }
  }
}

定義

名前	説明
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 での静的ルートの構成この 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 での静的ルートの構成この 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.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	リソースの種類。