Skip to content

Commit 87cd139

Browse files
committed
Added migration guide and modified ms.topic in existing migration guides.
1 parent dba97cd commit 87cd139

19 files changed

Lines changed: 95 additions & 93 deletions

articles/azure-maps/how-to-use-best-practices-for-search.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1127,6 +1127,8 @@ GET https://atlas.microsoft.com/polygon
11271127
> [!div class="nextstepaction"]
11281128
> [Search service API documentation](/rest/api/maps/search)
11291129
1130+
> [!div class="nextstepaction"]
1131+
> [Search service API documentation](migrate-search-v1-api.md)
11301132
:::zone-end
11311133

11321134
[Azure Maps account]: quick-demo-map-app.md#create-an-azure-maps-account

articles/azure-maps/migrate-bing-maps-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Overview for the migration guides that show how to migrate code fro
55
author: jkebeck
66
ms.author: jokebeck
77
ms.date: 05/16/2024
8-
ms.topic: how-to
8+
ms.topic: upgrade-and-migration-article
99
ms.service: azure-maps
1010
ms.subservice: general
1111
---

articles/azure-maps/migrate-calculate-route.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Migrate Bing Maps Calculate a Route API to Azure Maps Route Directions API
33
titleSuffix: Microsoft Azure Maps
4-
description: Learn how to Migrate the Bing Maps Calculate a Route API to the Azure Maps Route Directions API.
4+
description: Learn how to migrate the Bing Maps Calculate a Route API to the Azure Maps Route Directions API.
55
author: farazgis
66
ms.author: fsiddiqui
77
ms.date: 05/16/2024
8-
ms.topic: how-to
8+
ms.topic: upgrade-and-migration-article
99
ms.service: azure-maps
1010
ms.subservice: routing
1111
---
@@ -46,13 +46,13 @@ The following table lists the Bing Maps _Calculate a Route_ request parameters a
4646
| heading  | hd  | heading  | False | integer  | |
4747
| itineraryGroups  | ig  | Not supported | Not supported  | | |
4848
| maxSolutions  | maxSolns | maxRouteCount | False | Integer  | |
49-
| optimize  | optmz  | optimizeRoute | False | String  | Here are the Bing Maps Calculate a Route API to Azure Maps Route Directions API optimizeRoute equivalents:<br><br>time: fastestWithoutTraffic<br>timeWithTraffic: fastestWithTraffic<br>Azure Maps Route Directions API also supports optimizing routes by distance to return the shortest route by specifying shortest as the optimizeRoute input value.  |
49+
| optimize  | optmz  | optimizeRoute | False | String  | Here are the Bing Maps Calculate a Route API to Azure Maps Route Directions API optimizeRoute equivalents:<br><br>time: fastestWithoutTraffic<br>timeWithTraffic: fastestWithTraffic<br>Azure Maps Route Directions API also supports optimizing routes by distance to return the shortest route by specifying shortest as the 'optimizeRoute' input value.  |
5050
| optimizeWaypoints  | optWp  | optimizeWaypointOrder | False | boolean  | |
5151
| routeAttributes  | ra  | routeOutputOptions  | False | string  | Here are the Bing Maps Calculate a Route API to Azure Maps Route Directions API routeOutputOptions equivalents:<br><br>routePath: routePath<br>regionTravelSummary: regionTravelSummary<br>Azure Maps Route Directions API supports more values like itinerary and routeSummary. See the RouteOutputOption for details.  |
5252
| routePathOutput  | rpo  | routeOutputOptions  | False | string  | Azure Maps Route Directions API supports returning the coordinates for the route path geometry by passing routeOutputOptions=routePath in the request.  |
5353
| timeType  | tt  | Not supported | Not supported  | Not supported  | Azure Maps Route Directions API doesn't support Transit Routing.  |
5454
| tolerances  | tl  | Not supported | Not supported  | Not supported  | |
55-
| travelMode  | | travelMode  | False | String  | Here are the Bing Maps Calculate a Route API to Azure Maps Route Directions API travelMode equivalents:<br><br>Driving: driving<br>Walking: walking<br>Transit: Not supported<br>Azure Maps support extra travelMode truck for truck routing. |
55+
| travelMode  | | travelMode  | False | String  | Here are the Bing Maps Calculate a Route API to Azure Maps Route Directions API travelMode equivalents:<br><br>Driving: driving<br>Walking: walking<br>Transit: Not supported<br>Azure Maps support extra travelMode 'truck' for truck routing. |
5656
| viaWaypoint.n  | vwp.n  | features<br>InputWaypointFeaturesItem[] | True  | GeoJSON Point  | waypoint and viaWaypoint are specified as features, which is a required parameter. However, only waypoint is a required pointType and the request can be made without viaWaypoint.<br><br>In Bing Maps Calculate a Route API, viaWaypoint can be a point, landmark, or address, whereas, in Azure Maps Route Directions API, it must be a point. To convert a landmark or address to a point, you can use the Azure Maps Get Geocoding API.<br><br>Bing Maps Calculate a Truck Route API requires viaWaypoints to be in latitude/longitude format, whereas, Azure Maps requires them to be in longitude/latitude format, as defined in the GeoJSON format. |
5757
| waypoint.n  | wp.n  | features  InputWaypointFeaturesItem[]  | True  | GeoJSON Point  | In Bing Maps Calculate a Route API, waypoint can be a point, landmark, or address, whereas, in Azure Maps Route Directions API, it must be a point. To convert a landmark or address to a point, you can use the Azure Maps Get Geocoding API.<br><br>Bing Maps Calculate a Route API requires waypoints to be in latitude/longitude format, whereas, Azure Maps requires them to be in longitude/latitude format, as defined in the GeoJSON format. |
5858

