Vpn Gateways - Reset

Service:

Virtual WAN

API-versie:

2024-05-01

Hiermee stelt u de primaire waarde van de VPN-gateway in de opgegeven resourcegroep opnieuw in.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
gatewayName	path	True	string	De naam van de gateway.
resourceGroupName	path	True	string	De naam van de resourcegroep van de VpnGateway.
subscriptionId	path	True	string	De abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string	Client-API-versie.
ipConfigurationId	query		string	VpnGateway ipConfigurationId om het gateway-exemplaar op te geven.

Antwoorden

Name	Type	Description
200 OK	VpnGateway	Aanvraag is voltooid. Met de bewerking wordt de primaire waarde van de VpnGateway opnieuw ingesteld.
202 Accepted		Geaccepteerd en de bewerking wordt asynchroon voltooid.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ResetVpnGateway

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

202

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

Statuscode:

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

Definities

Name	Description
BgpSettings	Details van BGP-instellingen.
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
DhGroup	De DH-groepen die worden gebruikt in IKE Fase 1 voor de eerste SA.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration voor een virtuele netwerkgatewayverbinding.
IkeEncryption	Het IKE-versleutelingsalgoritmen (IKE-fase 2).
IkeIntegrity	Het IKE-integriteitsalgoritmen (IKE-fase 2).
IPConfigurationBgpPeeringAddress	Eigenschappen van IPConfigurationBgpPeeringAddress.
IpsecEncryption	Het IPSec-versleutelingsalgoritmen (IKE-fase 1).
IpsecIntegrity	Het IPSec-integriteitsalgoritmen (IKE-fase 1).
IpsecPolicy	Een IPSec-beleidsconfiguratie voor een virtuele netwerkgatewayverbinding.
PfsGroup	De Pfs-groepen die worden gebruikt in IKE Fase 2 voor nieuwe onderliggende SA.
PropagatedRouteTable	De lijst met RouteTables om de routes naar te adverteren.
ProvisioningState	De huidige inrichtingsstatus.
RoutingConfiguration	Routeringsconfiguratie die de gekoppelde en doorgegeven routetabellen voor deze verbinding aangeeft.
StaticRoute	Lijst met alle statische routes.
StaticRoutesConfig	Configuratie voor statische routes op deze HubVnetConnectionConfiguration voor statische routes op deze HubVnetConnection.
SubResource	Verwijzing naar een andere subresource.
TrafficSelectorPolicy	Een verkeersselectorbeleid voor een gatewayverbinding met een virtueel netwerk.
VirtualNetworkGatewayConnectionProtocol	Verbindingsprotocol dat wordt gebruikt voor deze verbinding.
VnetLocalRouteOverrideCriteria	Parameter die bepaalt of NVA in spoke-vnet wordt omzeild voor verkeer met bestemming in spoke-vnet.
VnetRoute	Lijst met routes die routering van VirtualHub naar een virtuele netwerkverbinding beheren.
VpnConnection	VpnConnection-resource.
VpnConnectionStatus	De huidige status van de VPN-verbinding.
VpnGateway	VpnGateway-resource.
VpnGatewayIpConfiguration	IP-configuratie van een VPN Gateway-resource.
VpnGatewayNatRule	VpnGatewayNatRule-resource.
VpnLinkConnectionMode	Vpn-koppelingsverbindingsmodus.
VpnNatRuleMapping	Vpn NatRule-toewijzing.
VpnNatRuleMode	De bron-NAT-richting van een VPN NAT.
VpnNatRuleType	Het type NAT-regel voor VPN NAT.
VpnSiteLinkConnection	VpnSiteLinkConnection-resource.

BgpSettings

Object

Details van BGP-instellingen.

Name	Type	Description
asn	integer (int64) minimum: 0 maximum: 4294967295	De ASN van de BGP-spreker.
bgpPeeringAddress	string	Het BGP-peeringadres en de BGP-id van deze BGP-spreker.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	BGP-peeringadres met IP-configuratie-id voor virtuele netwerkgateway.
peerWeight	integer (int32)	Het gewicht toegevoegd aan routes die zijn geleerd van deze BGP-luidspreker.

CloudError

Object

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Hoofdtekst van cloudfout.

CloudErrorBody

Object

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

DhGroup

Inventarisatie

De DH-groepen die worden gebruikt in IKE Fase 1 voor de eerste SA.

Waarde	Description
DHGroup1
DHGroup14
DHGroup2
DHGroup2048
DHGroup24
ECP256
ECP384
None

GatewayCustomBgpIpAddressIpConfiguration

