Express Route Circuit Peerings - Get

Referência

Service:: ExpressRoute

API Version:: 2023-09-01

Obtém o peering especificado para o circuito express route.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
circuitName	path	True	string	O nome do circuito express route.
peeringName	path	True	string	O nome do peering.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	As credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API de Cliente.

Respostas

Name	Tipo	Description
200 OK	ExpressRouteCircuitPeering	Pedido com êxito. A operação devolve o recurso expressRouteCircuitPeering resultante.
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Get ExpressRouteCircuit Peering

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering?api-version=2023-09-01


/**
 * Samples for ExpressRouteCircuitPeerings Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCircuitPeeringGet
     * .json
     */
    /**
     * Sample code: Get ExpressRouteCircuit Peering.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getExpressRouteCircuitPeering(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRouteCircuitPeerings().getWithResponse("rg1",
            "circuitName", "MicrosoftPeering", 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_circuit_peering_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_circuit_peerings.get(
        resource_group_name="rg1",
        circuit_name="circuitName",
        peering_name="MicrosoftPeering",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCircuitPeeringGet.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/ExpressRouteCircuitPeeringGet.json
func ExampleExpressRouteCircuitPeeringsClient_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.NewExpressRouteCircuitPeeringsClient().Get(ctx, "rg1", "circuitName", "MicrosoftPeering", 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.ExpressRouteCircuitPeering = armnetwork.ExpressRouteCircuitPeering{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering"),
	// 	Name: to.Ptr("MicrosoftPeering"),
	// 	Type: to.Ptr("Microsoft.Network/expressRouteCircuits/peerings"),
	// 	Etag: to.Ptr("W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\""),
	// 	Properties: &armnetwork.ExpressRouteCircuitPeeringPropertiesFormat{
	// 		AzureASN: to.Ptr[int32](12076),
	// 		GatewayManagerEtag: to.Ptr("103"),
	// 		IPv6PeeringConfig: &armnetwork.IPv6ExpressRouteCircuitPeeringConfig{
	// 			MicrosoftPeeringConfig: &armnetwork.ExpressRouteCircuitPeeringConfig{
	// 				AdvertisedCommunities: []*string{
	// 				},
	// 				AdvertisedPublicPrefixes: []*string{
	// 					to.Ptr("3FFE:FFFF:0:CD31::/120")},
	// 					AdvertisedPublicPrefixesState: to.Ptr(armnetwork.ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateValidationNeeded),
	// 					CustomerASN: to.Ptr[int32](23),
	// 					LegacyMode: to.Ptr[int32](0),
	// 					RoutingRegistryName: to.Ptr("ARIN"),
	// 				},
	// 				PrimaryPeerAddressPrefix: to.Ptr("3FFE:FFFF:0:CD30::/126"),
	// 				SecondaryPeerAddressPrefix: to.Ptr("3FFE:FFFF:0:CD30::4/126"),
	// 				State: to.Ptr(armnetwork.ExpressRouteCircuitPeeringStateEnabled),
	// 			},
	// 			LastModifiedBy: to.Ptr("Customer"),
	// 			MicrosoftPeeringConfig: &armnetwork.ExpressRouteCircuitPeeringConfig{
	// 				AdvertisedCommunities: []*string{
	// 				},
	// 				AdvertisedPublicPrefixes: []*string{
	// 					to.Ptr("123.1.0.0/24")},
	// 					AdvertisedPublicPrefixesState: to.Ptr(armnetwork.ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateValidationNeeded),
	// 					CustomerASN: to.Ptr[int32](23),
	// 					LegacyMode: to.Ptr[int32](0),
	// 					RoutingRegistryName: to.Ptr("ARIN"),
	// 				},
	// 				PeerASN: to.Ptr[int64](100),
	// 				PeeringType: to.Ptr(armnetwork.ExpressRoutePeeringTypeMicrosoftPeering),
	// 				PrimaryAzurePort: to.Ptr("A51-TEST-06GMR-CIS-1-PRI-A"),
	// 				PrimaryPeerAddressPrefix: to.Ptr("123.0.0.0/30"),
	// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				RouteFilter: &armnetwork.SubResource{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName"),
	// 				},
	// 				SecondaryAzurePort: to.Ptr("A51-TEST-06GMR-CIS-2-SEC-A"),
	// 				SecondaryPeerAddressPrefix: to.Ptr("123.0.0.4/30"),
	// 				State: to.Ptr(armnetwork.ExpressRoutePeeringStateEnabled),
	// 				VlanID: to.Ptr[int32](300),
	// 			},
	// 		}
}

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 Gets the specified peering for the express route circuit.
 *
 * @summary Gets the specified peering for the express route circuit.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCircuitPeeringGet.json
 */
