Virtual Network Gateways - Create Or Update

參考

Service:: Network Gateway

API Version:: 2023-09-01

在指定的資源群組中建立或更新虛擬網路閘道。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
virtualNetworkGatewayName	path	True	string	虛擬網路閘道的名稱。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	類型	Description
extendedLocation	ExtendedLocation	本機虛擬網路閘道類型的擴充位置。
id	string	資源識別碼。
location	string	資源位置。
properties.activeActive	boolean	ActiveActive 旗標。
properties.adminState	adminState	屬性，指出當 vnet 中有多個 Express Route 閘道時，Express Route 閘道是否提供流量
properties.allowRemoteVnetTraffic	boolean	設定此閘道以接受來自其他 Azure 虛擬網路的流量。此設定不支持連線到 Azure Virtual WAN。
properties.allowVirtualWanTraffic	boolean	設定此閘道以接受來自遠端 Virtual WAN 網路的流量。
properties.autoScaleConfiguration	VirtualNetworkGatewayAutoScaleConfiguration	虛擬網路閘道的自動調整設定
properties.bgpSettings	BgpSettings	虛擬網路閘道的 BGP 喇叭設定。
properties.customRoutes	AddressSpace	位址空間資源的參考，代表客戶針對虛擬網路網關和 VpnClient 所指定的自定義路由地址空間。
properties.disableIPSecReplayProtection	boolean	disableIPSecReplayProtection 旗標。
properties.enableBgp	boolean	是否啟用此虛擬網路閘道的 BGP。
properties.enableBgpRouteTranslationForNat	boolean	EnableBgpRouteTranslationForNat 旗標。
properties.enableDnsForwarding	boolean	是否啟用 DNS 轉送。
properties.enablePrivateIpAddress	boolean	是否需要在此閘道上啟用私人IP以進行連線。
properties.gatewayDefaultSite	SubResource	LocalNetworkGateway 資源的參考，代表具有預設路由的局域網路網站。拿掉現有的預設網站設定時，請指派 Null 值。
properties.gatewayType	VirtualNetworkGatewayType	此虛擬網路閘道的類型。
properties.ipConfigurations	VirtualNetworkGatewayIPConfiguration[]	虛擬網路閘道的IP組態。
properties.natRules	VirtualNetworkGatewayNatRule[]	虛擬網路閘道的 NatRules。
properties.sku	VirtualNetworkGatewaySku	VirtualNetworkGatewaySku 資源的參考，代表針對虛擬網路網關選取的 SKU。
properties.vNetExtendedLocationResourceId	string	客戶 vnet 資源標識碼。本機閘道類型的 VirtualNetworkGateway 與客戶 vnet 相關聯。
properties.virtualNetworkGatewayPolicyGroups	VirtualNetworkGatewayPolicyGroup[]	VirtualNetworkGatewayPolicyGroup 資源的參考，代表網關可用的 VirtualNetworkGatewayPolicyGroup。
properties.vpnClientConfiguration	VpnClientConfiguration	代表 P2S VpnClient 組態之 VpnClientConfiguration 資源的參考。
properties.vpnGatewayGeneration	VpnGatewayGeneration	此 VirtualNetworkGateway 的產生。如果 gatewayType 不是 VPN，則必須為 None。
properties.vpnType	VpnType	此虛擬網路閘道的類型。
tags	object	資源標籤。

回應

名稱	類型	Description
200 OK	VirtualNetworkGateway	更新成功。作業會傳回產生的 VirtualNetworkGateway 資源。
201 Created	VirtualNetworkGateway	建立成功。作業會傳回產生的 VirtualNetworkGateway 資源。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

UpdateVirtualNetworkGateway

UpdateVirtualNetworkScalableGateway

UpdateVirtualNetworkGateway

Sample Request

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


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

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

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

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

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

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


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

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

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

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

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

定義

名稱	Description
AddressSpace	Addressspace 包含可供虛擬網路的子網路使用的 IP 位址範圍陣列。
adminState	屬性，指出當 vnet 中有多個 Express Route 閘道時，Express Route 閘道是否提供流量
BgpSettings	BGP 設定詳細數據。
CloudError	來自服務的錯誤回應。
CloudErrorBody	來自服務的錯誤回應。
DhGroup	IKE 階段 1 中用於初始 SA 的 DH 群組。
ExtendedLocation	ExtendedLocation 複雜類型。
ExtendedLocationTypes	擴充位置的類型。
IkeEncryption	IKE 加密演算法 (IKE 階段 2) 。
IkeIntegrity	IKE 完整性演算法 (IKE 階段 2) 。
IPAllocationMethod	IP 位址配置方法。
IPConfigurationBgpPeeringAddress	IPConfigurationBgpPeeringAddress 的屬性。
IpsecEncryption	IPSec 加密演算法 (IKE 階段 1) 。
IpsecIntegrity	IPSec 完整性演算法 (IKE 階段 1) 。
IpsecPolicy	虛擬網路網關聯機的IPSec原則設定。
PfsGroup	IKE 階段 2 中用於新子 SA 的 Pfs 群組。
ProvisioningState	目前的布建狀態。
RadiusServer	Radius 伺服器設定。
SubResource	另一個子資源的參考。
VirtualNetworkGateway	一般資源資訊的通用類別。
VirtualNetworkGatewayAutoScaleBounds
VirtualNetworkGatewayAutoScaleConfiguration	虛擬網路閘道自動調整設定詳細數據
VirtualNetworkGatewayIPConfiguration	虛擬網路閘道的IP組態。
VirtualNetworkGatewayNatRule	VirtualNetworkGatewayNatRule 資源。
VirtualNetworkGatewayPolicyGroup	VirtualNetworkGatewayPolicyGroup 的參數。
VirtualNetworkGatewayPolicyGroupMember	Vpn 用戶端連線設定 PolicyGroup 成員
VirtualNetworkGatewaySku	VirtualNetworkGatewaySku 詳細數據。
VirtualNetworkGatewaySkuName	閘道 SKU 名稱。
VirtualNetworkGatewaySkuTier	閘道 SKU 層。
VirtualNetworkGatewayType	此虛擬網路閘道的類型。
VngClientConnectionConfiguration	用戶端聯機組態的 vpn 用戶端聯機組態。
VpnAuthenticationType	虛擬網路閘道的 VPN 驗證類型。
VpnClientConfiguration	P2S 用戶端的 VpnClientConfiguration。
VpnClientProtocol	虛擬網路閘道的 VpnClientProtocols。
VpnClientRevokedCertificate	VPN 用戶端撤銷虛擬網路閘道的憑證。
VpnClientRootCertificate	虛擬網路閘道的 VPN 用戶端跟證書。
VpnGatewayGeneration	此 VirtualNetworkGateway 的產生。如果 gatewayType 不是 VPN，則必須為 None。
VpnNatRuleMapping	Vpn NatRule 對應。
VpnNatRuleMode	VPN NAT 的來源 NAT 方向。
VpnNatRuleType	VPN NAT 的 NAT 規則類型。
VpnPolicyMemberAttributeType	Vpn 原則成員屬性類型。
VpnType	此虛擬網路閘道的類型。

