Express Route Ports - Get

服务:

ExpressRoute

API 版本:

2025-05-01

检索请求的 ExpressRoutePort 资源。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}?api-version=2025-05-01

URI 参数

名称	在	必需	类型	说明
expressRoutePortName	path	True	string	ExpressRoutePort 的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
200 OK	ExpressRoutePort	Azure 运营顺利完成。
Other Status Codes	CloudError	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ExpressRoutePortGet

示例请求

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/ExpressRoutePorts/portName?api-version=2025-05-01

JavaScript

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

/**
 * This sample demonstrates how to Retrieves the requested ExpressRoutePort resource.
 *
 * @summary Retrieves the requested ExpressRoutePort resource.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/ExpressRoutePortGet.json
 */
async function expressRoutePortGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const expressRoutePortName = "portName";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.expressRoutePorts.get(resourceGroupName, expressRoutePortName);
  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

示例响应

状态代码:

200

{
  "name": "portName",
  "type": "Microsoft.Network/expressRoutePorts",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName",
  "location": "westus",
  "properties": {
    "allocationDate": "Friday, July 1, 2018",
    "bandwidthInGbps": 100,
    "billingType": "UnlimitedData",
    "circuits": [],
    "encapsulation": "QinQ",
    "etherType": "0x8100",
    "links": [
      {
        "name": "link1",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1",
        "properties": {
          "adminState": "Disabled",
          "coloLocation": "coloLocation1",
          "connectorType": "LC",
          "interfaceName": "Ethernet 0/0",
          "patchPanelId": "patchPanelId1",
          "provisioningState": "Succeeded",
          "rackId": "rackId1",
          "routerName": "router1"
        }
      },
      {
        "name": "link2",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2",
        "properties": {
          "adminState": "Disabled",
          "coloLocation": "coloLocation2",
          "connectorType": "LC",
          "interfaceName": "Ethernet 0/0",
          "patchPanelId": "patchPanelId2",
          "provisioningState": "Succeeded",
          "rackId": "rackId2",
          "routerName": "router2"
        }
      }
    ],
    "mtu": "1500",
    "peeringLocation": "peeringLocationName",
    "provisionedBandwidthInGbps": 0,
    "provisioningState": "Succeeded"
  }
}

定义

名称	说明
CloudError	服务的错误响应。
CloudErrorBody	服务的错误响应。
ExpressRouteLink	ExpressRoute链接
ExpressRouteLinkAdminState	物理端口的管理状态。
ExpressRouteLinkConnectorType	物理光纤端口类型。
ExpressRouteLinkMacSecCipher	Mac 安全密码。
ExpressRouteLinkMacSecConfig	ExpressRouteLink Mac 安全配置的定义。
ExpressRouteLinkMacSecSciState	已启用/禁用 Sci 模式。
ExpressRoutePort	ExpressRoute 端口
ExpressRoutePortsBillingType	ExpressRoutePort 资源的计费类型。
ExpressRoutePortsEncapsulation	物理端口上的封装方法。
ManagedServiceIdentity	资源的标识。
ManagedServiceIdentityUserAssignedIdentities
ProvisioningState	资源的预配状态。
ResourceIdentityType	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。
SubResource	对另一个子资源的引用。

CloudError

对象

服务的错误响应。

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

CloudErrorBody

对象

服务的错误响应。

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

ExpressRouteLink

对象

ExpressRoute链接

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	父级子端口资源中唯一的子端口资源的名称。
properties.adminState	ExpressRouteLinkAdminState	物理端口的管理状态。
properties.coloLocation	string	ExpressRoute 混合直接的共定位。
properties.connectorType	ExpressRouteLinkConnectorType	物理光纤端口类型。
properties.interfaceName	string	Azure 路由器接口的名称。
properties.macSecConfig	ExpressRouteLinkMacSecConfig	ExpressRouteLink Mac 安全配置的定义。 MacSec 配置。
properties.patchPanelId	string	物理端口与配线架端口之间的映射。
properties.provisioningState	ProvisioningState	快速路由链接资源的预配状态。
properties.rackId	string	将物理配线架映射到机架。
properties.routerName	string	与物理端口关联的 Azure 路由器的名称。

