Vpn Gateways - Create Or Update

Service:

Virtual WAN

API Version:

2023-09-01

Skapar en VPN-gateway för virtuellt wan om den inte finns, annars uppdateras den befintliga gatewayen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
gatewayName	path	True	string	Namnet på gatewayen.
resourceGroupName	path	True	string	Resursgruppens namn på VpnGateway.
subscriptionId	path	True	string	Autentiseringsuppgifterna för prenumerationen som unikt identifierar Microsoft Azure-prenumerationen. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Obligatorisk	Typ	Description
location	True	string	Resursplats.
id		string	Resurs-ID.
properties.bgpSettings		BgpSettings	BGP-talarinställningar för den lokala nätverksgatewayen.
properties.connections		VpnConnection[]	Lista över alla VPN-anslutningar till gatewayen.
properties.enableBgpRouteTranslationForNat		boolean	Aktivera översättning av BGP-vägar för NAT på denna VpnGateway.
properties.isRoutingPreferenceInternet		boolean	Aktivera egenskapen Routing Preference för vpnGateways offentliga IP-gränssnitt.
properties.natRules		VpnGatewayNatRule[]	Lista över alla nat-regler som är associerade med gatewayen.
properties.virtualHub		SubResource	Den VirtualHub som gatewayen tillhör.
properties.vpnGatewayScaleUnit		integer	Skalningsenheten för den här VPN-gatewayen.
tags		object	Resurstaggar.

Svar

Name	Typ	Description
200 OK	VpnGateway	Begäran lyckades. Returnerar information om vpn-gatewayen för virtuellt wan som skapats eller uppdaterats.
201 Created	VpnGateway	Begäran lyckades. Returnerar information om vpn-gatewayen för virtuellt wan som hämtats.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

VpnGatewayPut

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1?api-version=2023-09-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/2023-09-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/2023-09-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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-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/2023-09-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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-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 = 65515,
        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

Sample Response

Status code:

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

Status code:

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

Definitioner

Name	Description
BgpSettings	Information om BGP-inställningar.
CloudError	Ett felsvar från tjänsten.
CloudErrorBody	Ett felsvar från tjänsten.
DhGroup	De DH-grupper som används i IKE Fas 1 för inledande SA.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration för en anslutning till en virtuell nätverksgateway.
IkeEncryption	IKE-krypteringsalgoritmen (IKE fas 2).
IkeIntegrity	IKE-integritetsalgoritmen (IKE fas 2).
IPConfigurationBgpPeeringAddress	Egenskaper för IPConfigurationBgpPeeringAddress.
IpsecEncryption	IPSec-krypteringsalgoritmen (IKE fas 1).
IpsecIntegrity	IPSec-integritetsalgoritmen (IKE fas 1).
IpsecPolicy	En IPSec-principkonfiguration för en anslutning till en virtuell nätverksgateway.
PfsGroup	Pfs-grupper som används i IKE Fas 2 för ny underordnad SA.
PropagatedRouteTable	Listan över RouteTables som vägarna ska annonseras till.
ProvisioningState	Det aktuella etableringstillståndet.
RoutingConfiguration	Routningskonfiguration som anger de associerade och spridde routningstabellerna för den här anslutningen.
StaticRoute	Lista över alla statiska vägar.
StaticRoutesConfig	Konfiguration för statiska vägar på denna HubVnetConnectionConfiguration för statiska vägar på denna HubVnetConnection.
SubResource	Referens till en annan underresurs.
TrafficSelectorPolicy	En trafikväljareprincip för en anslutning till en virtuell nätverksgateway.
VirtualNetworkGatewayConnectionProtocol	Anslutningsprotokoll som används för den här anslutningen.
VnetLocalRouteOverrideCriteria	Parameter som avgör om NVA i ett virtuellt ekernätverk kringgås för trafik med målet i det virtuella ekernätverket.
VnetRoute	Lista över vägar som styr routning från VirtualHub till en virtuell nätverksanslutning.
VpnConnection	VpnConnection-resurs.
VpnConnectionStatus	Vpn-anslutningens aktuella tillstånd.
VpnGateway	VpnGateway-resurs.
VpnGatewayIpConfiguration	IP-konfiguration av en VPN Gateway resurs.
VpnGatewayNatRule	VpnGatewayNatRule-resurs.
VpnLinkConnectionMode	Anslutningsläge för VPN-länk.
VpnNatRuleMapping	Vpn NatRule-mappning.
VpnNatRuleMode	NAT-källriktningen för en VPN NAT.
VpnNatRuleType	Typ av NAT-regel för VPN NAT.
VpnSiteLinkConnection	VpnSiteLinkConnection-resurs.

