Vpn Gateways - Create Or Update

Serviço:

Virtual WAN

Versão da API:

2024-05-01

Cria um gateway virtual wan vpn se ele não existir, atualiza o gateway existente.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
gatewayName	path	True	string	O nome do gateway.
resourceGroupName	path	True	string	O nome do grupo de recursos do VpnGateway.
subscriptionId	path	True	string	As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
location	True	string	Localização do recurso.
id		string	ID do recurso.
properties.bgpSettings		BgpSettings	Configurações de alto-falante BGP do gateway de rede local.
properties.connections		VpnConnection[]	Lista de todas as conexões vpn para o gateway.
properties.enableBgpRouteTranslationForNat		boolean	Habilite a conversão de rotas BGP para NAT neste VpnGateway.
properties.isRoutingPreferenceInternet		boolean	Habilite a propriedade Routing Preference para a interface IP pública do VpnGateway.
properties.natRules		VpnGatewayNatRule[]	Lista de todas as regras nat associadas ao gateway.
properties.virtualHub		SubResource	O VirtualHub ao qual o gateway pertence.
properties.vpnGatewayScaleUnit		integer	A unidade de escala para este gateway vpn.
tags		object	Tags de recursos.

Respostas

Name	Tipo	Description
200 OK	VpnGateway	Pedido bem-sucedido. Retorna os detalhes do virtual wan vpn Gateway criado ou atualizado.
201 Created	VpnGateway	Pedido bem-sucedido. Retorna os detalhes do gateway virtual wan vpn recuperado.
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

VpnGatewayPut

Pedido de amostra

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1?api-version=2024-05-01

{
  "location": "westcentralus",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "virtualHub": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
    },
    "connections": [
      {
        "name": "vpnConnection1",
        "properties": {
          "remoteVpnSite": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
          },
          "vpnLinkConnections": [
            {
              "name": "Connection-Link1",
              "properties": {
                "vpnSiteLink": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
                },
                "connectionBandwidth": 200,
                "vpnConnectionProtocolType": "IKEv2",
                "sharedKey": "key",
                "egressNatRules": [
                  {
                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"
                  }
                ]
              }
            }
          ]
        }
      }
    ],
    "bgpSettings": {
      "asn": 65515,
      "peerWeight": 0,
      "bgpPeeringAddresses": [
        {
          "ipconfigurationId": "Instance0",
          "customBgpIpAddresses": [
            "169.254.21.5"
          ]
        },
        {
          "ipconfigurationId": "Instance1",
          "customBgpIpAddresses": [
            "169.254.21.10"
          ]
        }
      ]
    },
    "natRules": [
      {
        "name": "nat03",
        "properties": {
          "type": "Static",
          "mode": "EgressSnat",
          "internalMappings": [
            {
              "addressSpace": "0.0.0.0/26"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "192.168.0.0/26"
            }
          ],
          "ipConfigurationId": ""
        }
      }
    ],
    "isRoutingPreferenceInternet": false,
    "enableBgpRouteTranslationForNat": false
  }
}

Java