Object

GatewayCustomBgpIpAddressIpConfiguration voor een virtuele netwerkgatewayverbinding.

Name	Type	Description
customBgpIpAddress	string	Het aangepaste BgpPeeringAddress dat deel uitmaakt van IpconfigurationId.
ipConfigurationId	string	De IpconfigurationId van ipconfiguration die deel uitmaakt van de gateway.

IkeEncryption

Inventarisatie

Het IKE-versleutelingsalgoritmen (IKE-fase 2).

Waarde	Description
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES256

IkeIntegrity

Inventarisatie

Het IKE-integriteitsalgoritmen (IKE-fase 2).

Waarde	Description
GCMAES128
GCMAES256
MD5
SHA1
SHA256
SHA384

IPConfigurationBgpPeeringAddress

Object

Eigenschappen van IPConfigurationBgpPeeringAddress.

Name	Type	Description
customBgpIpAddresses	string[]	De lijst met aangepaste BGP-peeringadressen die deel uitmaken van ip-configuratie.
defaultBgpIpAddresses	string[]	De lijst met standaard BGP-peeringadressen die deel uitmaken van ip-configuratie.
ipconfigurationId	string	De id van de IP-configuratie die deel uitmaakt van de gateway.
tunnelIpAddresses	string[]	De lijst met openbare IP-adressen van de tunnel die deel uitmaken van de IP-configuratie.

IpsecEncryption

Inventarisatie

Het IPSec-versleutelingsalgoritmen (IKE-fase 1).

Waarde	Description
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES192
GCMAES256
None

IpsecIntegrity

Inventarisatie

Het IPSec-integriteitsalgoritmen (IKE-fase 1).

Waarde	Description
GCMAES128
GCMAES192
GCMAES256
MD5
SHA1
SHA256

IpsecPolicy

Object

Een IPSec-beleidsconfiguratie voor een virtuele netwerkgatewayverbinding.

Name	Type	Description
dhGroup	DhGroup	De DH-groep die wordt gebruikt in IKE Fase 1 voor de eerste SA.
ikeEncryption	IkeEncryption	Het IKE-versleutelingsalgoritmen (IKE-fase 2).
ikeIntegrity	IkeIntegrity	Het IKE-integriteitsalgoritmen (IKE-fase 2).
ipsecEncryption	IpsecEncryption	Het IPSec-versleutelingsalgoritmen (IKE-fase 1).
ipsecIntegrity	IpsecIntegrity	Het IPSec-integriteitsalgoritmen (IKE-fase 1).
pfsGroup	PfsGroup	De Pfs-groep die wordt gebruikt in IKE Fase 2 voor nieuwe onderliggende SA.
saDataSizeKilobytes	integer (int32)	De nettoladinggrootte IPSec-beveiligingskoppeling (ook wel snelle modus of fase 2 SA genoemd) in KB voor een site-naar-site-VPN-tunnel.
saLifeTimeSeconds	integer (int32)	De LEVENSDUUR van de IPSec-beveiligingskoppeling (ook wel snelle modus of fase 2 SA genoemd) in seconden voor een site-naar-site-VPN-tunnel.

PfsGroup

Inventarisatie

De Pfs-groepen die worden gebruikt in IKE Fase 2 voor nieuwe onderliggende SA.

Waarde	Description
ECP256
ECP384
None
PFS1
PFS14
PFS2
PFS2048
PFS24
PFSMM

PropagatedRouteTable

Object

De lijst met RouteTables om de routes naar te adverteren.

Name	Type	Description
ids	SubResource[]	De lijst met resource-id's van alle RouteTables.
labels	string[]	De lijst met labels.

ProvisioningState

Inventarisatie

De huidige inrichtingsstatus.

Waarde	Description
Deleting
Failed
Succeeded
Updating

RoutingConfiguration

Object

Routeringsconfiguratie die de gekoppelde en doorgegeven routetabellen voor deze verbinding aangeeft.

Name	Type	Description
associatedRouteTable	SubResource	De resource-id RouteTable die is gekoppeld aan deze RoutingConfiguration.
inboundRouteMap	SubResource	De resource-id van de RouteMap die is gekoppeld aan deze RoutingConfiguration voor binnenkomende geleerde routes.
outboundRouteMap	SubResource	De resource-id van deRouteMap die is gekoppeld aan deze RoutingConfiguration voor uitgaande geadverteerde routes.
propagatedRouteTables	PropagatedRouteTable	De lijst met RouteTables om de routes naar te adverteren.
vnetRoutes	VnetRoute	Lijst met routes die routering van VirtualHub naar een virtuele netwerkverbinding beheren.

