Express Route Cross Connections - List
Retrieves all the ExpressRouteCrossConnections in a subscription.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCrossConnections?api-version=2023-09-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
subscription
|
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 |
Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned. |
|
Other Status Codes |
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
ExpressRouteCrossConnectionList
Sample Request
Sample Response
{
"value": [
{
"name": "<circuitServiceKey>",
"id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>",
"type": "Microsoft.Network/expressRouteCrossConnections",
"location": "brazilsouth",
"properties": {
"provisioningState": "Enabled",
"expressRouteCircuit": {
"id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1"
},
"peerings": [],
"peeringLocation": "SiliconValley",
"bandwidthInMbps": 1000,
"primaryAzurePort": "bvtazureixp01",
"secondaryAzurePort": "bvtazureixp01",
"sTag": 2,
"serviceProviderProvisioningState": "NotProvisioned"
}
}
]
}
Definitions
Name | Description |
---|---|
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
Express |
The advertised public prefix state of the Peering resource. |
Express |
Specifies the peering configuration. |
Express |
The state of peering. |
Express |
Reference to an express route circuit. |
Express |
ExpressRouteCrossConnection resource. |
Express |
Response for ListExpressRouteCrossConnection API service call. |
Express |
Peering in an ExpressRoute Cross Connection resource. |
Express |
The state of peering. |
Express |
The peering type. |
Ipv6Express |
Contains IPv6 peering config. |
Provisioning |
The current provisioning state. |
Service |
The ServiceProviderProvisioningState state of the resource. |
Sub |
Reference to another subresource. |
CloudError
An error response from the service.
Name | Type | Description |
---|---|---|
error |
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 |
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 |
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 |
ExpressRouteCircuitReference
Reference to an express route circuit.
Name | Type | Description |
---|---|---|
id |
string |
Corresponding Express Route Circuit Id. |
ExpressRouteCrossConnection
ExpressRouteCrossConnection resource.
Name | Type | Description |
---|---|---|
etag |
string |
A unique read-only string that changes whenever the resource is updated. |
id |
string |
Resource ID. |
location |
string |
Resource location. |
name |
string |
Resource name. |
properties.bandwidthInMbps |
integer |
The circuit bandwidth In Mbps. |
properties.expressRouteCircuit |
The ExpressRouteCircuit. |
|
properties.peeringLocation |
string |
The peering location of the ExpressRoute circuit. |
properties.peerings |
The list of peerings. |
|
properties.primaryAzurePort |
string |
The name of the primary port. |
properties.provisioningState |
The provisioning state of the express route cross connection resource. |
|
properties.sTag |
integer |
The identifier of the circuit traffic. |
properties.secondaryAzurePort |
string |
The name of the secondary port. |
properties.serviceProviderNotes |
string |
Additional read only notes set by the connectivity provider. |
properties.serviceProviderProvisioningState |
The provisioning state of the circuit in the connectivity provider system. |
|
tags |
object |
Resource tags. |
type |
string |
Resource type. |
ExpressRouteCrossConnectionListResult
Response for ListExpressRouteCrossConnection API service call.
Name | Type | Description |
---|---|---|
nextLink |
string |
The URL to get the next set of results. |
value |
A list of ExpressRouteCrossConnection resources. |
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 |
The IPv6 peering configuration. |
|
properties.lastModifiedBy |
string |
Who was the last to modify the peering. |
properties.microsoftPeeringConfig |
The Microsoft peering configuration. |
|
properties.peerASN |
integer |
The peer ASN. |
properties.peeringType |
The peering type. |
|
properties.primaryAzurePort |
string |
The primary port. |
properties.primaryPeerAddressPrefix |
string |
The primary address prefix. |
properties.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 |
The peering state. |
|
properties.vlanId |
integer |
The VLAN ID. |
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 |
The Microsoft peering configuration. |
|
primaryPeerAddressPrefix |
string |
The primary address prefix. |
routeFilter |
The reference to the RouteFilter resource. |
|
secondaryPeerAddressPrefix |
string |
The secondary address prefix. |
state |
The state of peering. |
ProvisioningState
The current provisioning state.
Name | Type | Description |
---|---|---|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
ServiceProviderProvisioningState
The ServiceProviderProvisioningState state of the resource.
Name | Type | Description |
---|---|---|
Deprovisioning |
string |
|
NotProvisioned |
string |
|
Provisioned |
string |
|
Provisioning |
string |
SubResource
Reference to another subresource.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |