Azure Maps Render 1.0 API の移行

Azure Maps Render API version 2024-04-01 は Render API version 1.0 を置き換えました。 この記事では、Render 1.0リクエストをバージョン2024-04-01に移行する方法を説明します。

Important

Azure Maps Render バージョン1.0は2026年9月17日に廃止されます。 サービスの中断を避けるため、その日までにすべてのRender 1.0リクエストとクライアントライブラリをサポートされたバージョンに移行してください。 詳細については、Azure Maps Render v1の廃止発表をご覧ください。

API 等価性マッピング

レンダリング1.0の操作 2024-04-01 移行オプションをレンダリング
著作権キャプションv1を入手してください 著作権キャプションを入手
タイルv1の著作権取得 タイルの著作権を取得する
World v1の著作権を取得 世界の著作権を取得
Bounding Box v1から著作権を取得してください Bounding Boxから著作権を取得してください
地図画像を取得 マップの静的イメージを取得する
地図画像タイルを入手 マップタイルを入手 してください tilesetId=microsoft.imagery
Map State Tile v1を入手 マップのステートタイルを取得する
Map Tile v1を入手してください マップ タイルの取得

Render 2024-04-01は以下の操作も提供しています:

主な相違点

面積 レンダリング1.0 レンダリング 2024-04-01
地図タイルのパス /map/tile/{format} /map/tile
マップタイル選択 layer と style tilesetId
マップタイル形式 パス内のpngまたはpbf tilesetId によって決定されます
静的画像経路 /map/static/png /map/static
静的画像スタイル layer と style tilesetId およびオプション trafficLayer
静的画像フォーマット パス内の png Accept ヘッダーは image/png または image/jpeg;PNGがデフォルトです
静的画像の寸法 幅と高さは1から8,192ピクセルまでです 幅は80ピクセルから2,000ピクセル、高さは80ピクセルから1,500ピクセルまでです
イメージタイル /map/imagery/png と style=satellite /map/tile と tilesetId=microsoft.imagery
天候タイル Get Map Tileによるサポートなし レーダーや赤外線タイルも対応しており、オプションの timeStamp パラメータも含まれます
サービス エンドポイント https://atlas.microsoft.com Azureパブリッククラウドにはhttps://atlas.microsoft.comを使い、Azure地理的またはソブリンクラウドには適切なエンドポイントを使いましょう

静止画像の許容最小および最大バウンディングボックス範囲はズームレベルによって異なります。 ワークロードを本番環境に移行する前に、既存の bbox、 height、 width 値を Get Map Static Image 要件と照らし合わせて検証してください。

マップタイルパラメータマッピング

Render 1.0では、パスフォーマットと layer および style パラメータでタイルを選択します。 Render 2024-04-01では、代わりに tilesetId を使用してください。

Render 1.0フォーマット Render 1.0 レイヤー レンダリング1.0スタイル レンダリング 2024-04-01 tilesetId
pbf basic main microsoft.base
pbf labels main microsoft.base.labels
pbf hybrid main microsoft.base.hybrid
png basic main microsoft.base.road
png basic dark microsoft.base.darkgrey
png labels main microsoft.base.labels.road
png labels dark microsoft.base.labels.darkgrey
png hybrid main microsoft.base.hybrid.road
png hybrid dark microsoft.base.hybrid.darkgrey
png terra shaded_relief microsoft.terra.main

フォーマット、ズーム範囲、利用可能な値の完全なリストについては、 TilesetIDをご覧ください。

マップタイルのリクエストを移行する

以下のRender 1.0リクエストはラスタ道路タイルを返します:

https://atlas.microsoft.com/map/tile/png?api-version=1.0&layer=basic&style=main&zoom=6&x=10&y=22&subscription-key={Your-Azure-Maps-Subscription-key}

パスからフォーマットを削除し、 layer と style を対応する tilesetIdに置き換え、 api-versionを更新します:

https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId=microsoft.base.road&zoom=6&x=10&y=22&subscription-key={Your-Azure-Maps-Subscription-key}

以下の例では、ベクター ベース タイルを移行します：

https://atlas.microsoft.com/map/tile/pbf?api-version=1.0&layer=basic&style=main&zoom=6&x=10&y=22&subscription-key={Your-Azure-Maps-Subscription-key}

現在のリクエストには microsoft.base タイルセットをご利用ください:

