Virtual Network Gateways - Create Or Update

Service:

Network Gateway

API Version:

2023-09-01

Skapar eller uppdaterar en virtuell nätverksgateway i den angivna resursgruppen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen.
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.
virtualNetworkGatewayName	path	True	string	Namnet på den virtuella nätverksgatewayen.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Typ	Description
extendedLocation	ExtendedLocation	Den utökade platsen för typen lokal virtuell nätverksgateway.
id	string	Resurs-ID.
location	string	Resursplats.
properties.activeActive	boolean	ActiveActive-flagga.
properties.adminState	adminState	Egenskap som anger om Express Route Gateway hanterar trafik när det finns flera Express Route-gatewayer i det virtuella nätverket
properties.allowRemoteVnetTraffic	boolean	Konfigurera den här gatewayen så att den accepterar trafik från andra virtuella Azure-nätverk. Den här konfigurationen stöder inte anslutning till Azure Virtual WAN.
properties.allowVirtualWanTraffic	boolean	Konfigurerar den här gatewayen för att ta emot trafik från fjärranslutna Virtual WAN nätverk.
properties.autoScaleConfiguration	VirtualNetworkGatewayAutoScaleConfiguration	Autoskalningskonfiguration för virutal nätverksgateway
properties.bgpSettings	BgpSettings	BGP-talarinställningarna för den virtuella nätverksgatewayen.
properties.customRoutes	AddressSpace	Referensen till adressutrymmesresursen som representerar adressutrymmet för anpassade vägar som kunden har angett för virtuell nätverksgateway och VpnClient.
properties.disableIPSecReplayProtection	boolean	disableIPSecReplayProtection-flaggan.
properties.enableBgp	boolean	Om BGP är aktiverat för den här virtuella nätverksgatewayen eller inte.
properties.enableBgpRouteTranslationForNat	boolean	Flaggan EnableBgpRouteTranslationForNat.
properties.enableDnsForwarding	boolean	Om dns-vidarebefordran är aktiverat eller inte.
properties.enablePrivateIpAddress	boolean	Om privat IP måste aktiveras på den här gatewayen för anslutningar eller inte.
properties.gatewayDefaultSite	SubResource	Referensen till resursen LocalNetworkGateway som representerar den lokala nätverksplatsen som har standardvägar. Tilldela Null-värde vid borttagning av befintlig standardplatsinställning.
properties.gatewayType	VirtualNetworkGatewayType	Typen av den här virtuella nätverksgatewayen.
properties.ipConfigurations	VirtualNetworkGatewayIPConfiguration[]	IP-konfigurationer för virtuell nätverksgateway.
properties.natRules	VirtualNetworkGatewayNatRule[]	NatRules för virtuell nätverksgateway.
properties.sku	VirtualNetworkGatewaySku	Referensen till virtualnetworkGatewaySku-resursen som representerar den SKU som valts för virtuell nätverksgateway.
properties.vNetExtendedLocationResourceId	string	Kundens vnet-resurs-ID. VirtualNetworkGateway av typen lokal gateway är associerad med kundens virtuella nätverk.
properties.virtualNetworkGatewayPolicyGroups	VirtualNetworkGatewayPolicyGroup[]	Referensen till resursen VirtualNetworkGatewayPolicyGroup som representerar den tillgängliga VirtualNetworkGatewayPolicyGroup för gatewayen.
properties.vpnClientConfiguration	VpnClientConfiguration	Referensen till resursen VpnClientConfiguration som representerar P2S VpnClient-konfigurationerna.
properties.vpnGatewayGeneration	VpnGatewayGeneration	Genereringen för den här VirtualNetworkGateway. Måste vara Ingen om gatewayType inte är VPN.
properties.vpnType	VpnType	Typen av den här virtuella nätverksgatewayen.
tags	object	Resurstaggar.

Svar

Name	Typ	Description
200 OK	VirtualNetworkGateway	Uppdateringen lyckades. Åtgärden returnerar den resulterande VirtualNetworkGateway-resursen.
201 Created	VirtualNetworkGateway	Skapa lyckades. Åtgärden returnerar den resulterande VirtualNetworkGateway-resursen.
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

UpdateVirtualNetworkGateway

UpdateVirtualNetworkScalableGateway

UpdateVirtualNetworkGateway

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw?api-version=2023-09-01

