Virtual Network Gateways - Create Or Update

Service:

Network Gateway

API Version:

2023-09-01

Cria ou atualiza um gateway de rede virtual no grupo de recursos especificado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
virtualNetworkGatewayName	path	True	string	O nome do gateway de rede virtual.
api-version	query	True	string	Versão de API do cliente.

Corpo da solicitação

Nome	Tipo	Description
extendedLocation	ExtendedLocation	O local estendido do tipo gateway de rede virtual local.
id	string	ID do recurso.
location	string	Local do recurso.
properties.activeActive	boolean	Sinalizador ActiveActive.
properties.adminState	adminState	Propriedade para indicar se o Gateway de Rota Expressa atende ao tráfego quando há vários Gateways de Rota Expressa na vnet
properties.allowRemoteVnetTraffic	boolean	Configure esse gateway para aceitar o tráfego de outras Redes Virtuais do Azure. Essa configuração não dá suporte à conectividade com o Azure WAN Virtual.
properties.allowVirtualWanTraffic	boolean	Configura esse gateway para aceitar o tráfego de redes de WAN Virtual remotas.
properties.autoScaleConfiguration	VirtualNetworkGatewayAutoScaleConfiguration	Configuração de dimensionamento automático para gateway de rede virutal
properties.bgpSettings	BgpSettings	Configurações do alto-falante BGP do gateway de rede virtual.
properties.customRoutes	AddressSpace	A referência ao recurso de espaço de endereço que representa o espaço de endereço de rotas personalizadas especificado pelo cliente para o gateway de rede virtual e VpnClient.
properties.disableIPSecReplayProtection	boolean	sinalizador disableIPSecReplayProtection.
properties.enableBgp	boolean	Se BGP está ou não habilitado para este gateway de rede virtual.
properties.enableBgpRouteTranslationForNat	boolean	Sinalizador EnableBgpRouteTranslationForNat.
properties.enableDnsForwarding	boolean	Se o encaminhamento de dns está habilitado ou não.
properties.enablePrivateIpAddress	boolean	Se o IP privado precisa ser habilitado nesse gateway para conexões ou não.
properties.gatewayDefaultSite	SubResource	A referência ao recurso LocalNetworkGateway que representa o site de rede local com rotas padrão. Atribua valor Nulo no caso de remover a configuração de site padrão existente.
properties.gatewayType	VirtualNetworkGatewayType	O tipo desse gateway de rede virtual.
properties.ipConfigurations	VirtualNetworkGatewayIPConfiguration[]	Configurações de IP para gateway de rede virtual.
properties.natRules	VirtualNetworkGatewayNatRule[]	NatRules para gateway de rede virtual.
properties.sku	VirtualNetworkGatewaySku	A referência ao recurso VirtualNetworkGatewaySku que representa a SKU selecionada para o gateway de rede virtual.
properties.vNetExtendedLocationResourceId	string	ID do recurso de vnet do cliente. VirtualNetworkGateway do tipo gateway local está associado à vnet do cliente.
properties.virtualNetworkGatewayPolicyGroups	VirtualNetworkGatewayPolicyGroup[]	A referência ao recurso VirtualNetworkGatewayPolicyGroup que representa o VirtualNetworkGatewayPolicyGroup disponível para o gateway.
properties.vpnClientConfiguration	VpnClientConfiguration	A referência ao recurso VpnClientConfiguration que representa as configurações de VpnClient P2S.
properties.vpnGatewayGeneration	VpnGatewayGeneration	A geração deste VirtualNetworkGateway. Deve ser Nenhum se gatewayType não for VPN.
properties.vpnType	VpnType	O tipo desse gateway de rede virtual.
tags	object	Marcas de recurso.

Respostas

Nome	Tipo	Description
200 OK	VirtualNetworkGateway	Atualização bem-sucedida. A operação retorna o recurso VirtualNetworkGateway resultante.
201 Created	VirtualNetworkGateway	Crie com êxito. A operação retorna o recurso VirtualNetworkGateway resultante.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Definições

