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

Express Route Ports - Get

参考

服务:: ExpressRoute

API 版本:: 2024-05-01

检索请求的 ExpressRoutePort 资源。

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

URI 参数

名称	在	必需	类型	说明
expressRoutePortName	path	True	string	ExpressRoutePort 的名称。
resourceGroupName	path	True	string	资源组的名称。
subscriptionId	path	True	string	唯一标识 Azure 订阅Microsoft的订阅凭据。订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	ExpressRoutePort	请求成功。该操作返回请求的 ExpressRoutePort 资源。
Other Status Codes	CloudError	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ExpressRoutePortGet

示例请求

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ExpressRoutePorts/portName?api-version=2024-05-01


/**
 * Samples for ExpressRoutePorts GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRoutePortGet.json
     */
    /**
     * Sample code: ExpressRoutePortGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void expressRoutePortGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRoutePorts().getByResourceGroupWithResponse("rg1",
            "portName", 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_port_get.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.get(
        resource_group_name="rg1",
        express_route_port_name="portName",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRoutePortGet.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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRoutePortGet.json
func ExampleExpressRoutePortsClient_Get() {
	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.NewExpressRoutePortsClient().Get(ctx, "rg1", "portName", 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.ExpressRoutePort = 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

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

/**
 * 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/stable/2024-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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRoutePortGet.json
// this example is just showing the usage of "ExpressRoutePorts_Get" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this ExpressRoutePortResource
ExpressRoutePortCollection collection = resourceGroupResource.GetExpressRoutePorts();

// invoke the operation
string expressRoutePortName = "portName";
NullableResponse<ExpressRoutePortResource> response = await collection.GetIfExistsAsync(expressRoutePortName);
ExpressRoutePortResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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",
  "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": []
  }
}

定义

名称	说明
CloudError	服务的错误响应。
CloudErrorBody	服务的错误响应。
ExpressRouteLink	ExpressRouteLink
ExpressRouteLinkAdminState	物理端口的管理状态。
ExpressRouteLinkConnectorType	物理光纤端口类型。
ExpressRouteLinkMacSecCipher	Mac 安全密码。
ExpressRouteLinkMacSecConfig	ExpressRouteLink Mac 安全配置的定义。
ExpressRouteLinkMacSecSciState	已启用/禁用 Sci 模式。
ExpressRoutePort	ExpressRoute 端口
ExpressRoutePortsBillingType	ExpressRoutePort 资源的计费类型。
ExpressRoutePortsEncapsulation	物理端口上的封装方法。
ManagedServiceIdentity	资源的标识。
ProvisioningState	当前预配状态。
ResourceIdentityType	用于资源的标识类型。类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。类型“None”将从虚拟机中删除任何标识。
SubResource	对另一个子资源的引用。
UserAssignedIdentities	与资源关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

CloudError

Object

服务的错误响应。

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

CloudErrorBody

Object

服务的错误响应。

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

ExpressRouteLink

Object

ExpressRouteLink

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	父级子端口资源中唯一的子端口资源的名称。
properties.adminState	ExpressRouteLinkAdminState	物理端口的管理状态。
properties.coloLocation	string	ExpressRoute 混合直接的 Cololocation。
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

枚举

物理端口的管理状态。

值	说明
Disabled
Enabled

ExpressRouteLinkConnectorType

枚举

物理光纤端口类型。

值	说明
LC
SC

ExpressRouteLinkMacSecCipher

枚举

Mac 安全密码。

值	说明
GcmAes128
GcmAes256
GcmAesXpn128
GcmAesXpn256

ExpressRouteLinkMacSecConfig

Object

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

Object

ExpressRoute 端口

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
identity	ManagedServiceIdentity	ExpressRoutePort 的标识（如果已配置）。
location	string	资源位置。
name	string	资源名称。
properties.allocationDate	string	要在授权信中使用的物理端口分配的日期。
properties.bandwidthInGbps	integer	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	聚合关联的线路带宽的 Gbps。
properties.provisioningState	ProvisioningState	快速路由端口资源的预配状态。
properties.resourceGuid	string	快速路由端口资源的资源 GUID 属性。
tags	object	资源标记。
type	string	资源类型。

ExpressRoutePortsBillingType

枚举

ExpressRoutePort 资源的计费类型。

值	说明
MeteredData
UnlimitedData

ExpressRoutePortsEncapsulation

枚举

物理端口上的封装方法。

值	说明
Dot1Q
QinQ

ManagedServiceIdentity

Object

资源的标识。

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

ProvisioningState

枚举

当前预配状态。

值	说明
Deleting
Failed
Succeeded
Updating

ResourceIdentityType

枚举

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

值	说明
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

SubResource

Object

对另一个子资源的引用。

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

UserAssignedIdentities

Object

与资源关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

名称	类型	说明