Virtual Network Gateways - Get

Service:

Network Gateway

API Version:

2023-09-01

Ottiene il gateway di rete virtuale specificato in base al gruppo di risorse.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse.
subscriptionId	path	True	string	Credenziali della sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
virtualNetworkGatewayName	path	True	string	Nome del gateway di rete virtuale.
api-version	query	True	string	Versione API client.

Risposte

Nome	Tipo	Descrizione
200 OK	VirtualNetworkGateway	Richiesta riuscita. L'operazione restituisce una risorsa VirtualNetworkGateway.
Other Status Codes	CloudError	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

GetVirtualNetworkGateway

GetVirtualNetworkScalableGateway

GetVirtualNetworkGateway

Sample Request

HTTP

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

Java

/**
 * Samples for VirtualNetworkGateways GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGet.json
     */
    /**
     * Sample code: GetVirtualNetworkGateway.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVirtualNetworkGateway(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualNetworkGateways().getByResourceGroupWithResponse("rg1",
            "vpngw", 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_get.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.get(
        resource_group_name="rg1",
        virtual_network_gateway_name="vpngw",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGet.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/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/VirtualNetworkGatewayGet.json
func ExampleVirtualNetworkGatewaysClient_Get_getVirtualNetworkGateway() {
	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)
	}
	res, err := clientFactory.NewVirtualNetworkGatewaysClient().Get(ctx, "rg1", "vpngw", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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](65514),
	// 			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),
	// 						EnablePrivateIPAddress: to.Ptr(false),
	// 						GatewayType: to.Ptr(armnetwork.VirtualNetworkGatewayTypeVPN),
	// 						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"),
	// 								Etag: to.Ptr("W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\""),
	// 								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"),
	// 									}},
	// 									Mode: to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
	// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 								},
	// 							},
	// 							{
	// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2"),
	// 								Name: to.Ptr("natRule2"),
	// 								Etag: to.Ptr("W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\""),
	// 								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"),
	// 									}},
	// 									Mode: to.Ptr(armnetwork.VPNNatRuleModeIngressSnat),
	// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 								},
	// 						}},
	// 						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.1.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 Gets the specified virtual network gateway by resource group.
 *
 * @summary Gets the specified virtual network gateway by resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGet.json
 */
async function getVirtualNetworkGateway() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkGatewayName = "vpngw";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualNetworkGateways.get(
    resourceGroupName,
    virtualNetworkGatewayName,
  );
  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;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGet.json
// this example is just showing the usage of "VirtualNetworkGateways_Get" 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 VirtualNetworkGatewayResource created on azure
// for more information of creating VirtualNetworkGatewayResource, please refer to the document of VirtualNetworkGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string virtualNetworkGatewayName = "vpngw";
ResourceIdentifier virtualNetworkGatewayResourceId = VirtualNetworkGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualNetworkGatewayName);
VirtualNetworkGatewayResource virtualNetworkGateway = client.GetVirtualNetworkGatewayResource(virtualNetworkGatewayResourceId);

// invoke the operation
VirtualNetworkGatewayResource result = await virtualNetworkGateway.GetAsync();

// 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",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "EgressSnat",
          "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",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "IngressSnat",
          "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,
    "enablePrivateIpAddress": false,
    "activeActive": false,
    "disableIPSecReplayProtection": false,
    "vpnClientConfiguration": {
      "vpnClientProtocols": [
        "OpenVPN"
      ],
      "vpnClientRootCertificates": [],
      "vpnClientRevokedCertificates": [],
      "radiusServers": [
        {
          "radiusServerAddress": "10.1.0.0",
          "radiusServerScore": 20
        }
      ]
    },
    "bgpSettings": {
      "asn": 65514,
      "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
  }
}

GetVirtualNetworkScalableGateway

Sample Request

HTTP

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

Java

