Skip to content

Commit 1c358c0

Browse files
committed
Migration guides
1 parent 786ac43 commit 1c358c0

12 files changed

+33
-34
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ Developers can get migration support through the [Azure Maps Q&A] or through one
225225
[Search: Fuzzy (typehead)]: /rest/api/maps/search/get-search-fuzzy
226226
[Search: Fuzzy Search (typeahead)]: /rest/api/maps/search/get-search-fuzzy
227227
[Search: Fuzzy]: /rest/api/maps/search/get-search-fuzzy
228-
[Search: POI]:  /rest/api/maps/search/get-search-poi
228+
[Search: POI]: /rest/api/maps/search/get-search-poi
229229
[Search: Polygon]: /rest/api/maps/search/get-polygon
230230
[Search: Reverse Geocoding Batch]: /rest/api/maps/search/get-reverse-geocoding-batch
231231
[Search: Reverse Geocoding]: /rest/api/maps/search/get-reverse-geocoding

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Bing Maps for Enterprise only supports API key authentication. Azure Maps suppor
3737

3838
The following table lists the Bing Maps _Calculate a Route_ request parameters and the Azure Maps equivalent:
3939

40-
| Bing Maps Request Parameter | Bing Maps Request Parameter Alias  | Azure Maps Request Parameter | Required in Azure Maps  | Azure Maps Data Type  | Description|
40+
| Bing Maps request parameter | Bing Maps request parameter alias  | Azure Maps request parameter | Required in Azure Maps  | Azure Maps data type  | Description|
4141
|-----------------------------------|------------------------------------|------------------------------------|-------------------------|-----------------------|------------|
4242
| avoid  | | avoid  | False | string  | Here are the Bing Maps Calculate a Route API to Azure Maps Route Directions API avoid equivalents, where supported: <br><br>tolls: tollRoads<br>ferry: ferries<br>borderCrossings: borderCrossings<br>minimizeDrivingSideTurn: Not supported<br><br>minimizeAgainstDrivingSideTurn: Not supported<br>minimizeUTurn: Not supported<br>minimizeTolls: Not supported<br>highways: limitedAccessHighways<br>minimizeHighways: Not supported<br> |
4343
| dateTime  | dt  | departAt  | False | string  | Azure Maps Route Directions API also supports arriveAt parameter that is used to specify the desired date and time of arrival. It can't be used with departAt.|

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Bing Maps for Enterprise only supports API key authentication. Azure Maps suppor
3636

3737
The following table lists the Bing Maps _Calculate a Truck Route_ request parameters and the Azure Maps equivalent:
3838

39-
| Bing Maps Request Parameter | Bing Maps Request Parameter Alias  | Azure Maps Request Parameter | Required in Azure Maps  | Azure Maps Data Type  | Description|
39+
| Bing Maps request parameter | Bing Maps request parameter alias  | Azure Maps request parameter | Required in Azure Maps  | Azure Maps data type  | Description|
4040
|-----------------------------------|------------------------------------|------------------------------------|-------------------------|-----------------------|------------|
4141
| avoid  | | avoid  | False  | string  | Here are the Bing Maps to Azure Maps Route Directions API _avoid_ equivalents, where supported:<br><br>- tolls: tollRoads<br>- ferry: ferries<br>- borderCrossings: borderCrossings<br>- highways: limitedAccessHighways<br>- minimizeDrivingSideTurn: Not supported<br>- minimizeAgainstDrivingSideTurn: Not supported<br>- minimizeUTurn: Not supported <br>- minimizeTolls: Not supported<br>- minimizeHighways: Not supported  |
4242
| borderRestriction  | | Not supported  | Not supported  | Not supported  | In Azure Maps Route Directions API, _avoid=borderCrossings_ can be used to restrict routes from crossing country borders however specifying a region list for border restriction isn't supported.  |
@@ -579,6 +579,7 @@ Support
579579
[Microsoft Q&A Forum]: /answers/tags/209/azure-maps
580580
[Post Directions Batch]: /rest/api/maps/route/post-directions-batch
581581
[Route Directions]: /rest/api/maps/route/post-directions
582+
[RouteOutputOption]: /rest/api/maps/route/post-directions#routeoutputoption
582583
[Security section]: /rest/api/maps/route/get-route-range?#security
583584
[Shared Access Signature (SAS) Token]: azure-maps-authentication.md#shared-access-signature-token-authentication
584585
[subscription key]: quick-demo-map-app.md#get-the-subscription-key-for-your-account