https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&x=10&y=22&subscription-key={Your-Azure-Maps-Subscription-key}

地図の帰属表示

「Get Map Tile」から戻されたタイルを表示する際は、「Get Map Attribution」で表示されたタイルセット、ズームレベル、バウンディングボックスを呼び出します。 返された帰属表示は、サードパーティ製の地図コントロールやカスタム レンダリング実装を含め、タイルが表示されるすべての場所に表示してください。

https://atlas.microsoft.com/map/attribution?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&bounds=-122.414162,47.57949,-122.247157,47.668372&subscription-key={Your-Azure-Maps-Subscription-key}

実装の指針については「 正しい著作権帰属表示」をご覧ください。

画像タイルリクエストの移行

Render 1.0は別の画像パスを使用しています:

https://atlas.microsoft.com/map/imagery/png?api-version=1.0&style=satellite&zoom=6&x=10&y=22&subscription-key={Your-Azure-Maps-Subscription-key}

Render 2024-04-01で、microsoft.imageryタイルセットで「Get Map Tile」を使いましょう:

https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId=microsoft.imagery&zoom=6&x=10&y=22&subscription-key={Your-Azure-Maps-Subscription-key}

静的画像リクエストの移行

以下のRender 1.0リクエストは静的なPNGロードマップを返します:

https://atlas.microsoft.com/map/static/png?api-version=1.0&layer=basic&style=main&zoom=10&center=-122.177621,47.613079&subscription-key={Your-Azure-Maps-Subscription-key}

パスからフォーマットを削除し、 layer と style を tilesetIdに置き換え、 api-versionを更新します:

https://atlas.microsoft.com/map/static?api-version=2024-04-01&tilesetId=microsoft.base.road&zoom=10&center=-122.177621,47.613079&subscription-key={Your-Azure-Maps-Subscription-key}

PNGはデフォルトで返されます。 JPEGをリクエストするには、HTTP Accept ヘッダーを image/jpegに設定してください。

移行前に、要求された画像のサイズを確認してください。 Render 1.0は1から8,192までの height および width の値を受け入れます。 Render 2024-04-01は高さ80から1,500、幅80から2,000の範囲を受け入れます。 現在の範囲外のリクエストはリサイズするか、複数のリクエストに分割する必要があります。

トラフィックフローを重ねるには trafficLayer=microsoft.traffic.relative.mainを設定します。 ピン、パス、ポリゴン、交通、画像についての詳細は「ラ スターマップ上にカスタムデータをレンダリングする」をご覧ください。

Render クライアント ライブラリの移行

APIバージョン1.0をターゲットにしたRenderクライアントライブラリは必ずアップグレードしてください。 以下のパッケージ バージョンは Render 2024-04-01 を対象としています：

Language Render 1.0パッケージ 2024年4月1日パッケージをレンダリング
.NET Azure.Maps.Rendering 1.x Azure.Maps.Rendering 2.x
Python azure-maps-render 1.x azure-maps-render 2.x
Java com.azure:azure-maps-render 1.x com.azure:azure-maps-render 2.x
JavaScript/TypeScript @azure-rest/maps-render 1.x @azure-rest/maps-render 2.x

2.xのクライアントライブラリはプレリリースパッケージです。 言語固有のパッケージドキュメントを確認し、更新されたクライアントを本番環境にデプロイする前にテストしてください。

移行を検証する

本番環境トラフィックを切り替える前に、移行したアプリケーションが以下のことを確認してください:

  • api-version=1.0でRenderリクエストを送信しなくなりました。
  • /map/tile/png、/map/tile/pbf、/map/imagery/png、/map/static/pngパスは使いません。
  • すべてのタイルと静的画像のリクエストに対して期待される tilesetId を使用します。
  • 要求は静的イメージのディメンションと境界ボックスをサポートしていました。
  • 各タイルセットに期待されるレスポンスメディアタイプを処理します。
  • 地図タイルをレンダリングする際に「 Get Map Attribution 」から返された帰属を表示します。
  • すべての対応ズームレベルで、適切なラベル、注目ポイント、地図スタイル、オーバーレイ、画像を生成します。
  • 反子午線付近の地図や幾何学を扱います。
  • 必要なAzure地理的またはソブリンクラウドに適したエンドポイントを使用します。

関連するコンテンツ

  • Last updated on