/**
 * Samples for VirtualNetworkGateways GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * VirtualNetworkScalableGatewayGet.json
     */
    /**
     * Sample code: GetVirtualNetworkScalableGateway.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVirtualNetworkScalableGateway(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualNetworkGateways().getByResourceGroupWithResponse("rg1",
            "ergw", 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_get.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.get(
        resource_group_name="rg1",
        virtual_network_gateway_name="ergw",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkScalableGatewayGet.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/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/VirtualNetworkScalableGatewayGet.json
func ExampleVirtualNetworkGatewaysClient_Get_getVirtualNetworkScalableGateway() {
	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)
	}
	res, err := clientFactory.NewVirtualNetworkGatewaysClient().Get(ctx, "rg1", "ergw", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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),
	// 		EnablePrivateIPAddress: 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.IPAllocationMethodStatic),
	// 					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"),
	// 				Etag: to.Ptr("W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\""),
	// 				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"),
	// 					}},
	// 					Mode: to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				},
	// 			},
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2"),
	// 				Name: to.Ptr("natRule2"),
	// 				Etag: to.Ptr("W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\""),
	// 				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"),
	// 					}},
	// 					Mode: to.Ptr(armnetwork.VPNNatRuleModeIngressSnat),
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				},
	// 		}},
	// 		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](2),
	// 			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 Gets the specified virtual network gateway by resource group.
 *
 * @summary Gets the specified virtual network gateway by resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkScalableGatewayGet.json
 */
async function getVirtualNetworkScalableGateway() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkGatewayName = "ergw";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualNetworkGateways.get(
    resourceGroupName,
    virtualNetworkGatewayName,
  );
  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;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkScalableGatewayGet.json
// this example is just showing the usage of "VirtualNetworkGateways_Get" 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 VirtualNetworkGatewayResource created on azure
// for more information of creating VirtualNetworkGatewayResource, please refer to the document of VirtualNetworkGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string virtualNetworkGatewayName = "ergw";
ResourceIdentifier virtualNetworkGatewayResourceId = VirtualNetworkGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualNetworkGatewayName);
VirtualNetworkGatewayResource virtualNetworkGateway = client.GetVirtualNetworkGatewayResource(virtualNetworkGatewayResourceId);

// invoke the operation
VirtualNetworkGatewayResource result = await virtualNetworkGateway.GetAsync();

// 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": "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",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "EgressSnat",
          "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",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "IngressSnat",
          "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",
    "vpnGatewayGeneration": "None",
    "enableBgp": false,
    "enablePrivateIpAddress": false,
    "activeActive": false,
    "disableIPSecReplayProtection": false,
    "vpnClientConfiguration": null,
    "bgpSettings": null,
    "customRoutes": null,
    "allowVirtualWanTraffic": false,
    "allowRemoteVnetTraffic": false
  }
}

Definizioni

Nome	Descrizione
AddressSpace	AddressSpace contiene una matrice di intervalli di indirizzi IP che possono essere usati dalle subnet della rete virtuale.
adminState	Proprietà per indicare se il gateway Express Route serve il traffico quando sono presenti più gateway express route nella rete virtuale
BgpSettings	Dettagli delle impostazioni BGP.
CloudError	Risposta di errore dal servizio.
CloudErrorBody	Risposta di errore dal servizio.
DhGroup	I gruppi di DH usati nella fase 1 di IKE per la sa iniziale.
ExtendedLocation	Tipo complesso ExtendedLocation.
ExtendedLocationTypes	Tipo della posizione estesa.
IkeEncryption	Algoritmo di crittografia IKE (fase 2).
IkeIntegrity	Algoritmo di integrità IKE (fase 2).
IPAllocationMethod	Metodo di allocazione degli indirizzi IP.
IPConfigurationBgpPeeringAddress	Proprietà di IPConfigurationBgpPeeringAddress.
IpsecEncryption	Algoritmo di crittografia IPSec (fase 1).
IpsecIntegrity	Algoritmo di integrità IPSec (fase IKE 1).
IpsecPolicy	Configurazione dei criteri IPSec per una connessione gateway di rete virtuale.
PfsGroup	I gruppi Pfs usati nella fase 2 di IKE per la nuova sa figlio.
ProvisioningState	Stato di provisioning corrente.
RadiusServer	Impostazioni del server Radius.
SubResource	Riferimento a un'altra sottorisorsa.
VirtualNetworkGateway	Classe comune per informazioni generali sulle risorse.
VirtualNetworkGatewayAutoScaleBounds
VirtualNetworkGatewayAutoScaleConfiguration	Dettagli di configurazione della scalabilità automatica del gateway Rete virtuale
VirtualNetworkGatewayIPConfiguration	Configurazione IP per il gateway di rete virtuale.
VirtualNetworkGatewayNatRule	Risorsa VirtualNetworkGatewayNatRule.
VirtualNetworkGatewayPolicyGroup	Parametri per VirtualNetworkGatewayPolicyGroup.
VirtualNetworkGatewayPolicyGroupMember	Membro PolicyGroup di configurazione connessione client VPN
VirtualNetworkGatewaySku	Dettagli di VirtualNetworkGatewaySku.
VirtualNetworkGatewaySkuName	Nome SKU del gateway.
VirtualNetworkGatewaySkuTier	Livello SKU del gateway.
VirtualNetworkGatewayType	Tipo di gateway di rete virtuale.
VngClientConnectionConfiguration	Configurazione della connessione client VPN per la configurazione della connessione client.
VpnAuthenticationType	Tipi di autenticazione VPN per il gateway di rete virtuale.
VpnClientConfiguration	VpnClientConfiguration per il client da sito a sito.
VpnClientProtocol	VpnClientProtocols per il gateway di rete virtuale.
VpnClientRevokedCertificate	Il client VPN ha revocato il certificato del gateway di rete virtuale.
VpnClientRootCertificate	Certificato radice del client VPN del gateway di rete virtuale.
VpnGatewayGeneration	Generazione per virtualNetworkGateway. Deve essere Nessuno se gatewayType non è VPN.
VpnNatRuleMapping	Mapping vpn NatRule.
VpnNatRuleMode	Direzione NAT di origine di un NAT VPN.
VpnNatRuleType	Tipo di regola NAT per NAT VPN.
VpnPolicyMemberAttributeType	Tipo di attributo membro di Criteri VPN.
VpnType	Tipo di gateway di rete virtuale.

