Vpn Connections - Get

Referens

Tjänst:: Virtual WAN

API-version:: 2024-05-01

Hämtar information om en VPN-anslutning.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
connectionName	path	True	string	Namnet på VPN-anslutningen.
gatewayName	path	True	string	Namnet på gatewayen.
resourceGroupName	path	True	string	Resursgruppens namn på VpnGateway.
subscriptionId	path	True	string	Autentiseringsuppgifterna för prenumerationen som unikt identifierar Microsoft Azure-prenumerationen. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	VpnConnection	Begäran lyckades. Returnerar information om VPN-anslutningen.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

VpnConnectionGet

Exempelbegäran

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


/**
 * Samples for VpnConnections Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-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

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/2024-05-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

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/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/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

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/2024-05-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

Exempelsvar

Statuskod:: 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"
      }
    }
  }
}

Definitioner

Name	Description
CloudError	Ett felsvar från tjänsten.
CloudErrorBody	Ett felsvar från tjänsten.
DhGroup	De DH-grupper som används i IKE Fas 1 för inledande SA.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration för en virtuell nätverksgatewayanslutning.
IkeEncryption	IKE-krypteringsalgoritmen (IKE fas 2).
IkeIntegrity	IKE-integritetsalgoritmen (IKE fas 2).
IpsecEncryption	IPSec-krypteringsalgoritmen (IKE-fas 1).
IpsecIntegrity	IPSec-integritetsalgoritmen (IKE fas 1).
IpsecPolicy	En IPSec-principkonfiguration för en anslutning till en virtuell nätverksgateway.
PfsGroup	Pfs-grupper som används i IKE Fas 2 för ny underordnad SA.
PropagatedRouteTable	Listan med RouteTables som du vill annonsera vägarna till.
ProvisioningState	Det aktuella etableringstillståndet.
RoutingConfiguration	Routningskonfiguration som anger de associerade och distribuerade routningstabellerna för den här anslutningen.
StaticRoute	Lista över alla statiska vägar.
StaticRoutesConfig	Konfiguration för statiska vägar på detta HubVnetConnectionConfiguration för statiska vägar på denna HubVnetConnection.
SubResource	Referens till en annan underresurs.
TrafficSelectorPolicy	En trafikväljarprincip för en virtuell nätverksgatewayanslutning.
VirtualNetworkGatewayConnectionProtocol	Anslutningsprotokoll som används för den här anslutningen.
VnetLocalRouteOverrideCriteria	Parameter som avgör om NVA i eker-vnet kringgås för trafik med målet i det virtuella ekernätverket.
VnetRoute	Lista över vägar som styr routning från VirtualHub till en virtuell nätverksanslutning.
VpnConnection	VpnConnection-resurs.
VpnConnectionStatus	Vpn-anslutningens aktuella tillstånd.
VpnLinkConnectionMode	Anslutningsläge för VPN-länk.
VpnSiteLinkConnection	VpnSiteLinkConnection-resurs.

CloudError

Ett felsvar från tjänsten.

Name	Typ	Description
error	CloudErrorBody	Molnfeltext.

CloudErrorBody

Ett felsvar från tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
details	CloudErrorBody[]	En lista med ytterligare information om felet.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
target	string	Målet för det specifika felet. Till exempel namnet på egenskapen i fel.

DhGroup

De DH-grupper som används i IKE Fas 1 för inledande SA.

Name	Typ	Description
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration för en virtuell nätverksgatewayanslutning.

Name	Typ	Description
customBgpIpAddress	string	Den anpassade BgpPeeringAddress som tillhör IpconfigurationId.
ipConfigurationId	string	IpconfigurationId för ipconfiguration som tillhör gatewayen.

IkeEncryption

IKE-krypteringsalgoritmen (IKE fas 2).

Name	Typ	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

IKE-integritetsalgoritmen (IKE fas 2).

Name	Typ	Description
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IpsecEncryption

IPSec-krypteringsalgoritmen (IKE-fas 1).

Name	Typ	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

IPSec-integritetsalgoritmen (IKE fas 1).

Name	Typ	Description
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

En IPSec-principkonfiguration för en anslutning till en virtuell nätverksgateway.

Name	Typ	Description
dhGroup	DhGroup	Den DH-grupp som används i IKE Fas 1 för inledande SA.
ikeEncryption	IkeEncryption	IKE-krypteringsalgoritmen (IKE fas 2).
ikeIntegrity	IkeIntegrity	IKE-integritetsalgoritmen (IKE fas 2).
ipsecEncryption	IpsecEncryption	IPSec-krypteringsalgoritmen (IKE-fas 1).
ipsecIntegrity	IpsecIntegrity	IPSec-integritetsalgoritmen (IKE fas 1).
pfsGroup	PfsGroup	Pfs-gruppen som används i IKE Fas 2 för ny underordnad SA.
saDataSizeKilobytes	integer	IPSec-säkerhetsassociationen (kallas även snabbläge eller fas 2 SA) nyttolaststorlek i KB för en VPN-tunnel från plats till plats.
saLifeTimeSeconds	integer	IPSec-säkerhetsassociationen (kallas även snabbläge eller fas 2 SA) i sekunder för en VPN-tunnel för plats-till-plats.

PfsGroup

Pfs-grupper som används i IKE Fas 2 för ny underordnad SA.

Name	Typ	Description
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

PropagatedRouteTable

Listan med RouteTables som du vill annonsera vägarna till.

Name	Typ	Description
ids	SubResource[]	Listan över resurs-ID:t för alla RouteTables.
labels	string[]	Listan med etiketter.

ProvisioningState

Det aktuella etableringstillståndet.

Name	Typ	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingConfiguration

Routningskonfiguration som anger de associerade och distribuerade routningstabellerna för den här anslutningen.

Name	Typ	Description
associatedRouteTable	SubResource	Resurs-ID:t RouteTable som är associerad med den här RoutingConfiguration.
inboundRouteMap	SubResource	Resurs-ID för RouteMap som är associerad med den här RoutingConfiguration för inkommande inlärda vägar.
outboundRouteMap	SubResource	Resurs-ID för denRouteMap som är associerad med den här RoutingConfiguration för utgående annonserade vägar.
propagatedRouteTables	PropagatedRouteTable	Listan med RouteTables som du vill annonsera vägarna till.
vnetRoutes	VnetRoute	Lista över vägar som styr routning från VirtualHub till en virtuell nätverksanslutning.

StaticRoute

Lista över alla statiska vägar.

Name	Typ	Description
addressPrefixes	string[]	Lista över alla adressprefix.
name	string	Namnet på StaticRoute som är unikt i en VnetRoute.
nextHopIpAddress	string	IP-adressen för nästa hopp.

StaticRoutesConfig

Konfiguration för statiska vägar på detta HubVnetConnectionConfiguration för statiska vägar på denna HubVnetConnection.

Name	Typ	Description
propagateStaticRoutes	boolean	Booleskt värde som anger om statiska vägar i den här anslutningen automatiskt sprids till routningstabeller som anslutningen sprids till.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Parameter som avgör om NVA i eker-vnet kringgås för trafik med målet i eker.

SubResource

Referens till en annan underresurs.

Name	Typ	Description
id	string	Resurs-ID.

TrafficSelectorPolicy

En trafikväljarprincip för en virtuell nätverksgatewayanslutning.

Name	Typ	Description
localAddressRanges	string[]	En samling lokala adressutrymmen i CIDR-format.
remoteAddressRanges	string[]	En samling fjärradressutrymmen i CIDR-format.

VirtualNetworkGatewayConnectionProtocol

Anslutningsprotokoll som används för den här anslutningen.

Name	Typ	Description
IKEv1	string
IKEv2	string

VnetLocalRouteOverrideCriteria

Parameter som avgör om NVA i eker-vnet kringgås för trafik med målet i det virtuella ekernätverket.

Name	Typ	Description
Contains	string
Equal	string

VnetRoute

Lista över vägar som styr routning från VirtualHub till en virtuell nätverksanslutning.

Name	Typ	Description
bgpConnections	SubResource[]	Listan med referenser till HubBgpConnection-objekt.
staticRoutes	StaticRoute[]	Lista över alla statiska vägar.
staticRoutesConfig	StaticRoutesConfig	Konfiguration för statiska vägar på denna HubVnetConnection.

VpnConnection

VpnConnection-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
name	string	Namnet på resursen som är unik i en resursgrupp. Det här namnet kan användas för att komma åt resursen.
properties.connectionBandwidth	integer	Förväntad bandbredd i MBPS.
properties.connectionStatus	VpnConnectionStatus	Anslutningsstatus.
properties.dpdTimeoutSeconds	integer	DPD-timeout i sekunder för VPN-anslutning.
properties.egressBytesTransferred	integer	Utgående byte har överförts.
properties.enableBgp	boolean	AktiveraBgp-flagga.
properties.enableInternetSecurity	boolean	Aktivera internetsäkerhet.
properties.enableRateLimiting	boolean	AktiveraBgp-flagga.
properties.ingressBytesTransferred	integer	Inkommande byte har överförts.
properties.ipsecPolicies	IpsecPolicy[]	IPSec-principerna som ska beaktas av den här anslutningen.
properties.provisioningState	ProvisioningState	Etableringstillståndet för VPN-anslutningsresursen.
properties.remoteVpnSite	SubResource	ID för den anslutna VPN-platsen.
properties.routingConfiguration	RoutingConfiguration	Routningskonfigurationen som anger de associerade och spridade routningstabellerna i den här anslutningen.
properties.routingWeight	integer	Routningsvikt för VPN-anslutning.
properties.sharedKey	string	SharedKey för VPN-anslutningen.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	De trafikväljarprinciper som ska beaktas av den här anslutningen.
properties.useLocalAzureIpAddress	boolean	Använd lokal azure ip för att initiera anslutningen.
properties.usePolicyBasedTrafficSelectors	boolean	Aktivera principbaserade trafikväljare.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Anslutningsprotokoll som används för den här anslutningen.
properties.vpnLinkConnections	VpnSiteLinkConnection[]	Lista över alla vpn-platslänkanslutningar till gatewayen.

VpnConnectionStatus

Vpn-anslutningens aktuella tillstånd.

Name	Typ	Description
Connected	string
Connecting	string
NotConnected	string
Unknown	string

VpnLinkConnectionMode

Anslutningsläge för VPN-länk.

Name	Typ	Description
Default	string
InitiatorOnly	string
ResponderOnly	string

VpnSiteLinkConnection

VpnSiteLinkConnection-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
name	string	Namnet på resursen som är unik i en resursgrupp. Det här namnet kan användas för att komma åt resursen.
properties.connectionBandwidth	integer	Förväntad bandbredd i MBPS.
properties.connectionStatus	VpnConnectionStatus	Anslutningsstatus.
properties.dpdTimeoutSeconds	integer	Tidsgränsen för död peeridentifiering i sekunder för VpnLink-anslutning.
properties.egressBytesTransferred	integer	Utgående byte har överförts.
properties.egressNatRules	SubResource[]	Lista över utgående NatRules.
properties.enableBgp	boolean	AktiveraBgp-flagga.
properties.enableRateLimiting	boolean	AktiveraBgp-flagga.
properties.ingressBytesTransferred	integer	Inkommande byte har överförts.
properties.ingressNatRules	SubResource[]	Lista över inkommande NatRules.
properties.ipsecPolicies	IpsecPolicy[]	IPSec-principerna som ska beaktas av den här anslutningen.
properties.provisioningState	ProvisioningState	Etableringstillståndet för VPN-platslänkanslutningsresursen.
properties.routingWeight	integer	Routningsvikt för VPN-anslutning.
properties.sharedKey	string	SharedKey för VPN-anslutningen.
properties.useLocalAzureIpAddress	boolean	Använd lokal azure ip för att initiera anslutningen.
properties.usePolicyBasedTrafficSelectors	boolean	Aktivera principbaserade trafikväljare.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Anslutningsprotokoll som används för den här anslutningen.
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	vpnGatewayCustomBgpAddresses som används av den här anslutningen.
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	Anslutningsläge för VPN-länk.
properties.vpnSiteLink	SubResource	Id för den anslutna vpn-platslänken.
type	string	Resurstyp.

Dela via

Vpn Connections - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

VpnConnectionGet

Exempelbegäran

Exempelsvar

Definitioner

CloudError

CloudErrorBody

DhGroup

GatewayCustomBgpIpAddressIpConfiguration

IkeEncryption

IkeIntegrity

IpsecEncryption

IpsecIntegrity

IpsecPolicy

PfsGroup

PropagatedRouteTable

ProvisioningState

RoutingConfiguration

StaticRoute

StaticRoutesConfig

SubResource

TrafficSelectorPolicy

VirtualNetworkGatewayConnectionProtocol

VnetLocalRouteOverrideCriteria

VnetRoute

VpnConnection

VpnConnectionStatus

VpnLinkConnectionMode

VpnSiteLinkConnection

Ytterligare resurser