async function getExpressRouteCircuitPeering() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const circuitName = "circuitName";
  const peeringName = "MicrosoftPeering";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.expressRouteCircuitPeerings.get(
    resourceGroupName,
    circuitName,
    peeringName,
  );
  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;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCircuitPeeringGet.json
// this example is just showing the usage of "ExpressRouteCircuitPeerings_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 ExpressRouteCircuitResource created on azure
// for more information of creating ExpressRouteCircuitResource, please refer to the document of ExpressRouteCircuitResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string circuitName = "circuitName";
ResourceIdentifier expressRouteCircuitResourceId = ExpressRouteCircuitResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, circuitName);
ExpressRouteCircuitResource expressRouteCircuit = client.GetExpressRouteCircuitResource(expressRouteCircuitResourceId);

// get the collection of this ExpressRouteCircuitPeeringResource
ExpressRouteCircuitPeeringCollection collection = expressRouteCircuit.GetExpressRouteCircuitPeerings();

// invoke the operation
string peeringName = "MicrosoftPeering";
NullableResponse<ExpressRouteCircuitPeeringResource> response = await collection.GetIfExistsAsync(peeringName);
ExpressRouteCircuitPeeringResource 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
    ExpressRouteCircuitPeeringData 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": "MicrosoftPeering",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering",
  "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"",
  "properties": {
    "provisioningState": "Succeeded",
    "peeringType": "MicrosoftPeering",
    "azureASN": 12076,
    "peerASN": 100,
    "primaryPeerAddressPrefix": "123.0.0.0/30",
    "secondaryPeerAddressPrefix": "123.0.0.4/30",
    "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A",
    "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A",
    "state": "Enabled",
    "vlanId": 300,
    "gatewayManagerEtag": "103",
    "lastModifiedBy": "Customer",
    "microsoftPeeringConfig": {
      "advertisedPublicPrefixes": [
        "123.1.0.0/24"
      ],
      "advertisedCommunities": [],
      "advertisedPublicPrefixesState": "ValidationNeeded",
      "customerASN": 23,
      "legacyMode": 0,
      "routingRegistryName": "ARIN"
    },
    "ipv6PeeringConfig": {
      "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126",
      "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126",
      "state": "Enabled",
      "microsoftPeeringConfig": {
        "advertisedPublicPrefixes": [
          "3FFE:FFFF:0:CD31::/120"
        ],
        "advertisedCommunities": [],
        "advertisedPublicPrefixesState": "ValidationNeeded",
        "customerASN": 23,
        "legacyMode": 0,
        "routingRegistryName": "ARIN"
      }
    },
    "routeFilter": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName"
    }
  },
  "type": "Microsoft.Network/expressRouteCircuits/peerings"
}

Definições