AddressSpace

AddressSpace contiene una matrice di intervalli di indirizzi IP che possono essere usati dalle subnet della rete virtuale.

Nome	Tipo	Descrizione
addressPrefixes	string[]	Elenco di blocchi di indirizzi riservati per questa rete virtuale nella notazione CIDR.

adminState

Proprietà per indicare se il gateway Express Route serve il traffico quando sono presenti più gateway express route nella rete virtuale

Nome	Tipo	Descrizione
Disabled	string
Enabled	string

BgpSettings

Dettagli delle impostazioni BGP.

Nome	Tipo	Descrizione
asn	integer	AsN dell'altoparlante BGP.
bgpPeeringAddress	string	L'indirizzo di peering BGP e l'identificatore BGP di questo altoparlante BGP.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	Indirizzo di peering BGP con ID di configurazione IP per il gateway di rete virtuale.
peerWeight	integer	Peso aggiunto alle route apprese da questo altoparlante BGP.

CloudError

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	CloudErrorBody	Corpo dell'errore cloud.

CloudErrorBody

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere usati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in caso di errore.

DhGroup

I gruppi di DH usati nella fase 1 di IKE per la sa iniziale.

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

ExtendedLocation

Tipo complesso ExtendedLocation.

Nome	Tipo	Descrizione
name	string	Nome della posizione estesa.
type	ExtendedLocationTypes	Tipo della posizione estesa.

ExtendedLocationTypes

Tipo della posizione estesa.

Nome	Tipo	Descrizione
EdgeZone	string

IkeEncryption

Algoritmo di crittografia IKE (fase 2).

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

IkeIntegrity

Algoritmo di integrità IKE (fase 2).

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

IPAllocationMethod

Metodo di allocazione degli indirizzi IP.

Nome	Tipo	Descrizione
Dynamic	string
Static	string

IPConfigurationBgpPeeringAddress

Proprietà di IPConfigurationBgpPeeringAddress.

Nome	Tipo	Descrizione
customBgpIpAddresses	string[]	Elenco di indirizzi di peering BGP personalizzati che appartengono alla configurazione IP.
defaultBgpIpAddresses	string[]	Elenco degli indirizzi di peering BGP predefiniti che appartengono alla configurazione IP.
ipconfigurationId	string	ID della configurazione IP che appartiene al gateway.
tunnelIpAddresses	string[]	Elenco di indirizzi IP pubblici del tunnel che appartengono alla configurazione IP.

IpsecEncryption

Algoritmo di crittografia IPSec (fase 1).

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

IpsecIntegrity

Algoritmo di integrità IPSec (fase IKE 1).

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

IpsecPolicy

Configurazione dei criteri IPSec per una connessione gateway di rete virtuale.

