Vpn Gateways - Create Or Update

Dienst:

Virtual WAN

API-Version:

2024-05-01

Erstellt ein virtuelles WAN-VPN-Gateway, wenn es nicht vorhanden ist, wird das vorhandene Gateway aktualisiert.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
gatewayName	path	True	string	Der Name des Gateways.
resourceGroupName	path	True	string	Der Ressourcengruppenname des VpnGateway.
subscriptionId	path	True	string	Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Ressourcenspeicherort.
id		string	Ressourcen-ID.
properties.bgpSettings		BgpSettings	BGP-Lautsprechereinstellungen des lokalen Netzwerkgateways.
properties.connections		VpnConnection[]	Liste aller VPN-Verbindungen mit dem Gateway.
properties.enableBgpRouteTranslationForNat		boolean	Aktivieren Sie die BGP-Routenübersetzung für NAT auf diesem VpnGateway.
properties.isRoutingPreferenceInternet		boolean	Enable Routing Preference property for the Public IP Interface of the VpnGateway.
properties.natRules		VpnGatewayNatRule[]	Liste aller nat-Regeln, die dem Gateway zugeordnet sind.
properties.virtualHub		SubResource	Der VirtualHub, zu dem das Gateway gehört.
properties.vpnGatewayScaleUnit		integer	Die Skalierungseinheit für dieses VPN-Gateway.
tags		object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	VpnGateway	Anforderung erfolgreich. Gibt die Details des virtuellen WAN-VPN-Gateways zurück, das erstellt oder aktualisiert wurde.
201 Created	VpnGateway	Anforderung erfolgreich. Gibt die Details des abgerufenen virtuellen WAN-VPN-Gateways zurück.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

VpnGatewayPut

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
BgpSettings	Details zu den BGP-Einstellungen.
CloudError	Eine Fehlerantwort des Diensts.
CloudErrorBody	Eine Fehlerantwort des Diensts.
DhGroup	Die DH-Gruppen, die in IKE Phase 1 für die erste SA verwendet werden.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration für eine Verbindung mit einem virtuellen Netzwerkgateway.
IkeEncryption	Der IKE-Verschlüsselungsalgorithmus (IKE Phase 2).
IkeIntegrity	Der IKE-Integritätsalgorithmus (IKE Phase 2).
IPConfigurationBgpPeeringAddress	Eigenschaften von IPConfigurationBgpPeeringAddress.
IpsecEncryption	Der IPSec-Verschlüsselungsalgorithmus (IKE Phase 1).
IpsecIntegrity	Der IPSec-Integritätsalgorithmus (IKE Phase 1).
IpsecPolicy	Eine IPSec-Richtlinienkonfiguration für eine Verbindung mit einem virtuellen Netzwerkgateway.
PfsGroup	Die pfs Groups, die in IKE Phase 2 für neue untergeordnete SA verwendet werden.
PropagatedRouteTable	Die Liste der RouteTables, an die die Routen angekündigt werden sollen.
ProvisioningState	Der aktuelle Bereitstellungsstatus.
RoutingConfiguration	Routingkonfiguration, die die zugeordneten und verteilten Routentabellen für diese Verbindung angibt.
StaticRoute	Liste aller statischen Routen.
StaticRoutesConfig	Konfiguration für statische Routen auf diesem HubVnetConnectionConfiguration für statische Routen auf diesem HubVnetConnection.
SubResource	Verweisen auf eine andere Unterressource.
TrafficSelectorPolicy	Eine Datenverkehrsauswahlrichtlinie für eine Verbindung mit einem virtuellen Netzwerkgateway.
VirtualNetworkGatewayConnectionProtocol	Verbindungsprotokoll, das für diese Verbindung verwendet wird.
VnetLocalRouteOverrideCriteria	Parameter, der bestimmt, ob NVA in Speichen-vnet für Datenverkehr mit Ziel in Speichen-vnet umgangen wird.
VnetRoute	Liste der Routen, die das Routing von VirtualHub in eine virtuelle Netzwerkverbindung steuern.
VpnConnection	VpnConnection-Ressource.
VpnConnectionStatus	Der aktuelle Status der VPN-Verbindung.
VpnGateway	VpnGateway-Ressource.
VpnGatewayIpConfiguration	IP-Konfiguration einer VPN-Gatewayressource.
VpnGatewayNatRule	VpnGatewayNatRule-Ressource.
VpnLinkConnectionMode	Verbindungsmodus für VPN-Verbindungen.
VpnNatRuleMapping	Vpn NatRule-Zuordnung.
VpnNatRuleMode	Die Quell-NAT-Richtung eines VPN-NAT.
VpnNatRuleType	Der Typ der NAT-Regel für VPN NAT.
VpnSiteLinkConnection	VpnSiteLinkConnection-Ressource.

