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 參數

名稱	位於	必要	類型	Description
expressRoutePortName	path	True	string	ExpressRoutePort 的名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	ExpressRoutePort	Azure 運作順利完成。
Other Status Codes	CloudError	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ExpressRoutePortGet

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

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"
  }
}

定義

名稱	Description
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

Object

來自服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	雲端錯誤內文。

CloudErrorBody

Object

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
details	CloudErrorBody[]	有關錯誤的其他詳細資料清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。例如，錯誤中的屬性名稱。

ExpressRouteLink

Object

ExpressRoute連結

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源標識碼。
name	string	父系子埠資源之間唯一的子埠資源名稱。
properties.adminState	ExpressRouteLinkAdminState	實體埠的系統管理狀態。
properties.coloLocation	string	ExpressRoute Hybrid Direct 的共置。
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

列舉型別

實體埠的系統管理狀態。

值	Description
Enabled	已啟用
Disabled	Disabled

ExpressRouteLinkConnectorType

列舉型別

實體光纖連接埠類型。

值	Description
LC	立法會
SC	SC

ExpressRouteLinkMacSecCipher

列舉型別

Mac 安全性加密。

值	Description
GcmAes256	GcmAes256
GcmAes128	GcmAes128
GcmAesXpn128	GcmAesXpn128
GcmAesXpn256	GcmAesXpn256

ExpressRouteLinkMacSecConfig

Object

ExpressRouteLink Mac 安全性設定的定義。

名稱	類型	Description
cakSecretIdentifier	string	包含 Mac 安全性 CAK 金鑰的 Keyvault 秘密識別碼 URL。
cipher	ExpressRouteLinkMacSecCipher	Mac 安全性加密。
cknSecretIdentifier	string	包含 Mac 安全性 CKN 金鑰的 Keyvault 秘密識別碼 URL。
sciState	ExpressRouteLinkMacSecSciState	啟用/停用 Sci 模式。

ExpressRouteLinkMacSecSciState

列舉型別

啟用/停用 Sci 模式。

值	Description
Disabled	Disabled
Enabled	已啟用

ExpressRoutePort

Object

ExpressRoute 埠

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源標識碼。
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 資源的計費類型。

值	Description
MeteredData	MeteredData
UnlimitedData	UnlimitedData

ExpressRoutePortsEncapsulation

列舉型別

實體埠上的封裝方法。

值	Description
Dot1Q	Dot1Q
QinQ	秦問

ManagedServiceIdentity

Object

資源的身分識別。

名稱	類型	Description
principalId	string	系統指派身分的主體識別碼。此屬性只會針對系統指派的身分識別提供。
tenantId	string	系統指派身分識別的租用戶識別碼。此屬性只會針對系統指派的身分識別提供。
type	ResourceIdentityType	用於資源的身分識別類型。類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。類型『None』會從虛擬機中移除任何身分識別。
userAssignedIdentities	<string, ManagedServiceIdentityUserAssignedIdentities>	與資源相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

ManagedServiceIdentityUserAssignedIdentities

Object

名稱	類型	Description
clientId	string	使用者指派身分識別的用戶端標識碼。
principalId	string	使用者指派身分識別的主體標識碼。

ProvisioningState

列舉型別

布建資源的狀態。

值	Description
Failed	失敗
Succeeded	成功
Canceled	已取消
Creating	建立中
Updating	更新中
Deleting	刪除中

ResourceIdentityType

列舉型別

用於資源的身分識別類型。類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。類型『None』會從虛擬機中移除任何身分識別。

值	Description
SystemAssigned	系統分配的
UserAssigned	UserAssigned
SystemAssigned, UserAssigned	SystemAssigned、UserAssigned
None	沒有

SubResource

Object

另一個子資源的參考。

名稱	類型	Description
id	string	資源標識碼。

共用方式為

Express Route Ports - Get

URI 參數

回應

安全性

azure_auth

範圍

範例

ExpressRoutePortGet

範例要求

範例回覆

定義

CloudError

CloudErrorBody

ExpressRouteLink

ExpressRouteLinkAdminState

ExpressRouteLinkConnectorType

ExpressRouteLinkMacSecCipher

ExpressRouteLinkMacSecConfig

ExpressRouteLinkMacSecSciState

ExpressRoutePort

ExpressRoutePortsBillingType

ExpressRoutePortsEncapsulation

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

ProvisioningState

ResourceIdentityType

SubResource