Vpn Gateways - Create Or Update

Service:

Virtual WAN

API-versie:

2024-05-01

Hiermee maakt u een vpn-gateway voor virtuele wan als deze niet bestaat, wordt de bestaande gateway bijgewerkt.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}?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.

Aanvraagbody

Name	Vereist	Type	Description
location	True	string	Resourcelocatie.
id		string	Resource-id.
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.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.virtualHub		SubResource	De VirtualHub waartoe de gateway behoort.
properties.vpnGatewayScaleUnit		integer	De schaaleenheid voor deze VPN-gateway.
tags		object	Resourcetags.

Antwoorden

Name	Type	Description
200 OK	VpnGateway	Aanvraag is voltooid. Retourneert de details van de vpn-gateway van virtual wan die is gemaakt of bijgewerkt.
201 Created	VpnGateway	Aanvraag is voltooid. Retourneert de details van de vpn-gateway van virtual wan die is opgehaald.
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

VpnGatewayPut

Voorbeeldaanvraag

HTTP

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

{
  "location": "westcentralus",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "virtualHub": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
    },
    "connections": [
      {
        "name": "vpnConnection1",
        "properties": {
          "remoteVpnSite": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
          },
          "vpnLinkConnections": [
            {
              "name": "Connection-Link1",
              "properties": {
                "vpnSiteLink": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
                },
                "connectionBandwidth": 200,
                "vpnConnectionProtocolType": "IKEv2",
                "sharedKey": "key",
                "egressNatRules": [
                  {
                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"
                  }
                ]
              }
            }
          ]
        }
      }
    ],
    "bgpSettings": {
      "asn": 65515,
      "peerWeight": 0,
      "bgpPeeringAddresses": [
        {
          "ipconfigurationId": "Instance0",
          "customBgpIpAddresses": [
            "169.254.21.5"
          ]
        },
        {
          "ipconfigurationId": "Instance1",
          "customBgpIpAddresses": [
            "169.254.21.10"
          ]
        }
      ]
    },
    "natRules": [
      {
        "name": "nat03",
        "properties": {
          "type": "Static",
          "mode": "EgressSnat",
          "internalMappings": [
            {
              "addressSpace": "0.0.0.0/26"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "192.168.0.0/26"
            }
          ],
          "ipConfigurationId": ""
        }
      }
    ],
    "isRoutingPreferenceInternet": false,
    "enableBgpRouteTranslationForNat": false
  }
}

Java

