Vpn Gateways - Reset

Service:

Virtual WAN

Version d'API:

2024-05-01

Réinitialise le principal de la passerelle VPN dans le groupe de ressources spécifié.

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

Avec des paramètres facultatifs:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/reset?ipConfigurationId={ipConfigurationId}&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.
ipConfigurationId	query		string	VpnGateway ipConfigurationId pour spécifier l’instance de passerelle.

Réponses

Nom	Type	Description
200 OK	VpnGateway	Demande réussie. L’opération réinitialise le principal du VpnGateway.
202 Accepted		Accepté et l’opération se termine de façon asynchrone.
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

ResetVpnGateway

Exemple de requête

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw/reset?api-version=2024-05-01

Java

/**
 * Samples for VpnGateways Reset.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayReset.json
     */
    /**
     * Sample code: ResetVpnGateway.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void resetVpnGateway(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnGateways().reset("rg1", "vpngw", null,
            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_gateway_reset.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_gateways.begin_reset(
        resource_group_name="rg1",
        gateway_name="vpngw",
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayReset.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/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/VpnGatewayReset.json
func ExampleVPNGatewaysClient_BeginReset() {
	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.NewVPNGatewaysClient().BeginReset(ctx, "rg1", "vpngw", &armnetwork.VPNGatewaysClientBeginResetOptions{IPConfigurationID: 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.VPNGateway = armnetwork.VPNGateway{
	// 	Name: to.Ptr("vpngw"),
	// 	Type: to.Ptr("Microsoft.Network/vpnGateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw"),
	// 	Location: to.Ptr("West US"),
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.VPNGatewayProperties{
	// 		BgpSettings: &armnetwork.BgpSettings{
	// 			Asn: to.Ptr[int64](65514),
	// 			BgpPeeringAddress: to.Ptr("10.0.1.30"),
	// 			BgpPeeringAddresses: []*armnetwork.IPConfigurationBgpPeeringAddress{
	// 				{
	// 					CustomBgpIPAddresses: []*string{
	// 						to.Ptr("169.254.21.5")},
	// 						DefaultBgpIPAddresses: []*string{
	// 							to.Ptr("10.30.0.4")},
	// 							IPConfigurationID: to.Ptr("Instance0"),
	// 							TunnelIPAddresses: []*string{
	// 								to.Ptr("104.208.48.178")},
	// 							},
	// 							{
	// 								CustomBgpIPAddresses: []*string{
	// 									to.Ptr("169.254.21.10")},
	// 									DefaultBgpIPAddresses: []*string{
	// 										to.Ptr("10.30.0.5")},
	// 										IPConfigurationID: to.Ptr("Instance1"),
	// 										TunnelIPAddresses: []*string{
	// 											to.Ptr("104.208.48.179")},
	// 									}},
	// 									PeerWeight: to.Ptr[int32](0),
	// 								},
	// 								Connections: []*armnetwork.VPNConnection{
	// 									{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw/vpnConnections/vpnConnection1"),
	// 										Name: to.Ptr("vpnConnection1"),
	// 										Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 										Properties: &armnetwork.VPNConnectionProperties{
	// 											ConnectionBandwidth: to.Ptr[int32](100),
	// 											ConnectionStatus: to.Ptr(armnetwork.VPNConnectionStatusConnected),
	// 											EgressBytesTransferred: to.Ptr[int64](0),
	// 											EnableBgp: to.Ptr(false),
	// 											IngressBytesTransferred: to.Ptr[int64](0),
	// 											IPSecPolicies: []*armnetwork.IPSecPolicy{
	// 											},
	// 											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/virtualHub1/hubRouteTables/hubRouteTable1"),
	// 												},
	// 												PropagatedRouteTables: &armnetwork.PropagatedRouteTable{
	// 													IDs: []*armnetwork.SubResource{
	// 														{
	// 															ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"),
	// 														},
	// 														{
	// 															ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2"),
	// 														},
	// 														{
	// 															ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3"),
	// 													}},
	// 													Labels: []*string{
	// 														to.Ptr("label1"),
	// 														to.Ptr("label2")},
	// 													},
	// 													VnetRoutes: &armnetwork.VnetRoute{
	// 														StaticRoutes: []*armnetwork.StaticRoute{
	// 														},
	// 													},
	// 												},
	// 												RoutingWeight: to.Ptr[int32](0),
	// 												SharedKey: to.Ptr("key"),
	// 												UseLocalAzureIPAddress: to.Ptr(false),
	// 											},
	// 									}},
	// 									EnableBgpRouteTranslationForNat: to.Ptr(false),
	// 									IsRoutingPreferenceInternet: to.Ptr(false),
	// 									NatRules: []*armnetwork.VPNGatewayNatRule{
	// 									},
	// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 									VirtualHub: &armnetwork.SubResource{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"),
	// 									},
	// 								},
	// 							}
}

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 Resets the primary of the vpn gateway in the specified resource group.
 *
 * @summary Resets the primary of the vpn gateway in the specified resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayReset.json
 */