BgpSettings

Information om BGP-inställningar.

Name	Typ	Description
asn	integer	BGP-talarens ASN.
bgpPeeringAddress	string	BGP-peeringadressen och BGP-identifieraren för den här BGP-talaren.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	BGP-peeringadress med IP-konfigurations-ID för virtuell nätverksgateway.
peerWeight	integer	Vikten som läggs till i vägar som lärts från den här BGP-talaren.

CloudError

Ett felsvar från tjänsten.

Name	Typ	Description
error	CloudErrorBody	Molnfeltext.

CloudErrorBody

Ett felsvar från tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
details	CloudErrorBody[]	En lista med ytterligare information om felet.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
target	string	Målet för det specifika felet. Till exempel namnet på egenskapen i fel.

DhGroup

De DH-grupper som används i IKE Fas 1 för inledande SA.

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

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration för en anslutning till en virtuell nätverksgateway.

Name	Typ	Description
customBgpIpAddress	string	Den anpassade BgpPeeringAddress som tillhör IpconfigurationId.
ipConfigurationId	string	IpconfigurationId för ipconfiguration som tillhör gatewayen.

IkeEncryption

IKE-krypteringsalgoritmen (IKE fas 2).

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

IkeIntegrity

IKE-integritetsalgoritmen (IKE fas 2).

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

IPConfigurationBgpPeeringAddress

Egenskaper för IPConfigurationBgpPeeringAddress.

Name	Typ	Description
customBgpIpAddresses	string[]	Listan över anpassade BGP-peeringadresser som tillhör IP-konfiguration.
defaultBgpIpAddresses	string[]	Listan över standard-BGP-peeringadresser som tillhör IP-konfigurationen.
ipconfigurationId	string	ID:t för IP-konfigurationen som tillhör gatewayen.
tunnelIpAddresses	string[]	Listan över offentliga IP-adresser för tunnlar som tillhör IP-konfigurationen.

IpsecEncryption

IPSec-krypteringsalgoritmen (IKE fas 1).

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

IpsecIntegrity

IPSec-integritetsalgoritmen (IKE fas 1).

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

IpsecPolicy

En IPSec-principkonfiguration för en anslutning till en virtuell nätverksgateway.

Name	Typ	Description
dhGroup	DhGroup	Den DH-grupp som används i IKE Fas 1 för inledande SA.
ikeEncryption	IkeEncryption	IKE-krypteringsalgoritmen (IKE fas 2).
ikeIntegrity	IkeIntegrity	IKE-integritetsalgoritmen (IKE fas 2).
ipsecEncryption	IpsecEncryption	IPSec-krypteringsalgoritmen (IKE fas 1).
ipsecIntegrity	IpsecIntegrity	IPSec-integritetsalgoritmen (IKE fas 1).
pfsGroup	PfsGroup	Pfs-gruppen som används i IKE Fas 2 för ny underordnad SA.
saDataSizeKilobytes	integer	IPSec-säkerhetsassociationen (kallas även snabbläge eller fas 2 SA) nyttolaststorlek i KB för en plats-till-plats-VPN-tunnel.
saLifeTimeSeconds	integer	IPSec-säkerhetsassociationen (kallas även snabbläge eller fas 2 SA) livslängd i sekunder för en plats-till-plats-VPN-tunnel.

PfsGroup

Pfs-grupper som används i IKE Fas 2 för ny underordnad SA.

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

PropagatedRouteTable

Listan över RouteTables som vägarna ska annonseras till.

Name	Typ	Description
ids	SubResource[]	Listan över resurs-ID:t för alla RouteTables.
labels	string[]	Listan över etiketter.

ProvisioningState

Det aktuella etableringstillståndet.

Name	Typ	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingConfiguration

Routningskonfiguration som anger de associerade och spridde routningstabellerna för den här anslutningen.

Name	Typ	Description
associatedRouteTable	SubResource	Resurs-ID:t RouteTable som är associerad med den här RoutingConfiguration.
inboundRouteMap	SubResource	Resurs-ID:t för RouteMap som är associerad med den här RoutingConfiguration för inkommande inlärda vägar.
outboundRouteMap	SubResource	Resurs-ID:t för denRouteMap som är associerad med den här RoutingConfiguration för utgående annonserade vägar.
propagatedRouteTables	PropagatedRouteTable	Listan över RouteTables som vägarna ska annonseras till.
vnetRoutes	VnetRoute	Lista över vägar som styr routning från VirtualHub till en virtuell nätverksanslutning.