{
  "properties": {
    "ipConfigurations": [
      {
        "properties": {
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"
          },
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"
          }
        },
        "name": "gwipconfig1"
      }
    ],
    "gatewayType": "Vpn",
    "vpnType": "RouteBased",
    "enableBgp": false,
    "activeActive": false,
    "disableIPSecReplayProtection": false,
    "enableDnsForwarding": true,
    "natRules": [
      {
        "name": "natRule1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1",
        "properties": {
          "type": "Static",
          "mode": "EgressSnat",
          "ipConfigurationId": "",
          "internalMappings": [
            {
              "addressSpace": "10.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "50.0.0.0/24"
            }
          ]
        }
      },
      {
        "name": "natRule2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2",
        "properties": {
          "type": "Static",
          "mode": "IngressSnat",
          "ipConfigurationId": "",
          "internalMappings": [
            {
              "addressSpace": "20.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "30.0.0.0/24"
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": false,
    "sku": {
      "name": "VpnGw1",
      "tier": "VpnGw1"
    },
    "vpnClientConfiguration": {
      "vpnClientProtocols": [
        "OpenVPN"
      ],
      "vpnClientRootCertificates": [],
      "vpnClientRevokedCertificates": [],
      "radiusServers": [
        {
          "radiusServerAddress": "10.2.0.0",
          "radiusServerScore": 20,
          "radiusServerSecret": "radiusServerSecret"
        }
      ]
    },
    "bgpSettings": {
      "asn": 65515,
      "bgpPeeringAddress": "10.0.1.30",
      "peerWeight": 0
    },
    "customRoutes": {
      "addressPrefixes": [
        "101.168.0.6/32"
      ]
    },
    "allowVirtualWanTraffic": false,
    "allowRemoteVnetTraffic": false
  },
  "location": "centralus"
}

Java

import com.azure.core.management.SubResource;
import com.azure.resourcemanager.network.fluent.models.VirtualNetworkGatewayInner;
import com.azure.resourcemanager.network.fluent.models.VirtualNetworkGatewayIpConfigurationInner;
import com.azure.resourcemanager.network.fluent.models.VirtualNetworkGatewayNatRuleInner;
import com.azure.resourcemanager.network.models.AddressSpace;
import com.azure.resourcemanager.network.models.BgpSettings;
import com.azure.resourcemanager.network.models.IpAllocationMethod;
import com.azure.resourcemanager.network.models.RadiusServer;
import com.azure.resourcemanager.network.models.VirtualNetworkGatewaySku;
import com.azure.resourcemanager.network.models.VirtualNetworkGatewaySkuName;
import com.azure.resourcemanager.network.models.VirtualNetworkGatewaySkuTier;
import com.azure.resourcemanager.network.models.VirtualNetworkGatewayType;
import com.azure.resourcemanager.network.models.VpnClientConfiguration;
import com.azure.resourcemanager.network.models.VpnClientProtocol;
import com.azure.resourcemanager.network.models.VpnNatRuleMapping;
import com.azure.resourcemanager.network.models.VpnNatRuleMode;
import com.azure.resourcemanager.network.models.VpnNatRuleType;
import com.azure.resourcemanager.network.models.VpnType;
import java.util.Arrays;

/**
 * Samples for VirtualNetworkGateways CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayUpdate.
     * json
     */
    /**
     * Sample code: UpdateVirtualNetworkGateway.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateVirtualNetworkGateway(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualNetworkGateways().createOrUpdate("rg1", "vpngw",
            new VirtualNetworkGatewayInner().withLocation("centralus")
                .withIpConfigurations(Arrays.asList(new VirtualNetworkGatewayIpConfigurationInner()
                    .withName("gwipconfig1").withPrivateIpAllocationMethod(IpAllocationMethod.DYNAMIC)
                    .withSubnet(new SubResource().withId(
                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"))
                    .withPublicIpAddress(new SubResource().withId(
                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"))))
                .withGatewayType(VirtualNetworkGatewayType.VPN).withVpnType(VpnType.ROUTE_BASED).withEnableBgp(false)
                .withActive(false).withDisableIpSecReplayProtection(false)
                .withSku(new VirtualNetworkGatewaySku().withName(VirtualNetworkGatewaySkuName.VPN_GW1)
                    .withTier(VirtualNetworkGatewaySkuTier.VPN_GW1))
                .withVpnClientConfiguration(new VpnClientConfiguration().withVpnClientRootCertificates(Arrays.asList())
                    .withVpnClientRevokedCertificates(Arrays.asList())
                    .withVpnClientProtocols(Arrays.asList(VpnClientProtocol.OPEN_VPN))
                    .withRadiusServers(Arrays.asList(new RadiusServer().withRadiusServerAddress("10.2.0.0")
                        .withRadiusServerScore(20L).withRadiusServerSecret("fakeTokenPlaceholder"))))
                .withBgpSettings(new BgpSettings().withAsn(65515L).withBgpPeeringAddress("10.0.1.30").withPeerWeight(0))
                .withCustomRoutes(new AddressSpace().withAddressPrefixes(Arrays.asList("101.168.0.6/32")))
                .withEnableDnsForwarding(true)
                .withNatRules(Arrays.asList(new VirtualNetworkGatewayNatRuleInner().withId(
                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1")
                    .withName("natRule1").withTypePropertiesType(VpnNatRuleType.STATIC)
                    .withMode(VpnNatRuleMode.EGRESS_SNAT)
                    .withInternalMappings(Arrays.asList(new VpnNatRuleMapping().withAddressSpace("10.10.0.0/24")))
                    .withExternalMappings(Arrays.asList(new VpnNatRuleMapping().withAddressSpace("50.0.0.0/24")))
                    .withIpConfigurationId(""),
                    new VirtualNetworkGatewayNatRuleInner().withId(
                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2")
                        .withName("natRule2").withTypePropertiesType(VpnNatRuleType.STATIC)
                        .withMode(VpnNatRuleMode.INGRESS_SNAT)
                        .withInternalMappings(Arrays.asList(new VpnNatRuleMapping().withAddressSpace("20.10.0.0/24")))
                        .withExternalMappings(Arrays.asList(new VpnNatRuleMapping().withAddressSpace("30.0.0.0/24")))
                        .withIpConfigurationId("")))
                .withEnableBgpRouteTranslationForNat(false).withAllowVirtualWanTraffic(false)
                .withAllowRemoteVnetTraffic(false),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python virtual_network_gateway_update.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.virtual_network_gateways.begin_create_or_update(
        resource_group_name="rg1",
        virtual_network_gateway_name="vpngw",
        parameters={
            "location": "centralus",
            "properties": {
                "activeActive": False,
                "allowRemoteVnetTraffic": False,
                "allowVirtualWanTraffic": False,
                "bgpSettings": {"asn": 65515, "bgpPeeringAddress": "10.0.1.30", "peerWeight": 0},
                "customRoutes": {"addressPrefixes": ["101.168.0.6/32"]},
                "disableIPSecReplayProtection": False,
                "enableBgp": False,
                "enableBgpRouteTranslationForNat": False,
                "enableDnsForwarding": True,
                "gatewayType": "Vpn",
                "ipConfigurations": [
                    {
                        "name": "gwipconfig1",
                        "properties": {
                            "privateIPAllocationMethod": "Dynamic",
                            "publicIPAddress": {
                                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"
                            },
                            "subnet": {
                                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"
                            },
                        },
                    }
                ],
                "natRules": [
                    {
                        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1",
                        "name": "natRule1",
                        "properties": {
                            "externalMappings": [{"addressSpace": "50.0.0.0/24"}],
                            "internalMappings": [{"addressSpace": "10.10.0.0/24"}],
                            "ipConfigurationId": "",
                            "mode": "EgressSnat",
                            "type": "Static",
                        },
                    },
                    {
                        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2",
                        "name": "natRule2",
                        "properties": {
                            "externalMappings": [{"addressSpace": "30.0.0.0/24"}],
                            "internalMappings": [{"addressSpace": "20.10.0.0/24"}],
                            "ipConfigurationId": "",
                            "mode": "IngressSnat",
                            "type": "Static",
                        },
                    },
                ],
                "sku": {"name": "VpnGw1", "tier": "VpnGw1"},
                "vpnClientConfiguration": {
                    "radiusServers": [
                        {
                            "radiusServerAddress": "10.2.0.0",
                            "radiusServerScore": 20,
                            "radiusServerSecret": "radiusServerSecret",
                        }
                    ],
                    "vpnClientProtocols": ["OpenVPN"],
                    "vpnClientRevokedCertificates": [],
                    "vpnClientRootCertificates": [],
                },
                "vpnType": "RouteBased",
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayUpdate.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/VirtualNetworkGatewayUpdate.json
func ExampleVirtualNetworkGatewaysClient_BeginCreateOrUpdate_updateVirtualNetworkGateway() {
	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.NewVirtualNetworkGatewaysClient().BeginCreateOrUpdate(ctx, "rg1", "vpngw", armnetwork.VirtualNetworkGateway{
		Location: to.Ptr("centralus"),
		Properties: &armnetwork.VirtualNetworkGatewayPropertiesFormat{
			Active:                 to.Ptr(false),
			AllowRemoteVnetTraffic: to.Ptr(false),
			AllowVirtualWanTraffic: to.Ptr(false),
			BgpSettings: &armnetwork.BgpSettings{
				Asn:               to.Ptr[int64](65515),
				BgpPeeringAddress: to.Ptr("10.0.1.30"),
				PeerWeight:        to.Ptr[int32](0),
			},
			CustomRoutes: &armnetwork.AddressSpace{
				AddressPrefixes: []*string{
					to.Ptr("101.168.0.6/32")},
			},
			DisableIPSecReplayProtection:    to.Ptr(false),
			EnableBgp:                       to.Ptr(false),
			EnableBgpRouteTranslationForNat: to.Ptr(false),
			EnableDNSForwarding:             to.Ptr(true),
			GatewayType:                     to.Ptr(armnetwork.VirtualNetworkGatewayTypeVPN),
			IPConfigurations: []*armnetwork.VirtualNetworkGatewayIPConfiguration{
				{
					Name: to.Ptr("gwipconfig1"),
					Properties: &armnetwork.VirtualNetworkGatewayIPConfigurationPropertiesFormat{
						PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
						PublicIPAddress: &armnetwork.SubResource{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"),
						},
						Subnet: &armnetwork.SubResource{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"),
						},
					},
				}},
			NatRules: []*armnetwork.VirtualNetworkGatewayNatRule{
				{
					ID:   to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1"),
					Name: to.Ptr("natRule1"),
					Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
						Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
						ExternalMappings: []*armnetwork.VPNNatRuleMapping{
							{
								AddressSpace: to.Ptr("50.0.0.0/24"),
							}},
						InternalMappings: []*armnetwork.VPNNatRuleMapping{
							{
								AddressSpace: to.Ptr("10.10.0.0/24"),
							}},
						IPConfigurationID: to.Ptr(""),
						Mode:              to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
					},
				},
				{
					ID:   to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2"),
					Name: to.Ptr("natRule2"),
					Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
						Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
						ExternalMappings: []*armnetwork.VPNNatRuleMapping{
							{
								AddressSpace: to.Ptr("30.0.0.0/24"),
							}},
						InternalMappings: []*armnetwork.VPNNatRuleMapping{
							{
								AddressSpace: to.Ptr("20.10.0.0/24"),
							}},
						IPConfigurationID: to.Ptr(""),
						Mode:              to.Ptr(armnetwork.VPNNatRuleModeIngressSnat),
					},
				}},
			SKU: &armnetwork.VirtualNetworkGatewaySKU{
				Name: to.Ptr(armnetwork.VirtualNetworkGatewaySKUNameVPNGw1),
				Tier: to.Ptr(armnetwork.VirtualNetworkGatewaySKUTierVPNGw1),
			},
			VPNClientConfiguration: &armnetwork.VPNClientConfiguration{
				RadiusServers: []*armnetwork.RadiusServer{
					{
						RadiusServerAddress: to.Ptr("10.2.0.0"),
						RadiusServerScore:   to.Ptr[int64](20),
						RadiusServerSecret:  to.Ptr("radiusServerSecret"),
					}},
				VPNClientProtocols: []*armnetwork.VPNClientProtocol{
					to.Ptr(armnetwork.VPNClientProtocolOpenVPN)},
				VPNClientRevokedCertificates: []*armnetwork.VPNClientRevokedCertificate{},
				VPNClientRootCertificates:    []*armnetwork.VPNClientRootCertificate{},
			},
			VPNType: to.Ptr(armnetwork.VPNTypeRouteBased),
		},
	}, 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.VirtualNetworkGateway = armnetwork.VirtualNetworkGateway{
	// 	Name: to.Ptr("vpngw"),
	// 	Type: to.Ptr("Microsoft.Network/virtualNetworkGateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw"),
	// 	Location: to.Ptr("centralus"),
	// 	Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 	Properties: &armnetwork.VirtualNetworkGatewayPropertiesFormat{
	// 		Active: to.Ptr(false),
	// 		AllowRemoteVnetTraffic: to.Ptr(false),
	// 		AllowVirtualWanTraffic: to.Ptr(false),
	// 		BgpSettings: &armnetwork.BgpSettings{
	// 			Asn: to.Ptr[int64](65515),
	// 			BgpPeeringAddress: to.Ptr("10.0.1.30"),
	// 			BgpPeeringAddresses: []*armnetwork.IPConfigurationBgpPeeringAddress{
	// 				{
	// 					CustomBgpIPAddresses: []*string{
	// 						to.Ptr("169.254.21.10")},
	// 						DefaultBgpIPAddresses: []*string{
	// 							to.Ptr("10.3.1.254")},
	// 							IPConfigurationID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1"),
	// 							TunnelIPAddresses: []*string{
	// 								to.Ptr("52.161.10.135")},
	// 						}},
	// 						PeerWeight: to.Ptr[int32](0),
	// 					},
	// 					CustomRoutes: &armnetwork.AddressSpace{
	// 						AddressPrefixes: []*string{
	// 							to.Ptr("101.168.0.6/32")},
	// 						},
	// 						DisableIPSecReplayProtection: to.Ptr(false),
	// 						EnableBgp: to.Ptr(false),
	// 						EnableBgpRouteTranslationForNat: to.Ptr(false),
	// 						EnableDNSForwarding: to.Ptr(true),
	// 						GatewayType: to.Ptr(armnetwork.VirtualNetworkGatewayTypeVPN),
	// 						InboundDNSForwardingEndpoint: to.Ptr("10.0.1.14"),
	// 						IPConfigurations: []*armnetwork.VirtualNetworkGatewayIPConfiguration{
	// 							{
	// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1"),
	// 								Name: to.Ptr("gwipconfig1"),
	// 								Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 								Properties: &armnetwork.VirtualNetworkGatewayIPConfigurationPropertiesFormat{
	// 									PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
	// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 									PublicIPAddress: &armnetwork.SubResource{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"),
	// 									},
	// 									Subnet: &armnetwork.SubResource{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"),
	// 									},
	// 								},
	// 						}},
	// 						NatRules: []*armnetwork.VirtualNetworkGatewayNatRule{
	// 							{
	// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1"),
	// 								Name: to.Ptr("natRule1"),
	// 								Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
	// 									Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 									ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 										{
	// 											AddressSpace: to.Ptr("50.0.0.0/24"),
	// 									}},
	// 									InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 										{
	// 											AddressSpace: to.Ptr("10.10.0.0/24"),
	// 									}},
	// 									IPConfigurationID: to.Ptr(""),
	// 									Mode: to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
	// 								},
	// 							},
	// 							{
	// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2"),
	// 								Name: to.Ptr("natRule2"),
	// 								Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
	// 									Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 									ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 										{
	// 											AddressSpace: to.Ptr("30.0.0.0/24"),
	// 									}},
	// 									InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 										{
	// 											AddressSpace: to.Ptr("20.10.0.0/24"),
	// 									}},
	// 									IPConfigurationID: to.Ptr(""),
	// 									Mode: to.Ptr(armnetwork.VPNNatRuleModeIngressSnat),
	// 								},
	// 						}},
	// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 						ResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 						SKU: &armnetwork.VirtualNetworkGatewaySKU{
	// 							Name: to.Ptr(armnetwork.VirtualNetworkGatewaySKUNameVPNGw1),
	// 							Capacity: to.Ptr[int32](0),
	// 							Tier: to.Ptr(armnetwork.VirtualNetworkGatewaySKUTierVPNGw1),
	// 						},
	// 						VPNClientConfiguration: &armnetwork.VPNClientConfiguration{
	// 							RadiusServers: []*armnetwork.RadiusServer{
	// 								{
	// 									RadiusServerAddress: to.Ptr("10.2.0.0"),
	// 									RadiusServerScore: to.Ptr[int64](20),
	// 							}},
	// 							VPNClientProtocols: []*armnetwork.VPNClientProtocol{
	// 								to.Ptr(armnetwork.VPNClientProtocolOpenVPN)},
	// 								VPNClientRevokedCertificates: []*armnetwork.VPNClientRevokedCertificate{
	// 								},
	// 								VPNClientRootCertificates: []*armnetwork.VPNClientRootCertificate{
	// 								},
	// 							},
	// 							VPNGatewayGeneration: to.Ptr(armnetwork.VPNGatewayGenerationNone),
	// 							VPNType: to.Ptr(armnetwork.VPNTypeRouteBased),
	// 						},
	// 					}
}

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 or updates a virtual network gateway in the specified resource group.
 *
 * @summary Creates or updates a virtual network gateway in the specified resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayUpdate.json
 */
async function updateVirtualNetworkGateway() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkGatewayName = "vpngw";
  const parameters = {
    active: false,
    allowRemoteVnetTraffic: false,
    allowVirtualWanTraffic: false,
    bgpSettings: { asn: 65515, bgpPeeringAddress: "10.0.1.30", peerWeight: 0 },
    customRoutes: { addressPrefixes: ["101.168.0.6/32"] },
    disableIPSecReplayProtection: false,
    enableBgp: false,
    enableBgpRouteTranslationForNat: false,
    enableDnsForwarding: true,
    gatewayType: "Vpn",
    ipConfigurations: [
      {
        name: "gwipconfig1",
        privateIPAllocationMethod: "Dynamic",
        publicIPAddress: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip",
        },
        subnet: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet",
        },
      },
    ],
    location: "centralus",
    natRules: [
      {
        name: "natRule1",
        typePropertiesType: "Static",
        externalMappings: [{ addressSpace: "50.0.0.0/24" }],
        id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1",
        internalMappings: [{ addressSpace: "10.10.0.0/24" }],
        ipConfigurationId: "",
        mode: "EgressSnat",
      },
      {
        name: "natRule2",
        typePropertiesType: "Static",
        externalMappings: [{ addressSpace: "30.0.0.0/24" }],
        id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2",
        internalMappings: [{ addressSpace: "20.10.0.0/24" }],
        ipConfigurationId: "",
        mode: "IngressSnat",
      },
    ],
    sku: { name: "VpnGw1", tier: "VpnGw1" },
    vpnClientConfiguration: {
      radiusServers: [
        {
          radiusServerAddress: "10.2.0.0",
          radiusServerScore: 20,
          radiusServerSecret: "radiusServerSecret",
        },
      ],
      vpnClientProtocols: ["OpenVPN"],
      vpnClientRevokedCertificates: [],
      vpnClientRootCertificates: [],
    },
    vpnType: "RouteBased",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualNetworkGateways.beginCreateOrUpdateAndWait(
    resourceGroupName,
    virtualNetworkGatewayName,
    parameters,
  );
  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;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayUpdate.json
// this example is just showing the usage of "VirtualNetworkGateways_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 VirtualNetworkGatewayResource
VirtualNetworkGatewayCollection collection = resourceGroupResource.GetVirtualNetworkGateways();

// invoke the operation
string virtualNetworkGatewayName = "vpngw";
VirtualNetworkGatewayData data = new VirtualNetworkGatewayData()
{
    IPConfigurations =
    {
    new VirtualNetworkGatewayIPConfiguration()
    {
    PrivateIPAllocationMethod = NetworkIPAllocationMethod.Dynamic,
    SubnetId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"),
    PublicIPAddressId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"),
    Name = "gwipconfig1",
    }
    },
    GatewayType = VirtualNetworkGatewayType.Vpn,
    VpnType = VpnType.RouteBased,
    EnableBgp = false,
    Active = false,
    DisableIPSecReplayProtection = false,
    Sku = new VirtualNetworkGatewaySku()
    {
        Name = VirtualNetworkGatewaySkuName.VpnGw1,
        Tier = VirtualNetworkGatewaySkuTier.VpnGw1,
    },
    VpnClientConfiguration = new VpnClientConfiguration()
    {
        VpnClientRootCertificates =
        {
        },
        VpnClientRevokedCertificates =
        {
        },
        VpnClientProtocols =
        {
        VpnClientProtocol.OpenVpn
        },
        RadiusServers =
        {
        new RadiusServer("10.2.0.0")
        {
        RadiusServerScore = 20,
        RadiusServerSecret = "radiusServerSecret",
        }
        },
    },
    BgpSettings = new BgpSettings()
    {
        Asn = 65515,
        BgpPeeringAddress = "10.0.1.30",
        PeerWeight = 0,
    },
    CustomRoutesAddressPrefixes =
    {
    "101.168.0.6/32"
    },
    EnableDnsForwarding = true,
    NatRules =
    {
    new VirtualNetworkGatewayNatRuleData()
    {
    VpnNatRuleType = VpnNatRuleType.Static,
    Mode = VpnNatRuleMode.EgressSnat,
    InternalMappings =
    {
    new VpnNatRuleMapping()
    {
    AddressSpace = "10.10.0.0/24",
    }
    },
    ExternalMappings =
    {
    new VpnNatRuleMapping()
    {
    AddressSpace = "50.0.0.0/24",
    }
    },
    IPConfigurationId = "",
    Id = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1"),
    Name = "natRule1",
    },new VirtualNetworkGatewayNatRuleData()
    {
    VpnNatRuleType = VpnNatRuleType.Static,
    Mode = VpnNatRuleMode.IngressSnat,
    InternalMappings =
    {
    new VpnNatRuleMapping()
    {
    AddressSpace = "20.10.0.0/24",
    }
    },
    ExternalMappings =
    {
    new VpnNatRuleMapping()
    {
    AddressSpace = "30.0.0.0/24",
    }
    },
    IPConfigurationId = "",
    Id = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2"),
    Name = "natRule2",
    }
    },
    EnableBgpRouteTranslationForNat = false,
    AllowVirtualWanTraffic = false,
    AllowRemoteVnetTraffic = false,
    Location = new AzureLocation("centralus"),
};
ArmOperation<VirtualNetworkGatewayResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, virtualNetworkGatewayName, data);
VirtualNetworkGatewayResource 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
VirtualNetworkGatewayData 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": "vpngw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "type": "Microsoft.Network/virtualNetworkGateways",
  "location": "centralus",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000",
    "ipConfigurations": [
      {
        "name": "gwipconfig1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1",
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Dynamic",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"
          },
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"
          }
        }
      }
    ],
    "natRules": [
      {
        "name": "natRule1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1",
        "properties": {
          "type": "Static",
          "mode": "EgressSnat",
          "ipConfigurationId": "",
          "internalMappings": [
            {
              "addressSpace": "10.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "50.0.0.0/24"
            }
          ]
        }
      },
      {
        "name": "natRule2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2",
        "properties": {
          "type": "Static",
          "mode": "IngressSnat",
          "ipConfigurationId": "",
          "internalMappings": [
            {
              "addressSpace": "20.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "30.0.0.0/24"
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": false,
    "sku": {
      "name": "VpnGw1",
      "tier": "VpnGw1",
      "capacity": 0
    },
    "gatewayType": "Vpn",
    "vpnType": "RouteBased",
    "vpnGatewayGeneration": "None",
    "enableBgp": false,
    "activeActive": false,
    "disableIPSecReplayProtection": false,
    "enableDnsForwarding": true,
    "inboundDnsForwardingEndpoint": "10.0.1.14",
    "vpnClientConfiguration": {
      "vpnClientProtocols": [
        "OpenVPN"
      ],
      "vpnClientRootCertificates": [],
      "vpnClientRevokedCertificates": [],
      "radiusServers": [
        {
          "radiusServerAddress": "10.2.0.0",
          "radiusServerScore": 20
        }
      ]
    },
    "bgpSettings": {
      "asn": 65515,
      "bgpPeeringAddress": "10.0.1.30",
      "peerWeight": 0,
      "bgpPeeringAddresses": [
        {
          "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1",
          "defaultBgpIpAddresses": [
            "10.3.1.254"
          ],
          "customBgpIpAddresses": [
            "169.254.21.10"
          ],
          "tunnelIpAddresses": [
            "52.161.10.135"
          ]
        }
      ]
    },
    "customRoutes": {
      "addressPrefixes": [
        "101.168.0.6/32"
      ]
    },
    "allowVirtualWanTraffic": false,
    "allowRemoteVnetTraffic": false
  }
}

Status code:

201

{
  "name": "vpngw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "type": "Microsoft.Network/virtualNetworkGateways",
  "location": "centralus",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000",
    "ipConfigurations": [
      {
        "name": "gwipconfig1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1",
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Dynamic",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"
          },
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"
          }
        }
      }
    ],
    "natRules": [
      {
        "name": "natRule1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1",
        "properties": {
          "type": "Static",
          "mode": "EgressSnat",
          "ipConfigurationId": "",
          "internalMappings": [
            {
              "addressSpace": "10.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "50.0.0.0/24"
            }
          ]
        }
      },
      {
        "name": "natRule2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2",
        "properties": {
          "type": "Static",
          "mode": "IngressSnat",
          "ipConfigurationId": "",
          "internalMappings": [
            {
              "addressSpace": "20.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "30.0.0.0/24"
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": false,
    "sku": {
      "name": "VpnGw1",
      "tier": "VpnGw1",
      "capacity": 0
    },
    "gatewayType": "Vpn",
    "vpnType": "RouteBased",
    "enableBgp": false,
    "activeActive": false,
    "disableIPSecReplayProtection": false,
    "enableDnsForwarding": true,
    "enablePrivateIpAddress": false,
    "inboundDnsForwardingEndpoint": "10.0.1.14",
    "vpnClientConfiguration": {
      "vpnClientProtocols": [
        "OpenVPN"
      ],
      "vpnClientRootCertificates": [],
      "vpnClientRevokedCertificates": [],
      "radiusServers": [
        {
          "radiusServerAddress": "10.2.0.0",
          "radiusServerScore": 20
        }
      ]
    },
    "bgpSettings": {
      "asn": 65515,
      "bgpPeeringAddress": "10.0.1.30",
      "peerWeight": 0,
      "bgpPeeringAddresses": [
        {
          "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1",
          "defaultBgpIpAddresses": [
            "10.3.1.254"
          ],
          "customBgpIpAddresses": [
            "169.254.21.10"
          ],
          "tunnelIpAddresses": [
            "52.161.10.135"
          ]
        }
      ]
    },
    "customRoutes": {
      "addressPrefixes": [
        "101.168.0.6/32"
      ]
    },
    "allowVirtualWanTraffic": false,
    "allowRemoteVnetTraffic": false
  }
}

UpdateVirtualNetworkScalableGateway

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw?api-version=2023-09-01

{
  "properties": {
    "ipConfigurations": [
      {
        "properties": {
          "privateIPAllocationMethod": "Static",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"
          },
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"
          }
        },
        "name": "gwipconfig1"
      }
    ],
    "gatewayType": "ExpressRoute",
    "vpnType": "PolicyBased",
    "enableBgp": false,
    "activeActive": false,
    "disableIPSecReplayProtection": false,
    "natRules": [
      {
        "name": "natRule1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1",
        "properties": {
          "type": "Static",
          "mode": "EgressSnat",
          "ipConfigurationId": "",
          "internalMappings": [
            {
              "addressSpace": "10.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "50.0.0.0/24"
            }
          ]
        }
      },
      {
        "name": "natRule2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2",
        "properties": {
          "type": "Static",
          "mode": "IngressSnat",
          "ipConfigurationId": "",
          "internalMappings": [
            {
              "addressSpace": "20.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "30.0.0.0/24"
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": false,
    "sku": {
      "name": "ErGwScale",
      "tier": "ErGwScale"
    },
    "vpnClientConfiguration": null,
    "bgpSettings": null,
    "allowVirtualWanTraffic": false,
    "allowRemoteVnetTraffic": false
  },
  "location": "centralus"
}

Java

import com.azure.core.management.SubResource;
import com.azure.resourcemanager.network.fluent.models.VirtualNetworkGatewayInner;
import com.azure.resourcemanager.network.fluent.models.VirtualNetworkGatewayIpConfigurationInner;
import com.azure.resourcemanager.network.fluent.models.VirtualNetworkGatewayNatRuleInner;
import com.azure.resourcemanager.network.models.IpAllocationMethod;
import com.azure.resourcemanager.network.models.VirtualNetworkGatewaySku;
import com.azure.resourcemanager.network.models.VirtualNetworkGatewaySkuName;
import com.azure.resourcemanager.network.models.VirtualNetworkGatewaySkuTier;
import com.azure.resourcemanager.network.models.VirtualNetworkGatewayType;
import com.azure.resourcemanager.network.models.VpnNatRuleMapping;
import com.azure.resourcemanager.network.models.VpnNatRuleMode;
import com.azure.resourcemanager.network.models.VpnNatRuleType;
import com.azure.resourcemanager.network.models.VpnType;
import java.util.Arrays;

/**
 * Samples for VirtualNetworkGateways CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * VirtualNetworkScalableGatewayUpdate.json
     */
    /**
     * Sample code: UpdateVirtualNetworkScalableGateway.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateVirtualNetworkScalableGateway(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualNetworkGateways().createOrUpdate("rg1", "ergw",
            new VirtualNetworkGatewayInner().withLocation("centralus")
                .withIpConfigurations(Arrays.asList(new VirtualNetworkGatewayIpConfigurationInner()
                    .withName("gwipconfig1").withPrivateIpAllocationMethod(IpAllocationMethod.STATIC)
                    .withSubnet(new SubResource().withId(
                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"))
                    .withPublicIpAddress(new SubResource().withId(
                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"))))
                .withGatewayType(VirtualNetworkGatewayType.EXPRESS_ROUTE).withVpnType(VpnType.POLICY_BASED)
                .withEnableBgp(false).withActive(false).withDisableIpSecReplayProtection(false)
                .withSku(new VirtualNetworkGatewaySku().withName(VirtualNetworkGatewaySkuName.ER_GW_SCALE)
                    .withTier(VirtualNetworkGatewaySkuTier.ER_GW_SCALE))
                .withNatRules(Arrays.asList(new VirtualNetworkGatewayNatRuleInner().withId(
                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1")
                    .withName("natRule1").withTypePropertiesType(VpnNatRuleType.STATIC)
                    .withMode(VpnNatRuleMode.EGRESS_SNAT)
                    .withInternalMappings(Arrays.asList(new VpnNatRuleMapping().withAddressSpace("10.10.0.0/24")))
                    .withExternalMappings(Arrays.asList(new VpnNatRuleMapping().withAddressSpace("50.0.0.0/24")))
                    .withIpConfigurationId(""),
                    new VirtualNetworkGatewayNatRuleInner().withId(
                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2")
                        .withName("natRule2").withTypePropertiesType(VpnNatRuleType.STATIC)
                        .withMode(VpnNatRuleMode.INGRESS_SNAT)
                        .withInternalMappings(Arrays.asList(new VpnNatRuleMapping().withAddressSpace("20.10.0.0/24")))
                        .withExternalMappings(Arrays.asList(new VpnNatRuleMapping().withAddressSpace("30.0.0.0/24")))
                        .withIpConfigurationId("")))
                .withEnableBgpRouteTranslationForNat(false).withAllowVirtualWanTraffic(false)
                .withAllowRemoteVnetTraffic(false),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python virtual_network_scalable_gateway_update.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.virtual_network_gateways.begin_create_or_update(
        resource_group_name="rg1",
        virtual_network_gateway_name="ergw",
        parameters={
            "location": "centralus",
            "properties": {
                "activeActive": False,
                "allowRemoteVnetTraffic": False,
                "allowVirtualWanTraffic": False,
                "bgpSettings": None,
                "disableIPSecReplayProtection": False,
                "enableBgp": False,
                "enableBgpRouteTranslationForNat": False,
                "gatewayType": "ExpressRoute",
                "ipConfigurations": [
                    {
                        "name": "gwipconfig1",
                        "properties": {
                            "privateIPAllocationMethod": "Static",
                            "publicIPAddress": {
                                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"
                            },
                            "subnet": {
                                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"
                            },
                        },
                    }
                ],
                "natRules": [
                    {
                        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1",
                        "name": "natRule1",
                        "properties": {
                            "externalMappings": [{"addressSpace": "50.0.0.0/24"}],
                            "internalMappings": [{"addressSpace": "10.10.0.0/24"}],
                            "ipConfigurationId": "",
                            "mode": "EgressSnat",
                            "type": "Static",
                        },
                    },
                    {
                        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2",
                        "name": "natRule2",
                        "properties": {
                            "externalMappings": [{"addressSpace": "30.0.0.0/24"}],
                            "internalMappings": [{"addressSpace": "20.10.0.0/24"}],
                            "ipConfigurationId": "",
                            "mode": "IngressSnat",
                            "type": "Static",
                        },
                    },
                ],
                "sku": {"name": "ErGwScale", "tier": "ErGwScale"},
                "vpnClientConfiguration": None,
                "vpnType": "PolicyBased",
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkScalableGatewayUpdate.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/VirtualNetworkScalableGatewayUpdate.json
func ExampleVirtualNetworkGatewaysClient_BeginCreateOrUpdate_updateVirtualNetworkScalableGateway() {
	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.NewVirtualNetworkGatewaysClient().BeginCreateOrUpdate(ctx, "rg1", "ergw", armnetwork.VirtualNetworkGateway{
		Location: to.Ptr("centralus"),
		Properties: &armnetwork.VirtualNetworkGatewayPropertiesFormat{
			Active:                          to.Ptr(false),
			AllowRemoteVnetTraffic:          to.Ptr(false),
			AllowVirtualWanTraffic:          to.Ptr(false),
			DisableIPSecReplayProtection:    to.Ptr(false),
			EnableBgp:                       to.Ptr(false),
			EnableBgpRouteTranslationForNat: to.Ptr(false),
			GatewayType:                     to.Ptr(armnetwork.VirtualNetworkGatewayTypeExpressRoute),
			IPConfigurations: []*armnetwork.VirtualNetworkGatewayIPConfiguration{
				{
					Name: to.Ptr("gwipconfig1"),
					Properties: &armnetwork.VirtualNetworkGatewayIPConfigurationPropertiesFormat{
						PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodStatic),
						PublicIPAddress: &armnetwork.SubResource{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"),
						},
						Subnet: &armnetwork.SubResource{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"),
						},
					},
				}},
			NatRules: []*armnetwork.VirtualNetworkGatewayNatRule{
				{
					ID:   to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1"),
					Name: to.Ptr("natRule1"),
					Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
						Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
						ExternalMappings: []*armnetwork.VPNNatRuleMapping{
							{
								AddressSpace: to.Ptr("50.0.0.0/24"),
							}},
						InternalMappings: []*armnetwork.VPNNatRuleMapping{
							{
								AddressSpace: to.Ptr("10.10.0.0/24"),
							}},
						IPConfigurationID: to.Ptr(""),
						Mode:              to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
					},
				},
				{
					ID:   to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2"),
					Name: to.Ptr("natRule2"),
					Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
						Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
						ExternalMappings: []*armnetwork.VPNNatRuleMapping{
							{
								AddressSpace: to.Ptr("30.0.0.0/24"),
							}},
						InternalMappings: []*armnetwork.VPNNatRuleMapping{
							{
								AddressSpace: to.Ptr("20.10.0.0/24"),
							}},
						IPConfigurationID: to.Ptr(""),
						Mode:              to.Ptr(armnetwork.VPNNatRuleModeIngressSnat),
					},
				}},
			SKU: &armnetwork.VirtualNetworkGatewaySKU{
				Name: to.Ptr(armnetwork.VirtualNetworkGatewaySKUNameErGwScale),
				Tier: to.Ptr(armnetwork.VirtualNetworkGatewaySKUTierErGwScale),
			},
			VPNType: to.Ptr(armnetwork.VPNTypePolicyBased),
		},
	}, 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.VirtualNetworkGateway = armnetwork.VirtualNetworkGateway{
	// 	Name: to.Ptr("ergw"),
	// 	Type: to.Ptr("Microsoft.Network/virtualNetworkGateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw"),
	// 	Location: to.Ptr("centralus"),
	// 	Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 	Properties: &armnetwork.VirtualNetworkGatewayPropertiesFormat{
	// 		Active: to.Ptr(false),
	// 		AllowRemoteVnetTraffic: to.Ptr(false),
	// 		AllowVirtualWanTraffic: to.Ptr(false),
	// 		AutoScaleConfiguration: &armnetwork.VirtualNetworkGatewayAutoScaleConfiguration{
	// 			Bounds: &armnetwork.VirtualNetworkGatewayAutoScaleBounds{
	// 				Max: to.Ptr[int32](3),
	// 				Min: to.Ptr[int32](2),
	// 			},
	// 		},
	// 		DisableIPSecReplayProtection: to.Ptr(false),
	// 		EnableBgp: to.Ptr(false),
	// 		EnableBgpRouteTranslationForNat: to.Ptr(false),
	// 		GatewayType: to.Ptr(armnetwork.VirtualNetworkGatewayTypeExpressRoute),
	// 		IPConfigurations: []*armnetwork.VirtualNetworkGatewayIPConfiguration{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/ipConfigurations/default"),
	// 				Name: to.Ptr("gwipconfig1"),
	// 				Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 				Properties: &armnetwork.VirtualNetworkGatewayIPConfigurationPropertiesFormat{
	// 					PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					PublicIPAddress: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"),
	// 					},
	// 					Subnet: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"),
	// 					},
	// 				},
	// 		}},
	// 		NatRules: []*armnetwork.VirtualNetworkGatewayNatRule{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1"),
	// 				Name: to.Ptr("natRule1"),
	// 				Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
	// 					Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 					ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 						{
	// 							AddressSpace: to.Ptr("50.0.0.0/24"),
	// 					}},
	// 					InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 						{
	// 							AddressSpace: to.Ptr("10.10.0.0/24"),
	// 					}},
	// 					IPConfigurationID: to.Ptr(""),
	// 					Mode: to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
	// 				},
	// 			},
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2"),
	// 				Name: to.Ptr("natRule2"),
	// 				Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
	// 					Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 					ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 						{
	// 							AddressSpace: to.Ptr("30.0.0.0/24"),
	// 					}},
	// 					InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 						{
	// 							AddressSpace: to.Ptr("20.10.0.0/24"),
	// 					}},
	// 					IPConfigurationID: to.Ptr(""),
	// 					Mode: to.Ptr(armnetwork.VPNNatRuleModeIngressSnat),
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		ResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		SKU: &armnetwork.VirtualNetworkGatewaySKU{
	// 			Name: to.Ptr(armnetwork.VirtualNetworkGatewaySKUNameErGwScale),
	// 			Capacity: to.Ptr[int32](0),
	// 			Tier: to.Ptr(armnetwork.VirtualNetworkGatewaySKUTierErGwScale),
	// 		},
	// 		VPNGatewayGeneration: to.Ptr(armnetwork.VPNGatewayGenerationNone),
	// 		VPNType: to.Ptr(armnetwork.VPNTypePolicyBased),
	// 	},
	// }
}

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 or updates a virtual network gateway in the specified resource group.
 *
 * @summary Creates or updates a virtual network gateway in the specified resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkScalableGatewayUpdate.json
 */
async function updateVirtualNetworkScalableGateway() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkGatewayName = "ergw";
  const parameters = {
    active: false,
    allowRemoteVnetTraffic: false,
    allowVirtualWanTraffic: false,
    bgpSettings: {},
    disableIPSecReplayProtection: false,
    enableBgp: false,
    enableBgpRouteTranslationForNat: false,
    gatewayType: "ExpressRoute",
    ipConfigurations: [
      {
        name: "gwipconfig1",
        privateIPAllocationMethod: "Static",
        publicIPAddress: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip",
        },
        subnet: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet",
        },
      },
    ],
    location: "centralus",
    natRules: [
      {
        name: "natRule1",
        typePropertiesType: "Static",
        externalMappings: [{ addressSpace: "50.0.0.0/24" }],
        id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1",
        internalMappings: [{ addressSpace: "10.10.0.0/24" }],
        ipConfigurationId: "",
        mode: "EgressSnat",
      },
      {
        name: "natRule2",
        typePropertiesType: "Static",
        externalMappings: [{ addressSpace: "30.0.0.0/24" }],
        id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2",
        internalMappings: [{ addressSpace: "20.10.0.0/24" }],
        ipConfigurationId: "",
        mode: "IngressSnat",
      },
    ],
    sku: { name: "ErGwScale", tier: "ErGwScale" },
    vpnClientConfiguration: {},
    vpnType: "PolicyBased",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualNetworkGateways.beginCreateOrUpdateAndWait(
    resourceGroupName,
    virtualNetworkGatewayName,
    parameters,
  );
  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;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkScalableGatewayUpdate.json
// this example is just showing the usage of "VirtualNetworkGateways_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 VirtualNetworkGatewayResource
VirtualNetworkGatewayCollection collection = resourceGroupResource.GetVirtualNetworkGateways();

// invoke the operation
string virtualNetworkGatewayName = "ergw";
VirtualNetworkGatewayData data = new VirtualNetworkGatewayData()
{
    IPConfigurations =
    {
    new VirtualNetworkGatewayIPConfiguration()
    {
    PrivateIPAllocationMethod = NetworkIPAllocationMethod.Static,
    SubnetId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"),
    PublicIPAddressId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"),
    Name = "gwipconfig1",
    }
    },
    GatewayType = VirtualNetworkGatewayType.ExpressRoute,
    VpnType = VpnType.PolicyBased,
    EnableBgp = false,
    Active = false,
    DisableIPSecReplayProtection = false,
    Sku = new VirtualNetworkGatewaySku()
    {
        Name = VirtualNetworkGatewaySkuName.ErGwScale,
        Tier = VirtualNetworkGatewaySkuTier.ErGwScale,
    },
    VpnClientConfiguration = null,
    BgpSettings = null,
    NatRules =
    {
    new VirtualNetworkGatewayNatRuleData()
    {
    VpnNatRuleType = VpnNatRuleType.Static,
    Mode = VpnNatRuleMode.EgressSnat,
    InternalMappings =
    {
    new VpnNatRuleMapping()
    {
    AddressSpace = "10.10.0.0/24",
    }
    },
    ExternalMappings =
    {
    new VpnNatRuleMapping()
    {
    AddressSpace = "50.0.0.0/24",
    }
    },
    IPConfigurationId = "",
    Id = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1"),
    Name = "natRule1",
    },new VirtualNetworkGatewayNatRuleData()
    {
    VpnNatRuleType = VpnNatRuleType.Static,
    Mode = VpnNatRuleMode.IngressSnat,
    InternalMappings =
    {
    new VpnNatRuleMapping()
    {
    AddressSpace = "20.10.0.0/24",
    }
    },
    ExternalMappings =
    {
    new VpnNatRuleMapping()
    {
    AddressSpace = "30.0.0.0/24",
    }
    },
    IPConfigurationId = "",
    Id = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2"),
    Name = "natRule2",
    }
    },
    EnableBgpRouteTranslationForNat = false,
    AllowVirtualWanTraffic = false,
    AllowRemoteVnetTraffic = false,
    Location = new AzureLocation("centralus"),
};
ArmOperation<VirtualNetworkGatewayResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, virtualNetworkGatewayName, data);
VirtualNetworkGatewayResource 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
VirtualNetworkGatewayData 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": "ergw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "type": "Microsoft.Network/virtualNetworkGateways",
  "location": "centralus",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000",
    "ipConfigurations": [
      {
        "name": "gwipconfig1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/ipConfigurations/default",
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Dynamic",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"
          },
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"
          }
        }
      }
    ],
    "natRules": [
      {
        "name": "natRule1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1",
        "properties": {
          "type": "Static",
          "mode": "EgressSnat",
          "ipConfigurationId": "",
          "internalMappings": [
            {
              "addressSpace": "10.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "50.0.0.0/24"
            }
          ]
        }
      },
      {
        "name": "natRule2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2",
        "properties": {
          "type": "Static",
          "mode": "IngressSnat",
          "ipConfigurationId": "",
          "internalMappings": [
            {
              "addressSpace": "20.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "30.0.0.0/24"
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": false,
    "sku": {
      "name": "ErGwScale",
      "tier": "ErGwScale",
      "capacity": 0
    },
    "autoScaleConfiguration": {
      "bounds": {
        "min": 2,
        "max": 3
      }
    },
    "gatewayType": "ExpressRoute",
    "vpnType": "PolicyBased",
    "vpnGatewayGeneration": "None",
    "enableBgp": false,
    "activeActive": false,
    "disableIPSecReplayProtection": false,
    "vpnClientConfiguration": null,
    "bgpSettings": null,
    "customRoutes": null,
    "allowVirtualWanTraffic": false,
    "allowRemoteVnetTraffic": false
  }
}

Status code:

201

{
  "name": "ergw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "type": "Microsoft.Network/virtualNetworkGateways",
  "location": "centralus",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000",
    "ipConfigurations": [
      {
        "name": "gwipconfig1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/ipConfigurations/default",
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Static",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"
          },
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"
          }
        }
      }
    ],
    "natRules": [
      {
        "name": "natRule1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1",
        "properties": {
          "type": "Static",
          "mode": "EgressSnat",
          "ipConfigurationId": "",
          "internalMappings": [
            {
              "addressSpace": "10.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "50.0.0.0/24"
            }
          ]
        }
      },
      {
        "name": "natRule2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2",
        "properties": {
          "type": "Static",
          "mode": "IngressSnat",
          "ipConfigurationId": "",
          "internalMappings": [
            {
              "addressSpace": "20.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "30.0.0.0/24"
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": false,
    "sku": {
      "name": "ErGwScale",
      "tier": "ErGwScale",
      "capacity": 2
    },
    "autoScaleConfiguration": {
      "bounds": {
        "min": 2,
        "max": 3
      }
    },
    "gatewayType": "ExpressRoute",
    "vpnType": "PolicyBased",
    "enableBgp": false,
    "activeActive": false,
    "disableIPSecReplayProtection": false,
    "enablePrivateIpAddress": false,
    "vpnClientConfiguration": null,
    "bgpSettings": null,
    "customRoutes": null,
    "allowVirtualWanTraffic": false,
    "allowRemoteVnetTraffic": false
  }
}

Definitioner

Name	Description
AddressSpace	AddressSpace innehåller en matris med IP-adressintervall som kan användas av undernät i det virtuella nätverket.
adminState	Egenskap som anger om Express Route Gateway hanterar trafik när det finns flera Express Route Gateways i det virtuella nätverket
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.
ExtendedLocation	Komplex typ av ExtendedLocation.
ExtendedLocationTypes	Typen av utökad plats.
IkeEncryption	IKE-krypteringsalgoritmen (IKE fas 2).
IkeIntegrity	IKE-integritetsalgoritmen (IKE fas 2).
IPAllocationMethod	IP-adressallokeringsmetod.
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.
ProvisioningState	Det aktuella etableringstillståndet.
RadiusServer	Radius Server-inställningar.
SubResource	Referens till en annan underresurs.
VirtualNetworkGateway	En vanlig klass för allmän resursinformation.
VirtualNetworkGatewayAutoScaleBounds
VirtualNetworkGatewayAutoScaleConfiguration	Virtual Network Information om konfiguration av autoskalning av gateway
VirtualNetworkGatewayIPConfiguration	IP-konfiguration för virtuell nätverksgateway.
VirtualNetworkGatewayNatRule	VirtualNetworkGatewayNatRule-resurs.
VirtualNetworkGatewayPolicyGroup	Parametrar för VirtualNetworkGatewayPolicyGroup.
VirtualNetworkGatewayPolicyGroupMember	Vpn-klientanslutningskonfigurationsprincipGruppmedlem
VirtualNetworkGatewaySku	Information om VirtualNetworkGatewaySku.
VirtualNetworkGatewaySkuName	Gateway-SKU-namn.
VirtualNetworkGatewaySkuTier	SKU-nivå för gateway.
VirtualNetworkGatewayType	Typen av den här virtuella nätverksgatewayen.
VngClientConnectionConfiguration	En vpn-klientanslutningskonfiguration för klientanslutningskonfiguration.
VpnAuthenticationType	VPN-autentiseringstyper för den virtuella nätverksgatewayen..
VpnClientConfiguration	VpnClientConfiguration för P2S-klienten.
VpnClientProtocol	VpnClientProtocols för virtuell nätverksgateway.
VpnClientRevokedCertificate	VPN-klienten återkallade certifikat för virtuell nätverksgateway.
VpnClientRootCertificate	VPN-klientens rotcertifikat för virtuell nätverksgateway.
VpnGatewayGeneration	Genereringen för den här VirtualNetworkGateway. Måste vara Ingen om gatewayType inte är VPN.
VpnNatRuleMapping	Vpn NatRule-mappning.
VpnNatRuleMode	Nat-källriktningen för en VPN NAT.
VpnNatRuleType	Typen av NAT-regel för VPN NAT.
VpnPolicyMemberAttributeType	Attributtypen Vpn Policy-medlem.
VpnType	Typen av den här virtuella nätverksgatewayen.

AddressSpace

AddressSpace innehåller en matris med IP-adressintervall som kan användas av undernät i det virtuella nätverket.

Name	Typ	Description
addressPrefixes	string[]	En lista över adressblock som är reserverade för det här virtuella nätverket i CIDR-notation.

adminState

Egenskap som anger om Express Route Gateway hanterar trafik när det finns flera Express Route Gateways i det virtuella nätverket

Name	Typ	Description
Disabled	string
Enabled	string

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

ExtendedLocation

Komplex typ av ExtendedLocation.

Name	Typ	Description
name	string	Namnet på den utökade platsen.
type	ExtendedLocationTypes	Typen av utökad plats.

ExtendedLocationTypes

Typen av utökad plats.

Name	Typ	Description
EdgeZone	string

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

IPAllocationMethod

IP-adressallokeringsmetod.

Name	Typ	Description
Dynamic	string
Static	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 standardadresser för BGP-peering som tillhör IP-konfiguration.
ipconfigurationId	string	ID för IP-konfiguration 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

ProvisioningState

Det aktuella etableringstillståndet.

Name	Typ	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RadiusServer

Radius Server-inställningar.

Name	Typ	Description
radiusServerAddress	string	Adressen till den här radius-servern.
radiusServerScore	integer	Den första poängen som tilldelats den här radius-servern.
radiusServerSecret	string	Hemligheten som används för den här radius-servern.

SubResource

Referens till en annan underresurs.

Name	Typ	Description
id	string	Resurs-ID.

VirtualNetworkGateway

En vanlig klass för allmän resursinformation.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
extendedLocation	ExtendedLocation	Den utökade platsen för typen lokal virtuell nätverksgateway.
id	string	Resurs-ID.
location	string	Resursplats.
name	string	Resursnamn.
properties.activeActive	boolean	ActiveActive-flagga.
properties.adminState	adminState	Egenskap som anger om Express Route Gateway hanterar trafik när det finns flera Express Route Gateways i det virtuella nätverket
properties.allowRemoteVnetTraffic	boolean	Konfigurera den här gatewayen så att den accepterar trafik från andra virtuella Azure-nätverk. Den här konfigurationen stöder inte anslutning till Azure Virtual WAN.
properties.allowVirtualWanTraffic	boolean	Konfigurerar den här gatewayen så att den accepterar trafik från fjärranslutna Virtual WAN nätverk.
properties.autoScaleConfiguration	VirtualNetworkGatewayAutoScaleConfiguration	Autoskalningskonfiguration för virutal nätverksgateway
properties.bgpSettings	BgpSettings	BGP-talarinställningarna för den virtuella nätverksgatewayen.
properties.customRoutes	AddressSpace	Referensen till adressutrymmesresursen som representerar adressutrymmet för anpassade vägar som kunden har angett för virtuell nätverksgateway och VpnClient.
properties.disableIPSecReplayProtection	boolean	disableIPSecReplayProtection-flaggan.
properties.enableBgp	boolean	Om BGP är aktiverat för den här virtuella nätverksgatewayen eller inte.
properties.enableBgpRouteTranslationForNat	boolean	Flaggan EnableBgpRouteTranslationForNat.
properties.enableDnsForwarding	boolean	Om dns-vidarebefordran är aktiverat eller inte.
properties.enablePrivateIpAddress	boolean	Om privat IP måste aktiveras på den här gatewayen för anslutningar eller inte.
properties.gatewayDefaultSite	SubResource	Referensen till resursen LocalNetworkGateway som representerar den lokala nätverksplatsen som har standardvägar. Tilldela Null-värde vid borttagning av befintlig standardplatsinställning.
properties.gatewayType	VirtualNetworkGatewayType	Typen av den här virtuella nätverksgatewayen.
properties.inboundDnsForwardingEndpoint	string	IP-adressen som allokeras av gatewayen som dns-begäranden kan skickas till.
properties.ipConfigurations	VirtualNetworkGatewayIPConfiguration[]	IP-konfigurationer för virtuell nätverksgateway.
properties.natRules	VirtualNetworkGatewayNatRule[]	NatRules för virtuell nätverksgateway.
properties.provisioningState	ProvisioningState	Etableringstillståndet för den virtuella nätverksgatewayresursen.
properties.resourceGuid	string	Resursens GUID-egenskap för den virtuella nätverksgatewayresursen.
properties.sku	VirtualNetworkGatewaySku	Referensen till virtualnetworkGatewaySku-resursen som representerar den SKU som valts för virtuell nätverksgateway.
properties.vNetExtendedLocationResourceId	string	Kundens vnet-resurs-ID. VirtualNetworkGateway av typen lokal gateway är associerad med kundens virtuella nätverk.
properties.virtualNetworkGatewayPolicyGroups	VirtualNetworkGatewayPolicyGroup[]	Referensen till resursen VirtualNetworkGatewayPolicyGroup som representerar den tillgängliga VirtualNetworkGatewayPolicyGroup för gatewayen.
properties.vpnClientConfiguration	VpnClientConfiguration	Referensen till resursen VpnClientConfiguration som representerar P2S VpnClient-konfigurationerna.
properties.vpnGatewayGeneration	VpnGatewayGeneration	Genereringen för den här VirtualNetworkGateway. Måste vara Ingen om gatewayType inte är VPN.
properties.vpnType	VpnType	Typen av den här virtuella nätverksgatewayen.
tags	object	Resurstaggar.
type	string	Resurstyp.

VirtualNetworkGatewayAutoScaleBounds

Name	Typ	Description
max	integer	Maximalt antal skalningsenheter för autoskalningskonfiguration
min	integer	Minsta skalningsenheter för autoskalningskonfiguration

VirtualNetworkGatewayAutoScaleConfiguration

Virtual Network Information om konfiguration av autoskalning av gateway

Name	Typ	Description
bounds	VirtualNetworkGatewayAutoScaleBounds	Gränserna för autoskalningskonfigurationen

VirtualNetworkGatewayIPConfiguration

IP-konfiguration för virtuell nätverksgateway.

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.privateIPAddress	string	Privat IP-adress för den här gatewayen.
properties.privateIPAllocationMethod	IPAllocationMethod	Den privata IP-adressallokeringsmetoden.
properties.provisioningState	ProvisioningState	Etableringstillståndet för ip-konfigurationsresursen för den virtuella nätverksgatewayen.
properties.publicIPAddress	SubResource	Referensen till den offentliga IP-resursen.
properties.subnet	SubResource	Referensen till undernätsresursen.

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayNatRule-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.externalMappings	VpnNatRuleMapping[]	Extern mappning av privat IP-adress för NAT.
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.

VirtualNetworkGatewayPolicyGroup

Parametrar för VirtualNetworkGatewayPolicyGroup.

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.isDefault	boolean	Visar om detta är en Standard VirtualNetworkGatewayPolicyGroup eller inte.
properties.policyMembers	VirtualNetworkGatewayPolicyGroupMember[]	Flera PolicyMembers för VirtualNetworkGatewayPolicyGroup.
properties.priority	integer	Prioritet för VirtualNetworkGatewayPolicyGroup.
properties.provisioningState	ProvisioningState	Etableringstillståndet för VirtualNetworkGatewayPolicyGroup-resursen.
properties.vngClientConnectionConfigurations	SubResource[]	Lista över referenser till vngClientConnectionConfigurations.

VirtualNetworkGatewayPolicyGroupMember

Vpn-klientanslutningskonfigurationsprincipGruppmedlem

Name	Typ	Description
attributeType	VpnPolicyMemberAttributeType	Attributtypen Vpn Policy-medlem.
attributeValue	string	Värdet för attributet som används för den här VirtualNetworkGatewayPolicyGroupMember.
name	string	Namnet på VirtualNetworkGatewayPolicyGroupMember.

VirtualNetworkGatewaySku

Information om VirtualNetworkGatewaySku.

Name	Typ	Description
capacity	integer	Kapaciteten.
name	VirtualNetworkGatewaySkuName	Gateway-SKU-namn.
tier	VirtualNetworkGatewaySkuTier	SKU-nivå för gateway.

VirtualNetworkGatewaySkuName

Gateway-SKU-namn.

Name	Typ	Description
Basic	string
ErGw1AZ	string
ErGw2AZ	string
ErGw3AZ	string
ErGwScale	string
HighPerformance	string
Standard	string
UltraPerformance	string
VpnGw1	string
VpnGw1AZ	string
VpnGw2	string
VpnGw2AZ	string
VpnGw3	string
VpnGw3AZ	string
VpnGw4	string
VpnGw4AZ	string
VpnGw5	string
VpnGw5AZ	string

VirtualNetworkGatewaySkuTier

SKU-nivå för gateway.

Name	Typ	Description
Basic	string
ErGw1AZ	string
ErGw2AZ	string
ErGw3AZ	string
ErGwScale	string
HighPerformance	string
Standard	string
UltraPerformance	string
VpnGw1	string
VpnGw1AZ	string
VpnGw2	string
VpnGw2AZ	string
VpnGw3	string
VpnGw3AZ	string
VpnGw4	string
VpnGw4AZ	string
VpnGw5	string
VpnGw5AZ	string

VirtualNetworkGatewayType

Typen av den här virtuella nätverksgatewayen.

Name	Typ	Description
ExpressRoute	string
LocalGateway	string
Vpn	string

VngClientConnectionConfiguration

En vpn-klientanslutningskonfiguration för klientanslutningskonfiguration.

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.provisioningState	ProvisioningState	Etableringstillståndet för resursen VngClientConnectionConfiguration.
properties.virtualNetworkGatewayPolicyGroups	SubResource[]	Lista över referenser till virtualNetworkGatewayPolicyGroups
properties.vpnClientAddressPool	AddressSpace	Referensen till adressutrymmesresursen som representerar adressutrymme för P2S VpnClient.

VpnAuthenticationType

VPN-autentiseringstyper för den virtuella nätverksgatewayen..

Name	Typ	Description
AAD	string
Certificate	string
Radius	string

VpnClientConfiguration

VpnClientConfiguration för P2S-klienten.

Name	Typ	Description
aadAudience	string	Egenskapen AADAudience för VirtualNetworkGateway-resursen för VPN-klientanslutning som används för AAD-autentisering.
aadIssuer	string	AADIssuer-egenskapen för VirtualNetworkGateway-resursen för VPN-klientanslutning som används för AAD-autentisering.
aadTenant	string	Egenskapen AADTenant för VirtualNetworkGateway-resursen för VPN-klientanslutning som används för AAD-autentisering.
radiusServerAddress	string	Radius-serverns adressegenskap för VirtualNetworkGateway-resursen för VPN-klientanslutning.
radiusServerSecret	string	Radius-hemlighetsegenskapen för VirtualNetworkGateway-resursen för VPN-klientanslutning.
radiusServers	RadiusServer[]	RadiusServers-egenskapen för serverkonfiguration med flera radie.
vngClientConnectionConfigurations	VngClientConnectionConfiguration[]	per ip-adresspoolanslutningsprincip för P2S-klienten för virtuell nätverksgateway.
vpnAuthenticationTypes	VpnAuthenticationType[]	VPN-autentiseringstyper för den virtuella nätverksgatewayen..
vpnClientAddressPool	AddressSpace	Referensen till adressutrymmesresursen som representerar adressutrymme för P2S VpnClient.
vpnClientIpsecPolicies	IpsecPolicy[]	VpnClientIpsecPolicies för P2S-klienten för virtuell nätverksgateway.
vpnClientProtocols	VpnClientProtocol[]	VpnClientProtocols för virtuell nätverksgateway.
vpnClientRevokedCertificates	VpnClientRevokedCertificate[]	VpnClientRevokedCertificate för virtuell nätverksgateway.
vpnClientRootCertificates	VpnClientRootCertificate[]	VpnClientRootCertificate för virtuell nätverksgateway.

VpnClientProtocol

VpnClientProtocols för virtuell nätverksgateway.

Name	Typ	Description
IkeV2	string
OpenVPN	string
SSTP	string

VpnClientRevokedCertificate

VPN-klienten återkallade certifikat för virtuell nätverksgateway.

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.provisioningState	ProvisioningState	Etableringstillståndet för VPN-klientens återkallade certifikatresurs.
properties.thumbprint	string	Tumavtrycket för återkallat VPN-klientcertifikat.

VpnClientRootCertificate

VPN-klientens rotcertifikat för virtuell nätverksgateway.

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.provisioningState	ProvisioningState	Etableringstillståndet för VPN-klientens rotcertifikatresurs.
properties.publicCertData	string	Offentliga certifikatdata.

VpnGatewayGeneration

Genereringen för den här VirtualNetworkGateway. Måste vara Ingen om gatewayType inte är VPN.

Name	Typ	Description
Generation1	string
Generation2	string
None	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

Typen av NAT-regel för VPN NAT.

Name	Typ	Description
Dynamic	string
Static	string

VpnPolicyMemberAttributeType

Attributtypen Vpn Policy-medlem.

Name	Typ	Description
AADGroupId	string
CertificateGroupId	string
RadiusAzureGroupId	string

VpnType

Typen av den här virtuella nätverksgatewayen.

Name	Typ	Description
PolicyBased	string
RouteBased	string