Express Route Ports - List

Service:

ExpressRoute

API Version:

2023-09-01

List all the ExpressRoutePort resources in the specified subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePorts?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	ExpressRoutePortListResult	Request successful. The operation returns a list of ExpressRoutePort resources. If there are no ExpressRoutePort resources then an empty list is returned.
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

ExpressRoutePortList

Sample Request

HTTP

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

Java

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

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


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRoutePortList.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/ExpressRoutePortList.json
func ExampleExpressRoutePortsClient_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.NewExpressRoutePortsClient().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.ExpressRoutePortListResult = armnetwork.ExpressRoutePortListResult{
		// 	Value: []*armnetwork.ExpressRoutePort{
		// 		{
		// 			Name: to.Ptr("portName"),
		// 			Type: to.Ptr("Microsoft.Network/expressRoutePorts"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName"),
		// 			Location: to.Ptr("westus"),
		// 			Properties: &armnetwork.ExpressRoutePortPropertiesFormat{
		// 				AllocationDate: to.Ptr("Friday, July 1, 2018"),
		// 				BandwidthInGbps: to.Ptr[int32](100),
		// 				BillingType: to.Ptr(armnetwork.ExpressRoutePortsBillingTypeUnlimitedData),
		// 				Circuits: []*armnetwork.SubResource{
		// 				},
		// 				Encapsulation: to.Ptr(armnetwork.ExpressRoutePortsEncapsulationQinQ),
		// 				EtherType: to.Ptr("0x8100"),
		// 				Links: []*armnetwork.ExpressRouteLink{
		// 					{
		// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1"),
		// 						Name: to.Ptr("link1"),
		// 						Properties: &armnetwork.ExpressRouteLinkPropertiesFormat{
		// 							AdminState: to.Ptr(armnetwork.ExpressRouteLinkAdminStateDisabled),
		// 							ColoLocation: to.Ptr("coloLocation1"),
		// 							ConnectorType: to.Ptr(armnetwork.ExpressRouteLinkConnectorTypeLC),
		// 							InterfaceName: to.Ptr("Ethernet 0/0"),
		// 							PatchPanelID: to.Ptr("patchPanelId1"),
		// 							ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 							RackID: to.Ptr("rackId1"),
		// 							RouterName: to.Ptr("router1"),
		// 						},
		// 					},
		// 					{
		// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2"),
		// 						Name: to.Ptr("link2"),
		// 						Properties: &armnetwork.ExpressRouteLinkPropertiesFormat{
		// 							AdminState: to.Ptr(armnetwork.ExpressRouteLinkAdminStateDisabled),
		// 							ColoLocation: to.Ptr("coloLocation2"),
		// 							ConnectorType: to.Ptr(armnetwork.ExpressRouteLinkConnectorTypeLC),
		// 							InterfaceName: to.Ptr("Ethernet 0/0"),
		// 							PatchPanelID: to.Ptr("patchPanelId2"),
		// 							ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 							RackID: to.Ptr("rackId2"),
		// 							RouterName: to.Ptr("router2"),
		// 						},
		// 				}},
		// 				Mtu: to.Ptr("1500"),
		// 				PeeringLocation: to.Ptr("peeringLocationName"),
		// 				ProvisionedBandwidthInGbps: to.Ptr[float32](0),
		// 				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

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List all the ExpressRoutePort resources in the specified subscription.
 *
 * @summary List all the ExpressRoutePort resources in the specified subscription.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRoutePortList.json
 */
async function expressRoutePortList() {
  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.expressRoutePorts.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

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;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRoutePortList.json
// this example is just showing the usage of "ExpressRoutePorts_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);

// invoke the operation and iterate over the result
await foreach (ExpressRoutePortResource item in subscriptionResource.GetExpressRoutePortsAsync())
{
    // 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
    ExpressRoutePortData 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": "portName",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName",
      "type": "Microsoft.Network/expressRoutePorts",
      "location": "westus",
      "properties": {
        "provisioningState": "Succeeded",
        "peeringLocation": "peeringLocationName",
        "bandwidthInGbps": 100,
        "provisionedBandwidthInGbps": 0,
        "mtu": "1500",
        "encapsulation": "QinQ",
        "billingType": "UnlimitedData",
        "etherType": "0x8100",
        "allocationDate": "Friday, July 1, 2018",
        "links": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1",
            "name": "link1",
            "properties": {
              "provisioningState": "Succeeded",
              "routerName": "router1",
              "interfaceName": "Ethernet 0/0",
              "patchPanelId": "patchPanelId1",
              "rackId": "rackId1",
              "coloLocation": "coloLocation1",
              "connectorType": "LC",
              "adminState": "Disabled"
            }
          },
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2",
            "name": "link2",
            "properties": {
              "provisioningState": "Succeeded",
              "routerName": "router2",
              "interfaceName": "Ethernet 0/0",
              "patchPanelId": "patchPanelId2",
              "rackId": "rackId2",
              "coloLocation": "coloLocation2",
              "connectorType": "LC",
              "adminState": "Disabled"
            }
          }
        ],
        "circuits": []
      }
    }
  ]
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
ExpressRouteLink	ExpressRouteLink
ExpressRouteLinkAdminState	Administrative state of the physical port.
ExpressRouteLinkConnectorType	Physical fiber port type.
ExpressRouteLinkMacSecCipher	Mac security cipher.
ExpressRouteLinkMacSecConfig	Definition of ExpressRouteLink Mac Security configuration.
ExpressRouteLinkMacSecSciState	Sci mode enabled/disabled.
ExpressRoutePort	ExpressRoute Port
ExpressRoutePortListResult	ExpressRoute Port List Result
ExpressRoutePortsBillingType	The billing type of the ExpressRoutePort resource.
ExpressRoutePortsEncapsulation	Encapsulation method on physical ports.
ManagedServiceIdentity	Identity for the resource.
ProvisioningState	The current provisioning state.
ResourceIdentityType	The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
SubResource	Reference to another subresource.
UserAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

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.

