Express Route Circuit Peerings - Create Or Update

Service:

ExpressRoute

Version d'API:

2023-11-01

Crée ou met à jour un peering dans les circuits d’itinéraire express spécifiés.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
circuitName	path	True	string	Nom du circuit express route.
peeringName	path	True	string	Nom du peering.
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	Informations d’identification de l’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
id	string	ID de ressource.
name	string	Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
properties.azureASN	integer	ASN Azure.
properties.connections	ExpressRouteCircuitConnection[]	Liste des connexions de circuit associées au peering privé Azure pour ce circuit.
properties.expressRouteConnection	ExpressRouteConnectionId	Connexion ExpressRoute.
properties.gatewayManagerEtag	string	The GatewayManager Etag.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	Configuration du peering IPv6.
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Configuration du peering Microsoft.
properties.peerASN	integer	ASN d’homologue.
properties.peeringType	ExpressRoutePeeringType	Type de peering.
properties.primaryAzurePort	string	Port principal.
properties.primaryPeerAddressPrefix	string	Préfixe d’adresse primaire.
properties.routeFilter	SubResource	Référence à la ressource RouteFilter.
properties.secondaryAzurePort	string	Port secondaire.
properties.secondaryPeerAddressPrefix	string	Préfixe d’adresse secondaire.
properties.sharedKey	string	Clé partagée.
properties.state	ExpressRoutePeeringState	État de peering.
properties.stats	ExpressRouteCircuitStats	Statistiques de peering du circuit express route.
properties.vlanId	integer	ID de réseau local virtuel.

Réponses

Nom	Type	Description
200 OK	ExpressRouteCircuitPeering	Mise à jour réussie. L’opération retourne la ressource ExpressRouteCircuitPeering résultante.
201 Created	ExpressRouteCircuitPeering	Créez une opération réussie. L’opération retourne la ressource ExpressRouteCircuitPeering résultante.
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Create ExpressRouteCircuit Peerings

Exemple de requête

HTTP

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

{
  "properties": {
    "peerASN": 200,
    "primaryPeerAddressPrefix": "192.168.16.252/30",
    "secondaryPeerAddressPrefix": "192.168.18.252/30",
    "vlanId": 200
  }
}

Java

import com.azure.resourcemanager.network.fluent.models.ExpressRouteCircuitPeeringInner;

/**
 * Samples for ExpressRouteCircuitPeerings CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/
     * ExpressRouteCircuitPeeringCreate.json
     */
    /**
     * Sample code: Create ExpressRouteCircuit Peerings.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createExpressRouteCircuitPeerings(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRouteCircuitPeerings().createOrUpdate("rg1", "circuitName",
            "AzurePrivatePeering",
            new ExpressRouteCircuitPeeringInner().withPeerAsn(200L).withPrimaryPeerAddressPrefix("192.168.16.252/30")
                .withSecondaryPeerAddressPrefix("192.168.18.252/30").withVlanId(200),
            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 typing import Any, IO, Union

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_create.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.begin_create_or_update(
        resource_group_name="rg1",
        circuit_name="circuitName",
        peering_name="AzurePrivatePeering",
        peering_parameters={
            "properties": {
                "peerASN": 200,
                "primaryPeerAddressPrefix": "192.168.16.252/30",
                "secondaryPeerAddressPrefix": "192.168.18.252/30",
                "vlanId": 200,
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/ExpressRouteCircuitPeeringCreate.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/azcore/to"
	"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/f4c6c8697c59f966db0d1e36b62df3af3bca9065/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/ExpressRouteCircuitPeeringCreate.json
func ExampleExpressRouteCircuitPeeringsClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewExpressRouteCircuitPeeringsClient().BeginCreateOrUpdate(ctx, "rg1", "circuitName", "AzurePrivatePeering", armnetwork.ExpressRouteCircuitPeering{
		Properties: &armnetwork.ExpressRouteCircuitPeeringPropertiesFormat{
			PeerASN:                    to.Ptr[int64](200),
			PrimaryPeerAddressPrefix:   to.Ptr("192.168.16.252/30"),
			SecondaryPeerAddressPrefix: to.Ptr("192.168.18.252/30"),
			VlanID:                     to.Ptr[int32](200),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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/AzurePrivatePeering"),
	// 	Name: to.Ptr("AzurePrivatePeering"),
	// 	Etag: to.Ptr("W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\""),
	// 	Properties: &armnetwork.ExpressRouteCircuitPeeringPropertiesFormat{
	// 		AzureASN: to.Ptr[int32](12076),
	// 		ExpressRouteConnection: &armnetwork.ExpressRouteConnectionID{
	// 		},
	// 		GatewayManagerEtag: to.Ptr(""),
	// 		IPv6PeeringConfig: &armnetwork.IPv6ExpressRouteCircuitPeeringConfig{
	// 			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"),
	// 		PeerASN: to.Ptr[int64](200),
	// 		PeeringType: to.Ptr(armnetwork.ExpressRoutePeeringTypeAzurePrivatePeering),
	// 		PrimaryAzurePort: to.Ptr(""),
	// 		PrimaryPeerAddressPrefix: to.Ptr("192.168.16.252/30"),
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		SecondaryAzurePort: to.Ptr(""),
	// 		SecondaryPeerAddressPrefix: to.Ptr("192.168.18.252/30"),
	// 		State: to.Ptr(armnetwork.ExpressRoutePeeringStateEnabled),
	// 		VlanID: to.Ptr[int32](200),
	// 	},
	// }
}

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 Creates or updates a peering in the specified express route circuits.
 *
 * @summary Creates or updates a peering in the specified express route circuits.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/ExpressRouteCircuitPeeringCreate.json
 */