Nome	Description
AddressSpace	O AddressSpace contém uma matriz de intervalos de endereços IP que podem ser usados por sub-redes da rede virtual.
adminState	Propriedade para indicar se o Gateway de Rota Expressa atende ao tráfego quando há vários Gateways de Rota Expressa na vnet
BgpSettings	Detalhes das configurações de BGP.
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
DhGroup	Os grupos dh usados na Fase 1 do IKE para SA inicial.
ExtendedLocation	Tipo complexo ExtendedLocation.
ExtendedLocationTypes	O tipo do local estendido.
IkeEncryption	O algoritmo de criptografia IKE (fase 2 do IKE).
IkeIntegrity	O algoritmo de integridade IKE (fase 2 do IKE).
IPAllocationMethod	Método de alocação de endereço IP.
IPConfigurationBgpPeeringAddress	Propriedades de IPConfigurationBgpPeeringAddress.
IpsecEncryption	O algoritmo de criptografia IPSec (fase 1 do IKE).
IpsecIntegrity	O algoritmo de integridade IPSec (fase 1 do IKE).
IpsecPolicy	Uma configuração de Política IPSec para uma conexão de gateway de rede virtual.
PfsGroup	Os Grupos de Pfs usados na Fase 2 do IKE para a NOVA SA filho.
ProvisioningState	O estado de provisionamento atual.
RadiusServer	Configurações do Servidor Radius.
SubResource	Referência a outro sub-recurso.
VirtualNetworkGateway	Uma classe comum para informações gerais de recursos.
VirtualNetworkGatewayAutoScaleBounds
VirtualNetworkGatewayAutoScaleConfiguration	Detalhes da Configuração de Dimensionamento Automático do Gateway de Rede Virtual
VirtualNetworkGatewayIPConfiguration	Configuração de IP para gateway de rede virtual.
VirtualNetworkGatewayNatRule	Recurso VirtualNetworkGatewayNatRule.
VirtualNetworkGatewayPolicyGroup	Parâmetros para VirtualNetworkGatewayPolicyGroup.
VirtualNetworkGatewayPolicyGroupMember	Membro PolicyGroup da configuração de conexão do cliente VPN
VirtualNetworkGatewaySku	Detalhes de VirtualNetworkGatewaySku.
VirtualNetworkGatewaySkuName	Nome do SKU do gateway.
VirtualNetworkGatewaySkuTier	Camada de SKU do gateway.
VirtualNetworkGatewayType	O tipo desse gateway de rede virtual.
VngClientConnectionConfiguration	Uma configuração de conexão de cliente vpn para a configuração de conexão do cliente.
VpnAuthenticationType	Tipos de autenticação VPN para o gateway de rede virtual..
VpnClientConfiguration	VpnClientConfiguration para o cliente P2S.
VpnClientProtocol	VpnClientProtocols para gateway de rede virtual.
VpnClientRevokedCertificate	O cliente VPN revogou o certificado do gateway de rede virtual.
VpnClientRootCertificate	Certificado raiz do cliente VPN do gateway de rede virtual.
VpnGatewayGeneration	A geração deste VirtualNetworkGateway. Deve ser Nenhum se gatewayType não for VPN.
VpnNatRuleMapping	Mapeamento de NatRule de VPN.
VpnNatRuleMode	A direção nat de origem de um NAT vpn.
VpnNatRuleType	O tipo de regra NAT para VPN NAT.
VpnPolicyMemberAttributeType	O tipo de atributo de membro da Política de Vpn.
VpnType	O tipo desse gateway de rede virtual.

AddressSpace

O AddressSpace contém uma matriz de intervalos de endereços IP que podem ser usados por sub-redes da rede virtual.

Nome	Tipo	Description
addressPrefixes	string[]	Uma lista de blocos de endereço reservados para essa rede virtual na notação CIDR.