StaticRoute

Object

Lijst met alle statische routes.

Name	Type	Description
addressPrefixes	string[]	Lijst met alle adresvoorvoegsels.
name	string	De naam van de StaticRoute die uniek is binnen een VnetRoute.
nextHopIpAddress	string	Het IP-adres van de volgende hop.

StaticRoutesConfig

Object

Configuratie voor statische routes op deze HubVnetConnectionConfiguration voor statische routes op deze HubVnetConnection.

Name	Type	Description
propagateStaticRoutes	boolean	Booleaanse waarde die aangeeft of statische routes op deze verbinding automatisch worden doorgegeven aan routetabellen waarnaar deze verbinding wordt doorgegeven.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Parameter die bepaalt of NVA in spoke-vnet wordt omzeild voor verkeer met bestemming in spoke.

SubResource

Object

Verwijzing naar een andere subresource.

Name	Type	Description
id	string	Resource-id.

TrafficSelectorPolicy

Object

Een verkeersselectorbeleid voor een gatewayverbinding met een virtueel netwerk.

Name	Type	Description
localAddressRanges	string[]	Een verzameling lokale adresruimten in CIDR-indeling.
remoteAddressRanges	string[]	Een verzameling externe adresruimten in CIDR-indeling.

VirtualNetworkGatewayConnectionProtocol

Inventarisatie

Verbindingsprotocol dat wordt gebruikt voor deze verbinding.

Waarde	Description
IKEv1
IKEv2

VnetLocalRouteOverrideCriteria

Inventarisatie

Parameter die bepaalt of NVA in spoke-vnet wordt omzeild voor verkeer met bestemming in spoke-vnet.

Waarde	Description
Contains
Equal

VnetRoute

Object

Lijst met routes die routering van VirtualHub naar een virtuele netwerkverbinding beheren.

Name	Type	Description
bgpConnections	SubResource[]	De lijst met verwijzingen naar HubBgpConnection-objecten.
staticRoutes	StaticRoute[]	Lijst met alle statische routes.
staticRoutesConfig	StaticRoutesConfig	Configuratie voor statische routes op deze HubVnetConnection.

VpnConnection

Object

VpnConnection-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.connectionBandwidth	integer (int32)	Verwachte bandbreedte in MBPS.
properties.connectionStatus	VpnConnectionStatus	De verbindingsstatus.
properties.dpdTimeoutSeconds	integer (int32)	DPD-time-out in seconden voor vpn-verbinding.
properties.egressBytesTransferred	integer (int64)	Uitgaande bytes overgedragen.
properties.enableBgp	boolean	EnableBgp-vlag.
properties.enableInternetSecurity	boolean	Internetbeveiliging inschakelen.
properties.enableRateLimiting	boolean	EnableBgp-vlag.
properties.ingressBytesTransferred	integer (int64)	Binnenkomende bytes overgedragen.
properties.ipsecPolicies	IpsecPolicy[]	Het IPSec-beleid dat door deze verbinding moet worden overwogen.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de VPN-verbindingsresource.
properties.remoteVpnSite	SubResource	Id van de verbonden VPN-site.
properties.routingConfiguration	RoutingConfiguration	De routeringsconfiguratie die de gekoppelde en doorgegeven routetabellen op deze verbinding aangeeft.
properties.routingWeight	integer (int32)	Routeringsgewicht voor vpn-verbinding.
properties.sharedKey	string	SharedKey voor de VPN-verbinding.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	Het beleid voor verkeersselector dat door deze verbinding moet worden overwogen.
properties.useLocalAzureIpAddress	boolean	Gebruik lokale Azure IP om verbinding te initiëren.
properties.usePolicyBasedTrafficSelectors	boolean	Schakel verkeerkiezers op basis van beleid in.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Verbindingsprotocol dat wordt gebruikt voor deze verbinding.
properties.vpnLinkConnections	VpnSiteLinkConnection[]	Lijst met alle vpn-sitekoppelingen naar de gateway.

VpnConnectionStatus

Inventarisatie

De huidige status van de VPN-verbinding.

Waarde	Description
Connected
Connecting
NotConnected
Unknown

VpnGateway

Object