ExpressRouteLinkAdminState

枚举

物理端口的管理状态。

值	说明
Enabled	已启用
Disabled	已禁用

ExpressRouteLinkConnectorType

枚举

物理光纤端口类型。

值	说明
LC	立法会
SC	SC

ExpressRouteLinkMacSecCipher

枚举

Mac 安全密码。

值	说明
GcmAes256	GcmAes256
GcmAes128	GcmAes128
GcmAesXpn128	GcmAesXpn128
GcmAesXpn256	GcmAesXpn256

ExpressRouteLinkMacSecConfig

对象

ExpressRouteLink Mac 安全配置的定义。

名称	类型	说明
cakSecretIdentifier	string	包含 Mac 安全 CAK 密钥的 Keyvault 机密标识符 URL。
cipher	ExpressRouteLinkMacSecCipher	Mac 安全密码。
cknSecretIdentifier	string	包含 Mac 安全 CKN 密钥的 Keyvault 机密标识符 URL。
sciState	ExpressRouteLinkMacSecSciState	已启用/禁用 Sci 模式。

ExpressRouteLinkMacSecSciState

枚举

已启用/禁用 Sci 模式。

值	说明
Disabled	已禁用
Enabled	已启用

ExpressRoutePort

对象

ExpressRoute 端口

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
identity	ManagedServiceIdentity	ExpressRoutePort 的标识（如果已配置）。
location	string	资源位置。
name	string	资源名称。
properties.allocationDate	string	授权书中使用的实际港口分配日期。
properties.bandwidthInGbps	integer (int32)	Gbps 中采购的端口的带宽。
properties.billingType	ExpressRoutePortsBillingType	ExpressRoutePort 资源的计费类型。
properties.circuits	SubResource[]	引用在此 ExpressRoutePort 资源上预配的 ExpressRoute 线路。
properties.encapsulation	ExpressRoutePortsEncapsulation	物理端口上的封装方法。
properties.etherType	string	物理端口的以太类型。
properties.links	ExpressRouteLink[]	ExpressRouteLink Sub-Resources ExpressRoutePort 资源的物理链接集。
properties.mtu	string	物理端口对的最大传输单位。
properties.peeringLocation	string	ExpressRoutePort 在物理上映射到的对等互连位置的名称。
properties.provisionedBandwidthInGbps	number (float)	关联电路带宽的聚合 Gbps。
properties.provisioningState	ProvisioningState	快速路由端口资源的预配状态。
properties.resourceGuid	string	快速路由端口资源的资源 GUID 属性。
tags	object	资源标记。
type	string	资源类型。

ExpressRoutePortsBillingType

枚举

ExpressRoutePort 资源的计费类型。

值	说明
MeteredData	计量数据
UnlimitedData	无限数据

ExpressRoutePortsEncapsulation

枚举

物理端口上的封装方法。

值	说明
Dot1Q	Dot1Q
QinQ	秦Q

ManagedServiceIdentity

对象

资源的标识。

名称	类型	说明
principalId	string	系统分配的标识的主体 ID。 此属性仅针对系统分配的标识提供。
tenantId	string	系统分配的标识的租户 ID。 此属性仅针对系统分配的标识提供。
type	ResourceIdentityType	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。
userAssignedIdentities	<string,  ManagedServiceIdentityUserAssignedIdentities>	与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

ManagedServiceIdentityUserAssignedIdentities

对象

名称	类型	说明
clientId	string	用户分配标识的客户端 ID。
principalId	string	用户分配标识的主体 ID。

ProvisioningState

枚举

资源的预配状态。

值	说明
Failed	Failed
Succeeded	成功
Canceled	已取消
Creating	创建
Updating	更新
Deleting	正在删除

ResourceIdentityType

枚举

用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。

值	说明
SystemAssigned	系统分配
UserAssigned	UserAssigned
SystemAssigned, UserAssigned	系统分配、用户分配
None	没有

SubResource

对象

对另一个子资源的引用。

名称	类型	说明
id	string	资源 ID。