import com.azure.core.management.SubResource;
import com.azure.resourcemanager.network.fluent.models.VpnConnectionInner;
import com.azure.resourcemanager.network.fluent.models.VpnGatewayInner;
import com.azure.resourcemanager.network.fluent.models.VpnGatewayNatRuleInner;
import com.azure.resourcemanager.network.fluent.models.VpnSiteLinkConnectionInner;
import com.azure.resourcemanager.network.models.BgpSettings;
import com.azure.resourcemanager.network.models.IpConfigurationBgpPeeringAddress;
import com.azure.resourcemanager.network.models.VirtualNetworkGatewayConnectionProtocol;
import com.azure.resourcemanager.network.models.VpnNatRuleMapping;
import com.azure.resourcemanager.network.models.VpnNatRuleMode;
import com.azure.resourcemanager.network.models.VpnNatRuleType;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for VpnGateways CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayPut.json
     */
    /**
     * Sample code: VpnGatewayPut.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnGatewayPut(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnGateways().createOrUpdate("rg1", "gateway1",
            new VpnGatewayInner().withLocation("westcentralus").withTags(mapOf("key1", "fakeTokenPlaceholder"))
                .withVirtualHub(new SubResource().withId(
                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"))
                .withConnections(Arrays.asList(new VpnConnectionInner().withName("vpnConnection1")
                    .withRemoteVpnSite(new SubResource().withId(
                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"))
                    .withVpnLinkConnections(Arrays.asList(new VpnSiteLinkConnectionInner().withName("Connection-Link1")
                        .withVpnSiteLink(new SubResource().withId(
                            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"))
                        .withVpnConnectionProtocolType(VirtualNetworkGatewayConnectionProtocol.IKEV2)
                        .withConnectionBandwidth(200).withSharedKey("fakeTokenPlaceholder")
                        .withEgressNatRules(Arrays.asList(new SubResource().withId(
                            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03")))))))
                .withBgpSettings(new BgpSettings().withAsn(65515L).withPeerWeight(0)
                    .withBgpPeeringAddresses(Arrays.asList(
                        new IpConfigurationBgpPeeringAddress().withIpconfigurationId("Instance0")
                            .withCustomBgpIpAddresses(Arrays.asList("169.254.21.5")),
                        new IpConfigurationBgpPeeringAddress().withIpconfigurationId("Instance1")
                            .withCustomBgpIpAddresses(Arrays.asList("169.254.21.10")))))
                .withEnableBgpRouteTranslationForNat(false).withIsRoutingPreferenceInternet(false)
                .withNatRules(Arrays.asList(new VpnGatewayNatRuleInner().withName("nat03")
                    .withTypePropertiesType(VpnNatRuleType.STATIC).withMode(VpnNatRuleMode.EGRESS_SNAT)
                    .withInternalMappings(Arrays.asList(new VpnNatRuleMapping().withAddressSpace("0.0.0.0/26")))
                    .withExternalMappings(Arrays.asList(new VpnNatRuleMapping().withAddressSpace("192.168.0.0/26")))
                    .withIpConfigurationId(""))),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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_put.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_create_or_update(
        resource_group_name="rg1",
        gateway_name="gateway1",
        vpn_gateway_parameters={
            "location": "westcentralus",
            "properties": {
                "bgpSettings": {
                    "asn": 65515,
                    "bgpPeeringAddresses": [
                        {"customBgpIpAddresses": ["169.254.21.5"], "ipconfigurationId": "Instance0"},
                        {"customBgpIpAddresses": ["169.254.21.10"], "ipconfigurationId": "Instance1"},
                    ],
                    "peerWeight": 0,
                },
                "connections": [
                    {
                        "name": "vpnConnection1",
                        "properties": {
                            "remoteVpnSite": {
                                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
                            },
                            "vpnLinkConnections": [
                                {
                                    "name": "Connection-Link1",
                                    "properties": {
                                        "connectionBandwidth": 200,
                                        "egressNatRules": [
                                            {
                                                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"
                                            }
                                        ],
                                        "sharedKey": "key",
                                        "vpnConnectionProtocolType": "IKEv2",
                                        "vpnSiteLink": {
                                            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
                                        },
                                    },
                                }
                            ],
                        },
                    }
                ],
                "enableBgpRouteTranslationForNat": False,
                "isRoutingPreferenceInternet": False,
                "natRules": [
                    {
                        "name": "nat03",
                        "properties": {
                            "externalMappings": [{"addressSpace": "192.168.0.0/26"}],
                            "internalMappings": [{"addressSpace": "0.0.0.0/26"}],
                            "ipConfigurationId": "",
                            "mode": "EgressSnat",
                            "type": "Static",
                        },
                    }
                ],
                "virtualHub": {
                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
                },
            },
            "tags": {"key1": "value1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayPut.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/azcore/to"
	"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/VpnGatewayPut.json
func ExampleVPNGatewaysClient_BeginCreateOrUpdate() {
	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().BeginCreateOrUpdate(ctx, "rg1", "gateway1", armnetwork.VPNGateway{
		Location: to.Ptr("westcentralus"),
		Tags: map[string]*string{
			"key1": to.Ptr("value1"),
		},
		Properties: &armnetwork.VPNGatewayProperties{
			BgpSettings: &armnetwork.BgpSettings{
				Asn: to.Ptr[int64](65515),
				BgpPeeringAddresses: []*armnetwork.IPConfigurationBgpPeeringAddress{
					{
						CustomBgpIPAddresses: []*string{
							to.Ptr("169.254.21.5")},
						IPConfigurationID: to.Ptr("Instance0"),
					},
					{
						CustomBgpIPAddresses: []*string{
							to.Ptr("169.254.21.10")},
						IPConfigurationID: to.Ptr("Instance1"),
					}},
				PeerWeight: to.Ptr[int32](0),
			},
			Connections: []*armnetwork.VPNConnection{
				{
					Name: to.Ptr("vpnConnection1"),
					Properties: &armnetwork.VPNConnectionProperties{
						RemoteVPNSite: &armnetwork.SubResource{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"),
						},
						VPNLinkConnections: []*armnetwork.VPNSiteLinkConnection{
							{
								Name: to.Ptr("Connection-Link1"),
								Properties: &armnetwork.VPNSiteLinkConnectionProperties{
									ConnectionBandwidth: to.Ptr[int32](200),
									EgressNatRules: []*armnetwork.SubResource{
										{
											ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"),
										}},
									SharedKey:                 to.Ptr("key"),
									VPNConnectionProtocolType: to.Ptr(armnetwork.VirtualNetworkGatewayConnectionProtocolIKEv2),
									VPNSiteLink: &armnetwork.SubResource{
										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"),
									},
								},
							}},
					},
				}},
			EnableBgpRouteTranslationForNat: to.Ptr(false),
			IsRoutingPreferenceInternet:     to.Ptr(false),
			NatRules: []*armnetwork.VPNGatewayNatRule{
				{
					Name: to.Ptr("nat03"),
					Properties: &armnetwork.VPNGatewayNatRuleProperties{
						Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
						ExternalMappings: []*armnetwork.VPNNatRuleMapping{
							{
								AddressSpace: to.Ptr("192.168.0.0/26"),
							}},
						InternalMappings: []*armnetwork.VPNNatRuleMapping{
							{
								AddressSpace: to.Ptr("0.0.0.0/26"),
							}},
						IPConfigurationID: to.Ptr(""),
						Mode:              to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
					},
				}},
			VirtualHub: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"),
			},
		},
	}, 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("gateway1"),
	// 	Type: to.Ptr("Microsoft.Network/vpnGateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1"),
	// 	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/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/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{
	// 														},
	// 													},
	// 												},
	// 												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),
	// 															EgressNatRules: []*armnetwork.SubResource{
	// 																{
	// 																	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"),
	// 															}},
	// 															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),
	// 															VPNSiteLink: &armnetwork.SubResource{
	// 																ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"),
	// 															},
	// 														},
	// 												}},
	// 											},
	// 									}},
	// 									IsRoutingPreferenceInternet: to.Ptr(false),
	// 									NatRules: []*armnetwork.VPNGatewayNatRule{
	// 										{
	// 											ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"),
	// 											Name: to.Ptr("nat03"),
	// 											Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 											Properties: &armnetwork.VPNGatewayNatRuleProperties{
	// 												Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 												EgressVPNSiteLinkConnections: []*armnetwork.SubResource{
	// 													{
	// 														ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1"),
	// 												}},
	// 												ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 													{
	// 														AddressSpace: to.Ptr("192.168.0.0/26"),
	// 												}},
	// 												InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 													{
	// 														AddressSpace: to.Ptr("0.0.0.0/26"),
	// 												}},
	// 												Mode: to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
	// 											},
	// 									}},
	// 									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 Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.
 *
 * @summary Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayPut.json
 */