import com.azure.core.management.SubResource;
import com.azure.resourcemanager.network.fluent.models.VpnConnectionInner;
import com.azure.resourcemanager.network.fluent.models.VpnGatewayInner;
import com.azure.resourcemanager.network.fluent.models.VpnGatewayNatRuleInner;
import com.azure.resourcemanager.network.fluent.models.VpnSiteLinkConnectionInner;
import com.azure.resourcemanager.network.models.BgpSettings;
import com.azure.resourcemanager.network.models.IpConfigurationBgpPeeringAddress;
import com.azure.resourcemanager.network.models.VirtualNetworkGatewayConnectionProtocol;
import com.azure.resourcemanager.network.models.VpnNatRuleMapping;
import com.azure.resourcemanager.network.models.VpnNatRuleMode;
import com.azure.resourcemanager.network.models.VpnNatRuleType;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for VpnGateways CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayPut.json
     */
    /**
     * Sample code: VpnGatewayPut.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnGatewayPut(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnGateways().createOrUpdate("rg1", "gateway1",
            new VpnGatewayInner().withLocation("westcentralus").withTags(mapOf("key1", "fakeTokenPlaceholder"))
                .withVirtualHub(new SubResource().withId(
                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"))
                .withConnections(Arrays.asList(new VpnConnectionInner().withName("vpnConnection1")
                    .withRemoteVpnSite(new SubResource().withId(
                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"))
                    .withVpnLinkConnections(Arrays.asList(new VpnSiteLinkConnectionInner().withName("Connection-Link1")
                        .withVpnSiteLink(new SubResource().withId(
                            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"))
                        .withVpnConnectionProtocolType(VirtualNetworkGatewayConnectionProtocol.IKEV2)
                        .withConnectionBandwidth(200).withSharedKey("fakeTokenPlaceholder")
                        .withEgressNatRules(Arrays.asList(new SubResource().withId(
                            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03")))))))
                .withBgpSettings(new BgpSettings().withAsn(65515L).withPeerWeight(0)
                    .withBgpPeeringAddresses(Arrays.asList(
                        new IpConfigurationBgpPeeringAddress().withIpconfigurationId("Instance0")
                            .withCustomBgpIpAddresses(Arrays.asList("169.254.21.5")),
                        new IpConfigurationBgpPeeringAddress().withIpconfigurationId("Instance1")
                            .withCustomBgpIpAddresses(Arrays.asList("169.254.21.10")))))
                .withEnableBgpRouteTranslationForNat(false).withIsRoutingPreferenceInternet(false)
                .withNatRules(Arrays.asList(new VpnGatewayNatRuleInner().withName("nat03")
                    .withTypePropertiesType(VpnNatRuleType.STATIC).withMode(VpnNatRuleMode.EGRESS_SNAT)
                    .withInternalMappings(Arrays.asList(new VpnNatRuleMapping().withAddressSpace("0.0.0.0/26")))
                    .withExternalMappings(Arrays.asList(new VpnNatRuleMapping().withAddressSpace("192.168.0.0/26")))
                    .withIpConfigurationId(""))),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python vpn_gateway_put.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.vpn_gateways.begin_create_or_update(
        resource_group_name="rg1",
        gateway_name="gateway1",
        vpn_gateway_parameters={
            "location": "westcentralus",
            "properties": {
                "bgpSettings": {
                    "asn": 65515,
                    "bgpPeeringAddresses": [
                        {"customBgpIpAddresses": ["169.254.21.5"], "ipconfigurationId": "Instance0"},
                        {"customBgpIpAddresses": ["169.254.21.10"], "ipconfigurationId": "Instance1"},
                    ],
                    "peerWeight": 0,
                },
                "connections": [
                    {
                        "name": "vpnConnection1",
                        "properties": {
                            "remoteVpnSite": {
                                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
                            },
                            "vpnLinkConnections": [
                                {
                                    "name": "Connection-Link1",
                                    "properties": {
                                        "connectionBandwidth": 200,
                                        "egressNatRules": [
                                            {
                                                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"
                                            }
                                        ],
                                        "sharedKey": "key",
                                        "vpnConnectionProtocolType": "IKEv2",
                                        "vpnSiteLink": {
                                            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
                                        },
                                    },
                                }
                            ],
                        },
                    }
                ],
                "enableBgpRouteTranslationForNat": False,
                "isRoutingPreferenceInternet": False,
                "natRules": [
                    {
                        "name": "nat03",
                        "properties": {
                            "externalMappings": [{"addressSpace": "192.168.0.0/26"}],
                            "internalMappings": [{"addressSpace": "0.0.0.0/26"}],
                            "ipConfigurationId": "",
                            "mode": "EgressSnat",
                            "type": "Static",
                        },
                    }
                ],
                "virtualHub": {
                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
                },
            },
            "tags": {"key1": "value1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayPut.json
if __name__ == "__main__":
    main()

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

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayPut.json
func ExampleVPNGatewaysClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVPNGatewaysClient().BeginCreateOrUpdate(ctx, "rg1", "gateway1", armnetwork.VPNGateway{
		Location: to.Ptr("westcentralus"),
		Tags: map[string]*string{
			"key1": to.Ptr("value1"),
		},
		Properties: &armnetwork.VPNGatewayProperties{
			BgpSettings: &armnetwork.BgpSettings{
				Asn: to.Ptr[int64](65515),
				BgpPeeringAddresses: []*armnetwork.IPConfigurationBgpPeeringAddress{
					{
						CustomBgpIPAddresses: []*string{
							to.Ptr("169.254.21.5")},
						IPConfigurationID: to.Ptr("Instance0"),
					},
					{
						CustomBgpIPAddresses: []*string{
							to.Ptr("169.254.21.10")},
						IPConfigurationID: to.Ptr("Instance1"),
					}},
				PeerWeight: to.Ptr[int32](0),
			},
			Connections: []*armnetwork.VPNConnection{
				{
					Name: to.Ptr("vpnConnection1"),
					Properties: &armnetwork.VPNConnectionProperties{
						RemoteVPNSite: &armnetwork.SubResource{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"),
						},
						VPNLinkConnections: []*armnetwork.VPNSiteLinkConnection{
							{
								Name: to.Ptr("Connection-Link1"),
								Properties: &armnetwork.VPNSiteLinkConnectionProperties{
									ConnectionBandwidth: to.Ptr[int32](200),
									EgressNatRules: []*armnetwork.SubResource{
										{
											ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"),
										}},
									SharedKey:                 to.Ptr("key"),
									VPNConnectionProtocolType: to.Ptr(armnetwork.VirtualNetworkGatewayConnectionProtocolIKEv2),
									VPNSiteLink: &armnetwork.SubResource{
										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"),
									},
								},
							}},
					},
				}},
			EnableBgpRouteTranslationForNat: to.Ptr(false),
			IsRoutingPreferenceInternet:     to.Ptr(false),
			NatRules: []*armnetwork.VPNGatewayNatRule{
				{
					Name: to.Ptr("nat03"),
					Properties: &armnetwork.VPNGatewayNatRuleProperties{
						Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
						ExternalMappings: []*armnetwork.VPNNatRuleMapping{
							{
								AddressSpace: to.Ptr("192.168.0.0/26"),
							}},
						InternalMappings: []*armnetwork.VPNNatRuleMapping{
							{
								AddressSpace: to.Ptr("0.0.0.0/26"),
							}},
						IPConfigurationID: to.Ptr(""),
						Mode:              to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
					},
				}},
			VirtualHub: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VPNGateway = armnetwork.VPNGateway{
	// 	Name: to.Ptr("gateway1"),
	// 	Type: to.Ptr("Microsoft.Network/vpnGateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1"),
	// 	Location: to.Ptr("West US"),
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.VPNGatewayProperties{
	// 		BgpSettings: &armnetwork.BgpSettings{
	// 			Asn: to.Ptr[int64](65514),
	// 			BgpPeeringAddress: to.Ptr("10.0.1.30"),
	// 			BgpPeeringAddresses: []*armnetwork.IPConfigurationBgpPeeringAddress{
	// 				{
	// 					CustomBgpIPAddresses: []*string{
	// 						to.Ptr("169.254.21.5")},
	// 						DefaultBgpIPAddresses: []*string{
	// 							to.Ptr("10.30.0.4")},
	// 							IPConfigurationID: to.Ptr("Instance0"),
	// 							TunnelIPAddresses: []*string{
	// 								to.Ptr("104.208.48.178")},
	// 							},
	// 							{
	// 								CustomBgpIPAddresses: []*string{
	// 									to.Ptr("169.254.21.10")},
	// 									DefaultBgpIPAddresses: []*string{
	// 										to.Ptr("10.30.0.5")},
	// 										IPConfigurationID: to.Ptr("Instance1"),
	// 										TunnelIPAddresses: []*string{
	// 											to.Ptr("104.208.48.179")},
	// 									}},
	// 									PeerWeight: to.Ptr[int32](0),
	// 								},
	// 								Connections: []*armnetwork.VPNConnection{
	// 									{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1"),
	// 										Name: to.Ptr("vpnConnection1"),
	// 										Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 										Properties: &armnetwork.VPNConnectionProperties{
	// 											EgressBytesTransferred: to.Ptr[int64](0),
	// 											EnableInternetSecurity: to.Ptr(false),
	// 											IngressBytesTransferred: to.Ptr[int64](0),
	// 											ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 											RemoteVPNSite: &armnetwork.SubResource{
	// 												ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"),
	// 											},
	// 											RoutingConfiguration: &armnetwork.RoutingConfiguration{
	// 												AssociatedRouteTable: &armnetwork.SubResource{
	// 													ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"),
	// 												},
	// 												PropagatedRouteTables: &armnetwork.PropagatedRouteTable{
	// 													IDs: []*armnetwork.SubResource{
	// 														{
	// 															ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"),
	// 														},
	// 														{
	// 															ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2"),
	// 														},
	// 														{
	// 															ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3"),
	// 													}},
	// 													Labels: []*string{
	// 														to.Ptr("label1"),
	// 														to.Ptr("label2")},
	// 													},
	// 													VnetRoutes: &armnetwork.VnetRoute{
	// 														StaticRoutes: []*armnetwork.StaticRoute{
	// 														},
	// 													},
	// 												},
	// 												VPNLinkConnections: []*armnetwork.VPNSiteLinkConnection{
	// 													{
	// 														ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1"),
	// 														Name: to.Ptr("Connection-Link1"),
	// 														Type: to.Ptr("Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"),
	// 														Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 														Properties: &armnetwork.VPNSiteLinkConnectionProperties{
	// 															ConnectionBandwidth: to.Ptr[int32](200),
	// 															EgressBytesTransferred: to.Ptr[int64](0),
	// 															EgressNatRules: []*armnetwork.SubResource{
	// 																{
	// 																	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"),
	// 															}},
	// 															EnableBgp: to.Ptr(false),
	// 															EnableRateLimiting: to.Ptr(false),
	// 															IngressBytesTransferred: to.Ptr[int64](0),
	// 															IPSecPolicies: []*armnetwork.IPSecPolicy{
	// 															},
	// 															ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 															RoutingWeight: to.Ptr[int32](0),
	// 															SharedKey: to.Ptr("key"),
	// 															UseLocalAzureIPAddress: to.Ptr(false),
	// 															UsePolicyBasedTrafficSelectors: to.Ptr(false),
	// 															VPNConnectionProtocolType: to.Ptr(armnetwork.VirtualNetworkGatewayConnectionProtocolIKEv2),
	// 															VPNSiteLink: &armnetwork.SubResource{
	// 																ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"),
	// 															},
	// 														},
	// 												}},
	// 											},
	// 									}},
	// 									IsRoutingPreferenceInternet: to.Ptr(false),
	// 									NatRules: []*armnetwork.VPNGatewayNatRule{
	// 										{
	// 											ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"),
	// 											Name: to.Ptr("nat03"),
	// 											Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 											Properties: &armnetwork.VPNGatewayNatRuleProperties{
	// 												Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 												EgressVPNSiteLinkConnections: []*armnetwork.SubResource{
	// 													{
	// 														ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1"),
	// 												}},
	// 												ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 													{
	// 														AddressSpace: to.Ptr("192.168.0.0/26"),
	// 												}},
	// 												InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 													{
	// 														AddressSpace: to.Ptr("0.0.0.0/26"),
	// 												}},
	// 												Mode: to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
	// 											},
	// 									}},
	// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 									VirtualHub: &armnetwork.SubResource{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"),
	// 									},
	// 								},
	// 							}
}

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

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.
 *
 * @summary Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayPut.json
 */
async function vpnGatewayPut() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const gatewayName = "gateway1";
  const vpnGatewayParameters = {
    bgpSettings: {
      asn: 65515,
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: ["169.254.21.5"],
          ipconfigurationId: "Instance0",
        },
        {
          customBgpIpAddresses: ["169.254.21.10"],
          ipconfigurationId: "Instance1",
        },
      ],
      peerWeight: 0,
    },
    connections: [
      {
        name: "vpnConnection1",
        remoteVpnSite: {
          id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
        },
        vpnLinkConnections: [
          {
            name: "Connection-Link1",
            connectionBandwidth: 200,
            egressNatRules: [
              {
                id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03",
              },
            ],
            sharedKey: "key",
            vpnConnectionProtocolType: "IKEv2",
            vpnSiteLink: {
              id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1",
            },
          },
        ],
      },
    ],
    enableBgpRouteTranslationForNat: false,
    isRoutingPreferenceInternet: false,
    location: "westcentralus",
    natRules: [
      {
        name: "nat03",
        typePropertiesType: "Static",
        externalMappings: [{ addressSpace: "192.168.0.0/26" }],
        internalMappings: [{ addressSpace: "0.0.0.0/26" }],
        ipConfigurationId: "",
        mode: "EgressSnat",
      },
    ],
    tags: { key1: "value1" },
    virtualHub: {
      id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.vpnGateways.beginCreateOrUpdateAndWait(
    resourceGroupName,
    gatewayName,
    vpnGatewayParameters,
  );
  console.log(result);
}

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