adminState

Propriedade para indicar se o Gateway de Rota Expressa atende ao tráfego quando há vários Gateways de Rota Expressa na vnet

Nome	Tipo	Description
Disabled	string
Enabled	string

BgpSettings

Detalhes das configurações de BGP.

Nome	Tipo	Description
asn	integer	O ASN do alto-falante BGP.
bgpPeeringAddress	string	O endereço de emparelhamento BGP e o identificador BGP desse alto-falante BGP.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	Endereço de emparelhamento BGP com ID de configuração de IP para gateway de rede virtual.
peerWeight	integer	O peso adicionado às rotas aprendidas com esse alto-falante BGP.

CloudError

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	CloudErrorBody	Corpo do erro de nuvem.

CloudErrorBody

Uma resposta de erro do serviço.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

DhGroup

Os grupos dh usados na Fase 1 do IKE para SA inicial.

Nome	Tipo	Description
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

ExtendedLocation

Tipo complexo ExtendedLocation.

Nome	Tipo	Description
name	string	O nome do local estendido.
type	ExtendedLocationTypes	O tipo do local estendido.

ExtendedLocationTypes

O tipo do local estendido.

Nome	Tipo	Description
EdgeZone	string

IkeEncryption

O algoritmo de criptografia IKE (fase 2 do IKE).

Nome	Tipo	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

O algoritmo de integridade IKE (fase 2 do IKE).

Nome	Tipo	Description
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IPAllocationMethod

Método de alocação de endereço IP.

Nome	Tipo	Description
Dynamic	string
Static	string

IPConfigurationBgpPeeringAddress

Propriedades de IPConfigurationBgpPeeringAddress.

Nome	Tipo	Description
customBgpIpAddresses	string[]	A lista de endereços de emparelhamento BGP personalizados que pertencem à configuração de IP.
defaultBgpIpAddresses	string[]	A lista de endereços de emparelhamento BGP padrão que pertencem à configuração de IP.
ipconfigurationId	string	A ID da configuração de IP que pertence ao gateway.
tunnelIpAddresses	string[]	A lista de endereços IP públicos de túnel que pertencem à configuração de IP.

IpsecEncryption

O algoritmo de criptografia IPSec (fase 1 do IKE).

Nome	Tipo	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

O algoritmo de integridade IPSec (fase 1 do IKE).

Nome	Tipo	Description
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

Uma configuração de Política IPSec para uma conexão de gateway de rede virtual.

Nome	Tipo	Description
dhGroup	DhGroup	O grupo DH usado na Fase 1 do IKE para SA inicial.
ikeEncryption	IkeEncryption	O algoritmo de criptografia IKE (fase 2 do IKE).
ikeIntegrity	IkeIntegrity	O algoritmo de integridade IKE (fase 2 do IKE).
ipsecEncryption	IpsecEncryption	O algoritmo de criptografia IPSec (fase 1 do IKE).
ipsecIntegrity	IpsecIntegrity	O algoritmo de integridade IPSec (fase 1 do IKE).
pfsGroup	PfsGroup	O Grupo de Pfs usado na Fase 2 do IKE para a NOVA SA filho.
saDataSizeKilobytes	integer	O tamanho da carga da Associação de Segurança IPSec (também chamada de Modo Rápido ou SA da Fase 2) em KB para um túnel VPN site a site.
saLifeTimeSeconds	integer	O tempo de vida da Associação de Segurança IPSec (também chamado de Modo Rápido ou SA da Fase 2) em segundos para um túnel VPN site a site.

PfsGroup

Os Grupos de Pfs usados na Fase 2 do IKE para a NOVA SA filho.

Nome	Tipo	Description
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

ProvisioningState

O estado de provisionamento atual.

Nome	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RadiusServer

Configurações do Servidor Radius.