async function vpnGatewayPut() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const gatewayName = "gateway1";
  const vpnGatewayParameters = {
    bgpSettings: {
      asn: 65515,
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: ["169.254.21.5"],
          ipconfigurationId: "Instance0",
        },
        {
          customBgpIpAddresses: ["169.254.21.10"],
          ipconfigurationId: "Instance1",
        },
      ],
      peerWeight: 0,
    },
    connections: [
      {
        name: "vpnConnection1",
        remoteVpnSite: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
        },
        vpnLinkConnections: [
          {
            name: "Connection-Link1",
            connectionBandwidth: 200,
            egressNatRules: [
              {
                id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03",
              },
            ],
            sharedKey: "key",
            vpnConnectionProtocolType: "IKEv2",
            vpnSiteLink: {
              id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1",
            },
          },
        ],
      },
    ],
    enableBgpRouteTranslationForNat: false,
    isRoutingPreferenceInternet: false,
    location: "westcentralus",
    natRules: [
      {
        name: "nat03",
        typePropertiesType: "Static",
        externalMappings: [{ addressSpace: "192.168.0.0/26" }],
        internalMappings: [{ addressSpace: "0.0.0.0/26" }],
        ipConfigurationId: "",
        mode: "EgressSnat",
      },
    ],
    tags: { key1: "value1" },
    virtualHub: {
      id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.vpnGateways.beginCreateOrUpdateAndWait(
    resourceGroupName,
    gatewayName,
    vpnGatewayParameters,
  );
  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.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayPut.json
// this example is just showing the usage of "VpnGateways_CreateOrUpdate" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this VpnGatewayResource
VpnGatewayCollection collection = resourceGroupResource.GetVpnGateways();

// invoke the operation
string gatewayName = "gateway1";
VpnGatewayData data = new VpnGatewayData
{
    VirtualHubId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"),
    Connections = {new VpnConnectionData
    {
    RemoteVpnSiteId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"),
    VpnLinkConnections = {new VpnSiteLinkConnectionData
    {
    VpnSiteLinkId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"),
    VpnConnectionProtocolType = VirtualNetworkGatewayConnectionProtocol.IkeV2,
    ConnectionBandwidth = 200,
    SharedKey = "key",
    EgressNatRules = {new WritableSubResource
    {
    Id = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"),
    }},
    Name = "Connection-Link1",
    }},
    Name = "vpnConnection1",
    }},
    BgpSettings = new BgpSettings
    {
        Asn = 65515L,
        PeerWeight = 0,
        BgpPeeringAddresses = {new NetworkIPConfigurationBgpPeeringAddress
        {
        IPConfigurationId = "Instance0",
        CustomBgpIPAddresses = {"169.254.21.5"},
        }, new NetworkIPConfigurationBgpPeeringAddress
        {
        IPConfigurationId = "Instance1",
        CustomBgpIPAddresses = {"169.254.21.10"},
        }},
    },
    EnableBgpRouteTranslationForNat = false,
    IsRoutingPreferenceInternet = false,
    NatRules = {new VpnGatewayNatRuleData
    {
    VpnNatRuleType = VpnNatRuleType.Static,
    Mode = VpnNatRuleMode.EgressSnat,
    InternalMappings = {new VpnNatRuleMapping
    {
    AddressSpace = "0.0.0.0/26",
    }},
    ExternalMappings = {new VpnNatRuleMapping
    {
    AddressSpace = "192.168.0.0/26",
    }},
    IPConfigurationId = "",
    Name = "nat03",
    }},
    Location = new AzureLocation("westcentralus"),
    Tags =
    {
    ["key1"] = "value1"
    },
};
ArmOperation<VpnGatewayResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, gatewayName, data);
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:

200

{
  "name": "gateway1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1",
  "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/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,
          "vpnLinkConnections": [
            {
              "name": "Connection-Link1",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
              "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
              "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
              "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,
                "egressNatRules": [
                  {
                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"
                  }
                ]
              }
            }
          ],
          "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": [
      {
        "name": "nat03",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "properties": {
          "type": "Static",
          "mode": "EgressSnat",
          "internalMappings": [
            {
              "addressSpace": "0.0.0.0/26"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "192.168.0.0/26"
            }
          ],
          "egressVpnSiteLinkConnections": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1"
            }
          ]
        }
      }
    ],
    "isRoutingPreferenceInternet": false
  }
}

Statuscode:

201

{
  "name": "gateway1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1",
  "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/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,
          "vpnLinkConnections": [
            {
              "name": "Connection-Link1",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
              "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
              "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
              "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,
                "egressNatRules": [
                  {
                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"
                  }
                ]
              }
            }
          ],
          "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": [
      {
        "name": "nat03",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "properties": {
          "type": "Static",
          "mode": "EgressSnat",
          "internalMappings": [
            {
              "addressSpace": "0.0.0.0/26"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "192.168.0.0/26"
            }
          ],
          "egressVpnSiteLinkConnections": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1"
            }
          ]
        }
      }
    ],
    "isRoutingPreferenceInternet": 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