Nome	Tipo	Descrizione
dhGroup	DhGroup	Il gruppo DH usato nella fase 1 di IKE per la sa iniziale.
ikeEncryption	IkeEncryption	Algoritmo di crittografia IKE (fase 2).
ikeIntegrity	IkeIntegrity	Algoritmo di integrità IKE (fase 2).
ipsecEncryption	IpsecEncryption	Algoritmo di crittografia IPSec (fase 1).
ipsecIntegrity	IpsecIntegrity	Algoritmo di integrità IPSec (fase IKE 1).
pfsGroup	PfsGroup	Il gruppo Pfs usato nella fase 2 di IKE per la nuova sa figlio.
saDataSizeKilobytes	integer	L'associazione di sicurezza IPSec (denominata anche modalità rapida o fase 2 SA) dimensioni del payload in KB per un sito al tunnel VPN del sito.
saLifeTimeSeconds	integer	L'associazione di sicurezza IPSec (denominata anche modalità rapida o fase 2 SA) in secondi per un tunnel VPN da sito a sito.

PfsGroup

I gruppi Pfs usati nella fase 2 di IKE per la nuova sa figlio.

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

ProvisioningState

Stato di provisioning corrente.

Nome	Tipo	Descrizione
Deleting	string
Failed	string
Succeeded	string
Updating	string

RadiusServer

Impostazioni del server Radius.

Nome	Tipo	Descrizione
radiusServerAddress	string	Indirizzo di questo server radius.
radiusServerScore	integer	Punteggio iniziale assegnato a questo server radius.
radiusServerSecret	string	Segreto usato per questo server radius.

SubResource

Riferimento a un'altra sottorisorsa.

Nome	Tipo	Descrizione
id	string	ID risorsa.

VirtualNetworkGateway

Classe comune per informazioni generali sulle risorse.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
extendedLocation	ExtendedLocation	Percorso esteso di tipo gateway di rete virtuale locale.
id	string	ID risorsa.
location	string	Percorso della risorsa.
name	string	Nome risorsa.
properties.activeActive	boolean	Flag ActiveActive.
properties.adminState	adminState	Proprietà per indicare se il gateway ExpressRoute gestisce il traffico quando sono presenti più gateway ExpressRoute nella rete virtuale
properties.allowRemoteVnetTraffic	boolean	Configurare questo gateway per accettare il traffico da altre reti virtuali di Azure. Questa configurazione non supporta la connettività ad Azure rete WAN virtuale.
properties.allowVirtualWanTraffic	boolean	Configura questo gateway per accettare il traffico da reti remote rete WAN virtuale.
properties.autoScaleConfiguration	VirtualNetworkGatewayAutoScaleConfiguration	Configurazione della scalabilità automatica per il gateway di rete virutal
properties.bgpSettings	BgpSettings	Impostazioni dell'altoparlante BGP del gateway di rete virtuale.
properties.customRoutes	AddressSpace	Riferimento alla risorsa dello spazio indirizzi che rappresenta lo spazio indirizzi delle route personalizzate specificato dal cliente per il gateway di rete virtuale e VpnClient.
properties.disableIPSecReplayProtection	boolean	disableIPSecReplayProtection flag.
properties.enableBgp	boolean	Indica se BGP è abilitato per il gateway di rete virtuale.
properties.enableBgpRouteTranslationForNat	boolean	Abilitare il flagBgpRouteTranslationForNat.
properties.enableDnsForwarding	boolean	Indica se l'inoltro DNS è abilitato o meno.
properties.enablePrivateIpAddress	boolean	Indica se è necessario abilitare o meno l'indirizzo IP privato in questo gateway per le connessioni.
properties.gatewayDefaultSite	SubResource	Riferimento alla risorsa LocalNetworkGateway che rappresenta il sito di rete locale con route predefinite. Assegnare un valore Null in caso di rimozione dell'impostazione del sito predefinita esistente.
properties.gatewayType	VirtualNetworkGatewayType	Tipo di gateway di rete virtuale.
properties.inboundDnsForwardingEndpoint	string	Indirizzo IP allocato dal gateway a cui è possibile inviare richieste DNS.
properties.ipConfigurations	VirtualNetworkGatewayIPConfiguration[]	Configurazioni IP per il gateway di rete virtuale.
properties.natRules	VirtualNetworkGatewayNatRule[]	NatRules per il gateway di rete virtuale.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa gateway di rete virtuale.
properties.resourceGuid	string	Proprietà GUID della risorsa del gateway di rete virtuale.
properties.sku	VirtualNetworkGatewaySku	Riferimento alla risorsa VirtualNetworkGatewaySku che rappresenta lo SKU selezionato per Gateway di rete virtuale.
properties.vNetExtendedLocationResourceId	string	ID risorsa rete virtuale del cliente. VirtualNetworkGateway di tipo gateway locale è associato alla rete virtuale del cliente.
properties.virtualNetworkGatewayPolicyGroups	VirtualNetworkGatewayPolicyGroup[]	Riferimento alla risorsa VirtualNetworkGatewayPolicyGroup che rappresenta il VirtualNetworkGatewayPolicyGroup disponibile per il gateway.
properties.vpnClientConfiguration	VpnClientConfiguration	Riferimento alla risorsa VpnClientConfiguration che rappresenta le configurazioni VpnClient da sito a sito.
properties.vpnGatewayGeneration	VpnGatewayGeneration	Generazione per virtualNetworkGateway. Deve essere Nessuno se gatewayType non è VPN.
properties.vpnType	VpnType	Tipo di gateway di rete virtuale.
tags	object	Tag delle risorse.
type	string	Tipo di risorsa.

