Skip to content

Commit 5a998c1

Browse files
author
duongau
committed
updates per PM's comments
1 parent 8fc5e45 commit 5a998c1

File tree

1 file changed

+58
-57
lines changed

1 file changed

+58
-57
lines changed

‎articles/expressroute/circuit-placement-api.md

Lines changed: 58 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ ms.author: mialdrid
1111

1212
# ExpressRoute circuit placement API
1313

14-
The ExpressRoute partner circuit placement API allows ExpressRoute partner to provision circuit connectivity on a specific port pair. Specifically, if an ExpressRoute partner manages multiple port pairs at one peering location, they can use this API to select which port pair will facilitate the ExpressRoute circuit.
14+
The ExpressRoute partner circuit placement API allows ExpressRoute partners to provision circuit connectivity on a specific port pair. Specifically, if an ExpressRoute partner manages multiple port pairs at one peering location, they can use this API to select which port pair will facilitate the ExpressRoute circuit.
1515

16-
This API uses the expressRouteCrossConnection resource type. For more information, see [ExpressRoute CrossConnection API development and integration](https://docs.microsoft.com/azure/expressroute/cross-connections-api-development)
16+
This API uses the expressRouteCrossConnection resource type. For more information, see [ExpressRoute CrossConnection API development and integration](cross-connections-api-development.md).
1717

1818
## Workflow
1919

@@ -93,12 +93,10 @@ https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.
9393
**Response status code**
9494

9595
* 200 (OK)  The request is success. It will fetch list of ports.
96-
* 4XX (Bad Request)  One of validations failed – for example: Provider subid is not valid.
96+
* 4XX (Bad Request)  One of validations failed – for example: Provider subid isn't valid.
9797

9898
### List of all port for a provider for a particular peering location
9999

100-
This is same API as above with an extra query parameter of location.
101-
102100
#### GET
103101

104102
https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteProviderPorts?location={locationName}
@@ -107,37 +105,37 @@ https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.
107105

108106
```rest
109107
{
110-
"parameters": {
111-
"api-version": "2020-03-01",
112-
"locationName": "SiliconValley",
113-
"subscriptionId": "subid"
114-
},
115-
"responses": {
116-
"200": {
117-
"body": {
118-
"value": [
119-
{
120-
"portPairDescriptor": "bvtazureixpportpair1",
121-
"id": "/subscriptions/subid/providers/Microsoft.Network/ ExpressRouteProviderPort /bvtazureixpportpair1",
122-
"type": "Microsoft.Network/expressRouteProviderPort",
123-
"location": "uswest",
124-
"etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"",
125-
"properties": {
126-
"portPairDescriptor": "bvtazureixpportpair",
127-
"primaryAzurePort": "bvtazureixp01a",
128-
"secondaryAzurePort": "bvtazureixp01b",
129-
"peeringLocation": "SiliconValley",
130-
"overprovisionFactor": 4,
131-
"portBandwidthInMbps": 4000,
132-
"usedBandwidthInMbps": 2500,
133-
"remainingBandwidthInMbps": 1500
134-
}
135-
}
136-
]
108+
"parameters": {
109+
"api-version": "2020-03-01",
110+
"locationName": "SiliconValley",
111+
"subscriptionId": "subid"
112+
},
113+
"responses": {
114+
"200": {
115+
"body": {
116+
"value": [
117+
{
118+
"portPairDescriptor": "bvtazureixpportpair1",
119+
"id": "/subscriptions/subid/providers/Microsoft.Network/ ExpressRouteProviderPort /bvtazureixpportpair1",
120+
"type": "Microsoft.Network/expressRouteProviderPort",
121+
"location": "uswest",
122+
"etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"",
123+
"properties": {
124+
"portPairDescriptor": "bvtazureixpportpair",
125+
"primaryAzurePort": "bvtazureixp01a",
126+
"secondaryAzurePort": "bvtazureixp01b",
127+
"peeringLocation": "SiliconValley",
128+
"overprovisionFactor": 4,
129+
"portBandwidthInMbps": 4000,
130+
"usedBandwidthInMbps": 2500,
131+
"remainingBandwidthInMbps": 1500
132+
}
137133
}
138-
}
134+
]
135+
}
139136
}
140137
}
138+
}
141139
```
142140

143141
**Response status code**
@@ -161,28 +159,29 @@ https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.
161159
"subscriptionId": "subid"
162160
},
163161
"responses": {
164-
"200": {
165-
"body": {
166-
"value":
167-
{
168-
"portPairDescriptor": "bvtazureixpportpair1",
169-
"id": "/subscriptions/subid/providers/Microsoft.Network/ExpressRouteProviderPort/bvtazureixpportpair1",
170-
"type": "Microsoft.Network/expressRouteProviderPort",
171-
"location": "uswest",
172-
"etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"",
173-
"properties": {
174-
"portPairDescriptor": "bvtazureixpportpair",
175-
"primaryAzurePort": "bvtazureixp01a",
176-
"secondaryAzurePort": "bvtazureixp01b",
177-
"peeringLocation": "SiliconValley",
178-
"overprovisionFactor": 4,
179-
"portBandwidthInMbps": 4000,
180-
"usedBandwidthInMbps": 2500,
181-
"remainingBandwidthInMbps": 15
182-
}
162+
"200": {
163+
"body": {
164+
"value": [
165+
{
166+
"portPairDescriptor": "bvtazureixpportpair1",
167+
"id": "/subscriptions/subid/providers/Microsoft.Network/ExpressRouteProviderPort/bvtazureixpportpair1",
168+
"type": "Microsoft.Network/expressRouteProviderPort",
169+
"location": "uswest",
170+
"etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"",
171+
"properties": {
172+
"portPairDescriptor": "bvtazureixpportpair",
173+
"primaryAzurePort": "bvtazureixp01a",
174+
"secondaryAzurePort": "bvtazureixp01b",
175+
"peeringLocation": "SiliconValley",
176+
"overprovisionFactor": 4,
177+
"portBandwidthInMbps": 4000,
178+
"usedBandwidthInMbps": 2500,
179+
"remainingBandwidthInMbps": 15
183180
}
184-
}
181+
}
182+
]
185183
}
184+
}
186185
}
187186
}
188187
```
@@ -195,13 +194,11 @@ https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.
195194

196195
### PUT expressRouteCrossConnection API to move a circuit to a specific port pair
197196

198-
Once the portPairDescriptor of the target port pair is identified, the ExpressRoute Partner can use the expressRouteCrossConnection API to move the ExpressRoute circuit to a specific port pair.
199-
200-
https://docs.microsoft.com/rest/api/expressroute/express-route-cross-connections/create-or-update
197+
Once the portPairDescriptor of the target port pair is identified, the ExpressRoute partner can use the [ExpressRouteCrossConnection API](/rest/api/expressroute/express-route-cross-connections/create-or-update) to move the ExpressRoute circuit to a specific port pair.
201198

202199
Currently this API is used by providers to update provisioning state of circuit. This same API will be used by providers to update port pair of the circuit.
203200

204-
Currently the primaryAzurePort and secondaryAzurePort are read-only properties. Now we have disabled the read-only properties for these ports.
201+
Currently the primaryAzurePort and secondaryAzurePort are read-only properties. Now we've disabled the read-only properties for these ports.
205202

206203
#### PUT
207204

@@ -244,3 +241,7 @@ Response:
244241
}
245242
}
246243
```
244+
245+
## Next steps
246+
247+
For more information on all ExpressRoute REST APIs, see [ExpressRoute REST APIs](/rest/api/expressroute/).

0 commit comments

Comments
 (0)