Details van BGP-instellingen.

Name	Type	Description
asn	integer	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	Het gewicht toegevoegd aan routes die zijn geleerd van deze BGP-luidspreker.

CloudError

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Hoofdtekst van cloudfout.

CloudErrorBody

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

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

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

GatewayCustomBgpIpAddressIpConfiguration

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

Het IKE-versleutelingsalgoritmen (IKE-fase 2).

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

IkeIntegrity

Het IKE-integriteitsalgoritmen (IKE-fase 2).

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

IPConfigurationBgpPeeringAddress

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

Het IPSec-versleutelingsalgoritmen (IKE-fase 1).

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

IpsecIntegrity

Het IPSec-integriteitsalgoritmen (IKE-fase 1).

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

IpsecPolicy

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	De nettoladinggrootte IPSec-beveiligingskoppeling (ook wel snelle modus of fase 2 SA genoemd) in KB voor een site-naar-site-VPN-tunnel.
saLifeTimeSeconds	integer	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

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

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

PropagatedRouteTable

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

De huidige inrichtingsstatus.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingConfiguration

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

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

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

Verwijzing naar een andere subresource.

Name	Type	Description
id	string	Resource-id.

TrafficSelectorPolicy

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

Verbindingsprotocol dat wordt gebruikt voor deze verbinding.

Name	Type	Description
IKEv1	string
IKEv2	string

VnetLocalRouteOverrideCriteria

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

Name	Type	Description
Contains	string
Equal	string

VnetRoute

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

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	Verwachte bandbreedte in MBPS.
properties.connectionStatus	VpnConnectionStatus	De verbindingsstatus.
properties.dpdTimeoutSeconds	integer	DPD-time-out in seconden voor vpn-verbinding.
properties.egressBytesTransferred	integer	Uitgaande bytes overgedragen.
properties.enableBgp	boolean	EnableBgp-vlag.
properties.enableInternetSecurity	boolean	Internetbeveiliging inschakelen.
properties.enableRateLimiting	boolean	EnableBgp-vlag.
properties.ingressBytesTransferred	integer	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	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

De huidige status van de VPN-verbinding.

Name	Type	Description
Connected	string
Connecting	string
NotConnected	string
Unknown	string

VpnGateway

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	De schaaleenheid voor deze VPN-gateway.
tags	object	Resourcetags.
type	string	Resourcetype.

VpnGatewayIpConfiguration

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

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

Vpn-koppelingsverbindingsmodus.

Name	Type	Description
Default	string
InitiatorOnly	string
ResponderOnly	string

VpnNatRuleMapping

Vpn NatRule-toewijzing.

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

VpnNatRuleMode

De bron-NAT-richting van een VPN NAT.

Name	Type	Description
EgressSnat	string
IngressSnat	string

VpnNatRuleType

Het type NAT-regel voor VPN NAT.

Name	Type	Description
Dynamic	string
Static	string

VpnSiteLinkConnection

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	Verwachte bandbreedte in MBPS.
properties.connectionStatus	VpnConnectionStatus	De verbindingsstatus.
properties.dpdTimeoutSeconds	integer	Time-out voor dead peer detection in seconden voor VpnLink-verbinding.
properties.egressBytesTransferred	integer	Uitgaande bytes overgedragen.
properties.egressNatRules	SubResource[]	Lijst met uitgaande NatRules.
properties.enableBgp	boolean	EnableBgp-vlag.
properties.enableRateLimiting	boolean	EnableBgp-vlag.
properties.ingressBytesTransferred	integer	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	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.