Express Route Ports - Get

Serviço:

ExpressRoute

Versão da API:

2024-05-01

Recupera o recurso do ExpressRoutePort solicitado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
expressRoutePortName	path	True	string	O nome de ExpressRoutePort.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Respostas

Nome	Tipo	Description
200 OK	ExpressRoutePort	Solicitação bem-sucedida. A operação retorna o recurso do ExpressRoutePort solicitado.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ExpressRoutePortGet

Solicitação de exemplo

HTTP

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

Java

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

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_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

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/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

JavaScript

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

dotnet

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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
ExpressRouteLink	ExpressRouteLink
ExpressRouteLinkAdminState	Estado administrativo da porta física.
ExpressRouteLinkConnectorType	Tipo de porta de fibra física.
ExpressRouteLinkMacSecCipher	Codificação de segurança do Mac.
ExpressRouteLinkMacSecConfig	Definição da configuração do ExpressRouteLink Mac Security.
ExpressRouteLinkMacSecSciState	Modo sci habilitado/desabilitado.
ExpressRoutePort	Porta do ExpressRoute
ExpressRoutePortsBillingType	O tipo de cobrança do recurso ExpressRoutePort.
ExpressRoutePortsEncapsulation	Método de encapsulamento em portas físicas.
ManagedServiceIdentity	Identidade do recurso.
ProvisioningState	O estado de provisionamento atual.
ResourceIdentityType	O tipo de identidade usado para o recurso. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades da máquina virtual.
SubResource	Referência a outro sub-recurso.
UserAssignedIdentities	A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

CloudError

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	CloudErrorBody	Corpo do erro de nuvem.

CloudErrorBody

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

ExpressRouteLink

Objeto

ExpressRouteLink

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	Nome do recurso de porta filho exclusivo entre os recursos de porta filho do pai.
properties.adminState	ExpressRouteLinkAdminState	Estado administrativo da porta física.
properties.coloLocation	string	Cololocação para o ExpressRoute Hybrid Direct.
properties.connectorType	ExpressRouteLinkConnectorType	Tipo de porta de fibra física.
properties.interfaceName	string	Nome da interface do roteador do Azure.
properties.macSecConfig	ExpressRouteLinkMacSecConfig	Definição da configuração do ExpressRouteLink Mac Security. Configuração do MacSec.
properties.patchPanelId	string	Mapeamento entre a porta física para a porta do painel de patch.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de link de rota expressa.
properties.rackId	string	Mapeamento do painel de patch físico para o rack.
properties.routerName	string	Nome do roteador do Azure associado à porta física.

ExpressRouteLinkAdminState

Enumeração

Estado administrativo da porta física.

Valor	Description
Disabled
Enabled

ExpressRouteLinkConnectorType

Enumeração

Tipo de porta de fibra física.

Valor	Description
LC
SC

ExpressRouteLinkMacSecCipher

Enumeração

Codificação de segurança do Mac.

Valor	Description
GcmAes128
GcmAes256
GcmAesXpn128
GcmAesXpn256

ExpressRouteLinkMacSecConfig

Objeto

Definição da configuração do ExpressRouteLink Mac Security.

Nome	Tipo	Description
cakSecretIdentifier	string	URL do Identificador de Segredo do Keyvault que contém a chave CAK de segurança do Mac.
cipher	ExpressRouteLinkMacSecCipher	Codificação de segurança do Mac.
cknSecretIdentifier	string	URL do Identificador de Segredo do Keyvault que contém a chave CKN de segurança do Mac.
sciState	ExpressRouteLinkMacSecSciState	Modo sci habilitado/desabilitado.

ExpressRouteLinkMacSecSciState

Enumeração

Modo sci habilitado/desabilitado.

Valor	Description
Disabled
Enabled

ExpressRoutePort

Objeto

Porta do ExpressRoute

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
identity	ManagedServiceIdentity	A identidade do ExpressRoutePort, se configurada.
location	string	Local do recurso.
name	string	Nome do recurso.
properties.allocationDate	string	Data da alocação de porta física a ser usada na Carta de Autorização.
properties.bandwidthInGbps	integer	Largura de banda de portas adquiridas em Gbps.
properties.billingType	ExpressRoutePortsBillingType	O tipo de cobrança do recurso ExpressRoutePort.
properties.circuits	SubResource[]	Faça referência aos circuitos do ExpressRoute que são provisionados neste recurso do ExpressRoutePort.
properties.encapsulation	ExpressRoutePortsEncapsulation	Método de encapsulamento em portas físicas.
properties.etherType	string	Tipo de ether da porta física.
properties.links	ExpressRouteLink[]	Sub-Resources do ExpressRouteLink O conjunto de links físicos do recurso ExpressRoutePort.
properties.mtu	string	Unidade de transmissão máxima dos pares de porta física.
properties.peeringLocation	string	O nome do local de emparelhamento para o qual o ExpressRoutePort está mapeado fisicamente.
properties.provisionedBandwidthInGbps	number	Agregar Gbps de larguras de banda de circuito associadas.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de porta de rota expressa.
properties.resourceGuid	string	A propriedade GUID de recurso do recurso de porta de rota expressa.
tags	object	Marcas de recurso.
type	string	Tipo de recurso.

ExpressRoutePortsBillingType

Enumeração

O tipo de cobrança do recurso ExpressRoutePort.

Valor	Description
MeteredData
UnlimitedData

ExpressRoutePortsEncapsulation

Enumeração

Método de encapsulamento em portas físicas.

Valor	Description
Dot1Q
QinQ

ManagedServiceIdentity

Objeto

Identidade do recurso.

Nome	Tipo	Description
principalId	string	A ID principal da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
tenantId	string	A ID do locatário da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
type	ResourceIdentityType	O tipo de identidade usado para o recurso. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades da máquina virtual.
userAssignedIdentities	UserAssignedIdentities	A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ProvisioningState

Enumeração

O estado de provisionamento atual.

Valor	Description
Deleting
Failed
Succeeded
Updating

ResourceIdentityType

Enumeração

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades da máquina virtual.

Valor	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

SubResource

Objeto

Referência a outro sub-recurso.

Nome	Tipo	Description
id	string	ID do recurso.

UserAssignedIdentities

Objeto

A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Nome	Tipo	Description