Resposta da amostra

Código de estado:

200

{
  "name": "gateway1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "type": "Microsoft.Network/vpnGateways",
  "properties": {
    "provisioningState": "Succeeded",
    "virtualHub": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
    },
    "connections": [
      {
        "name": "vpnConnection1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "properties": {
          "provisioningState": "Succeeded",
          "remoteVpnSite": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
          },
          "enableInternetSecurity": false,
          "ingressBytesTransferred": 0,
          "egressBytesTransferred": 0,
          "vpnLinkConnections": [
            {
              "name": "Connection-Link1",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
              "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
              "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
              "properties": {
                "provisioningState": "Succeeded",
                "vpnSiteLink": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
                },
                "connectionBandwidth": 200,
                "ipsecPolicies": [],
                "vpnConnectionProtocolType": "IKEv2",
                "sharedKey": "key",
                "ingressBytesTransferred": 0,
                "egressBytesTransferred": 0,
                "enableBgp": false,
                "enableRateLimiting": false,
                "useLocalAzureIpAddress": false,
                "usePolicyBasedTrafficSelectors": false,
                "routingWeight": 0,
                "egressNatRules": [
                  {
                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"
                  }
                ]
              }
            }
          ],
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
            },
            "propagatedRouteTables": {
              "labels": [
                "label1",
                "label2"
              ],
              "ids": [
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
                },
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2"
                },
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3"
                }
              ]
            },
            "vnetRoutes": {
              "staticRoutes": []
            }
          }
        }
      }
    ],
    "bgpSettings": {
      "asn": 65514,
      "bgpPeeringAddress": "10.0.1.30",
      "peerWeight": 0,
      "bgpPeeringAddresses": [
        {
          "ipconfigurationId": "Instance0",
          "defaultBgpIpAddresses": [
            "10.30.0.4"
          ],
          "customBgpIpAddresses": [
            "169.254.21.5"
          ],
          "tunnelIpAddresses": [
            "104.208.48.178"
          ]
        },
        {
          "ipconfigurationId": "Instance1",
          "defaultBgpIpAddresses": [
            "10.30.0.5"
          ],
          "customBgpIpAddresses": [
            "169.254.21.10"
          ],
          "tunnelIpAddresses": [
            "104.208.48.179"
          ]
        }
      ]
    },
    "natRules": [
      {
        "name": "nat03",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "properties": {
          "type": "Static",
          "mode": "EgressSnat",
          "internalMappings": [
            {
              "addressSpace": "0.0.0.0/26"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "192.168.0.0/26"
            }
          ],
          "egressVpnSiteLinkConnections": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1"
            }
          ]
        }
      }
    ],
    "isRoutingPreferenceInternet": false
  }
}