Nome	Tipo	Description
radiusServerAddress	string	O endereço desse servidor radius.
radiusServerScore	integer	A pontuação inicial atribuída a esse servidor radius.
radiusServerSecret	string	O segredo usado para esse servidor radius.

SubResource

Referência a outro sub-recurso.

Nome	Tipo	Description
id	string	ID do recurso.

VirtualNetworkGateway

Uma classe comum para informações gerais de recursos.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres exclusiva somente leitura que é alterada sempre que o recurso é atualizado.
extendedLocation	ExtendedLocation	O local estendido do tipo gateway de rede virtual local.
id	string	ID do recurso.
location	string	Local do recurso.
name	string	Nome do recurso.
properties.activeActive	boolean	Sinalizador ActiveActive.
properties.adminState	adminState	Propriedade para indicar se o Gateway de Rota Expressa atende ao tráfego quando há vários Gateways de Rota Expressa na vnet
properties.allowRemoteVnetTraffic	boolean	Configure esse gateway para aceitar o tráfego de outras Redes Virtuais do Azure. Essa configuração não dá suporte à conectividade com o Azure WAN Virtual.
properties.allowVirtualWanTraffic	boolean	Configura esse gateway para aceitar o tráfego de redes de WAN Virtual remotas.
properties.autoScaleConfiguration	VirtualNetworkGatewayAutoScaleConfiguration	Configuração de dimensionamento automático para gateway de rede virutal
properties.bgpSettings	BgpSettings	Configurações do alto-falante BGP do gateway de rede virtual.
properties.customRoutes	AddressSpace	A referência ao recurso de espaço de endereço que representa o espaço de endereço de rotas personalizadas especificado pelo cliente para o gateway de rede virtual e VpnClient.
properties.disableIPSecReplayProtection	boolean	sinalizador disableIPSecReplayProtection.
properties.enableBgp	boolean	Se BGP está ou não habilitado para este gateway de rede virtual.
properties.enableBgpRouteTranslationForNat	boolean	Sinalizador EnableBgpRouteTranslationForNat.
properties.enableDnsForwarding	boolean	Se o encaminhamento de dns está habilitado ou não.
properties.enablePrivateIpAddress	boolean	Se o IP privado precisa ser habilitado nesse gateway para conexões ou não.
properties.gatewayDefaultSite	SubResource	A referência ao recurso LocalNetworkGateway que representa o site de rede local com rotas padrão. Atribua Valor nulo em caso de remoção da configuração de site padrão existente.
properties.gatewayType	VirtualNetworkGatewayType	O tipo desse gateway de rede virtual.
properties.inboundDnsForwardingEndpoint	string	O endereço IP alocado pelo gateway para o qual as solicitações dns podem ser enviadas.
properties.ipConfigurations	VirtualNetworkGatewayIPConfiguration[]	Configurações de IP para gateway de rede virtual.
properties.natRules	VirtualNetworkGatewayNatRule[]	NatRules para gateway de rede virtual.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de gateway de rede virtual.
properties.resourceGuid	string	A propriedade GUID do recurso de gateway de rede virtual.
properties.sku	VirtualNetworkGatewaySku	A referência ao recurso VirtualNetworkGatewaySku que representa o SKU selecionado para o Gateway de rede virtual.
properties.vNetExtendedLocationResourceId	string	ID do recurso de vnet do cliente. VirtualNetworkGateway do tipo gateway local está associado à vnet do cliente.
properties.virtualNetworkGatewayPolicyGroups	VirtualNetworkGatewayPolicyGroup[]	A referência ao recurso VirtualNetworkGatewayPolicyGroup que representa o VirtualNetworkGatewayPolicyGroup disponível para o gateway.
properties.vpnClientConfiguration	VpnClientConfiguration	A referência ao recurso VpnClientConfiguration que representa as configurações de VpnClient P2S.
properties.vpnGatewayGeneration	VpnGatewayGeneration	A geração deste VirtualNetworkGateway. Deve ser Nenhum se gatewayType não for VPN.
properties.vpnType	VpnType	O tipo desse gateway de rede virtual.
tags	object	Marcas de recurso.
type	string	Tipo de recurso.