@@ -116,8 +116,8 @@ The following table lists the fields that can appear in the HTTP response when r
116116

117117
| Bing Maps Field | Azure Maps Field | Description |
118118
|------------------------|---------------------------|----------------------------------------------------------------------------------------------------|
119-
| actualStart   | Point feature object  | Point feature object with type=waypoint and inputIndex = 0 defines the routable start location. |
120-
| actualEnd  | Point feature object  | Point feature object with type=waypoint and inputIndex = last defines the routable end location. |
119+
| actualStart   | Point feature object  | Point feature object with type="waypoint" and inputIndex = 0 defines the routable start location. |
120+
| actualEnd  | Point feature object  | Point feature object with type="waypoint" and inputIndex = last defines the routable end location. |
121121
| alternateVias  | alternativeRoutes  | Bing Maps alternateVias identifies the separate routes. In Azure Maps, alternate routes are returned as a new feature collection under alternativeRoutes. |
122122
| compassDegrees  | compassDegrees  ||
123123
| compassDirection  | compassDirection  ||
@@ -126,7 +126,7 @@ The following table lists the fields that can appear in the HTTP response when r
126126
| distanceUnit  | Not applicable  | Azure Maps Route Directions API returns the distance in meters. |
127127
| durationUnit  | Not  applicable  | Azure Maps Route Directions API returns the duration in seconds. |
128128
| endPathIndices  | range  | Azure Maps returns the start and end index covered by a specific leg of a route as a range. |
129-
| endWaypoint  | Not supported  | In Azure Maps Route Directions API response, the endWaypoint can be derived from type=waypoint and inputIndex = last index |
129+
| endWaypoint  | Not supported  | In Azure Maps Route Directions API response, the endWaypoint can be derived from type="waypoint" and inputIndex = last index |
130130
| formattedText  | formattedText  ||
131131
| hints  | Not supported  ||
132132
| hintType  | Not supported  ||
@@ -146,7 +146,7 @@ The following table lists the fields that can appear in the HTTP response when r
146146
| routeSubLegs  | subLegs  ||
147147
| sideOfStreet  | sideOfStreet  ||
148148
| startPathIndices  | range  | Azure Maps returns the start and end index covered by a specific leg of a route as a range.  |
149-
| startWaypoint  | Not supported  | In Azure Maps Route Directions API response, the startWaypoint can be derived from type=waypoint and inputIndex = first index |
149+
| startWaypoint  | Not supported  | In Azure Maps Route Directions API response, the startWaypoint can be derived from type="waypoint" and inputIndex = first index |
150150
| towardsRoadName  | towardsRoadName  ||
151151
| trafficCongestion  | trafficCongestion  ||
152152
| trafficDataUsed  | trafficDataUsed  ||
@@ -165,7 +165,7 @@ The following JSON sample shows what is returned in the body of the HTTP respons
165165
{
166166
    "authenticationResultCode": "ValidCredentials",
167167
    "brandLogoUri": "https://dev.virtualearth.net/Branding/logo_powered_by.png",
168-
    "copyright": "Copyright © 2024 Microsoft and its suppliers. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Microsoft Corporation.",
168+
    "copyright": "Copyright &copy; 2024 Microsoft and its suppliers. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Microsoft Corporation.",
169169
    "resourceSets": [
170170
        {
171171
            "estimatedTotal": 1,

articles/azure-maps/migrate-calculate-truck-route.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Migrate Bing Maps Calculate a Truck Route API to Azure Maps Route Directions API
33
titleSuffix: Microsoft Azure Maps
4-
description: Learn how to Migrate the Bing Maps Calculate a Truck Route API to the Azure Maps Route Directions API.
4+
description: Learn how to migrate the Bing Maps Calculate a Truck Route API to the Azure Maps Route Directions API.
55
author: farazgis
66
ms.author: fsiddiqui
77
ms.date: 05/16/2024
8-
ms.topic: how-to
8+
ms.topic: upgrade-and-migration-article
99
ms.service: azure-maps
1010
ms.subservice: routing
1111
---
@@ -25,7 +25,7 @@ This article explains how to migrate the Bing Maps [Calculate a Truck Route] API
2525
- Bing Maps Calculate a Truck Route is a standalone API dedicated to truck routing. Azure Maps Route Directions API provides truck routing support when `travelMode=truck` is specified in the request.
2626
- Bing Maps Calculate a Truck Route API supports GET or POST requests. Azure Maps Route Directions API supports POST requests.
2727
- Bing Maps Calculate a Truck Route API supports XML and JSON response formats. Azure Maps Route Directions API supports the GeoJSON response format.
28-
- Bing Maps Calculate a Truck Route API supports a maximum of 25 waypoints or viaWaypoints per request. Azure Maps Route Directions API supports up to 150 waypoints per request, but doesnt support viaWaypoints.
28+
- Bing Maps Calculate a Truck Route API supports a maximum of 25 waypoints or viaWaypoints per request. Azure Maps Route Directions API supports up to 150 waypoints per request, but doesn't support viaWaypoints.
2929
- Unlike Bing Maps for Enterprise, Azure Maps is a global service that supports specifying a geographic scope, allowing limits to data residency to the European (EU) or United States (US) geographic areas (geos). All requests (including input data) are processed exclusively in the specified geographic area. For more information, see [geographic scope].
3030

3131
## Security and authentication
@@ -149,8 +149,8 @@ The following table lists the fields that can appear in the HTTP response when r
149149

150150
| Bing Maps Field | Azure Maps Field | Description |
151151
|------------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
152-
| actualEnd  | Point feature object  | Point feature object with _type=waypoint_ and _inputIndex = last_ defines the routable end location. |
153-
| actualStart   | Point feature object  | Point feature object with _type=waypoint_ and _inputIndex = 0_ defines the routable start location.  |
152+
| actualEnd  | Point feature object  | Point feature object with _type="waypoint"_ and _inputIndex = last_ defines the routable end location. |
153+
| actualStart   | Point feature object  | Point feature object with _type="waypoint"_ and _inputIndex = 0_ defines the routable start location.  |
154154
| alternateVias  | alternativeRoutes  | Bing Maps `alternateVias` identifies the separate routes. In Azure Maps Route Directions API, alternate routes are returned as a new feature collection under `alternativeRoutes`|
155155
| compassDegrees  | Not supported  | |
156156
| compassDirection  | Not supported  | |
@@ -159,7 +159,7 @@ The following table lists the fields that can appear in the HTTP response when r
159159
| distanceUnit  | Not applicable  | Azure Maps Route Directions API returns the distance in meters by default.  |
160160
| durationUnit  | Not  applicable  | Azure Maps Route Directions API returns the duration in seconds.  |
161161
| endPathIndices  | range  | Azure Maps Route Directions API returns the start and end index covered by a specific leg of a route as a range.  |
162-
| endWaypoint  | Not supported  | In Azure Maps Route Directions API response, the end waypoint can be derived from _type=waypoint_ and _inputIndex = last_ index |
162+
| endWaypoint  | Not supported  | In Azure Maps Route Directions API response, the end waypoint can be derived from _type="waypoint"_ and _inputIndex = last_ index |
163163
| formattedText  | formattedText  | |
164164
| hints  | Not supported  | |
165165
| hintType  | Not supported  | |
@@ -179,7 +179,7 @@ The following table lists the fields that can appear in the HTTP response when r
179179
| routeSubLegs  | subLegs  | |
180180
| sideOfStreet  | sideOfStreet  | |
181181
| startPathIndices  | range  | Azure Maps Route Directions API returns the start and end index covered by a specific leg of a route as a range.   |
182-
| startWaypoint  | Not supported  | In Azure Maps Route Directions API response, the start waypoint can be derived from _type=waypoint_ and _inputIndex = first_ index|
182+
| startWaypoint  | Not supported  | In Azure Maps Route Directions API response, the start waypoint can be derived from _type="waypoint"_ and _inputIndex = first_ index|
183183
| towardsRoadName  | towardsRoadName  | |
184184
| trafficCongestion  | Not supported  | |
185185
| trafficDataUsed  | trafficDataUsed  | |
@@ -198,7 +198,7 @@ The following JSON sample shows what is returned in the body of the HTTP respons
198198
{
199199
"authenticationResultCode": "ValidCredentials",
200200
"brandLogoUri": "https://dev.virtualearth.net/Branding/logo_powered_by.png",
201-
"copyright": "Copyright © 2024 Microsoft and its suppliers. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Microsoft Corporation.",
201+
"copyright": "Copyright &copy; 2024 Microsoft and its suppliers. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Microsoft Corporation.",
202202
"resourceSets": [
203203
{
204204
"estimatedTotal": 1,

0 commit comments

Comments
 (0)