Name	Description
CircuitConnectionStatus	Estado de ligação do Circuito do ExpressRoute.
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
ExpressRouteCircuitConnection	Ligação do Circuito do ExpressRoute num recurso expressRouteCircuitPeering.
ExpressRouteCircuitPeering	Peering num recurso ExpressRouteCircuit.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	O estado de prefixo público anunciado do recurso peering.
ExpressRouteCircuitPeeringConfig	Especifica a configuração do peering.
ExpressRouteCircuitPeeringState	O estado do peering.
ExpressRouteCircuitStats	Contém estatísticas associadas ao peering.
ExpressRouteConnectionId	O ID do ExpressRouteConnection.
ExpressRoutePeeringState	O estado do peering.
ExpressRoutePeeringType	O tipo de peering.
Ipv6CircuitConnectionConfig	Propriedades de Ligação do Circuito IPv6 para alcance global.
Ipv6ExpressRouteCircuitPeeringConfig	Contém a configuração de peering IPv6.
PeerExpressRouteCircuitConnection	Ligação do Circuito do ExpressRoute peering num recurso ExpressRouteCircuitPeering.
ProvisioningState	O estado de aprovisionamento atual.
SubResource	Referência a outra sub-origem.

CircuitConnectionStatus

Estado de ligação do Circuito do ExpressRoute.

Name	Tipo	Description
Connected	string
Connecting	string
Disconnected	string

CloudError

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Corpo do erro da cloud.

CloudErrorBody

Uma resposta de erro do serviço.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

ExpressRouteCircuitConnection

Ligação do Circuito do ExpressRoute num recurso expressRouteCircuitPeering.

Name	Tipo	Description
etag	string	Uma cadeia só de leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do Recurso.
name	string	O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso.
properties.addressPrefix	string	/29 espaço de endereços IP para criar endereços de cliente para túneis.
properties.authorizationKey	string	A chave de autorização.
properties.circuitConnectionStatus	CircuitConnectionStatus	Estado de ligação do Circuito do ExpressRoute.
properties.expressRouteCircuitPeering	SubResource	Referência ao Recurso de Peering Privado do Circuito do Express Route do circuito que inicia a ligação.
properties.ipv6CircuitConnectionConfig	Ipv6CircuitConnectionConfig	Prefixo de Endereço IPv6Propriedades da ligação do circuito de rota rápida.
properties.peerExpressRouteCircuitPeering	SubResource	Referência ao Recurso de Peering Privado do Circuito do ExpressRoute do circuito em modo de peering.
properties.provisioningState	ProvisioningState	O estado de aprovisionamento do recurso de ligação do circuito expressroute.
type	string	Tipo do recurso.

ExpressRouteCircuitPeering

Peering num recurso ExpressRouteCircuit.

Name	Tipo	Description
etag	string	Uma cadeia só de leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do Recurso.
name	string	O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso.
properties.azureASN	integer	O ASN do Azure.
properties.connections	ExpressRouteCircuitConnection[]	A lista de ligações de circuito associadas ao Peering Privado do Azure para este circuito.
properties.expressRouteConnection	ExpressRouteConnectionId	A ligação do ExpressRoute.
properties.gatewayManagerEtag	string	O GatewayManager Etag.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	A configuração de peering IPv6.
properties.lastModifiedBy	string	Quem foi o último a modificar o peering.
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	A configuração do peering da Microsoft.
properties.peerASN	integer	O ASN do elemento da rede.
properties.peeredConnections	PeerExpressRouteCircuitConnection[]	A lista de ligações de circuitos em modo de peering associadas ao Peering Privado do Azure para este circuito.
properties.peeringType	ExpressRoutePeeringType	O tipo de peering.
properties.primaryAzurePort	string	A porta primária.
properties.primaryPeerAddressPrefix	string	O prefixo do endereço principal.
properties.provisioningState	ProvisioningState	O estado de aprovisionamento do recurso de peering do circuito do expressroute.
properties.routeFilter	SubResource	A referência ao recurso RouteFilter.
properties.secondaryAzurePort	string	A porta secundária.
properties.secondaryPeerAddressPrefix	string	O prefixo de endereço secundário.
properties.sharedKey	string	A chave partilhada.
properties.state	ExpressRoutePeeringState	O estado do peering.
properties.stats	ExpressRouteCircuitStats	As estatísticas de peering do circuito express route.
properties.vlanId	integer	O ID da VLAN.
type	string	Tipo do recurso.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