StaticRoute

Lista över alla statiska vägar.

Name	Typ	Description
addressPrefixes	string[]	Lista över alla adressprefix.
name	string	Namnet på den StaticRoute som är unik i en VnetRoute.
nextHopIpAddress	string	IP-adressen för nästa hopp.

StaticRoutesConfig

Konfiguration för statiska vägar på denna HubVnetConnectionConfiguration för statiska vägar på denna HubVnetConnection.

Name	Typ	Description
propagateStaticRoutes	boolean	Booleskt värde som anger om statiska vägar i den här anslutningen automatiskt sprids till routningstabeller som anslutningen sprids till.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Parameter som avgör om NVA i ett virtuellt ekernätverk kringgås för trafik med målet i ekern.

SubResource

Referens till en annan underresurs.

Name	Typ	Description
id	string	Resurs-ID.

TrafficSelectorPolicy

En trafikväljareprincip för en anslutning till en virtuell nätverksgateway.

Name	Typ	Description
localAddressRanges	string[]	En samling lokala adressutrymmen i CIDR-format.
remoteAddressRanges	string[]	En samling fjärradressutrymmen i CIDR-format.

VirtualNetworkGatewayConnectionProtocol

Anslutningsprotokoll som används för den här anslutningen.

Name	Typ	Description
IKEv1	string
IKEv2	string

VnetLocalRouteOverrideCriteria

Parameter som avgör om NVA i ett virtuellt ekernätverk kringgås för trafik med målet i det virtuella ekernätverket.

Name	Typ	Description
Contains	string
Equal	string

VnetRoute

Lista över vägar som styr routning från VirtualHub till en virtuell nätverksanslutning.

Name	Typ	Description
bgpConnections	SubResource[]	Listan över referenser till HubBgpConnection-objekt.
staticRoutes	StaticRoute[]	Lista över alla statiska vägar.
staticRoutesConfig	StaticRoutesConfig	Konfiguration för statiska vägar på denna HubVnetConnection.

VpnConnection

VpnConnection-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
name	string	Namnet på resursen som är unik i en resursgrupp. Det här namnet kan användas för att komma åt resursen.
properties.connectionBandwidth	integer	Förväntad bandbredd i MBPS.
properties.connectionStatus	VpnConnectionStatus	Anslutningsstatus.
properties.dpdTimeoutSeconds	integer	DPD-timeout i sekunder för VPN-anslutning.
properties.egressBytesTransferred	integer	Utgående byte har överförts.
properties.enableBgp	boolean	AktiveraBgp-flagga.
properties.enableInternetSecurity	boolean	Aktivera internetsäkerhet.
properties.enableRateLimiting	boolean	AktiveraBgp-flagga.
properties.ingressBytesTransferred	integer	Inkommande byte har överförts.
properties.ipsecPolicies	IpsecPolicy[]	IPSec-principer som ska beaktas av den här anslutningen.
properties.provisioningState	ProvisioningState	Etableringstillståndet för VPN-anslutningsresursen.
properties.remoteVpnSite	SubResource	ID för den anslutna VPN-platsen.
properties.routingConfiguration	RoutingConfiguration	Routningskonfigurationen som anger de associerade och utbredda routningstabellerna i den här anslutningen.
properties.routingWeight	integer	Routningsvikt för VPN-anslutning.
properties.sharedKey	string	SharedKey för VPN-anslutningen.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	De trafikväljarprinciper som ska beaktas av den här anslutningen.
properties.useLocalAzureIpAddress	boolean	Använd lokal azure ip för att initiera anslutningen.
properties.usePolicyBasedTrafficSelectors	boolean	Aktivera principbaserade trafikväljare.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Anslutningsprotokoll som används för den här anslutningen.
properties.vpnLinkConnections	VpnSiteLinkConnection[]	Lista över alla vpn-platslänkanslutningar till gatewayen.

VpnConnectionStatus

Vpn-anslutningens aktuella tillstånd.

Name	Typ	Description
Connected	string
Connecting	string
NotConnected	string
Unknown	string

VpnGateway