async function resetVpnGateway() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const gatewayName = "vpngw";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.vpnGateways.beginResetAndWait(resourceGroupName, gatewayName);
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayReset.json
// this example is just showing the usage of "VpnGateways_Reset" 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 = "vpngw";
ResourceIdentifier vpnGatewayResourceId = VpnGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, gatewayName);
VpnGatewayResource vpnGateway = client.GetVpnGatewayResource(vpnGatewayResourceId);

// invoke the operation
ArmOperation<VpnGatewayResource> lro = await vpnGateway.ResetAsync(WaitUntil.Completed);
VpnGatewayResource 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
VpnGatewayData 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

Exemple de réponse

Code d’état:

202

location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}

Code d’état:

200

{
  "name": "vpngw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "type": "Microsoft.Network/vpnGateways",
  "properties": {
    "provisioningState": "Succeeded",
    "virtualHub": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
    },
    "connections": [
      {
        "name": "vpnConnection1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw/vpnConnections/vpnConnection1",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "properties": {
          "provisioningState": "Succeeded",
          "remoteVpnSite": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
          },
          "connectionStatus": "Connected",
          "ingressBytesTransferred": 0,
          "egressBytesTransferred": 0,
          "routingWeight": 0,
          "connectionBandwidth": 100,
          "sharedKey": "key",
          "enableBgp": false,
          "useLocalAzureIpAddress": false,
          "ipsecPolicies": [],
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
            },
            "propagatedRouteTables": {
              "labels": [
                "label1",
                "label2"
              ],
              "ids": [
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
                },
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2"
                },
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3"
                }
              ]
            },
            "vnetRoutes": {
              "staticRoutes": []
            }
          }
        }
      }
    ],
    "bgpSettings": {
      "asn": 65514,
      "bgpPeeringAddress": "10.0.1.30",
      "peerWeight": 0,
      "bgpPeeringAddresses": [
        {
          "ipconfigurationId": "Instance0",
          "defaultBgpIpAddresses": [
            "10.30.0.4"
          ],
          "customBgpIpAddresses": [
            "169.254.21.5"
          ],
          "tunnelIpAddresses": [
            "104.208.48.178"
          ]
        },
        {
          "ipconfigurationId": "Instance1",
          "defaultBgpIpAddresses": [
            "10.30.0.5"
          ],
          "customBgpIpAddresses": [
            "169.254.21.10"
          ],
          "tunnelIpAddresses": [
            "104.208.48.179"
          ]
        }
      ]
    },
    "natRules": [],
    "isRoutingPreferenceInternet": false,
    "enableBgpRouteTranslationForNat": false
  }
}

Définitions

Nom	Description
BgpSettings	Détails des paramètres BGP.
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).
IPConfigurationBgpPeeringAddress	Propriétés d’IPConfigurationBgpPeeringAddress.
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.
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.
VpnGateway	Ressource VpnGateway.
VpnGatewayIpConfiguration	Configuration IP d’une ressource de passerelle VPN.
VpnGatewayNatRule	Ressource VpnGatewayNatRule.
VpnLinkConnectionMode	Mode de connexion de liaison VPN.
VpnNatRuleMapping	Mappage NatRule vpn.
VpnNatRuleMode	Direction NAT source d’un NAT VPN.
VpnNatRuleType	Type de règle NAT pour VPN NAT.
VpnSiteLinkConnection	Ressource VpnSiteLinkConnection.

BgpSettings

Object

Détails des paramètres BGP.

Nom	Type	Description
asn	integer	ASN de l’orateur BGP.
bgpPeeringAddress	string	Adresse de peering BGP et identificateur BGP de cet orateur BGP.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	Adresse de peering BGP avec l’ID de configuration IP pour la passerelle de réseau virtuel.
peerWeight	integer	Poids ajouté aux itinéraires appris à partir de ce haut-parleur BGP.

CloudError

Object

Réponse d’erreur du service.

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

CloudErrorBody

Object

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

Enumeration

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

Valeur	Description
DHGroup1
DHGroup14
DHGroup2
DHGroup2048
DHGroup24
ECP256
ECP384
None

GatewayCustomBgpIpAddressIpConfiguration

Object

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

Enumeration

Algorithme de chiffrement IKE (phase IKE 2).

Valeur	Description
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES256

IkeIntegrity

Enumeration

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

Valeur	Description
GCMAES128
GCMAES256
MD5
SHA1
SHA256
SHA384

IPConfigurationBgpPeeringAddress

Object

Propriétés d’IPConfigurationBgpPeeringAddress.