VirtualNetworkGatewayAutoScaleBounds

Nome	Tipo	Description
max	integer	Unidades de escala máxima para configuração de dimensionamento automático
min	integer	Unidades de escala mínimas para configuração de dimensionamento automático

VirtualNetworkGatewayAutoScaleConfiguration

Detalhes da Configuração de Dimensionamento Automático do Gateway de Rede Virtual

Nome	Tipo	Description
bounds	VirtualNetworkGatewayAutoScaleBounds	Os limites da configuração de dimensionamento automático

VirtualNetworkGatewayIPConfiguration

Configuração de IP para gateway de rede virtual.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres exclusiva somente leitura que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.privateIPAddress	string	Endereço IP privado para este gateway.
properties.privateIPAllocationMethod	IPAllocationMethod	O método de alocação de endereço IP privado.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de configuração de IP do gateway de rede virtual.
properties.publicIPAddress	SubResource	A referência ao recurso de IP público.
properties.subnet	SubResource	A referência ao recurso de sub-rede.

VirtualNetworkGatewayNatRule

Recurso VirtualNetworkGatewayNatRule.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres exclusiva somente leitura que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.externalMappings	VpnNatRuleMapping[]	O mapeamento externo do endereço IP privado para NAT.
properties.internalMappings	VpnNatRuleMapping[]	O mapeamento interno do endereço IP privado para NAT.
properties.ipConfigurationId	string	A ID de configuração de IP à qual essa regra NAT se aplica.
properties.mode	VpnNatRuleMode	A direção nat de origem de um NAT vpn.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de regra NAT.
properties.type	VpnNatRuleType	O tipo de regra NAT para VPN NAT.
type	string	Tipo de recurso.

VirtualNetworkGatewayPolicyGroup

Parâmetros para VirtualNetworkGatewayPolicyGroup.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres exclusiva somente leitura que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.isDefault	boolean	Mostra se esse é um VirtualNetworkGatewayPolicyGroup padrão ou não.
properties.policyMembers	VirtualNetworkGatewayPolicyGroupMember[]	Vários PolicyMembers para VirtualNetworkGatewayPolicyGroup.
properties.priority	integer	Prioridade para VirtualNetworkGatewayPolicyGroup.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso VirtualNetworkGatewayPolicyGroup.
properties.vngClientConnectionConfigurations	SubResource[]	Lista de referências a vngClientConnectionConfigurations.

VirtualNetworkGatewayPolicyGroupMember

Membro PolicyGroup da configuração de conexão do cliente VPN

Nome	Tipo	Description
attributeType	VpnPolicyMemberAttributeType	O tipo de atributo de membro da Política de Vpn.
attributeValue	string	O valor de Attribute usado para este VirtualNetworkGatewayPolicyGroupMember.
name	string	Nome do VirtualNetworkGatewayPolicyGroupMember.

VirtualNetworkGatewaySku

Detalhes de VirtualNetworkGatewaySku.

Nome	Tipo	Description
capacity	integer	A capacidade.
name	VirtualNetworkGatewaySkuName	Nome do SKU do gateway.
tier	VirtualNetworkGatewaySkuTier	Camada de SKU do gateway.

VirtualNetworkGatewaySkuName

Nome do SKU do gateway.

Nome	Tipo	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

Camada de SKU do gateway.

Nome	Tipo	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

O tipo desse gateway de rede virtual.

Nome	Tipo	Description
ExpressRoute	string
LocalGateway	string
Vpn	string

VngClientConnectionConfiguration

Uma configuração de conexão de cliente vpn para a configuração de conexão do cliente.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso VngClientConnectionConfiguration.
properties.virtualNetworkGatewayPolicyGroups	SubResource[]	Lista de referências a virtualNetworkGatewayPolicyGroups
properties.vpnClientAddressPool	AddressSpace	A referência ao recurso de espaço de endereço que representa o espaço de endereço para VpnClient P2S.

