Vpn Connections - List By Vpn Gateway

Service:

Virtual WAN

Version d'API:

2024-05-01

Récupère toutes les connexions vpn pour une passerelle vpn de wan virtuel particulière.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
gatewayName	path	True	string	Nom de la passerelle.
resourceGroupName	path	True	string	Nom du groupe de ressources du VpnGateway.
subscriptionId	path	True	string	Informations d’identification de l’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	ListVpnConnectionsResult	Demande réussie. Retourne toutes les connexions VPN pour une passerelle vpn de wan virtuel.
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

VpnConnectionList

Exemple de requête

HTTP

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

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/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/VpnConnectionList.json
func ExampleVPNConnectionsClient_NewListByVPNGatewayPager() {
	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)
	}
	pager := clientFactory.NewVPNConnectionsClient().NewListByVPNGatewayPager("rg1", "gateway1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ListVPNConnectionsResult = armnetwork.ListVPNConnectionsResult{
		// }
	}
}

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

Exemple de réponse

Code d’état:

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": "Default"
          }
        },
        {
          "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": "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"
        }
      }
    }
  }
]

Définitions

Nom	Description
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
DhGroup	Groupes DH utilisés dans la phase 1 de IKE pour la sa initiale.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration pour une connexion de passerelle de réseau virtuel.
IkeEncryption	Algorithme de chiffrement IKE (phase IKE 2).
IkeIntegrity	Algorithme d’intégrité IKE (phase IKE 2).
IpsecEncryption	Algorithme de chiffrement IPSec (phase IKE 1).
IpsecIntegrity	Algorithme d’intégrité IPSec (phase IKE 1).
IpsecPolicy	Configuration d’une stratégie IPSec pour une connexion de passerelle de réseau virtuel.
ListVpnConnectionsResult	Résultat de la demande de lister toutes les connexions vpn à une passerelle vpn virtual wan. Il contient une liste de connexions VPN et une URL nextLink pour obtenir l’ensemble de résultats suivant.
PfsGroup	Groupes Pfs utilisés dans la phase IKE 2 pour la nouvelle sape enfant.
PropagatedRouteTable	Liste des RoutesTables pour publier les itinéraires vers.
ProvisioningState	État d’approvisionnement actuel.
RoutingConfiguration	Configuration de routage indiquant les tables de routage associées et propagées pour cette connexion.
StaticRoute	Liste de tous les itinéraires statiques.
StaticRoutesConfig	Configuration des itinéraires statiques sur ce HubVnetConnectionConfiguration pour les itinéraires statiques sur ce HubVnetConnection.
SubResource	Référence à une autre sous-ressource.
TrafficSelectorPolicy	Stratégie de sélecteur de trafic pour une connexion de passerelle de réseau virtuel.
VirtualNetworkGatewayConnectionProtocol	Protocole de connexion utilisé pour cette connexion.
VnetLocalRouteOverrideCriteria	Paramètre déterminant si l’appliance virtuelle réseau dans le réseau virtuel spoke est contournée pour le trafic avec la destination dans le réseau virtuel spoke.
VnetRoute	Liste des itinéraires qui contrôlent le routage à partir de VirtualHub vers une connexion de réseau virtuel.
VpnConnection	Ressource VpnConnection.
VpnConnectionStatus	État actuel de la connexion vpn.
VpnLinkConnectionMode	Mode de connexion de liaison VPN.
VpnSiteLinkConnection	Ressource VpnSiteLinkConnection.

CloudError

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Corps de l’erreur cloud.

CloudErrorBody

Réponse d’erreur du service.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

DhGroup

Groupes DH utilisés dans la phase 1 de IKE pour la sa initiale.

Nom	Type	Description
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration pour une connexion de passerelle de réseau virtuel.

Nom	Type	Description
customBgpIpAddress	string	BgpPeeringAddress personnalisé qui appartient à IpconfigurationId.
ipConfigurationId	string	IpconfigurationId de ipconfiguration qui appartient à la passerelle.

IkeEncryption

Algorithme de chiffrement IKE (phase IKE 2).

Nom	Type	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

Algorithme d’intégrité IKE (phase IKE 2).

Nom	Type	Description
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IpsecEncryption

Algorithme de chiffrement IPSec (phase IKE 1).

Nom	Type	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

Algorithme d’intégrité IPSec (phase IKE 1).