Nom	Type	Description
customBgpIpAddresses	string[]	Liste des adresses de peering BGP personnalisées qui appartiennent à la configuration IP.
defaultBgpIpAddresses	string[]	Liste des adresses de peering BGP par défaut qui appartiennent à la configuration IP.
ipconfigurationId	string	ID de la configuration IP qui appartient à la passerelle.
tunnelIpAddresses	string[]	Liste des adresses IP publiques de tunnel qui appartiennent à la configuration IP.

IpsecEncryption

Enumeration

Algorithme de chiffrement IPSec (phase IKE 1).

Valeur	Description
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES192
GCMAES256
None

IpsecIntegrity

Enumeration

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

Valeur	Description
GCMAES128
GCMAES192
GCMAES256
MD5
SHA1
SHA256

IpsecPolicy

Object

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.

PfsGroup

Enumeration

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

Valeur	Description
ECP256
ECP384
None
PFS1
PFS14
PFS2
PFS2048
PFS24
PFSMM

PropagatedRouteTable

Object

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

Enumeration

État d’approvisionnement actuel.

Valeur	Description
Deleting
Failed
Succeeded
Updating

RoutingConfiguration

Object

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

Object

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

Object

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

Object

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

Nom	Type	Description
id	string	ID de ressource.

TrafficSelectorPolicy

Object

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

Enumeration

Protocole de connexion utilisé pour cette connexion.

Valeur	Description
IKEv1
IKEv2

VnetLocalRouteOverrideCriteria

Enumeration

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.

Valeur	Description
Contains
Equal

VnetRoute

Object

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

Object

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

Enumeration

État actuel de la connexion vpn.

Valeur	Description
Connected
Connecting
NotConnected
Unknown

VpnGateway

Object

Ressource VpnGateway.

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.
location	string	Emplacement des ressources.
name	string	Nom de la ressource.
properties.bgpSettings	BgpSettings	Paramètres de l’orateur BGP de la passerelle de réseau local.
properties.connections	VpnConnection[]	Liste de toutes les connexions VPN à la passerelle.
properties.enableBgpRouteTranslationForNat	boolean	Activez la traduction d’itinéraires BGP pour NAT sur ce VpnGateway.
properties.ipConfigurations	VpnGatewayIpConfiguration[]	Liste de toutes les adresses IP configurées sur la passerelle.
properties.isRoutingPreferenceInternet	boolean	Activez la propriété Préférence de routage pour l’interface IP publique du VpnGateway.
properties.natRules	VpnGatewayNatRule[]	Liste de toutes les règles nat associées à la passerelle.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de passerelle VPN.
properties.virtualHub	SubResource	VirtualHub auquel appartient la passerelle.
properties.vpnGatewayScaleUnit	integer	Unité d’échelle pour cette passerelle vpn.
tags	object	Balises de ressource.
type	string	Type de ressource.

VpnGatewayIpConfiguration

Object

Configuration IP d’une ressource de passerelle VPN.

Nom	Type	Description
id	string	Identificateur de la configuration IP d’une passerelle VPN.
privateIpAddress	string	Adresse IP privée de cette configuration IP.
publicIpAddress	string	Adresse IP publique de cette configuration IP.

VpnGatewayNatRule

Object

Ressource VpnGatewayNatRule.

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.egressVpnSiteLinkConnections	SubResource[]	Liste des connexions VpnSiteLinkConnections de sortie.
properties.externalMappings	VpnNatRuleMapping[]	Mappage externe d’adresse IP privée pour NAT.
properties.ingressVpnSiteLinkConnections	SubResource[]	Liste des connexions VpnSiteLinkConnections d’entrée.
properties.internalMappings	VpnNatRuleMapping[]	Mappage interne d’adresse IP privée pour NAT.
properties.ipConfigurationId	string	L’ID de configuration IP à cette règle NAT s’applique.
properties.mode	VpnNatRuleMode	Direction NAT source d’un NAT VPN.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de règle NAT.
properties.type	VpnNatRuleType	Type de règle NAT pour VPN NAT.
type	string	Type de ressource.

VpnLinkConnectionMode

Enumeration

Mode de connexion de liaison VPN.

Valeur	Description
Default
InitiatorOnly
ResponderOnly

VpnNatRuleMapping

Object

Mappage NatRule vpn.

Nom	Type	Description
addressSpace	string	Espace d’adressage pour le mappage NatRule vpn.
portRange	string	Plage de ports pour le mappage NatRule vpn.

VpnNatRuleMode

Enumeration

Direction NAT source d’un NAT VPN.

Valeur	Description
EgressSnat
IngressSnat

VpnNatRuleType

Enumeration

Type de règle NAT pour VPN NAT.

Valeur	Description
Dynamic
Static

VpnSiteLinkConnection

Object

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.