VpnGateway-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
location	string	Resursplats.
name	string	Resursnamn.
properties.bgpSettings	BgpSettings	BGP-talarinställningarna för den lokala nätverksgatewayen.
properties.connections	VpnConnection[]	Lista över alla VPN-anslutningar till gatewayen.
properties.enableBgpRouteTranslationForNat	boolean	Aktivera översättning av BGP-vägar för NAT på denna VpnGateway.
properties.ipConfigurations	VpnGatewayIpConfiguration[]	Lista över alla IP-adresser som konfigurerats på gatewayen.
properties.isRoutingPreferenceInternet	boolean	Aktivera egenskapen Routing Preference för vpnGateways offentliga IP-gränssnitt.
properties.natRules	VpnGatewayNatRule[]	Lista över alla nat-regler som är associerade med gatewayen.
properties.provisioningState	ProvisioningState	Etableringstillståndet för VPN-gatewayresursen.
properties.virtualHub	SubResource	Den VirtualHub som gatewayen tillhör.
properties.vpnGatewayScaleUnit	integer	Skalningsenheten för den här VPN-gatewayen.
tags	object	Resurstaggar.
type	string	Resurstyp.

VpnGatewayIpConfiguration

IP-konfiguration av en VPN Gateway resurs.

Name	Typ	Description
id	string	Identifieraren för IP-konfigurationen för en VPN Gateway.
privateIpAddress	string	Den privata IP-adressen för den här IP-konfigurationen.
publicIpAddress	string	Den offentliga IP-adressen för den här IP-konfigurationen.

VpnGatewayNatRule

VpnGatewayNatRule-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
name	string	Namnet på resursen som är unik i en resursgrupp. Det här namnet kan användas för att komma åt resursen.
properties.egressVpnSiteLinkConnections	SubResource[]	Lista över utgående VpnSiteLinkConnections.
properties.externalMappings	VpnNatRuleMapping[]	Extern mappning av privat IP-adress för NAT.
properties.ingressVpnSiteLinkConnections	SubResource[]	Lista över inkommande VpnSiteLinkConnections.
properties.internalMappings	VpnNatRuleMapping[]	Intern mappning av den privata IP-adressen för NAT.
properties.ipConfigurationId	string	IP-konfigurations-ID:t som nat-regeln gäller för.
properties.mode	VpnNatRuleMode	Nat-källriktningen för en VPN NAT.
properties.provisioningState	ProvisioningState	Etableringstillståndet för NAT-regelresursen.
properties.type	VpnNatRuleType	Typen av NAT-regel för VPN NAT.
type	string	Resurstyp.

VpnLinkConnectionMode

Anslutningsläge för VPN-länk.

Name	Typ	Description
Default	string
InitiatorOnly	string
ResponderOnly	string

VpnNatRuleMapping

Vpn NatRule-mappning.

Name	Typ	Description
addressSpace	string	Adressutrymme för Vpn NatRule-mappning.
portRange	string	Portintervall för Vpn NatRule-mappning.

VpnNatRuleMode

NAT-källriktningen för en VPN NAT.

Name	Typ	Description
EgressSnat	string
IngressSnat	string

VpnNatRuleType

Typ av NAT-regel för VPN NAT.

Name	Typ	Description
Dynamic	string
Static	string

VpnSiteLinkConnection

VpnSiteLinkConnection-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
name	string	Namnet på resursen som är unik i en resursgrupp. Det här namnet kan användas för att komma åt resursen.
properties.connectionBandwidth	integer	Förväntad bandbredd i MBPS.
properties.connectionStatus	VpnConnectionStatus	Anslutningsstatus.
properties.egressBytesTransferred	integer	Utgående byte har överförts.
properties.egressNatRules	SubResource[]	Lista över utgående NatRules.
properties.enableBgp	boolean	AktiveraBgp-flagga.
properties.enableRateLimiting	boolean	EnableBgp-flagga.
properties.ingressBytesTransferred	integer	Inkommande byte har överförts.
properties.ingressNatRules	SubResource[]	Lista över inkommande NatRules.
properties.ipsecPolicies	IpsecPolicy[]	IPSec-principerna som ska beaktas av den här anslutningen.
properties.provisioningState	ProvisioningState	Etableringstillståndet för anslutningsresursen för VPN-platslänken.
properties.routingWeight	integer	Routningsvikt för VPN-anslutning.
properties.sharedKey	string	SharedKey för VPN-anslutningen.
properties.useLocalAzureIpAddress	boolean	Använd lokal azure ip för att initiera anslutningen.
properties.usePolicyBasedTrafficSelectors	boolean	Aktivera principbaserade trafikväljare.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Anslutningsprotokoll som används för den här anslutningen.
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	vpnGatewayCustomBgpAddresses som används av den här anslutningen.
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	Anslutningsläge för VPN-länk.
properties.vpnSiteLink	SubResource	ID för den anslutna vpn-platslänken.
type	string	Resurstyp.