VpnGateway-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.bgpSettings	BgpSettings	De BGP-sprekerinstellingen van de lokale netwerkgateway.
properties.connections	VpnConnection[]	Lijst met alle VPN-verbindingen met de gateway.
properties.enableBgpRouteTranslationForNat	boolean	Schakel BGP-routes vertalen in voor NAT op deze VpnGateway.
properties.ipConfigurations	VpnGatewayIpConfiguration[]	Lijst met alle IP-adressen die zijn geconfigureerd op de gateway.
properties.isRoutingPreferenceInternet	boolean	Schakel de eigenschap Routeringsvoorkeur in voor de openbare IP-interface van de VpnGateway.
properties.natRules	VpnGatewayNatRule[]	Lijst met alle nat-regels die zijn gekoppeld aan de gateway.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de VPN-gatewayresource.
properties.virtualHub	SubResource	De VirtualHub waartoe de gateway behoort.
properties.vpnGatewayScaleUnit	integer (int32)	De schaaleenheid voor deze VPN-gateway.
tags	object	Resourcetags.
type	string	Resourcetype.

VpnGatewayIpConfiguration

Object

IP-configuratie van een VPN Gateway-resource.

Name	Type	Description
id	string	De id van de IP-configuratie voor een VPN-gateway.
privateIpAddress	string	Het privé-IP-adres van deze IP-configuratie.
publicIpAddress	string	Het openbare IP-adres van deze IP-configuratie.

VpnGatewayNatRule

Object

VpnGatewayNatRule-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.egressVpnSiteLinkConnections	SubResource[]	Lijst met uitgaande VpnSiteLinkConnections.
properties.externalMappings	VpnNatRuleMapping[]	De externe toewijzing van het privé-IP-adres voor NAT.
properties.ingressVpnSiteLinkConnections	SubResource[]	Lijst met inkomende VpnSiteLinkConnections.
properties.internalMappings	VpnNatRuleMapping[]	De interne toewijzing van het privé-IP-adres voor NAT.
properties.ipConfigurationId	string	De IP-configuratie-id op deze NAT-regel is van toepassing.
properties.mode	VpnNatRuleMode	De bron-NAT-richting van een VPN NAT.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de NAT-regelresource.
properties.type	VpnNatRuleType	Het type NAT-regel voor VPN NAT.
type	string	Resourcetype.

VpnLinkConnectionMode

Inventarisatie

Vpn-koppelingsverbindingsmodus.

Waarde	Description
Default
InitiatorOnly
ResponderOnly

VpnNatRuleMapping

Object

Vpn NatRule-toewijzing.

Name	Type	Description
addressSpace	string	Adresruimte voor vpn NatRule-toewijzing.
portRange	string	Poortbereik voor Vpn NatRule-toewijzing.

VpnNatRuleMode

Inventarisatie

De bron-NAT-richting van een VPN NAT.

Waarde	Description
EgressSnat
IngressSnat

VpnNatRuleType

Inventarisatie

Het type NAT-regel voor VPN NAT.

Waarde	Description
Dynamic
Static

VpnSiteLinkConnection

Object

VpnSiteLinkConnection-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.connectionBandwidth	integer (int32)	Verwachte bandbreedte in MBPS.
properties.connectionStatus	VpnConnectionStatus	De verbindingsstatus.
properties.dpdTimeoutSeconds	integer (int32)	Time-out voor dead peer detection in seconden voor VpnLink-verbinding.
properties.egressBytesTransferred	integer (int64)	Uitgaande bytes overgedragen.
properties.egressNatRules	SubResource[]	Lijst met uitgaande NatRules.
properties.enableBgp	boolean	EnableBgp-vlag.
properties.enableRateLimiting	boolean	EnableBgp-vlag.
properties.ingressBytesTransferred	integer (int64)	Binnenkomende bytes overgedragen.
properties.ingressNatRules	SubResource[]	Lijst met inkomend verkeer NatRules.
properties.ipsecPolicies	IpsecPolicy[]	Het IPSec-beleid dat door deze verbinding moet worden overwogen.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de verbindingsresource van de VPN-sitekoppeling.
properties.routingWeight	integer (int32)	Routeringsgewicht voor vpn-verbinding.
properties.sharedKey	string	SharedKey voor de VPN-verbinding.
properties.useLocalAzureIpAddress	boolean	Gebruik lokale Azure IP om verbinding te initiëren.
properties.usePolicyBasedTrafficSelectors	boolean	Schakel verkeerkiezers op basis van beleid in.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Verbindingsprotocol dat wordt gebruikt voor deze verbinding.
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	vpnGatewayCustomBgpAddresses die door deze verbinding worden gebruikt.
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	Vpn-koppelingsverbindingsmodus.
properties.vpnSiteLink	SubResource	Id van de gekoppelde vpn-sitekoppeling.
type	string	Resourcetype.