async function createExpressRouteCircuitPeerings() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const circuitName = "circuitName";
  const peeringName = "AzurePrivatePeering";
  const peeringParameters = {
    peerASN: 200,
    primaryPeerAddressPrefix: "192.168.16.252/30",
    secondaryPeerAddressPrefix: "192.168.18.252/30",
    vlanId: 200,
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.expressRouteCircuitPeerings.beginCreateOrUpdateAndWait(
    resourceGroupName,
    circuitName,
    peeringName,
    peeringParameters,
  );
  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

Exemple de réponse

Code d’état:

201

{
  "name": "AzurePrivatePeering",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering",
  "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"",
  "properties": {
    "provisioningState": "Succeeded",
    "peeringType": "AzurePrivatePeering",
    "azureASN": 12076,
    "peerASN": 200,
    "primaryPeerAddressPrefix": "192.168.16.252/30",
    "secondaryPeerAddressPrefix": "192.168.18.252/30",
    "primaryAzurePort": "",
    "secondaryAzurePort": "",
    "state": "Enabled",
    "vlanId": 200,
    "gatewayManagerEtag": "",
    "lastModifiedBy": "Customer",
    "ipv6PeeringConfig": {
      "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126",
      "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126",
      "state": "Enabled"
    },
    "expressRouteConnection": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName"
    }
  }
}

Code d’état:

200

{
  "name": "AzurePrivatePeering",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering",
  "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"",
  "properties": {
    "provisioningState": "Succeeded",
    "peeringType": "AzurePrivatePeering",
    "azureASN": 12076,
    "peerASN": 200,
    "primaryPeerAddressPrefix": "192.168.16.252/30",
    "secondaryPeerAddressPrefix": "192.168.18.252/30",
    "primaryAzurePort": "",
    "secondaryAzurePort": "",
    "state": "Enabled",
    "vlanId": 200,
    "gatewayManagerEtag": "",
    "lastModifiedBy": "Customer",
    "ipv6PeeringConfig": {
      "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126",
      "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126",
      "state": "Enabled"
    },
    "expressRouteConnection": ""
  }
}

Définitions

Nom	Description
CircuitConnectionStatus	État de connexion express Route Circuit.
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
ExpressRouteCircuitConnection	Connexion de circuit ExpressRoute dans une ressource ExpressRouteCircuitPeering.
ExpressRouteCircuitPeering	Peering dans une ressource ExpressRouteCircuit.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	État de préfixe public annoncé de la ressource Peering.
ExpressRouteCircuitPeeringConfig	Spécifie la configuration de peering.
ExpressRouteCircuitPeeringState	État du peering.
ExpressRouteCircuitStats	Contient des statistiques associées au peering.
ExpressRouteConnectionId	ID d’ExpressRouteConnection.
ExpressRoutePeeringState	État du peering.
ExpressRoutePeeringType	Type de peering.
Ipv6CircuitConnectionConfig	Propriétés de connexion de circuit IPv6 pour une portée globale.
Ipv6ExpressRouteCircuitPeeringConfig	Contient la configuration de peering IPv6.
PeerExpressRouteCircuitConnection	Peer Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.
ProvisioningState	État d’approvisionnement actuel.
SubResource	Référence à une autre sous-ressource.

CircuitConnectionStatus

État de connexion express Route Circuit.

Nom	Type	Description
Connected	string
Connecting	string
Disconnected	string

CloudError

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Corps de l’erreur cloud.

CloudErrorBody

Réponse d’erreur du service.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

ExpressRouteCircuitConnection

Connexion de circuit ExpressRoute dans une ressource ExpressRouteCircuitPeering.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
name	string	Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
properties.addressPrefix	string	/29'espace d’adressage IP pour extraire les adresses client pour les tunnels.
properties.authorizationKey	string	Clé d’autorisation.
properties.circuitConnectionStatus	CircuitConnectionStatus	État de connexion express Route Circuit.
properties.expressRouteCircuitPeering	SubResource	Référence à la ressource de peering privé du circuit Express Route Circuit du circuit qui lance la connexion.
properties.ipv6CircuitConnectionConfig	Ipv6CircuitConnectionConfig	Préfixe d’adresse IPv6Properties de la connexion de circuit express route.
properties.peerExpressRouteCircuitPeering	SubResource	Référence à la ressource de peering privé du circuit Express Route Circuit du circuit appairé.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de connexion de circuit express route.
type	string	Type de la ressource.

