Express Route Ports - Get

リファレンス

Service:: ExpressRoute

API Version:: 2023-09-01

要求された ExpressRoutePort リソースを取得します。

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

URI パラメーター

名前	/	必須	型	説明
expressRoutePortName	path	True	string	ExpressRoutePort の名前。
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプションの資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API バージョン。

応答

名前	型	説明
200 OK	ExpressRoutePort	要求が成功しました。操作は、要求された ExpressRoutePort リソースを返します。
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

ExpressRoutePortGet

Sample Request

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


/**
 * Samples for ExpressRoutePorts GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-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/2023-09-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/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/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/2023-09-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 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/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

Sample Response

Status code:: 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	リソースの ID。
ProvisioningState	現在のプロビジョニング状態。
ResourceIdentityType	リソースに使用される ID の種類。種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。種類 'None' は、仮想マシンから ID を削除します。
SubResource	別のサブリソースへの参照。
UserAssignedIdentities	リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリキーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

CloudError

サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	クラウドエラー本文。

CloudErrorBody

サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムによって使用されることを意図しています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

ExpressRouteLink

ExpressRouteLink

名前	型	説明
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

物理ポートの管理状態。

名前	型	説明
Disabled	string
Enabled	string

ExpressRouteLinkConnectorType

物理ファイバーポートの種類。

名前	型	説明
LC	string
SC	string

ExpressRouteLinkMacSecCipher

Mac セキュリティ暗号。

名前	型	説明
GcmAes128	string
GcmAes256	string
GcmAesXpn128	string
GcmAesXpn256	string

ExpressRouteLinkMacSecConfig

ExpressRouteLink Mac セキュリティ構成の定義。

名前	型	説明
cakSecretIdentifier	string	Mac セキュリティ CAK キーを含む Keyvault シークレット識別子 URL。
cipher	ExpressRouteLinkMacSecCipher	Mac セキュリティ暗号。
cknSecretIdentifier	string	Mac セキュリティ CKN キーを含む Keyvault シークレット識別子 URL。
sciState	ExpressRouteLinkMacSecSciState	Sci モードが有効または無効になっています。

ExpressRouteLinkMacSecSciState

Sci モードが有効または無効になっています。

名前	型	説明
Disabled	string
Enabled	string

ExpressRoutePort

ExpressRoute ポート

名前	型	説明
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソースの ID
identity	ManagedServiceIdentity	ExpressRoutePort の ID (構成されている場合)。
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	物理ポートの Ether 型。
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	string
UnlimitedData	string

ExpressRoutePortsEncapsulation

物理ポートでのカプセル化方法。

名前	型	説明
Dot1Q	string
QinQ	string

ManagedServiceIdentity

リソースの ID。

名前	型	説明
principalId	string	システム割り当て ID のプリンシパル ID。このプロパティは、システム割り当て ID に対してのみ提供されます。
tenantId	string	システム割り当て ID のテナント ID。このプロパティは、システム割り当て ID に対してのみ提供されます。
type	ResourceIdentityType	リソースに使用される ID の種類。種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。種類 'None' は、仮想マシンから ID を削除します。
userAssignedIdentities	UserAssignedIdentities	リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリキーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

ProvisioningState

現在のプロビジョニング状態。

名前	型	説明
Deleting	string
Failed	string
Succeeded	string
Updating	string

ResourceIdentityType

リソースに使用される ID の種類。種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。種類 'None' は、仮想マシンから ID を削除します。

名前	型	説明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

SubResource

別のサブリソースへの参照。

名前	型	説明
id	string	リソースの ID

UserAssignedIdentities

リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリキーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

名前	型	説明