VirtualNetworkGatewayAutoScaleBounds

Nome	Tipo	Descrizione
max	integer	Unità di scalabilità massime per la configurazione di scalabilità automatica
min	integer	Unità di scalabilità minima per la configurazione della scalabilità automatica

VirtualNetworkGatewayAutoScaleConfiguration

Dettagli di configurazione della scalabilità automatica del gateway Rete virtuale

Nome	Tipo	Descrizione
bounds	VirtualNetworkGatewayAutoScaleBounds	Limiti della configurazione della scalabilità automatica

VirtualNetworkGatewayIPConfiguration

Configurazione IP per il gateway di rete virtuale.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.privateIPAddress	string	Indirizzo IP privato per questo gateway.
properties.privateIPAllocationMethod	IPAllocationMethod	Metodo di allocazione dell'indirizzo IP privato.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa di configurazione IP del gateway di rete virtuale.
properties.publicIPAddress	SubResource	Riferimento alla risorsa IP pubblica.
properties.subnet	SubResource	Riferimento alla risorsa subnet.

VirtualNetworkGatewayNatRule

Risorsa VirtualNetworkGatewayNatRule.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.externalMappings	VpnNatRuleMapping[]	Mapping esterno dell'indirizzo IP privato per NAT.
properties.internalMappings	VpnNatRuleMapping[]	Mapping interno dell'indirizzo IP privato per NAT.
properties.ipConfigurationId	string	L'ID configurazione IP a cui si applica questa regola NAT.
properties.mode	VpnNatRuleMode	Direzione NAT di origine di un NAT VPN.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa regola NAT.
properties.type	VpnNatRuleType	Tipo di regola NAT per NAT VPN.
type	string	Tipo di risorsa.

VirtualNetworkGatewayPolicyGroup

Parametri per VirtualNetworkGatewayPolicyGroup.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.isDefault	boolean	Indica se si tratta di un oggetto VirtualNetworkGatewayPolicyGroup predefinito.
properties.policyMembers	VirtualNetworkGatewayPolicyGroupMember[]	Multiple PolicyMembers for VirtualNetworkGatewayPolicyGroup.
properties.priority	integer	Priorità per VirtualNetworkGatewayPolicyGroup.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa VirtualNetworkGatewayPolicyGroup.
properties.vngClientConnectionConfigurations	SubResource[]	Elenco di riferimenti a vngClientConnectionConfigurations.

VirtualNetworkGatewayPolicyGroupMember

Membro PolicyGroup di configurazione connessione client VPN

Nome	Tipo	Descrizione
attributeType	VpnPolicyMemberAttributeType	Tipo di attributo membro di Criteri VPN.
attributeValue	string	Valore di Attributo usato per questo VirtualNetworkGatewayPolicyGroupMember.
name	string	Nome del VirtualNetworkGatewayPolicyGroupMember.

VirtualNetworkGatewaySku

Dettagli di VirtualNetworkGatewaySku.

Nome	Tipo	Descrizione
capacity	integer	Capacità.
name	VirtualNetworkGatewaySkuName	Nome SKU del gateway.
tier	VirtualNetworkGatewaySkuTier	Livello SKU del gateway.

VirtualNetworkGatewaySkuName

Nome SKU del gateway.

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

Livello SKU del gateway.

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

Tipo di gateway di rete virtuale.