articles/azure-maps/migrate-find-location-address.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,22 +31,21 @@ This article explains how to migrate the Bing Maps [Find a Location by Address]
3131

3232
## Security and authentication
3333

34-
Bing Maps for Enterprise only supports API key authentication. Azure Maps supports multiple ways to authenticate your API calls, such as a [subscription key](azure-maps-authentication.md#shared-key-authentication), [Microsoft Entra ID], and [Shared Access Signature (SAS) Token]. For more information on security and authentication in Azure Maps, See [Authentication with Azure Maps].
34+
Bing Maps for Enterprise only supports API key authentication. Azure Maps supports multiple ways to authenticate your API calls, such as a [subscription key](azure-maps-authentication.md#shared-key-authentication), [Microsoft Entra ID], and [Shared Access Signature (SAS) Token]. For more information on security and authentication in Azure Maps, See [Authentication with Microsoft Azure Maps] and the [Security section] in the Azure Maps Get Geocoding documentation.
3535

3636
## Request parameters
3737

3838
The following table lists the Bing Maps _Find a Location by Address_ request parameters and the Azure Maps equivalent:
3939

40-
| Bing Maps Request Parameter | Bing Maps Request Parameter Alias  | Azure Maps Request Parameter | Required in Azure Maps  | Azure Maps Data Type  | Description|
40+
| Bing Maps request parameter | Bing Maps request parameter alias  | Azure Maps request parameter | Required in Azure Maps  | Azure Maps data type  | Description|
4141
|-----------------------------|------------------------------------|------------------------------|-------------------------|-----------------------|------------|
42-
| Bing Maps Request Parameter Name  | Bing Maps Request Parameter Alias  | Azure Maps Request Parameter Name  | Required in Azure Maps  | Azure Maps Data Type  | Note  |
42+
| Bing Maps request parameter | Bing Maps request parameter alias  | Azure Maps request parameter | Required in Azure Maps  | Azure Maps data type  | Note  |
4343
| addressLine  | | addressLine  | False  | string  | In Azure Maps Get Geocoding API, a street address, or street address with locality and `adminDistrict`, is supported input for `addressLine`|
4444
| adminDistrict  | | adminDistrict  | False  | string  | |
4545
| countryRegion  | | countryRegion  | False  | string  | |
4646
| locality  | | locality  | False  | string  | |
4747
| postalCode  | | postalCode  | False  | string  | |
4848
| culture  || Request Header:  Accept-Language   | False  | string  | As specified in the Azure Maps [request header], `culture` defines the language used in search results when using the Azure Maps Get Geocoding API. For more information, see [Supported Languages]. |
49-
| | | | | | |
5049
| include  | incl  | Not needed  | Not needed  | Not needed  | In Bing Maps Find a Location by Address API, the ‘include’ input parameter is required in order to get a two-letter ISO country code for the location result in the response (_include=ciso2_). In Azure Maps Get Geocoding API, the two-letter ISO country code is returned by default.  |
5150
| includeNeighborhood  | inclnb  | Not needed  | Not needed  | Not needed  | In Azure Maps Get Geocoding API, neighborhood info is returned in the response by default, when available.  |
5251
| maxResults  | maxRes  | top  | False  | Integer (int32)  | In Azure Maps Get Geocoding API, the default number of responses returned is 5. The minimum is 1 and the maximum is 20.  |
@@ -286,9 +285,10 @@ Support
286285
[Microsoft Q&A Forum]: /answers/tags/209/azure-maps
287286
[Migrate Bing Maps Find a Location by Query API]: migrate-find-location-query.md
288287
[request header]: /rest/api/maps/search/get-geocoding?#request-headers
288+
[Security section]: /rest/api/maps/search/get-geocoding#security
289289
[Shared Access Signature (SAS) Token]: azure-maps-authentication.md#shared-access-signature-token-authentication
290290
[subscription key]: quick-demo-map-app.md#get-the-subscription-key-for-your-account
291291
[Supported Languages]: supported-languages.md
292292
[Supported Views]: supported-languages.md#azure-maps-supported-views
293293
[Understanding Azure Maps Transactions]: understanding-azure-maps-transactions.md
294-
[URI Parameters]: /rest/api/maps/search/get-geocoding#uri-parameters
294+
[URI Parameters]: /rest/api/maps/search/get-geocoding#uri-parameters

articles/azure-maps/migrate-find-location-by-point.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,23 +30,20 @@ This article explains how to migrate the Bing Maps [Find a Location by Point] AP
3030

3131
## Security and authentication
3232

33-
Bing Maps for Enterprise only supports API key authentication. Azure Maps supports multiple ways to authenticate your API calls, such as a [subscription key](azure-maps-authentication.md#shared-key-authentication), [Microsoft Entra ID], and [Shared Access Signature (SAS) Token]. For more information on security and authentication in Azure Maps, See [Authentication with Azure Maps].
33+
Bing Maps for Enterprise only supports API key authentication. Azure Maps supports multiple ways to authenticate your API calls, such as a [subscription key](azure-maps-authentication.md#shared-key-authentication), [Microsoft Entra ID], and [Shared Access Signature (SAS) Token]. For more information on security and authentication in Azure Maps, See [Authentication with Microsoft Azure Maps] and the [Security section] in the Azure Maps Get Geocoding documentation.
3434

3535
## Request parameters
3636

3737
The following table lists the Bing Maps _Find a Location by Point_ request parameters and the Azure Maps equivalent:
3838

39-
| Bing Maps Request Parameter | Bing Maps Request Parameter Alias | Azure Maps Request Parameter | Required in Azure Maps | Azure Maps Data Type | Description |
39+
| Bing Maps request parameter | Bing Maps request parameter alias | Azure Maps request parameter | Required in Azure Maps | Azure Maps data type | Description |
4040
|-----------------------------|-----------------------------------|------------------------------|------------------------|----------------------|-------------|
4141
| culture | c | Request Header: Accept-Language | False | string | In Azure Maps Get Reverse Geocoding API, this is the language in which search results should be returned. This is specified in the Azure Maps [request header]. Please refer to [Supported Languages] for details. |
42-
| | | | | | |
4342
| include | incl | Not needed | Not needed | Not needed | In Bing Maps Find a Location by Point, the ‘include’ input parameter is required to get a two-letter ISO country code for the location result in the response. In Azure Maps Get Reverse Geocoding API, the two-letter ISO country code is returned by default. |
4443
| includeEntityTypes | | resultTypes | False | query | |
45-
| | | | | | |
4644
| includeNeighborhood | inclnb | Not needed | Not needed | Not needed | In Azure Maps Get Reverse Geocoding API, neighborhood info is returned in the response by default, when available. |
4745
| point | | coordinates | True | number[] | In Bing Maps Find a Location by Point API, the coordinates in the request and the response are in latitude/longitude format, whereas Azure Maps Get Reverse Geocoding API requires the coordinates in the request and the coordinates in the response use longitude/latitude format, as defined by [GeoJSON]. |
48-
| userRegion | ur | view | False | string | A string that represents an [ISO 3166-1 Alpha-2 region/country code]. This will alter geopolitical disputed borders and labels to align with the specified user region. By default, the View parameter is set to “Auto” even if you haven’t defined it in the request. |
49-
| | | | | | Please refer to [Supported Views] for details and to see the available Views. |
46+
| userRegion | ur | view | False | string | A string that represents an [ISO 3166-1 Alpha-2 region/country code]. This will alter geopolitical disputed borders and labels to align with the specified user region. By default, the View parameter is set to “Auto” even if you haven’t defined it in the request.<br><br> Please refer to [Supported Views] for details and to see the available Views. |
5047
| verboseplacenames | vbpn | Not supported | Not supported | Not supported | Azure Maps Get Reverse Geocoding API only supports returning [adminDistricts] short name (FL instead of Florida). |
5148

5249
For more information about the Azure Maps Get Reverse Geocoding API request parameters, see [URI Parameters].
@@ -69,7 +66,7 @@ http://atlas.microsoft.com/reverseGeocode?api-version=2023-06-01&coordinates=2.3
6966

7067
The following table lists the fields that can appear in the HTTP response when running the Bing Maps _Find a Location by Point_ request and the Azure Maps equivalent:
7168

72-
| Bing Maps Response | Azure Maps Response | Description |
69+
| Bing Maps response | Azure Maps response | Description |
7370
|---------------------------|------------------------|-------------------------------|
7471
| address: addressLine (JSON)<br>Address: AddressLine (XML) | address: addressLine | |
7572
| address: adminDistrict (JSON)<br>Address: AdminDistrict (XML) | address: adminDistricts | |
@@ -255,6 +252,7 @@ Support
255252

256253
- [Microsoft Q&A Forum]
257254

255+
[adminDistricts]: /rest/api/maps/search/get-reverse-geocoding#admindistricts
258256
[Authentication with Azure Maps]: azure-maps-authentication.md
259257
[Azure Account]: https://azure.microsoft.com/
260258
[Azure Maps account]: quick-demo-map-app.md#create-an-azure-maps-account
@@ -268,6 +266,7 @@ Support
268266
[Microsoft Entra ID]: azure-maps-authentication.md#microsoft-entra-authentication
269267
[Microsoft Q&A Forum]: /answers/tags/209/azure-maps
270268
[request header]: /rest/api/maps/search/get-reverse-geocoding?#request-headers
269+
[Security section]: /rest/api/maps/search/get-reverse-geocoding#security
271270
[Shared Access Signature (SAS) Token]: azure-maps-authentication.md#shared-access-signature-token-authentication
272271
[subscription key]: quick-demo-map-app.md#get-the-subscription-key-for-your-account
273272
[Supported Languages]: supported-languages.md

articles/azure-maps/migrate-find-location-query.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,16 @@ This article explains how to migrate the Bing Maps [Find a Location by Query] AP
3131

3232
## Security and authentication
3333

34-
Bing Maps for Enterprise only supports API key authentication. Azure Maps supports multiple ways to authenticate your API calls, such as a [subscription key](azure-maps-authentication.md#shared-key-authentication), [Microsoft Entra ID], and [Shared Access Signature (SAS) Token]. For more information on security and authentication in Azure Maps, See [Authentication with Azure Maps].
34+
Bing Maps for Enterprise only supports API key authentication. Azure Maps supports multiple ways to authenticate your API calls, such as a [subscription key](azure-maps-authentication.md#shared-key-authentication), [Microsoft Entra ID], and [Shared Access Signature (SAS) Token]. For more information on security and authentication in Azure Maps, See [Authentication with Microsoft Azure Maps] and the [Security section] in the Azure Maps Get Geocoding documentation.
3535

3636
## Request parameters
3737

3838
The following table lists the Bing Maps _Find a Location by Query_ request parameters and the Azure Maps equivalent:
3939

40-
| Bing Maps Request Parameter | Bing Maps Request Parameter Alias  | Azure Maps Request Parameter | Required in Azure Maps  | Azure Maps Data Type  | Description|
40+
| Bing Maps request parameter | Bing Maps request parameter alias  | Azure Maps request parameter | Required in Azure Maps  | Azure Maps data type  | Description|
4141
|-----------------------------|------------------------------------|------------------------------|-------------------------|-----------------------|------------|
4242
| culture | c | Request Header:  Accept-Language   | False | string | As specified in the Azure Maps [request header], `culture` defines the language used in search results when using the Azure Maps Get Geocoding API. For more information, see [Supported Languages].|
4343
| include | incl  | Not needed  | Not needed  | Not needed | In Bing Maps Find a Location by Query API, the `include` input parameter is required to get a two-letter ISO country code for the location result in the response (_include=ciso2_) and to specify that the response shows how the query string was parsed into address values (_include=queryParse_). In Azure Maps Get Geocoding API, the two-letter ISO country code is returned by default and doesn’t support a queryParse equivalent. |
44-
| || Not supported | Not supported  | Not supported  | |
4544
| includeNeighborhood  | inclnb  | Not needed  | Not needed  | Not needed | In Azure Maps Get Geocoding API, neighborhood info is returned in the response by default, when available.  |
4645
| maxResults | maxRes  | top  | False | Integer (int32)  | In Azure Maps Get Geocoding API, the default number of responses returned is 5. The minimum is 1 and the maximum is 20. |
4746
| query | q | query  | True | string | |
@@ -280,6 +279,7 @@ Support
280279
[Microsoft Q&A Forum]: /answers/tags/209/azure-maps
281280
[Migrate Bing Maps Find a Location by Address API]: migrate-find-location-address.md
282281
[request header]: /rest/api/maps/search/get-geocoding?#request-headers
282+
[Security section]: /rest/api/maps/search/get-geocoding#security
283283
[Shared Access Signature (SAS) Token]: azure-maps-authentication.md#shared-access-signature-token-authentication
284284
[subscription key]: quick-demo-map-app.md#get-the-subscription-key-for-your-account
285285
[Supported Languages]: supported-languages.md

articles/azure-maps/migrate-find-time-zone.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Bing Maps for Enterprise only supports API key authentication. Azure Maps suppor
3636

3737
The following table lists the Bing Maps *Find Time Zone* request parameters and the Azure Maps equivalent:
3838

39-
| Bing Maps Parameter | Bing Maps Parameter Alias | Azure Maps Parameter | Required in Azure Maps | Azure Maps Data Type | Description |
39+
| Bing Maps Parameter | Bing Maps Parameter Alias | Azure Maps Parameter | Required in Azure Maps | Azure Maps data type | Description |
4040
|---------------------|---------------------------|----------------------|-------------------------|-----------------------|--------------|
4141
| dateTime  | dt | timeStamp | False | string date-time | Alternatively, use alias "stamp", or "s". Reference time, if omitted, the API uses the machine time serving the request. |
4242
| IncludeDstRules  | None  | transitionsFrom | False | string date-time | The start date from which daylight savings time (DST) transitions are requested, only applies when "options" = all or "options" = transitions. See options (Timezone Options) parameter for more info.  |
@@ -58,14 +58,14 @@ https://dev.virtualearth.net/REST/v1/timezone/37.7800,-122.4201?key=%7bBingMapsK
5858
Azure Maps *Get Time Zone by Coordinates* API request:
5959

6060
```HTTP
61-
https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&query=37.7800,-122.4201
61+
https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&query=37.7800,-122.4201&subscription-key={Your-Azure-Maps-Subscription-key}
6262
```
6363

6464
## Response fields
6565

6666
The following table lists the fields that can appear in the HTTP response when running the Bing Maps Find Time Zone API and the Azure Maps equivalent:
6767

68-
| Bing Maps Response Field | Azure Maps Response Field |
68+
| Bing Maps response field | Azure Maps response field |
6969
|------------------------------------------------|-------------------------------------|
7070
| abbreviation (JSON) <br> Abbreviation (XML)    | ReferenceTime (Tag)                 |
7171
| convertedTime (JSON) <br>ConvertedTime (XML)   |ReferenceTime (WallTime)             |

0 commit comments

Comments
 (0)