BgpSettings

Details zu den BGP-Einstellungen.

Name	Typ	Beschreibung
asn	integer	Der ASN des BGP-Sprechers.
bgpPeeringAddress	string	Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Lautsprechers.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	BGP-Peeringadresse mit IP-Konfigurations-ID für virtuelles Netzwerkgateway.
peerWeight	integer	Das Gewicht, das zu Routen hinzugefügt wurde, die von diesem BGP-Lautsprecher gelernt wurden.

CloudError

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Cloudfehlertext.

CloudErrorBody

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

DhGroup

Die DH-Gruppen, die in IKE Phase 1 für die erste SA verwendet werden.

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

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration für eine Verbindung mit einem virtuellen Netzwerkgateway.

Name	Typ	Beschreibung
customBgpIpAddress	string	Die benutzerdefinierte BgpPeeringAddress, die zu IpconfigurationId gehört.
ipConfigurationId	string	Die IpconfigurationId der ipconfiguration, die zum Gateway gehört.

IkeEncryption

Der IKE-Verschlüsselungsalgorithmus (IKE Phase 2).

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

IkeIntegrity

Der IKE-Integritätsalgorithmus (IKE Phase 2).

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

IPConfigurationBgpPeeringAddress

Eigenschaften von IPConfigurationBgpPeeringAddress.

Name	Typ	Beschreibung
customBgpIpAddresses	string[]	Die Liste der benutzerdefinierten BGP-Peeringadressen, die zur IP-Konfiguration gehören.
defaultBgpIpAddresses	string[]	Die Liste der standardmäßigen BGP-Peeringadressen, die zur IP-Konfiguration gehören.
ipconfigurationId	string	Die ID der IP-Konfiguration, die zum Gateway gehört.
tunnelIpAddresses	string[]	Die Liste der öffentlichen Tunnel-IP-Adressen, die zur IP-Konfiguration gehören.

IpsecEncryption

Der IPSec-Verschlüsselungsalgorithmus (IKE Phase 1).

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

IpsecIntegrity

Der IPSec-Integritätsalgorithmus (IKE Phase 1).

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

IpsecPolicy

Eine IPSec-Richtlinienkonfiguration für eine Verbindung mit einem virtuellen Netzwerkgateway.

Name	Typ	Beschreibung
dhGroup	DhGroup	Die DH Group wurde in IKE Phase 1 für die erste SA verwendet.
ikeEncryption	IkeEncryption	Der IKE-Verschlüsselungsalgorithmus (IKE Phase 2).
ikeIntegrity	IkeIntegrity	Der IKE-Integritätsalgorithmus (IKE Phase 2).
ipsecEncryption	IpsecEncryption	Der IPSec-Verschlüsselungsalgorithmus (IKE Phase 1).
ipsecIntegrity	IpsecIntegrity	Der IPSec-Integritätsalgorithmus (IKE Phase 1).
pfsGroup	PfsGroup	Die Pfs Group, die in IKE Phase 2 für neue untergeordnete SA verwendet wird.
saDataSizeKilobytes	integer	Die Nutzlastgröße der IPSec-Sicherheitszuordnung (auch als Schnellmodus oder Phase 2 SA bezeichnet) in KB für einen Standort-zu-Standort-VPN-Tunnel.
saLifeTimeSeconds	integer	Die IPSec Security Association (auch als Schnellmodus oder Phase 2 SA bezeichnet) Lebensdauer in Sekunden für einen Standort-zu-Standort-VPN-Tunnel.

PfsGroup

Die pfs Groups, die in IKE Phase 2 für neue untergeordnete SA verwendet werden.

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

PropagatedRouteTable

Die Liste der RouteTables, an die die Routen angekündigt werden sollen.

Name	Typ	Beschreibung
ids	SubResource[]	Die Liste der Ressourcen-IDs aller RouteTables.
labels	string[]	Die Liste der Bezeichnungen.

ProvisioningState

Der aktuelle Bereitstellungsstatus.

Name	Typ	Beschreibung
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingConfiguration

Routingkonfiguration, die die zugeordneten und verteilten Routentabellen für diese Verbindung angibt.

Name	Typ	Beschreibung
associatedRouteTable	SubResource	Die Ressourcen-ID RouteTable, die dieser RoutingConfiguration zugeordnet ist.
inboundRouteMap	SubResource	Die Ressourcen-ID der RouteMap, die dieser RoutingConfiguration für eingehende gelernte Routen zugeordnet ist.
outboundRouteMap	SubResource	Die Ressourcen-ID der RouteMap, die dieser RoutingConfiguration für ausgehende angekündigte Routen zugeordnet ist.
propagatedRouteTables	PropagatedRouteTable	Die Liste der RouteTables, an die die Routen angekündigt werden sollen.
vnetRoutes	VnetRoute	Liste der Routen, die das Routing von VirtualHub in eine virtuelle Netzwerkverbindung steuern.

