Local Network Gateways - List

Service:

Network Gateway

API Version:

2023-09-01

Obtient toutes les passerelles de réseau local dans un groupe de ressources.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de façon unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version d’API client.

Réponses

Nom	Type	Description
200 OK	LocalNetworkGatewayListResult	Demande réussie. L’opération retourne une liste de ressources LocalNetworkGateway.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

ListLocalNetworkGateways

Sample Request

HTTP

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

Java

/**
 * Samples for LocalNetworkGateways ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/LocalNetworkGatewayList.json
     */
    /**
     * Sample code: ListLocalNetworkGateways.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listLocalNetworkGateways(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getLocalNetworkGateways().listByResourceGroup("rg1",
            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 local_network_gateway_list.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.local_network_gateways.list(
        resource_group_name="rg1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/LocalNetworkGatewayList.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/LocalNetworkGatewayList.json
func ExampleLocalNetworkGatewaysClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewLocalNetworkGatewaysClient().NewListPager("rg1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.LocalNetworkGatewayListResult = armnetwork.LocalNetworkGatewayListResult{
		// 	Value: []*armnetwork.LocalNetworkGateway{
		// 		{
		// 			Name: to.Ptr("localgw1"),
		// 			Type: to.Ptr("Microsoft.Network/localNetworkGateways"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw1"),
		// 			Location: to.Ptr("centralus"),
		// 			Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
		// 			Properties: &armnetwork.LocalNetworkGatewayPropertiesFormat{
		// 				GatewayIPAddress: to.Ptr("x.x.x.x"),
		// 				LocalNetworkAddressSpace: &armnetwork.AddressSpace{
		// 					AddressPrefixes: []*string{
		// 						to.Ptr("10.1.0.0/16")},
		// 					},
		// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 					ResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("localgw2"),
		// 				Type: to.Ptr("Microsoft.Network/localNetworkGateways"),
		// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw2"),
		// 				Location: to.Ptr("eastus"),
		// 				Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
		// 				Properties: &armnetwork.LocalNetworkGatewayPropertiesFormat{
		// 					GatewayIPAddress: to.Ptr("x.x.x.x"),
		// 					LocalNetworkAddressSpace: &armnetwork.AddressSpace{
		// 						AddressPrefixes: []*string{
		// 							to.Ptr("10.2.0.0/16")},
		// 						},
		// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 						ResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 					},
		// 			}},
		// 		}
	}
}

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 all the local network gateways in a resource group.
 *
 * @summary Gets all the local network gateways in a resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/LocalNetworkGatewayList.json
 */
async function listLocalNetworkGateways() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.localNetworkGateways.list(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/LocalNetworkGatewayList.json
// this example is just showing the usage of "LocalNetworkGateways_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this LocalNetworkGatewayResource
LocalNetworkGatewayCollection collection = resourceGroupResource.GetLocalNetworkGateways();

// invoke the operation and iterate over the result
await foreach (LocalNetworkGatewayResource item in collection.GetAllAsync())
{
    // the variable item 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
    LocalNetworkGatewayData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "name": "localgw1",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw1",
      "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
      "type": "Microsoft.Network/localNetworkGateways",
      "location": "centralus",
      "properties": {
        "provisioningState": "Succeeded",
        "resourceGuid": "00000000-0000-0000-0000-000000000000",
        "localNetworkAddressSpace": {
          "addressPrefixes": [
            "10.1.0.0/16"
          ]
        },
        "gatewayIpAddress": "x.x.x.x"
      }
    },
    {
      "name": "localgw2",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw2",
      "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
      "type": "Microsoft.Network/localNetworkGateways",
      "location": "eastus",
      "properties": {
        "provisioningState": "Succeeded",
        "resourceGuid": "00000000-0000-0000-0000-000000000000",
        "localNetworkAddressSpace": {
          "addressPrefixes": [
            "10.2.0.0/16"
          ]
        },
        "gatewayIpAddress": "x.x.x.x"
      }
    }
  ]
}

Définitions

Nom	Description
AddressSpace	AddressSpace contient un tableau de plages d'adresses IP qui peuvent être utilisées par les sous-réseaux du réseau virtuel.
BgpSettings	Détails des paramètres BGP.
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
IPConfigurationBgpPeeringAddress	Propriétés de IPConfigurationBgpPeeringAddress.
LocalNetworkGateway	Classe courante pour les informations générales sur les ressources.
LocalNetworkGatewayListResult	Réponse à l’appel de service d’API ListLocalNetworkGateways.
ProvisioningState	État d’approvisionnement actuel.

AddressSpace

AddressSpace contient un tableau de plages d'adresses IP qui peuvent être utilisées par les sous-réseaux du réseau virtuel.

Nom	Type	Description
addressPrefixes	string[]	Liste des blocs d’adresses réservés à ce réseau virtuel en notation CIDR.

BgpSettings

Détails des paramètres BGP.

Nom	Type	Description
asn	integer	ASN de l’orateur BGP.
bgpPeeringAddress	string	Adresse de peering BGP et identificateur BGP de ce haut-parleur BGP.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	Adresse de peering BGP avec ID de configuration IP pour la passerelle de réseau virtuel.
peerWeight	integer	Poids ajouté aux itinéraires appris par ce haut-parleur BGP.

CloudError

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Corps de l’erreur cloud.

CloudErrorBody

Réponse d’erreur du service.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété dans l’erreur.

IPConfigurationBgpPeeringAddress

Propriétés de IPConfigurationBgpPeeringAddress.

Nom	Type	Description
customBgpIpAddresses	string[]	Liste des adresses de peering BGP personnalisées qui appartiennent à la configuration IP.
defaultBgpIpAddresses	string[]	Liste des adresses de peering BGP par défaut qui appartiennent à la configuration IP.
ipconfigurationId	string	ID de la configuration IP qui appartient à la passerelle.
tunnelIpAddresses	string[]	Liste des adresses IP publiques de tunnel qui appartiennent à la configuration IP.

LocalNetworkGateway

Classe courante pour les informations générales sur les ressources.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de la ressource
location	string	Emplacement de la ressource.
name	string	Nom de la ressource.
properties.bgpSettings	BgpSettings	Paramètres de l’orateur BGP de la passerelle de réseau local.
properties.fqdn	string	Nom de domaine complet de la passerelle de réseau local.
properties.gatewayIpAddress	string	Adresse IP de la passerelle de réseau local.
properties.localNetworkAddressSpace	AddressSpace	Espace d’adressage du site de réseau local.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de passerelle de réseau local.
properties.resourceGuid	string	Propriété GUID de ressource de la ressource de passerelle de réseau local.
tags	object	Balises de ressource.
type	string	Type de ressource.

LocalNetworkGatewayListResult

Réponse à l’appel de service d’API ListLocalNetworkGateways.

Nom	Type	Description
nextLink	string	URL permettant d’obtenir l’ensemble de résultats suivant.
value	LocalNetworkGateway[]	Liste des passerelles de réseau local qui existent dans un groupe de ressources.

ProvisioningState

État d’approvisionnement actuel.

Nom	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string