Nom	Type	Description
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

Configuration d’une stratégie IPSec pour une connexion de passerelle de réseau virtuel.

Nom	Type	Description
dhGroup	DhGroup	Groupe DH utilisé dans la phase 1 de IKE pour la sa initiale.
ikeEncryption	IkeEncryption	Algorithme de chiffrement IKE (phase IKE 2).
ikeIntegrity	IkeIntegrity	Algorithme d’intégrité IKE (phase IKE 2).
ipsecEncryption	IpsecEncryption	Algorithme de chiffrement IPSec (phase IKE 1).
ipsecIntegrity	IpsecIntegrity	Algorithme d’intégrité IPSec (phase IKE 1).
pfsGroup	PfsGroup	Groupe Pfs utilisé dans la phase IKE 2 pour la nouvelle SAP enfant.
saDataSizeKilobytes	integer	La taille de charge utile IPSec Security Association (également appelée mode rapide ou sa phase 2) en Ko pour un tunnel VPN de site à site.
saLifeTimeSeconds	integer	Durée de vie de l’association de sécurité IPSec (également appelée mode rapide ou sa phase 2) en secondes pour un tunnel VPN de site à site.

ListVpnConnectionsResult

Résultat de la demande de lister toutes les connexions vpn à une passerelle vpn virtual wan. Il contient une liste de connexions VPN et une URL nextLink pour obtenir l’ensemble de résultats suivant.

Nom	Type	Description
nextLink	string	URL permettant d’obtenir le jeu de résultats de liste d’opérations suivant s’il existe.
value	VpnConnection[]	Liste des connexions VPN.

PfsGroup

Groupes Pfs utilisés dans la phase IKE 2 pour la nouvelle sape enfant.

Nom	Type	Description
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

PropagatedRouteTable

Liste des RoutesTables pour publier les itinéraires vers.

Nom	Type	Description
ids	SubResource[]	Liste des ID de ressource de tous les RouteTables.
labels	string[]	Liste des étiquettes.

ProvisioningState

État d’approvisionnement actuel.

Nom	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingConfiguration

Configuration de routage indiquant les tables de routage associées et propagées pour cette connexion.

Nom	Type	Description
associatedRouteTable	SubResource	Id de ressource RouteTable associé à ce RoutingConfiguration.
inboundRouteMap	SubResource	ID de ressource de RouteMap associé à ce RoutingConfiguration pour les itinéraires appris entrants.
outboundRouteMap	SubResource	ID de ressource de l’ObjetRouteMap associé à ce RoutingConfiguration pour les itinéraires publiés sortants.
propagatedRouteTables	PropagatedRouteTable	Liste des RoutesTables pour publier les itinéraires vers.
vnetRoutes	VnetRoute	Liste des itinéraires qui contrôlent le routage à partir de VirtualHub vers une connexion de réseau virtuel.

StaticRoute

Liste de tous les itinéraires statiques.

Nom	Type	Description
addressPrefixes	string[]	Liste de tous les préfixes d’adresse.
name	string	Nom de StaticRoute unique au sein d’un réseau virtuel.
nextHopIpAddress	string	Adresse IP du tronçon suivant.

StaticRoutesConfig

Configuration des itinéraires statiques sur ce HubVnetConnectionConfiguration pour les itinéraires statiques sur ce HubVnetConnection.

Nom	Type	Description
propagateStaticRoutes	boolean	Boolean indiquant si les itinéraires statiques de cette connexion sont automatiquement propagés aux tables de routage vers lesquelles cette connexion se propage.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Paramètre déterminant si l’appliance virtuelle réseau dans le réseau virtuel spoke est contournée pour le trafic avec la destination en spoke.

SubResource

Référence à une autre sous-ressource.

Nom	Type	Description
id	string	ID de ressource.

TrafficSelectorPolicy

Stratégie de sélecteur de trafic pour une connexion de passerelle de réseau virtuel.

Nom	Type	Description
localAddressRanges	string[]	Collection d’espaces d’adressage locaux au format CIDR.
remoteAddressRanges	string[]	Collection d’espaces d’adressage distants au format CIDR.

VirtualNetworkGatewayConnectionProtocol

Protocole de connexion utilisé pour cette connexion.

Nom	Type	Description
IKEv1	string
IKEv2	string

VnetLocalRouteOverrideCriteria