StaticRoute

Liste aller statischen Routen.

Name	Typ	Beschreibung
addressPrefixes	string[]	Liste aller Adresspräfixe.
name	string	Der Name der StaticRoute, die innerhalb einer VnetRoute eindeutig ist.
nextHopIpAddress	string	Die IP-Adresse des nächsten Hops.

StaticRoutesConfig

Konfiguration für statische Routen auf diesem HubVnetConnectionConfiguration für statische Routen auf diesem HubVnetConnection.

Name	Typ	Beschreibung
propagateStaticRoutes	boolean	Boolescher Wert, der angibt, ob statische Routen für diese Verbindung automatisch an Routingtabellen weitergegeben werden, an die diese Verbindung weitergegeben wird.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Parameter, der bestimmt, ob NVA im Speichen-vnet für datenverkehr mit Ziel in Spoke umgangen wird.

SubResource

Verweisen auf eine andere Unterressource.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.

TrafficSelectorPolicy

Eine Datenverkehrsauswahlrichtlinie für eine Verbindung mit einem virtuellen Netzwerkgateway.

Name	Typ	Beschreibung
localAddressRanges	string[]	Eine Sammlung lokaler Adressräume im CIDR-Format.
remoteAddressRanges	string[]	Eine Sammlung von Remoteadressräumen im CIDR-Format.

VirtualNetworkGatewayConnectionProtocol

Verbindungsprotokoll, das für diese Verbindung verwendet wird.

Name	Typ	Beschreibung
IKEv1	string
IKEv2	string

VnetLocalRouteOverrideCriteria

Parameter, der bestimmt, ob NVA in Speichen-vnet für Datenverkehr mit Ziel in Speichen-vnet umgangen wird.

Name	Typ	Beschreibung
Contains	string
Equal	string

VnetRoute

Liste der Routen, die das Routing von VirtualHub in eine virtuelle Netzwerkverbindung steuern.

Name	Typ	Beschreibung
bgpConnections	SubResource[]	Die Liste der Verweise auf HubBgpConnection-Objekte.
staticRoutes	StaticRoute[]	Liste aller statischen Routen.
staticRoutesConfig	StaticRoutesConfig	Konfiguration für statische Routen für diese HubVnetConnection.

VpnConnection

VpnConnection-Ressource.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
name	string	Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
properties.connectionBandwidth	integer	Erwartete Bandbreite in MBPS.
properties.connectionStatus	VpnConnectionStatus	Der Verbindungsstatus.
properties.dpdTimeoutSeconds	integer	DPD-Timeout in Sekunden für vpn-Verbindung.
properties.egressBytesTransferred	integer	Übertragene Eingangsbytes.
properties.enableBgp	boolean	EnableBgp-Flag.
properties.enableInternetSecurity	boolean	Internetsicherheit aktivieren.
properties.enableRateLimiting	boolean	EnableBgp-Flag.
properties.ingressBytesTransferred	integer	Durchgestellte Byte.
properties.ipsecPolicies	IpsecPolicy[]	Die IPSec-Richtlinien, die von dieser Verbindung berücksichtigt werden sollen.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der VPN-Verbindungsressource.
properties.remoteVpnSite	SubResource	ID der verbundenen VPN-Website.
properties.routingConfiguration	RoutingConfiguration	Die Routingkonfiguration, die die zugeordneten und verteilten Routentabellen für diese Verbindung angibt.
properties.routingWeight	integer	Routinggewichtung für vpn-Verbindung.
properties.sharedKey	string	SharedKey für die VPN-Verbindung.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	Die Datenverkehrsauswahlrichtlinien, die von dieser Verbindung berücksichtigt werden sollen.
properties.useLocalAzureIpAddress	boolean	Verwenden Sie die lokale Azure-IP, um die Verbindung zu initiieren.
properties.usePolicyBasedTrafficSelectors	boolean	Aktivieren Sie richtlinienbasierte Datenverkehrsmarkierer.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Verbindungsprotokoll, das für diese Verbindung verwendet wird.
properties.vpnLinkConnections	VpnSiteLinkConnection[]	Liste aller Vpn-Standortlinkverbindungen mit dem Gateway.

VpnConnectionStatus

Der aktuelle Status der VPN-Verbindung.

Name	Typ	Beschreibung
Connected	string
Connecting	string
NotConnected	string
Unknown	string

VpnGateway

