你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Express Route Provider Ports Location - List

Service:

ExpressRoute

API Version:

2023-09-01

检索订阅中的所有 ExpressRouteProviderPorts。

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

With optional parameters:

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

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	可以唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。
$filter	query		string	要应用于操作的筛选器。 例如，可以使用 $filter=location eq“{state}”。

响应

名称	类型	说明
200 OK	ExpressRouteProviderPortListResult	请求成功。 该操作返回某个位置的 ExpressRouteProviderPort 资源列表。 如果没有提供程序的端口，则返回空列表。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

ExpressRouteProviderPortList

Sample Request

HTTP

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

Java

/**
 * Samples for ExpressRouteProviderPortsLocation List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/expressRouteProviderPortList.
     * json
     */
    /**
     * Sample code: ExpressRouteProviderPortList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void expressRouteProviderPortList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRouteProviderPortsLocations().listWithResponse(null,
            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_provider_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_provider_ports_location.list()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/expressRouteProviderPortList.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/expressRouteProviderPortList.json
func ExampleExpressRouteProviderPortsLocationClient_List() {
	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)
	}
	res, err := clientFactory.NewExpressRouteProviderPortsLocationClient().List(ctx, &armnetwork.ExpressRouteProviderPortsLocationClientListOptions{Filter: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ExpressRouteProviderPortListResult = armnetwork.ExpressRouteProviderPortListResult{
	// 	Value: []*armnetwork.ExpressRouteProviderPort{
	// 		{
	// 			Type: to.Ptr("Microsoft.Network/expressRouteProviderPort"),
	// 			ID: to.Ptr("/subscriptions/subid/providers/Microsoft.Network/ExpressRoutePortsLocations/SiliconValley/bvtazureixpportpair1"),
	// 			Location: to.Ptr("uswest"),
	// 			Etag: to.Ptr("W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\""),
	// 			Properties: &armnetwork.ExpressRouteProviderPortProperties{
	// 				OverprovisionFactor: to.Ptr[int32](4),
	// 				PeeringLocation: to.Ptr("SiliconValley"),
	// 				PortBandwidthInMbps: to.Ptr[int32](4000),
	// 				PortPairDescriptor: to.Ptr("bvtazureixpportpair1"),
	// 				PrimaryAzurePort: to.Ptr("bvtazureixp01"),
	// 				RemainingBandwidthInMbps: to.Ptr[int32](1500),
	// 				SecondaryAzurePort: to.Ptr("bvtazureixp01"),
	// 				UsedBandwidthInMbps: to.Ptr[int32](2500),
	// 			},
	// 		},
	// 		{
	// 			Type: to.Ptr("Microsoft.Network/expressRouteProviderPort"),
	// 			ID: to.Ptr("/subscriptions/subid/providers/Microsoft.Network/ExpressRoutePortsLocations/SiliconValley/bvtazureixpportpair2"),
	// 			Location: to.Ptr("uswest"),
	// 			Etag: to.Ptr("W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\""),
	// 			Properties: &armnetwork.ExpressRouteProviderPortProperties{
	// 				OverprovisionFactor: to.Ptr[int32](4),
	// 				PeeringLocation: to.Ptr("seattle"),
	// 				PortBandwidthInMbps: to.Ptr[int32](4000),
	// 				PortPairDescriptor: to.Ptr("bvtazureixpportpair2"),
	// 				PrimaryAzurePort: to.Ptr("bvtazureixp02"),
	// 				RemainingBandwidthInMbps: to.Ptr[int32](1800),
	// 				SecondaryAzurePort: to.Ptr("bvtazureixp02"),
	// 				UsedBandwidthInMbps: to.Ptr[int32](1200),
	// 			},
	// 	}},
	// }
}

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 Retrieves all the ExpressRouteProviderPorts in a subscription.
 *
 * @summary Retrieves all the ExpressRouteProviderPorts in a subscription.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/expressRouteProviderPortList.json
 */
async function expressRouteProviderPortList() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.expressRouteProviderPortsLocation.list();
  console.log(result);
}

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/expressRouteProviderPortList.json
// this example is just showing the usage of "ExpressRouteProviderPortsLocation_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 ExpressRouteProviderPortResource
ExpressRouteProviderPortCollection collection = subscriptionResource.GetExpressRouteProviderPorts();

// invoke the operation and iterate over the result
await foreach (ExpressRouteProviderPortResource 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
    ExpressRouteProviderPortData 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": [
    {
      "id": "/subscriptions/subid/providers/Microsoft.Network/ExpressRoutePortsLocations/SiliconValley/bvtazureixpportpair1",
      "type": "Microsoft.Network/expressRouteProviderPort",
      "location": "uswest",
      "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"",
      "properties": {
        "portPairDescriptor": "bvtazureixpportpair1",
        "primaryAzurePort": "bvtazureixp01",
        "secondaryAzurePort": "bvtazureixp01",
        "peeringLocation": "SiliconValley",
        "overprovisionFactor": 4,
        "portBandwidthInMbps": 4000,
        "usedBandwidthInMbps": 2500,
        "remainingBandwidthInMbps": 1500
      }
    },
    {
      "id": "/subscriptions/subid/providers/Microsoft.Network/ExpressRoutePortsLocations/SiliconValley/bvtazureixpportpair2",
      "type": "Microsoft.Network/expressRouteProviderPort",
      "location": "uswest",
      "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"",
      "properties": {
        "portPairDescriptor": "bvtazureixpportpair2",
        "primaryAzurePort": "bvtazureixp02",
        "secondaryAzurePort": "bvtazureixp02",
        "peeringLocation": "seattle",
        "overprovisionFactor": 4,
        "portBandwidthInMbps": 4000,
        "usedBandwidthInMbps": 1200,
        "remainingBandwidthInMbps": 1800
      }
    }
  ]
}

定义

名称	说明
CloudError	来自服务的错误响应。
CloudErrorBody	来自服务的错误响应。
ExpressRouteProviderPort	ExpressRouteProviderPort 资源。
ExpressRouteProviderPortListResult	ListExpressRouteProviderPort API 服务调用的响应。

CloudError

来自服务的错误响应。

名称	类型	说明
error	CloudErrorBody	云错误正文。

CloudErrorBody

来自服务的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，该消息适用于在用户界面中显示。
target	string	特定错误的目标。 例如，属性的名称出错。

ExpressRouteProviderPort

ExpressRouteProviderPort 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当资源更新时都会更改。
id	string	资源的完全限定的资源 ID。
location	string	资源位置。
name	string	资源的名称
properties.overprovisionFactor	integer	端口对的过度预配因素。
properties.peeringLocation	string	端口对的对等互连位置。
properties.portBandwidthInMbps	integer	端口的带宽（以 Mbps 为单位）
properties.portPairDescriptor	string	端口对的名称。
properties.primaryAzurePort	string	主端口的名称。
properties.remainingBandwidthInMbps	integer	端口的剩余带宽（以 Mbps 为单位）
properties.secondaryAzurePort	string	辅助端口的名称。
properties.usedBandwidthInMbps	integer	端口的已用带宽（以 Mbps 为单位）
tags	object	资源标记。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ExpressRouteProviderPortListResult

ListExpressRouteProviderPort API 服务调用的响应。

名称	类型	说明
nextLink	string	用于获取下一组结果的 URL。
value	ExpressRouteProviderPort[]	ExpressRouteProviderPort 资源的列表。