Código de estado:

201

{
  "name": "gateway1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "type": "Microsoft.Network/vpnGateways",
  "properties": {
    "provisioningState": "Succeeded",
    "virtualHub": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
    },
    "connections": [
      {
        "name": "vpnConnection1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "properties": {
          "provisioningState": "Succeeded",
          "remoteVpnSite": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
          },
          "enableInternetSecurity": false,
          "ingressBytesTransferred": 0,
          "egressBytesTransferred": 0,
          "vpnLinkConnections": [
            {
              "name": "Connection-Link1",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
              "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
              "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
              "properties": {
                "provisioningState": "Succeeded",
                "vpnSiteLink": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
                },
                "connectionBandwidth": 200,
                "ipsecPolicies": [],
                "vpnConnectionProtocolType": "IKEv2",
                "sharedKey": "key",
                "ingressBytesTransferred": 0,
                "egressBytesTransferred": 0,
                "enableBgp": false,
                "enableRateLimiting": false,
                "useLocalAzureIpAddress": false,
                "usePolicyBasedTrafficSelectors": false,
                "routingWeight": 0,
                "egressNatRules": [
                  {
                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"
                  }
                ]
              }
            }
          ],
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
            },
            "propagatedRouteTables": {
              "labels": [
                "label1",
                "label2"
              ],
              "ids": [
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
                },
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2"
                },
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3"
                }
              ]
            },
            "vnetRoutes": {
              "staticRoutes": []
            }
          }
        }
      }
    ],
    "bgpSettings": {
      "asn": 65514,
      "bgpPeeringAddress": "10.0.1.30",
      "peerWeight": 0,
      "bgpPeeringAddresses": [
        {
          "ipconfigurationId": "Instance0",
          "defaultBgpIpAddresses": [
            "10.30.0.4"
          ],
          "customBgpIpAddresses": [
            "169.254.21.5"
          ],
          "tunnelIpAddresses": [
            "104.208.48.178"
          ]
        },
        {
          "ipconfigurationId": "Instance1",
          "defaultBgpIpAddresses": [
            "10.30.0.5"
          ],
          "customBgpIpAddresses": [
            "169.254.21.10"
          ],
          "tunnelIpAddresses": [
            "104.208.48.179"
          ]
        }
      ]
    },
    "natRules": [
      {
        "name": "nat03",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "properties": {
          "type": "Static",
          "mode": "EgressSnat",
          "internalMappings": [
            {
              "addressSpace": "0.0.0.0/26"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "192.168.0.0/26"
            }
          ],
          "egressVpnSiteLinkConnections": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1"
            }
          ]
        }
      }
    ],
    "isRoutingPreferenceInternet": false
  }
}

