L 2 Networks - List By Subscription

Usługa:

Operator Nexus - Network Cloud

Wersja interfejsu API:

2025-02-01

Wyświetlanie listy sieci warstwy 2 (L2) w subskrypcji.
Pobierz listę sieci warstwy 2 (L2) w podanej subskrypcji.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/l2Networks?api-version=2025-02-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	L2NetworkList	Lista zasobów została pomyślnie pobrana.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List L2 networks for subscription

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/l2Networks?api-version=2025-02-01

Java

/**
 * Samples for L2Networks List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2025-02-01/examples/
     * L2Networks_ListBySubscription.json
     */
    /**
     * Sample code: List L2 networks for subscription.
     * 
     * @param manager Entry point to NetworkCloudManager.
     */
    public static void
        listL2NetworksForSubscription(com.azure.resourcemanager.networkcloud.NetworkCloudManager manager) {
        manager.l2Networks().list(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.networkcloud import NetworkCloudMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-networkcloud
# USAGE
    python l2_networks_list_by_subscription.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 = NetworkCloudMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="123e4567-e89b-12d3-a456-426655440000",
    )

    response = client.l2_networks.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2025-02-01/examples/L2Networks_ListBySubscription.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 armnetworkcloud_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/networkcloud/armnetworkcloud"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d0d3a9b4fe0fce880fded7a617e71f84406bacbd/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2025-02-01/examples/L2Networks_ListBySubscription.json
func ExampleL2NetworksClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetworkcloud.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewL2NetworksClient().NewListBySubscriptionPager(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.L2NetworkList = armnetworkcloud.L2NetworkList{
		// 	Value: []*armnetworkcloud.L2Network{
		// 		{
		// 			Name: to.Ptr("l2NetworkName"),
		// 			Type: to.Ptr("Microsoft.NetworkCloud/l2Networks"),
		// 			ID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName"),
		// 			SystemData: &armnetworkcloud.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:27:03.008Z"); return t}()),
		// 				CreatedBy: to.Ptr("identityA"),
		// 				CreatedByType: to.Ptr(armnetworkcloud.CreatedByTypeApplication),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:29:03.001Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("identityB"),
		// 				LastModifiedByType: to.Ptr(armnetworkcloud.CreatedByTypeUser),
		// 			},
		// 			Location: to.Ptr("location"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("myvalue1"),
		// 				"key2": to.Ptr("myvalue2"),
		// 			},
		// 			ExtendedLocation: &armnetworkcloud.ExtendedLocation{
		// 				Name: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"),
		// 				Type: to.Ptr("CustomLocation"),
		// 			},
		// 			Properties: &armnetworkcloud.L2NetworkProperties{
		// 				AssociatedResourceIDs: []*string{
		// 					to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName")},
		// 					ClusterID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName"),
		// 					DetailedStatus: to.Ptr(armnetworkcloud.L2NetworkDetailedStatusAvailable),
		// 					DetailedStatusMessage: to.Ptr("L2 network is up"),
		// 					InterfaceName: to.Ptr("eth0"),
		// 					L2IsolationDomainID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName"),
		// 					ProvisioningState: to.Ptr(armnetworkcloud.L2NetworkProvisioningStateSucceeded),
		// 				},
		// 		}},
		// 	}
	}
}

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 { NetworkCloud } = require("@azure/arm-networkcloud");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get a list of layer 2 (L2) networks in the provided subscription.
 *
 * @summary Get a list of layer 2 (L2) networks in the provided subscription.
 * x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2025-02-01/examples/L2Networks_ListBySubscription.json
 */
async function listL2NetworksForSubscription() {
  const subscriptionId =
    process.env["NETWORKCLOUD_SUBSCRIPTION_ID"] || "123e4567-e89b-12d3-a456-426655440000";
  const credential = new DefaultAzureCredential();
  const client = new NetworkCloud(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.l2Networks.listBySubscription()) {
    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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.NetworkCloud;

// Generated from example definition: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2025-02-01/examples/L2Networks_ListBySubscription.json
// this example is just showing the usage of "L2Networks_ListBySubscription" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "123e4567-e89b-12d3-a456-426655440000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (NetworkCloudL2NetworkResource item in subscriptionResource.GetNetworkCloudL2NetworksAsync())
{
    // 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
    NetworkCloudL2NetworkData 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

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName",
      "name": "l2NetworkName",
      "systemData": {
        "createdAt": "2021-01-22T13:27:03.008Z",
        "createdBy": "identityA",
        "createdByType": "Application",
        "lastModifiedAt": "2021-01-22T13:29:03.001Z",
        "lastModifiedBy": "identityB",
        "lastModifiedByType": "User"
      },
      "type": "Microsoft.NetworkCloud/l2Networks",
      "location": "location",
      "tags": {
        "key1": "myvalue1",
        "key2": "myvalue2"
      },
      "extendedLocation": {
        "type": "CustomLocation",
        "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"
      },
      "properties": {
        "interfaceName": "eth0",
        "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName",
        "provisioningState": "Succeeded",
        "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName",
        "associatedResourceIds": [
          "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName"
        ],
        "detailedStatus": "Available",
        "detailedStatusMessage": "L2 network is up"
      }
    }
  ],
  "nextLink": "https://fully.qualified.hyperlink"
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ExtendedLocation	ExtendedLocation reprezentuje niestandardową lokalizację platformy Azure, w której zostanie utworzony zasób.
HybridAksPluginType	Pole jest przestarzałe. Pole było wcześniej opcjonalne, teraz nie będzie miało zdefiniowanego zachowania i zostanie zignorowane. Typ wtyczki sieciowej dla hybrydowej usługi AKS.
L2Network	L2Network reprezentuje sieć, która korzysta z jednej domeny izolacji skonfigurowanej dla zasobów warstwy 2.
L2NetworkDetailedStatus	Bardziej szczegółowy stan sieci L2.
L2NetworkList	L2NetworkList reprezentuje listę sieci L2.
L2NetworkProvisioningState	Stan aprowizacji sieci L2.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

ExtendedLocation

Objekt

ExtendedLocation reprezentuje niestandardową lokalizację platformy Azure, w której zostanie utworzony zasób.

Nazwa	Typ	Opis
name	string	Identyfikator zasobu lokalizacji rozszerzonej, w której zostanie utworzony zasób.
type	string	Typ lokalizacji rozszerzonej, na przykład CustomLocation.

HybridAksPluginType

Wyliczanie

Pole jest przestarzałe. Pole było wcześniej opcjonalne, teraz nie będzie miało zdefiniowanego zachowania i zostanie zignorowane. Typ wtyczki sieciowej dla hybrydowej usługi AKS.

Wartość	Opis
DPDK
OSDevice
SRIOV

L2Network

Objekt

L2Network reprezentuje sieć, która korzysta z jednej domeny izolacji skonfigurowanej dla zasobów warstwy 2.

Nazwa	Typ	Domyślna wartość	Opis
etag	string		Zasób ETag.
extendedLocation	ExtendedLocation		ExtendedLocation reprezentuje niestandardową lokalizację platformy Azure, w której zostanie utworzony zasób. Rozszerzona lokalizacja klastra skojarzonego z zasobem.
id	string (arm-id)		W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		Lokalizacja geograficzna, w której znajduje się zasób
name	string		Nazwa zasobu
properties.associatedResourceIds	string[]		Lista identyfikatorów zasobów dla innych zasobów Microsoft.NetworkCloud, które dołączyły tę sieć.
properties.clusterId	string (arm-id)		Identyfikator zasobu klastra chmury sieciowej, z tą siecią L2 jest skojarzona.
properties.detailedStatus	L2NetworkDetailedStatus		Bardziej szczegółowy stan sieci L2.
properties.detailedStatusMessage	string		Komunikat opisujący aktualny szczegółowy stan.
properties.hybridAksClustersAssociatedIds	string[]		Pole jest przestarzałe. Te pola będą puste/pominięte. Lista identyfikatorów zasobów klastra hybrydowego usługi AKS skojarzonych z tą siecią L2.
properties.hybridAksPluginType	HybridAksPluginType	SRIOV	Pole jest przestarzałe. Pole było wcześniej opcjonalne, teraz nie będzie miało zdefiniowanego zachowania i zostanie zignorowane. Typ wtyczki sieciowej dla hybrydowej usługi AKS.
properties.interfaceName	string maxLength: 12 pattern: ^[a-zA-Z0-9@._-]*$		Domyślna nazwa interfejsu dla tej sieci L2 na maszynie wirtualnej. Tę nazwę można zastąpić nazwą podaną w konfiguracji załącznika sieciowego tej maszyny wirtualnej.
properties.l2IsolationDomainId	string (arm-id)		Identyfikator zasobu sieci szkieletowej l2IsolationDomain.
properties.provisioningState	L2NetworkProvisioningState		Stan aprowizacji sieci L2.
properties.virtualMachinesAssociatedIds	string[]		Pole jest przestarzałe. Te pola będą puste/pominięte. Lista identyfikatorów zasobów maszyny wirtualnej z wyłączeniem wszystkich maszyn wirtualnych hybrydowej usługi AKS, które obecnie korzystają z tej sieci L2.
systemData	systemData		Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
tags	object		Tagi zasobów.
type	string		Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

L2NetworkDetailedStatus

Wyliczanie

Bardziej szczegółowy stan sieci L2.

Wartość	Opis
Available
Error
Provisioning

L2NetworkList

Objekt

L2NetworkList reprezentuje listę sieci L2.

Nazwa	Typ	Opis
nextLink	string	Link użyty do pobrania następnej strony operacji.
value	L2Network[]	Lista sieci L2.

L2NetworkProvisioningState

Wyliczanie

Stan aprowizacji sieci L2.

Wartość	Opis
Accepted
Canceled
Failed
Provisioning
Succeeded

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.