VpnGateway-Ressource.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
properties.bgpSettings	BgpSettings	BGP-Lautsprechereinstellungen des lokalen Netzwerkgateways.
properties.connections	VpnConnection[]	Liste aller VPN-Verbindungen mit dem Gateway.
properties.enableBgpRouteTranslationForNat	boolean	Aktivieren Sie die BGP-Routenübersetzung für NAT auf diesem VpnGateway.
properties.ipConfigurations	VpnGatewayIpConfiguration[]	Liste aller auf dem Gateway konfigurierten IPs.
properties.isRoutingPreferenceInternet	boolean	Enable Routing Preference property for the Public IP Interface of the VpnGateway.
properties.natRules	VpnGatewayNatRule[]	Liste aller nat-Regeln, die dem Gateway zugeordnet sind.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der VPN-Gatewayressource.
properties.virtualHub	SubResource	Der VirtualHub, zu dem das Gateway gehört.
properties.vpnGatewayScaleUnit	integer	Die Skalierungseinheit für dieses VPN-Gateway.
tags	object	Ressourcentags.
type	string	Ressourcentyp.

VpnGatewayIpConfiguration

IP-Konfiguration einer VPN-Gatewayressource.

Name	Typ	Beschreibung
id	string	Der Bezeichner der IP-Konfiguration für ein VPN-Gateway.
privateIpAddress	string	Die private IP-Adresse dieser IP-Konfiguration.
publicIpAddress	string	Die öffentliche IP-Adresse dieser IP-Konfiguration.

VpnGatewayNatRule

VpnGatewayNatRule-Ressource.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
name	string	Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
properties.egressVpnSiteLinkConnections	SubResource[]	Liste des Ausgangs von VpnSiteLinkConnections.
properties.externalMappings	VpnNatRuleMapping[]	Die externe Zuordnung der privaten IP-Adresse für NAT.
properties.ingressVpnSiteLinkConnections	SubResource[]	Liste der eingehenden VpnSiteLinkConnections.
properties.internalMappings	VpnNatRuleMapping[]	Die interne Zuordnung der privaten IP-Adresse für NAT.
properties.ipConfigurationId	string	Die IP-Konfigurations-ID, für die diese NAT-Regel gilt.
properties.mode	VpnNatRuleMode	Die Quell-NAT-Richtung eines VPN-NAT.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der NAT-Regelressource.
properties.type	VpnNatRuleType	Der Typ der NAT-Regel für VPN NAT.
type	string	Ressourcentyp.

VpnLinkConnectionMode

Verbindungsmodus für VPN-Verbindungen.

Name	Typ	Beschreibung
Default	string
InitiatorOnly	string
ResponderOnly	string

VpnNatRuleMapping

Vpn NatRule-Zuordnung.

Name	Typ	Beschreibung
addressSpace	string	Adressraum für vpn NatRule-Zuordnung.
portRange	string	Portbereich für vpn NatRule-Zuordnung.

VpnNatRuleMode

Die Quell-NAT-Richtung eines VPN-NAT.

Name	Typ	Beschreibung
EgressSnat	string
IngressSnat	string

VpnNatRuleType

Der Typ der NAT-Regel für VPN NAT.

Name	Typ	Beschreibung
Dynamic	string
Static	string

VpnSiteLinkConnection

VpnSiteLinkConnection-Ressource.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
name	string	Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
properties.connectionBandwidth	integer	Erwartete Bandbreite in MBPS.
properties.connectionStatus	VpnConnectionStatus	Der Verbindungsstatus.
properties.dpdTimeoutSeconds	integer	Timeout für tote Peererkennung in Sekunden für die VpnLink-Verbindung.
properties.egressBytesTransferred	integer	Übertragene Eingangsbytes.
properties.egressNatRules	SubResource[]	Liste des Ausgangs natRules.
properties.enableBgp	boolean	EnableBgp-Flag.
properties.enableRateLimiting	boolean	EnableBgp-Flag.
properties.ingressBytesTransferred	integer	Durchgestellte Byte.
properties.ingressNatRules	SubResource[]	Liste der Eingangs natRules.
properties.ipsecPolicies	IpsecPolicy[]	Die IPSec-Richtlinien, die von dieser Verbindung berücksichtigt werden sollen.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der VPN-Standortverbindungsressource.
properties.routingWeight	integer	Routinggewichtung für vpn-Verbindung.
properties.sharedKey	string	SharedKey für die VPN-Verbindung.
properties.useLocalAzureIpAddress	boolean	Verwenden Sie die lokale Azure-IP, um die Verbindung zu initiieren.
properties.usePolicyBasedTrafficSelectors	boolean	Aktivieren Sie richtlinienbasierte Datenverkehrsmarkierer.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Verbindungsprotokoll, das für diese Verbindung verwendet wird.
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	vpnGatewayCustomBgpAddresses, die von dieser Verbindung verwendet werden.
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	Verbindungsmodus für VPN-Verbindungen.
properties.vpnSiteLink	SubResource	ID des verbundenen VPN-Standortlinks.
type	string	Ressourcentyp.