VpnAuthenticationType

Tipos de autenticação VPN para o gateway de rede virtual..

Nome	Tipo	Description
AAD	string
Certificate	string
Radius	string

VpnClientConfiguration

VpnClientConfiguration para o cliente P2S.

Nome	Tipo	Description
aadAudience	string	A propriedade AADAudience do recurso VirtualNetworkGateway para conexão de cliente vpn usada para autenticação do AAD.
aadIssuer	string	A propriedade AADIssuer do recurso VirtualNetworkGateway para conexão de cliente vpn usada para autenticação do AAD.
aadTenant	string	A propriedade AADTenant do recurso VirtualNetworkGateway para conexão de cliente vpn usada para autenticação do AAD.
radiusServerAddress	string	A propriedade de endereço do servidor radius do recurso VirtualNetworkGateway para conexão de cliente vpn.
radiusServerSecret	string	A propriedade de segredo radius do recurso VirtualNetworkGateway para conexão de cliente vpn.
radiusServers	RadiusServer[]	A propriedade radiusServers para configuração de servidor de raio múltiplo.
vngClientConnectionConfigurations	VngClientConnectionConfiguration[]	por política de conexão do pool de endereços IP para o cliente P2S do gateway de rede virtual.
vpnAuthenticationTypes	VpnAuthenticationType[]	Tipos de autenticação VPN para o gateway de rede virtual..
vpnClientAddressPool	AddressSpace	A referência ao recurso de espaço de endereço que representa o Espaço de endereço para VpnClient P2S.
vpnClientIpsecPolicies	IpsecPolicy[]	VpnClientIpsecPolicies para o cliente P2S do gateway de rede virtual.
vpnClientProtocols	VpnClientProtocol[]	VpnClientProtocols para Gateway de rede virtual.
vpnClientRevokedCertificates	VpnClientRevokedCertificate[]	VpnClientRevokedCertificate para Gateway de rede virtual.
vpnClientRootCertificates	VpnClientRootCertificate[]	VpnClientRootCertificate para gateway de rede virtual.

VpnClientProtocol

VpnClientProtocols para gateway de rede virtual.

Nome	Tipo	Description
IkeV2	string
OpenVPN	string
SSTP	string

VpnClientRevokedCertificate

O cliente VPN revogou o certificado do gateway de rede virtual.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de certificado revogado pelo cliente VPN.
properties.thumbprint	string	A impressão digital do certificado do cliente VPN revogada.

VpnClientRootCertificate

Certificado raiz do cliente VPN do gateway de rede virtual.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de certificado raiz do cliente VPN.
properties.publicCertData	string	Os dados públicos do certificado.

VpnGatewayGeneration

A geração deste VirtualNetworkGateway. Deve ser Nenhum se gatewayType não for VPN.

Nome	Tipo	Description
Generation1	string
Generation2	string
None	string

VpnNatRuleMapping

Mapeamento de NatRule de VPN.

Nome	Tipo	Description
addressSpace	string	Espaço de endereço para mapeamento de NatRule de Vpn.
portRange	string	Intervalo de portas para mapeamento de NatRule de Vpn.

VpnNatRuleMode

A direção nat de origem de um NAT vpn.

Nome	Tipo	Description
EgressSnat	string
IngressSnat	string

VpnNatRuleType

O tipo de regra NAT para VPN NAT.

Nome	Tipo	Description
Dynamic	string
Static	string

VpnPolicyMemberAttributeType

O tipo de atributo de membro da Política de Vpn.

Nome	Tipo	Description
AADGroupId	string
CertificateGroupId	string
RadiusAzureGroupId	string

VpnType

O tipo desse gateway de rede virtual.

Nome	Tipo	Description
PolicyBased	string
RouteBased	string