Definições

Name	Description
BgpSettings	Detalhes das configurações do BGP.
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
DhGroup	Os Grupos DH utilizados na Fase 1 do IKE para a SA inicial.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration para uma conexão de gateway de rede virtual.
IkeEncryption	O algoritmo de encriptação IKE (fase 2 IKE).
IkeIntegrity	O algoritmo de integridade IKE (fase 2 do IKE).
IPConfigurationBgpPeeringAddress	Propriedades de IPConfigurationBgpPeeringAddress.
IpsecEncryption	O algoritmo de encriptação IPSec (IKE fase 1).
IpsecIntegrity	O algoritmo de integridade IPSec (IKE fase 1).
IpsecPolicy	Uma configuração de Diretiva IPSec para uma conexão de gateway de rede virtual.
PfsGroup	Os Grupos Pfs usados na Fase 2 do IKE para a nova SA infantil.
PropagatedRouteTable	A lista de RouteTables para anunciar as rotas.
ProvisioningState	O estado de provisionamento atual.
RoutingConfiguration	Configuração de Roteamento indicando as tabelas de rotas associadas e propagadas para essa conexão.
StaticRoute	Lista de todas as rotas estáticas.
StaticRoutesConfig	Configuração para rotas estáticas neste HubVnetConnectionConfiguration para rotas estáticas neste HubVnetConnection.
SubResource	Referência a outro subrecurso.
TrafficSelectorPolicy	Uma política de seletor de tráfego para uma conexão de gateway de rede virtual.
VirtualNetworkGatewayConnectionProtocol	Protocolo de conexão usado para essa conexão.
VnetLocalRouteOverrideCriteria	Parâmetro que determina se o NVA no spoke vnet é ignorado para o tráfego com destino no spoke vnet.
VnetRoute	Lista de rotas que controlam o roteamento do VirtualHub para uma conexão de rede virtual.
VpnConnection	Recurso VpnConnection.
VpnConnectionStatus	O estado atual da conexão vpn.
VpnGateway	Recurso VpnGateway.
VpnGatewayIpConfiguration	Configuração de IP de um recurso de gateway VPN.
VpnGatewayNatRule	Recurso VpnGatewayNatRule.
VpnLinkConnectionMode	Modo de conexão de link vpn.
VpnNatRuleMapping	Mapeamento Vpn NatRule.
VpnNatRuleMode	A direção NAT de origem de um NAT VPN.
VpnNatRuleType	O tipo de regra NAT para NAT VPN.
VpnSiteLinkConnection	Recurso VpnSiteLinkConnection.

BgpSettings

Detalhes das configurações do BGP.

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

CloudError

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Corpo do erro na nuvem.

CloudErrorBody

Uma resposta de erro do serviço.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

DhGroup

Os Grupos DH utilizados na Fase 1 do IKE para a SA inicial.

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

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration para uma conexão de gateway de rede virtual.

Name	Tipo	Description
customBgpIpAddress	string	O BgpPeeringAddress personalizado que pertence a IpconfigurationId.
ipConfigurationId	string	O IpconfigurationId de ipconfiguration que pertence ao gateway.

IkeEncryption

O algoritmo de encriptação IKE (fase 2 IKE).

Name	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).

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

IPConfigurationBgpPeeringAddress

Propriedades de IPConfigurationBgpPeeringAddress.

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

IpsecEncryption

O algoritmo de encriptação IPSec (IKE fase 1).

Name	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 (IKE fase 1).

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

IpsecPolicy

Uma configuração de Diretiva IPSec para uma conexão de gateway de rede virtual.

Name	Tipo	Description
dhGroup	DhGroup	O Grupo DH utilizado na Fase 1 do IKE para a SA inicial.
ikeEncryption	IkeEncryption	O algoritmo de encriptação IKE (fase 2 IKE).
ikeIntegrity	IkeIntegrity	O algoritmo de integridade IKE (fase 2 do IKE).
ipsecEncryption	IpsecEncryption	O algoritmo de encriptação IPSec (IKE fase 1).
ipsecIntegrity	IpsecIntegrity	O algoritmo de integridade IPSec (IKE fase 1).
pfsGroup	PfsGroup	O Grupo Pfs usado na Fase 2 do IKE para a nova criança SA.
saDataSizeKilobytes	integer	O tamanho da carga útil da Associação de Segurança IPSec (também chamada de Modo Rápido ou SA de 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 de Fase 2) é executado em segundos para um túnel VPN site a site.

PfsGroup

Os Grupos Pfs usados na Fase 2 do IKE para a nova SA infantil.

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