Paramètre déterminant si l’appliance virtuelle réseau dans le réseau virtuel spoke est contournée pour le trafic avec la destination dans le réseau virtuel spoke.

Nom	Type	Description
Contains	string
Equal	string

VnetRoute

Liste des itinéraires qui contrôlent le routage à partir de VirtualHub vers une connexion de réseau virtuel.

Nom	Type	Description
bgpConnections	SubResource[]	Liste des références aux objets HubBgpConnection.
staticRoutes	StaticRoute[]	Liste de tous les itinéraires statiques.
staticRoutesConfig	StaticRoutesConfig	Configuration des itinéraires statiques sur ce HubVnetConnection.

VpnConnection

Ressource VpnConnection.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
name	string	Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
properties.connectionBandwidth	integer	Bande passante attendue en MBITs/S.
properties.connectionStatus	VpnConnectionStatus	État de la connexion.
properties.dpdTimeoutSeconds	integer	Délai DPD en secondes pour la connexion VPN.
properties.egressBytesTransferred	integer	Octets de sortie transférés.
properties.enableBgp	boolean	Indicateur EnableBgp.
properties.enableInternetSecurity	boolean	Activer la sécurité Internet.
properties.enableRateLimiting	boolean	Indicateur EnableBgp.
properties.ingressBytesTransferred	integer	Octets d’entrée transférés.
properties.ipsecPolicies	IpsecPolicy[]	Stratégies IPSec à prendre en compte par cette connexion.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de connexion VPN.
properties.remoteVpnSite	SubResource	ID du site vpn connecté.
properties.routingConfiguration	RoutingConfiguration	Configuration du routage indiquant les tables de routage associées et propagées sur cette connexion.
properties.routingWeight	integer	Poids du routage pour la connexion VPN.
properties.sharedKey	string	SharedKey pour la connexion vpn.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	Stratégies de sélecteur de trafic à prendre en compte par cette connexion.
properties.useLocalAzureIpAddress	boolean	Utilisez l’adresse IP Azure locale pour lancer la connexion.
properties.usePolicyBasedTrafficSelectors	boolean	Activez les sélecteurs de trafic basés sur des stratégies.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Protocole de connexion utilisé pour cette connexion.
properties.vpnLinkConnections	VpnSiteLinkConnection[]	Liste de toutes les connexions de site vpn à la passerelle.

VpnConnectionStatus

État actuel de la connexion vpn.

Nom	Type	Description
Connected	string
Connecting	string
NotConnected	string
Unknown	string

VpnLinkConnectionMode

Mode de connexion de liaison VPN.

Nom	Type	Description
Default	string
InitiatorOnly	string
ResponderOnly	string

VpnSiteLinkConnection

Ressource VpnSiteLinkConnection.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
name	string	Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
properties.connectionBandwidth	integer	Bande passante attendue en MBITs/S.
properties.connectionStatus	VpnConnectionStatus	État de la connexion.
properties.dpdTimeoutSeconds	integer	Délai d’expiration de détection d’homologue mort en secondes pour la connexion VpnLink.
properties.egressBytesTransferred	integer	Octets de sortie transférés.
properties.egressNatRules	SubResource[]	Liste des natRules de sortie.
properties.enableBgp	boolean	Indicateur EnableBgp.
properties.enableRateLimiting	boolean	Indicateur EnableBgp.
properties.ingressBytesTransferred	integer	Octets d’entrée transférés.
properties.ingressNatRules	SubResource[]	Liste des natRules d’entrée.
properties.ipsecPolicies	IpsecPolicy[]	Stratégies IPSec à prendre en compte par cette connexion.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de connexion de lien de site VPN.
properties.routingWeight	integer	Poids du routage pour la connexion VPN.
properties.sharedKey	string	SharedKey pour la connexion vpn.
properties.useLocalAzureIpAddress	boolean	Utilisez l’adresse IP Azure locale pour lancer la connexion.
properties.usePolicyBasedTrafficSelectors	boolean	Activez les sélecteurs de trafic basés sur des stratégies.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Protocole de connexion utilisé pour cette connexion.
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	vpnGatewayCustomBgpAddresses utilisé par cette connexion.
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	Mode de connexion de liaison VPN.
properties.vpnSiteLink	SubResource	ID du lien de site vpn connecté.
type	string	Type de ressource.