AddressSpace

Addressspace 包含可供虛擬網路的子網路使用的 IP 位址範圍陣列。

名稱	類型	Description
addressPrefixes	string[]	在 CIDR 表示法中保留給此虛擬網路的位址區塊清單。

adminState

屬性，指出當 vnet 中有多個 Express Route 閘道時，Express Route 閘道是否提供流量

名稱	類型	Description
Disabled	string
Enabled	string

BgpSettings

BGP 設定詳細數據。

名稱	類型	Description
asn	integer	BGP 說話者的 ASN。
bgpPeeringAddress	string	這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	具有虛擬網路閘道IP組態標識碼的 BGP 對等互連位址。
peerWeight	integer	新增至從這個 BGP 說話者學到之路由的權數。

CloudError

來自服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	雲端錯誤本文。

CloudErrorBody

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。程式碼不變，且要以程式設計方式使用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。例如，錯誤中的屬性名稱。

DhGroup

IKE 階段 1 中用於初始 SA 的 DH 群組。

名稱	類型	Description
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

ExtendedLocation

ExtendedLocation 複雜類型。

名稱	類型	Description
name	string	擴充位置的名稱。
type	ExtendedLocationTypes	擴充位置的類型。

ExtendedLocationTypes

擴充位置的類型。

名稱	類型	Description
EdgeZone	string

IkeEncryption

IKE 加密演算法 (IKE 階段 2) 。

名稱	類型	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

IKE 完整性演算法 (IKE 階段 2) 。

名稱	類型	Description
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IPAllocationMethod

IP 位址配置方法。

名稱	類型	Description
Dynamic	string
Static	string

IPConfigurationBgpPeeringAddress

IPConfigurationBgpPeeringAddress 的屬性。

名稱	類型	Description
customBgpIpAddresses	string[]	屬於IP組態的自訂BGP對等互連位址清單。
defaultBgpIpAddresses	string[]	屬於IP組態的預設 BGP 對等互連位址清單。
ipconfigurationId	string	屬於閘道的IP組態標識碼。
tunnelIpAddresses	string[]	屬於IP組態的通道公用IP位址清單。

IpsecEncryption

IPSec 加密演算法 (IKE 階段 1) 。

名稱	類型	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

IPSec 完整性演算法 (IKE 階段 1) 。

名稱	類型	Description
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

虛擬網路網關聯機的IPSec原則設定。

名稱	類型	Description
dhGroup	DhGroup	IKE 階段 1 中用於初始 SA 的 DH 群組。
ikeEncryption	IkeEncryption	IKE 加密演算法 (IKE 階段 2) 。
ikeIntegrity	IkeIntegrity	IKE 完整性演算法 (IKE 階段 2) 。
ipsecEncryption	IpsecEncryption	IPSec 加密演算法 (IKE 階段 1) 。
ipsecIntegrity	IpsecIntegrity	IPSec 完整性演算法 (IKE 階段 1) 。
pfsGroup	PfsGroup	IKE 階段 2 中用於新子 SA 的 Pfs 群組。
saDataSizeKilobytes	integer	IPSec 安全性關聯 (也稱為快速模式或階段 2 SA) KB 的承載大小，適用於站對站 VPN 通道。
saLifeTimeSeconds	integer	IPSec 安全性關聯 (也稱為快速模式或階段 2 SA) 存留期，以秒為單位，讓站對站 VPN 通道。

PfsGroup

IKE 階段 2 中用於新子 SA 的 Pfs 群組。

名稱	類型	Description
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

ProvisioningState

目前的布建狀態。

名稱	類型	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RadiusServer

Radius 伺服器設定。

名稱	類型	Description
radiusServerAddress	string	這個半徑伺服器的位址。
radiusServerScore	integer	指派給這個半徑伺服器的初始分數。
radiusServerSecret	string	用於這個半徑伺服器的秘密。

SubResource

另一個子資源的參考。

名稱	類型	Description
id	string	資源識別碼。