Local Network Gateways - List

Başvuru

Service:: Network Gateway

API Version:: 2023-09-01

Bir kaynak grubundaki tüm yerel ağ geçitlerini alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	Kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	LocalNetworkGatewayListResult	İstek başarılı. İşlem, LocalNetworkGateway kaynaklarının listesini döndürür.
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ListLocalNetworkGateways

Sample Request

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


/**
 * 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

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

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

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

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

Tanımlar

Name	Description
AddressSpace	AddressSpace, sanal ağın alt ağları tarafından kullanılabilecek bir IP adresi aralıkları dizisi içerir.
BgpSettings	BGP ayarları ayrıntıları.
CloudError	Hizmetten bir hata yanıtı.
CloudErrorBody	Hizmetten bir hata yanıtı.
IPConfigurationBgpPeeringAddress	IPConfigurationBgpPeeringAddress özellikleri.
LocalNetworkGateway	Genel kaynak bilgileri için ortak bir sınıf.
LocalNetworkGatewayListResult	ListLocalNetworkGateways API hizmet çağrısı yanıtı.
ProvisioningState	Geçerli sağlama durumu.

AddressSpace

AddressSpace, sanal ağın alt ağları tarafından kullanılabilecek bir IP adresi aralıkları dizisi içerir.

Name	Tür	Description
addressPrefixes	string[]	CIDR gösteriminde bu sanal ağ için ayrılmış adres bloklarının listesi.

BgpSettings

BGP ayarları ayrıntıları.

Name	Tür	Description
asn	integer	BGP hoparlörün ASN'sini.
bgpPeeringAddress	string	Bu BGP konuşmacısının BGP eşleme adresi ve BGP tanımlayıcısı.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	Sanal ağ geçidi için IP yapılandırma kimliğine sahip BGP eşleme adresi.
peerWeight	integer	Bu BGP hoparlöründen öğrenilen rotalara eklenen ağırlık.

CloudError

Hizmetten bir hata yanıtı.

Name	Tür	Description
error	CloudErrorBody	Bulut hata gövdesi.

CloudErrorBody

Hizmetten bir hata yanıtı.

Name	Tür	Description
code	string	Hatanın tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır.
details	CloudErrorBody[]	Hatayla ilgili ek ayrıntıların listesi.
message	string	Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.
target	string	Belirli bir hatanın hedefi. Örneğin, özelliğin adı hatalı.

IPConfigurationBgpPeeringAddress

IPConfigurationBgpPeeringAddress özellikleri.

Name	Tür	Description
customBgpIpAddresses	string[]	IP yapılandırmasına ait özel BGP eşleme adreslerinin listesi.
defaultBgpIpAddresses	string[]	IP yapılandırmasına ait varsayılan BGP eşleme adreslerinin listesi.
ipconfigurationId	string	Ağ geçidine ait IP yapılandırmasının kimliği.
tunnelIpAddresses	string[]	IP yapılandırmasına ait tünel genel IP adreslerinin listesi.

LocalNetworkGateway

Genel kaynak bilgileri için ortak bir sınıf.

Name	Tür	Description
etag	string	Kaynak her güncelleştirildiğinde değişen benzersiz bir salt okunur dize.
id	string	Kaynak Kimliği.
location	string	Kaynak konumu.
name	string	Kaynak adı.
properties.bgpSettings	BgpSettings	Yerel ağ geçidinin BGP hoparlör ayarları.
properties.fqdn	string	Yerel ağ geçidinin FQDN'sini seçin.
properties.gatewayIpAddress	string	Yerel ağ geçidinin IP adresi.
properties.localNetworkAddressSpace	AddressSpace	Yerel ağ sitesi adres alanı.
properties.provisioningState	ProvisioningState	Yerel ağ geçidi kaynağının sağlama durumu.
properties.resourceGuid	string	Yerel ağ geçidi kaynağının kaynak GUID özelliği.
tags	object	Kaynak etiketleri.
type	string	Kaynak türü.

LocalNetworkGatewayListResult

ListLocalNetworkGateways API hizmet çağrısı yanıtı.

Name	Tür	Description
nextLink	string	Sonraki sonuç kümesini almak için URL.
value	LocalNetworkGateway[]	Kaynak grubunda bulunan yerel ağ geçitlerinin listesi.

ProvisioningState

Geçerli sağlama durumu.

Name	Tür	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string