Compartir a través de


Express Route Cross Connection Peerings - List

Gets all peerings in a specified ExpressRouteCrossConnection.

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

URI Parameters

Name In Required Type Description
crossConnectionName
path True

string

The name of the ExpressRouteCrossConnection.

resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Client API version.

Responses

Name Type Description
200 OK

ExpressRouteCrossConnectionPeeringList

Request successful. The operation returns a list of ExpressRouteCrossConnectionPeering resources.

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ExpressRouteCrossConnectionBgpPeeringList

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>/peerings?api-version=2024-01-01

Sample response

{
  "value": [
    {
      "name": "AzurePrivatePeering",
      "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>/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"
        }
      }
    }
  ]
}

Definitions

Name Description
CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

The advertised public prefix state of the Peering resource.

ExpressRouteCircuitPeeringConfig

Specifies the peering configuration.

ExpressRouteCircuitPeeringState

The state of peering.

ExpressRouteCrossConnectionPeering

Peering in an ExpressRoute Cross Connection resource.

ExpressRouteCrossConnectionPeeringList

Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCrossConnection.

ExpressRoutePeeringState

The state of peering.

ExpressRoutePeeringType

The peering type.

Ipv6ExpressRouteCircuitPeeringConfig

Contains IPv6 peering config.

ProvisioningState

The current provisioning state.

SubResource

Reference to another subresource.

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

The advertised public prefix state of the Peering resource.

Name Type Description
Configured

string

Configuring

string

NotConfigured

string

ValidationNeeded

string

ExpressRouteCircuitPeeringConfig

Specifies the peering configuration.

Name Type Description
advertisedCommunities

string[]

The communities of bgp peering. Specified for microsoft peering.

advertisedPublicPrefixes

string[]

The reference to AdvertisedPublicPrefixes.

advertisedPublicPrefixesState

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

The advertised public prefix state of the Peering resource.

customerASN

integer

The CustomerASN of the peering.

legacyMode

integer

The legacy mode of the peering.

routingRegistryName

string

The RoutingRegistryName of the configuration.

ExpressRouteCircuitPeeringState

The state of peering.

Name Type Description
Disabled

string

Enabled

string

ExpressRouteCrossConnectionPeering

Peering in an ExpressRoute Cross Connection resource.

Name Type Description
etag

string

A unique read-only string that changes whenever the resource is updated.

id

string

Resource ID.

name

string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.azureASN

integer

The Azure ASN.

properties.gatewayManagerEtag

string

The GatewayManager Etag.

properties.ipv6PeeringConfig

Ipv6ExpressRouteCircuitPeeringConfig

The IPv6 peering configuration.

properties.lastModifiedBy

string

Who was the last to modify the peering.

properties.microsoftPeeringConfig

ExpressRouteCircuitPeeringConfig

The Microsoft peering configuration.

properties.peerASN

integer

The peer ASN.

properties.peeringType

ExpressRoutePeeringType

The peering type.

properties.primaryAzurePort

string

The primary port.

properties.primaryPeerAddressPrefix

string

The primary address prefix.

properties.provisioningState

ProvisioningState

The provisioning state of the express route cross connection peering resource.

properties.secondaryAzurePort

string

The secondary port.

properties.secondaryPeerAddressPrefix

string

The secondary address prefix.

properties.sharedKey

string

The shared key.

properties.state

ExpressRoutePeeringState

The peering state.

properties.vlanId

integer

The VLAN ID.

ExpressRouteCrossConnectionPeeringList

Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCrossConnection.

Name Type Description
nextLink

string

The URL to get the next set of results.

value

ExpressRouteCrossConnectionPeering[]

The peerings in an express route cross connection.

ExpressRoutePeeringState

The state of peering.

Name Type Description
Disabled

string

Enabled

string

ExpressRoutePeeringType

The peering type.

Name Type Description
AzurePrivatePeering

string

AzurePublicPeering

string

MicrosoftPeering

string

Ipv6ExpressRouteCircuitPeeringConfig

Contains IPv6 peering config.

Name Type Description
microsoftPeeringConfig

ExpressRouteCircuitPeeringConfig

The Microsoft peering configuration.

primaryPeerAddressPrefix

string

The primary address prefix.

routeFilter

SubResource

The reference to the RouteFilter resource.

secondaryPeerAddressPrefix

string

The secondary address prefix.

state

ExpressRouteCircuitPeeringState

The state of peering.

ProvisioningState

The current provisioning state.

Name Type Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

SubResource

Reference to another subresource.

Name Type Description
id

string

Resource ID.