Express Route Ports Locations - List

Reference

Service:: ExpressRoute

API Version:: 2023-09-01

Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location.

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

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	ExpressRoutePortsLocationListResult	Request successful. The operation returns the list of all ExpressRoutePort peering locations.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

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	impersonate your user account

Examples

ExpressRoutePortsLocationList

Sample Request

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


/**
 * Samples for ExpressRoutePortsLocations List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRoutePortsLocationList
     * .json
     */
    /**
     * Sample code: ExpressRoutePortsLocationList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void expressRoutePortsLocationList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRoutePortsLocations()
            .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

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python express_route_ports_location_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.express_route_ports_locations.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRoutePortsLocationList.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/ExpressRoutePortsLocationList.json
func ExampleExpressRoutePortsLocationsClient_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.NewExpressRoutePortsLocationsClient().NewListPager(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.ExpressRoutePortsLocationListResult = armnetwork.ExpressRoutePortsLocationListResult{
		// 	Value: []*armnetwork.ExpressRoutePortsLocation{
		// 		{
		// 			Name: to.Ptr("locationName"),
		// 			Type: to.Ptr("Microsoft.Network/expressRoutePortsLocations"),
		// 			ID: to.Ptr("/subscriptions/subid/providers/Microsoft.Network/expressRoutePortsLocations/locationName"),
		// 			Location: to.Ptr("westus"),
		// 			Properties: &armnetwork.ExpressRoutePortsLocationPropertiesFormat{
		// 				Address: to.Ptr("123 Main Street, City, State, Zip"),
		// 				AvailableBandwidths: []*armnetwork.ExpressRoutePortsLocationBandwidths{
		// 				},
		// 				Contact: to.Ptr("email@address.com"),
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 			},
		// 	}},
		// }
	}
}

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 Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location.
 *
 * @summary Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRoutePortsLocationList.json
 */
async function expressRoutePortsLocationList() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.expressRoutePortsLocations.list()) {
    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/ExpressRoutePortsLocationList.json
// this example is just showing the usage of "ExpressRoutePortsLocations_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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this ExpressRoutePortsLocationResource
ExpressRoutePortsLocationCollection collection = subscriptionResource.GetExpressRoutePortsLocations();

// invoke the operation and iterate over the result
await foreach (ExpressRoutePortsLocationResource 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
    ExpressRoutePortsLocationData 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": "locationName",
      "id": "/subscriptions/subid/providers/Microsoft.Network/expressRoutePortsLocations/locationName",
      "type": "Microsoft.Network/expressRoutePortsLocations",
      "location": "westus",
      "properties": {
        "provisioningState": "Succeeded",
        "address": "123 Main Street, City, State, Zip",
        "contact": "email@address.com",
        "availableBandwidths": []
      }
    }
  ]
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
ExpressRoutePortsLocation	ExpressRoutePorts Peering Location
ExpressRoutePortsLocationBandwidths	ExpressRoutePorts Location Bandwidths
ExpressRoutePortsLocationListResult	ExpressRoutePorts Location List Result
ProvisioningState	The current provisioning state.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ExpressRoutePortsLocation

ExpressRoutePorts Peering Location

Name	Type	Description
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.address	string	Address of peering location.
properties.availableBandwidths	ExpressRoutePortsLocationBandwidths[]	The inventory of available ExpressRoutePort bandwidths.
properties.contact	string	Contact details of peering locations.
properties.provisioningState	ProvisioningState	The provisioning state of the express route port location resource.
tags	object	Resource tags.
type	string	Resource type.

ExpressRoutePortsLocationBandwidths

ExpressRoutePorts Location Bandwidths

Name	Type	Description
offerName	string	Bandwidth descriptive name.
valueInGbps	integer	Bandwidth value in Gbps.

ExpressRoutePortsLocationListResult

ExpressRoutePorts Location List Result

Name	Type	Description
nextLink	string	The URL to get the next set of results.
value	ExpressRoutePortsLocation[]	The list of all ExpressRoutePort peering locations.

ProvisioningState

The current provisioning state.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string