O estado de prefixo público anunciado do recurso peering.

Name	Tipo	Description
Configured	string
Configuring	string
NotConfigured	string
ValidationNeeded	string

ExpressRouteCircuitPeeringConfig

Especifica a configuração do peering.

Name	Tipo	Description
advertisedCommunities	string[]	As comunidades do peering bgp. Especificado para peering da Microsoft.
advertisedPublicPrefixes	string[]	A referência a AdvertisedPublicPrefixes.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	O estado de prefixo público anunciado do recurso peering.
customerASN	integer	O CustomerASN do peering.
legacyMode	integer	O modo legado do peering.
routingRegistryName	string	O RoutingRegistryName da configuração.

ExpressRouteCircuitPeeringState

O estado do peering.

Name	Tipo	Description
Disabled	string
Enabled	string

ExpressRouteCircuitStats

Contém estatísticas associadas ao peering.

Name	Tipo	Description
primarybytesIn	integer	O BytesIn Principal do peering.
primarybytesOut	integer	O BytesOut principal do peering.
secondarybytesIn	integer	O BytesIn secundário do peering.
secondarybytesOut	integer	O BytesOut secundário do peering.

ExpressRouteConnectionId

O ID do ExpressRouteConnection.

Name	Tipo	Description
id	string	O ID do ExpressRouteConnection.

ExpressRoutePeeringState

O estado do peering.

Name	Tipo	Description
Disabled	string
Enabled	string

ExpressRoutePeeringType

O tipo de peering.

Name	Tipo	Description
AzurePrivatePeering	string
AzurePublicPeering	string
MicrosoftPeering	string

Ipv6CircuitConnectionConfig

Propriedades de Ligação do Circuito IPv6 para alcance global.

Name	Tipo	Description
addressPrefix	string	/125 espaço de endereços IP para criar endereços de cliente para alcance global.
circuitConnectionStatus	CircuitConnectionStatus	Estado de ligação do Circuito do ExpressRoute.

Ipv6ExpressRouteCircuitPeeringConfig

Contém a configuração de peering IPv6.

Name	Tipo	Description
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	A configuração do peering da Microsoft.
primaryPeerAddressPrefix	string	O prefixo do endereço principal.
routeFilter	SubResource	A referência ao recurso RouteFilter.
secondaryPeerAddressPrefix	string	O prefixo de endereço secundário.
state	ExpressRouteCircuitPeeringState	O estado do peering.

PeerExpressRouteCircuitConnection

Ligação do Circuito do ExpressRoute peering num recurso ExpressRouteCircuitPeering.

Name	Tipo	Description
etag	string	Uma cadeia só de leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do Recurso.
name	string	O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso.
properties.addressPrefix	string	/29 espaço de endereços IP para criar endereços de cliente para túneis.
properties.authResourceGuid	string	O guid do recurso da autorização utilizada para a ligação do circuito do expressroute.
properties.circuitConnectionStatus	CircuitConnectionStatus	Estado de ligação do Circuito do ExpressRoute.
properties.connectionName	string	O nome do recurso de ligação do circuito do expressroute.
properties.expressRouteCircuitPeering	SubResource	Referência ao Recurso de Peering Privado do Circuito do Express Route do circuito.
properties.peerExpressRouteCircuitPeering	SubResource	Referência ao Recurso de Peering Privado do Circuito do ExpressRoute do circuito em modo de peering.
properties.provisioningState	ProvisioningState	O estado de aprovisionamento do recurso de ligação do circuito expressroute do elemento da rede.
type	string	Tipo do recurso.

ProvisioningState

O estado de aprovisionamento atual.

Name	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Referência a outra sub-origem.

Name	Tipo	Description
id	string	ID do Recurso.