ExpressRouteCircuitPeering

Peering dans une ressource ExpressRouteCircuit.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
name	string	Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
properties.azureASN	integer	ASN Azure.
properties.connections	ExpressRouteCircuitConnection[]	Liste des connexions de circuit associées au peering privé Azure pour ce circuit.
properties.expressRouteConnection	ExpressRouteConnectionId	Connexion ExpressRoute.
properties.gatewayManagerEtag	string	The GatewayManager Etag.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	Configuration du peering IPv6.
properties.lastModifiedBy	string	Qui a été le dernier à modifier le peering.
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Configuration du peering Microsoft.
properties.peerASN	integer	ASN d’homologue.
properties.peeredConnections	PeerExpressRouteCircuitConnection[]	Liste des connexions de circuit appairées associées au peering privé Azure pour ce circuit.
properties.peeringType	ExpressRoutePeeringType	Type de peering.
properties.primaryAzurePort	string	Port principal.
properties.primaryPeerAddressPrefix	string	Préfixe d’adresse primaire.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de peering de circuit express route.
properties.routeFilter	SubResource	Référence à la ressource RouteFilter.
properties.secondaryAzurePort	string	Port secondaire.
properties.secondaryPeerAddressPrefix	string	Préfixe d’adresse secondaire.
properties.sharedKey	string	Clé partagée.
properties.state	ExpressRoutePeeringState	État de peering.
properties.stats	ExpressRouteCircuitStats	Statistiques de peering du circuit express route.
properties.vlanId	integer	ID de réseau local virtuel.
type	string	Type de la ressource.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

État de préfixe public annoncé de la ressource Peering.

Nom	Type	Description
Configured	string
Configuring	string
NotConfigured	string
ValidationNeeded	string

ExpressRouteCircuitPeeringConfig

Spécifie la configuration de peering.

Nom	Type	Description
advertisedCommunities	string[]	Communautés de peering bgp. Spécifié pour le peering Microsoft.
advertisedPublicPrefixes	string[]	Référence à AdvertisedPublicPrefixes.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	État de préfixe public annoncé de la ressource Peering.
customerASN	integer	CustomerASN du peering.
legacyMode	integer	Mode hérité du peering.
routingRegistryName	string	RoutingRegistryName de la configuration.

ExpressRouteCircuitPeeringState

État du peering.

Nom	Type	Description
Disabled	string
Enabled	string

ExpressRouteCircuitStats

Contient des statistiques associées au peering.

Nom	Type	Description
primarybytesIn	integer	Octets principaux du peering.
primarybytesOut	integer	Octets principaux De l’appairage.
secondarybytesIn	integer	Octets secondaires du peering.
secondarybytesOut	integer	Octets secondairesOut du peering.

ExpressRouteConnectionId

ID d’ExpressRouteConnection.

Nom	Type	Description
id	string	ID d’ExpressRouteConnection.

ExpressRoutePeeringState

État du peering.

Nom	Type	Description
Disabled	string
Enabled	string

ExpressRoutePeeringType

Type de peering.

Nom	Type	Description
AzurePrivatePeering	string
AzurePublicPeering	string
MicrosoftPeering	string

Ipv6CircuitConnectionConfig

Propriétés de connexion de circuit IPv6 pour une portée globale.

Nom	Type	Description
addressPrefix	string	/125'espace d’adressage IP pour découper les adresses client pour une portée globale.
circuitConnectionStatus	CircuitConnectionStatus	État de connexion express Route Circuit.

Ipv6ExpressRouteCircuitPeeringConfig

Contient la configuration de peering IPv6.

Nom	Type	Description
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Configuration du peering Microsoft.
primaryPeerAddressPrefix	string	Préfixe d’adresse primaire.
routeFilter	SubResource	Référence à la ressource RouteFilter.
secondaryPeerAddressPrefix	string	Préfixe d’adresse secondaire.
state	ExpressRouteCircuitPeeringState	État du peering.

PeerExpressRouteCircuitConnection

Peer Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
name	string	Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
properties.addressPrefix	string	/29'espace d’adressage IP pour extraire les adresses client pour les tunnels.
properties.authResourceGuid	string	Guid de ressource de l’autorisation utilisée pour la connexion de circuit express route.
properties.circuitConnectionStatus	CircuitConnectionStatus	État de connexion express Route Circuit.
properties.connectionName	string	Nom de la ressource de connexion de circuit express route.
properties.expressRouteCircuitPeering	SubResource	Référence à la ressource de peering privé du circuit Express Route Circuit.
properties.peerExpressRouteCircuitPeering	SubResource	Référence à la ressource de peering privé du circuit Express Route Circuit du circuit appairé.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de connexion de circuit express d’homologue.
type	string	Type de la ressource.

ProvisioningState

État d’approvisionnement actuel.

Nom	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Référence à une autre sous-ressource.

Nom	Type	Description
id	string	ID de ressource.