ExpressRouteLink

ExpressRouteLink

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of child port resource that is unique among child port resources of the parent.
properties.adminState	ExpressRouteLinkAdminState	Administrative state of the physical port.
properties.coloLocation	string	Cololocation for ExpressRoute Hybrid Direct.
properties.connectorType	ExpressRouteLinkConnectorType	Physical fiber port type.
properties.interfaceName	string	Name of Azure router interface.
properties.macSecConfig	ExpressRouteLinkMacSecConfig	Definition of ExpressRouteLink Mac Security configuration. MacSec configuration.
properties.patchPanelId	string	Mapping between physical port to patch panel port.
properties.provisioningState	ProvisioningState	The provisioning state of the express route link resource.
properties.rackId	string	Mapping of physical patch panel to rack.
properties.routerName	string	Name of Azure router associated with physical port.

ExpressRouteLinkAdminState

Administrative state of the physical port.

Name	Type	Description
Disabled	string
Enabled	string

ExpressRouteLinkConnectorType

Physical fiber port type.

Name	Type	Description
LC	string
SC	string

ExpressRouteLinkMacSecCipher

Mac security cipher.

Name	Type	Description
GcmAes128	string
GcmAes256	string
GcmAesXpn128	string
GcmAesXpn256	string

ExpressRouteLinkMacSecConfig

Definition of ExpressRouteLink Mac Security configuration.

Name	Type	Description
cakSecretIdentifier	string	Keyvault Secret Identifier URL containing Mac security CAK key.
cipher	ExpressRouteLinkMacSecCipher	Mac security cipher.
cknSecretIdentifier	string	Keyvault Secret Identifier URL containing Mac security CKN key.
sciState	ExpressRouteLinkMacSecSciState	Sci mode enabled/disabled.

ExpressRouteLinkMacSecSciState

Sci mode enabled/disabled.

Name	Type	Description
Disabled	string
Enabled	string

ExpressRoutePort

ExpressRoute Port

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
identity	ManagedServiceIdentity	The identity of ExpressRoutePort, if configured.
location	string	Resource location.
name	string	Resource name.
properties.allocationDate	string	Date of the physical port allocation to be used in Letter of Authorization.
properties.bandwidthInGbps	integer	Bandwidth of procured ports in Gbps.
properties.billingType	ExpressRoutePortsBillingType	The billing type of the ExpressRoutePort resource.
properties.circuits	SubResource[]	Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource.
properties.encapsulation	ExpressRoutePortsEncapsulation	Encapsulation method on physical ports.
properties.etherType	string	Ether type of the physical port.
properties.links	ExpressRouteLink[]	ExpressRouteLink Sub-Resources The set of physical links of the ExpressRoutePort resource.
properties.mtu	string	Maximum transmission unit of the physical port pair(s).
properties.peeringLocation	string	The name of the peering location that the ExpressRoutePort is mapped to physically.
properties.provisionedBandwidthInGbps	number	Aggregate Gbps of associated circuit bandwidths.
properties.provisioningState	ProvisioningState	The provisioning state of the express route port resource.
properties.resourceGuid	string	The resource GUID property of the express route port resource.
tags	object	Resource tags.
type	string	Resource type.

ExpressRoutePortListResult

ExpressRoute Port List Result

Name	Type	Description
nextLink	string	The URL to get the next set of results.
value	ExpressRoutePort[]	A list of ExpressRoutePort resources.

ExpressRoutePortsBillingType

The billing type of the ExpressRoutePort resource.

Name	Type	Description
MeteredData	string
UnlimitedData	string

ExpressRoutePortsEncapsulation

Encapsulation method on physical ports.

Name	Type	Description
Dot1Q	string
QinQ	string

ManagedServiceIdentity

Identity for the resource.

Name	Type	Description
principalId	string	The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string	The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type	ResourceIdentityType	The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
userAssignedIdentities	UserAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ProvisioningState

The current provisioning state.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

ResourceIdentityType

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

SubResource

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.

UserAssignedIdentities

The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name	Type	Description