PropagatedRouteTable

A lista de RouteTables para anunciar as rotas.

Name	Tipo	Description
ids	SubResource[]	A lista de ids de recursos de todas as RouteTables.
labels	string[]	A lista de rótulos.

ProvisioningState

O estado de provisionamento atual.

Name	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingConfiguration

Configuração de Roteamento indicando as tabelas de rotas associadas e propagadas para essa conexão.

Name	Tipo	Description
associatedRouteTable	SubResource	A id do recurso RouteTable associada a esta RoutingConfiguration.
inboundRouteMap	SubResource	A id de recurso do RouteMap associada a esta RoutingConfiguration para rotas aprendidas de entrada.
outboundRouteMap	SubResource	A id de recurso do RouteMap associada a esta RoutingConfiguration para rotas anunciadas de saída.
propagatedRouteTables	PropagatedRouteTable	A lista de RouteTables para anunciar as rotas.
vnetRoutes	VnetRoute	Lista de rotas que controlam o roteamento do VirtualHub para uma conexão de rede virtual.

StaticRoute

Lista de todas as rotas estáticas.

Name	Tipo	Description
addressPrefixes	string[]	Lista de todos os prefixos de endereço.
name	string	O nome do StaticRoute que é exclusivo dentro de um VnetRoute.
nextHopIpAddress	string	O endereço ip do próximo salto.

StaticRoutesConfig

Configuração para rotas estáticas neste HubVnetConnectionConfiguration para rotas estáticas neste HubVnetConnection.

Name	Tipo	Description
propagateStaticRoutes	boolean	Booleano indicando se as rotas estáticas nesta conexão são propagadas automaticamente para tabelas de rotas para as quais essa conexão se propaga.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Parâmetro que determina se o NVA na vnet spoke é ignorado para o tráfego com destino em spoke.

SubResource

Referência a outro subrecurso.

Name	Tipo	Description
id	string	ID do recurso.

TrafficSelectorPolicy

Uma política de seletor de tráfego para uma conexão de gateway de rede virtual.

Name	Tipo	Description
localAddressRanges	string[]	Uma coleção de espaços de endereço local no formato CIDR.
remoteAddressRanges	string[]	Uma coleção de espaços de endereço remoto no formato CIDR.

VirtualNetworkGatewayConnectionProtocol

Protocolo de conexão usado para essa conexão.

Name	Tipo	Description
IKEv1	string
IKEv2	string

VnetLocalRouteOverrideCriteria

Parâmetro que determina se o NVA no spoke vnet é ignorado para o tráfego com destino no spoke vnet.

Name	Tipo	Description
Contains	string
Equal	string

VnetRoute

Lista de rotas que controlam o roteamento do VirtualHub para uma conexão de rede virtual.

Name	Tipo	Description
bgpConnections	SubResource[]	A lista de referências a objetos HubBgpConnection.
staticRoutes	StaticRoute[]	Lista de todas as rotas estáticas.
staticRoutesConfig	StaticRoutesConfig	Configuração para rotas estáticas neste HubVnetConnection.

VpnConnection

Recurso VpnConnection.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.connectionBandwidth	integer	Largura de banda esperada em MBPS.
properties.connectionStatus	VpnConnectionStatus	O status da conexão.
properties.dpdTimeoutSeconds	integer	Tempo limite do DPD em segundos para conexão vpn.
properties.egressBytesTransferred	integer	Bytes de saída transferidos.
properties.enableBgp	boolean	Sinalizador EnableBgp.
properties.enableInternetSecurity	boolean	Habilite a segurança na Internet.
properties.enableRateLimiting	boolean	Sinalizador EnableBgp.
properties.ingressBytesTransferred	integer	Entrada de bytes transferidos.
properties.ipsecPolicies	IpsecPolicy[]	As políticas IPSec a serem consideradas por esta ligação.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de conexão VPN.
properties.remoteVpnSite	SubResource	ID do site vpn conectado.
properties.routingConfiguration	RoutingConfiguration	A Configuração de Roteamento indica as tabelas de rotas associadas e propagadas nessa conexão.
properties.routingWeight	integer	Peso de roteamento para conexão vpn.
properties.sharedKey	string	SharedKey para a conexão vpn.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	As Políticas do Seletor de Tráfego a serem consideradas por essa conexão.
properties.useLocalAzureIpAddress	boolean	Use o azure ip local para iniciar a conexão.
properties.usePolicyBasedTrafficSelectors	boolean	Habilite seletores de tráfego baseados em políticas.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Protocolo de conexão usado para essa conexão.
properties.vpnLinkConnections	VpnSiteLinkConnection[]	Lista de todas as conexões de link de site vpn para o gateway.