Nome	Tipo	Descrizione
ExpressRoute	string
LocalGateway	string
Vpn	string

VngClientConnectionConfiguration

Configurazione della connessione client VPN per la configurazione della connessione client.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa VngClientConnectionConfiguration.
properties.virtualNetworkGatewayPolicyGroups	SubResource[]	Elenco di riferimenti a virtualNetworkGatewayPolicyGroups
properties.vpnClientAddressPool	AddressSpace	Riferimento alla risorsa spazio indirizzi che rappresenta lo spazio indirizzi per VpnClient P2S.

VpnAuthenticationType

Tipi di autenticazione VPN per il gateway di rete virtuale.

Nome	Tipo	Descrizione
AAD	string
Certificate	string
Radius	string

VpnClientConfiguration

VpnClientConfiguration per il client da sito a sito.

Nome	Tipo	Descrizione
aadAudience	string	Proprietà AADAudience della risorsa VirtualNetworkGateway per la connessione client VPN usata per l'autenticazione AAD.
aadIssuer	string	Proprietà AADIssuer della risorsa VirtualNetworkGateway per la connessione client VPN usata per l'autenticazione AAD.
aadTenant	string	Proprietà AADTenant della risorsa VirtualNetworkGateway per la connessione client VPN usata per l'autenticazione AAD.
radiusServerAddress	string	Proprietà dell'indirizzo del server radius della risorsa VirtualNetworkGateway per la connessione client VPN.
radiusServerSecret	string	Proprietà del segreto radius della risorsa VirtualNetworkGateway per la connessione client VPN.
radiusServers	RadiusServer[]	Proprietà radiusServers per la configurazione di più server radius.
vngClientConnectionConfigurations	VngClientConnectionConfiguration[]	Per ogni criterio di connessione del pool di indirizzi IP per il client P2S del gateway di rete virtuale.
vpnAuthenticationTypes	VpnAuthenticationType[]	Tipi di autenticazione VPN per il gateway di rete virtuale.
vpnClientAddressPool	AddressSpace	Riferimento alla risorsa dello spazio indirizzi che rappresenta lo spazio indirizzi per VpnClient da sito a sito.
vpnClientIpsecPolicies	IpsecPolicy[]	VpnClientIpsecPolicies per il client P2S del gateway di rete virtuale.
vpnClientProtocols	VpnClientProtocol[]	VpnClientProtocols per gateway di rete virtuale.
vpnClientRevokedCertificates	VpnClientRevokedCertificate[]	VpnClientRevokedCertificate per il gateway di rete virtuale.
vpnClientRootCertificates	VpnClientRootCertificate[]	VpnClientRootCertificate per il gateway di rete virtuale.

VpnClientProtocol

VpnClientProtocols per il gateway di rete virtuale.

Nome	Tipo	Descrizione
IkeV2	string
OpenVPN	string
SSTP	string

VpnClientRevokedCertificate

Il client VPN ha revocato il certificato del gateway di rete virtuale.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa certificato revocata dal client VPN.
properties.thumbprint	string	Identificazione personale del certificato client VPN revocata.

VpnClientRootCertificate

Certificato radice del client VPN del gateway di rete virtuale.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa del certificato radice del client VPN.
properties.publicCertData	string	Dati pubblici del certificato.

VpnGatewayGeneration

Generazione per virtualNetworkGateway. Deve essere Nessuno se gatewayType non è VPN.

Nome	Tipo	Descrizione
Generation1	string
Generation2	string
None	string

VpnNatRuleMapping

Mapping vpn NatRule.

Nome	Tipo	Descrizione
addressSpace	string	Spazio indirizzi per il mapping vpn NatRule.
portRange	string	Intervallo di porte per il mapping NatRule vpn.

VpnNatRuleMode

Direzione NAT di origine di un NAT VPN.

Nome	Tipo	Descrizione
EgressSnat	string
IngressSnat	string

VpnNatRuleType

Tipo di regola NAT per NAT VPN.

Nome	Tipo	Descrizione
Dynamic	string
Static	string

VpnPolicyMemberAttributeType

Tipo di attributo membro di Criteri VPN.

Nome	Tipo	Descrizione
AADGroupId	string
CertificateGroupId	string
RadiusAzureGroupId	string

VpnType

Tipo di gateway di rete virtuale.

Nome	Tipo	Descrizione
PolicyBased	string
RouteBased	string