VpnConnectionStatus

O estado atual da conexão vpn.

Name	Tipo	Description
Connected	string
Connecting	string
NotConnected	string
Unknown	string

VpnGateway

Recurso VpnGateway.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
location	string	Localização do recurso.
name	string	Nome do recurso.
properties.bgpSettings	BgpSettings	Configurações de alto-falante BGP do gateway de rede local.
properties.connections	VpnConnection[]	Lista de todas as conexões vpn para o gateway.
properties.enableBgpRouteTranslationForNat	boolean	Habilite a conversão de rotas BGP para NAT neste VpnGateway.
properties.ipConfigurations	VpnGatewayIpConfiguration[]	Lista de todos os IPs configurados no gateway.
properties.isRoutingPreferenceInternet	boolean	Habilite a propriedade Routing Preference para a interface IP pública do VpnGateway.
properties.natRules	VpnGatewayNatRule[]	Lista de todas as regras nat associadas ao gateway.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de gateway VPN.
properties.virtualHub	SubResource	O VirtualHub ao qual o gateway pertence.
properties.vpnGatewayScaleUnit	integer	A unidade de escala para este gateway vpn.
tags	object	Tags de recursos.
type	string	Tipo de recurso.

VpnGatewayIpConfiguration

Configuração de IP de um recurso de gateway VPN.

Name	Tipo	Description
id	string	O identificador da configuração IP para um Gateway VPN.
privateIpAddress	string	O endereço IP privado desta configuração IP.
publicIpAddress	string	O endereço IP público desta configuração IP.

VpnGatewayNatRule

Recurso VpnGatewayNatRule.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.egressVpnSiteLinkConnections	SubResource[]	Lista de saídas VpnSiteLinkConnections.
properties.externalMappings	VpnNatRuleMapping[]	O mapeamento externo do endereço IP privado para NAT.
properties.ingressVpnSiteLinkConnections	SubResource[]	Lista de ingress VpnSiteLinkConnections.
properties.internalMappings	VpnNatRuleMapping[]	O mapeamento interno do endereço IP privado para NAT.
properties.ipConfigurationId	string	O ID de configuração IP ao qual esta 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 Regra NAT.
properties.type	VpnNatRuleType	O tipo de regra NAT para NAT VPN.
type	string	Tipo de recurso.

VpnLinkConnectionMode

Modo de conexão de link vpn.

Name	Tipo	Description
Default	string
InitiatorOnly	string
ResponderOnly	string

VpnNatRuleMapping

Mapeamento Vpn NatRule.

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

VpnNatRuleMode

A direção NAT de origem de um NAT VPN.

Name	Tipo	Description
EgressSnat	string
IngressSnat	string

VpnNatRuleType

O tipo de regra NAT para NAT VPN.

Name	Tipo	Description
Dynamic	string
Static	string

VpnSiteLinkConnection

Recurso VpnSiteLinkConnection.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.connectionBandwidth	integer	Largura de banda esperada em MBPS.
properties.connectionStatus	VpnConnectionStatus	O status da conexão.
properties.dpdTimeoutSeconds	integer	Tempo limite de deteção de peer inativo em segundos para conexão VpnLink.
properties.egressBytesTransferred	integer	Bytes de saída transferidos.
properties.egressNatRules	SubResource[]	Lista de NatRules de saída.
properties.enableBgp	boolean	Sinalizador EnableBgp.
properties.enableRateLimiting	boolean	Sinalizador EnableBgp.
properties.ingressBytesTransferred	integer	Entrada de bytes transferidos.
properties.ingressNatRules	SubResource[]	Lista de ingress NatRules.
properties.ipsecPolicies	IpsecPolicy[]	As políticas IPSec a serem consideradas por esta ligação.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de conexão de link de site VPN.
properties.routingWeight	integer	Peso de roteamento para conexão vpn.
properties.sharedKey	string	SharedKey para a conexão vpn.
properties.useLocalAzureIpAddress	boolean	Use o azure ip local para iniciar a conexão.
properties.usePolicyBasedTrafficSelectors	boolean	Habilite seletores de tráfego baseados em políticas.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Protocolo de conexão usado para essa conexão.
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	vpnGatewayCustomBgpAddresses usado por esta conexão.
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	Modo de conexão de link vpn.
properties.vpnSiteLink	SubResource	ID do link do site vpn conectado.
type	string	Tipo de recurso.