Render - Get Map Tileset

  • リファレンス
サービス:
Maps
API バージョン:
2024-04-01

タイルセットのメタデータを取得するには、 を使用します。

Get Map Tileset API を使用すると、ユーザーはタイルセットのメタデータを要求できます。

GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId={tilesetId}

URI パラメーター

名前 / 必須 型 説明
api-version
 query True

string

Azure Maps API のバージョン番号。 現在のバージョンは 2024-04-01 です。
tilesetId
 query True

TilesetID

タイルセットは、事前設定されたズーム レベルで、正方形のタイルの均一なグリッドに分割されたラスターまたはベクター データのコレクションです。 すべてのタイルセットには、要求を行うときに使用する tilesetId があります。 Azure Maps Creator を使用して作成されたタイルセットの tilesetId は、Tileset Create API を使用して生成されます。 Azure Maps によって提供されるすぐに使用できるタイルセットを次に示します。 たとえば、microsoft.base です。

要求ヘッダー

名前 必須 型 説明
x-ms-client-id

string

Microsoft Entra ID セキュリティ モデルと組み合わせて使用するアカウントを指定します。 これは Azure Maps アカウントの一意の ID を表し、Azure Maps 管理プレーン アカウント API から取得できます。 Azure Maps で Microsoft Entra ID セキュリティを使用するには、ガイダンスについては、次 の記事を 参照してください。

応答

名前 型 説明
200 OK

MapTileset

OK
Other Status Codes

ErrorResponse

予期しないエラーが発生しました。

セキュリティ

AADToken

これらは Microsoft Entra OAuth 2.0 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上の Azure Maps リソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 Azure Maps REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタム ロールを使用して、任意のユーザー、グループ、またはサービス プリンシパルにアクセス権を付与できます。

シナリオを実装するには、 認証の概念を表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。

メモ

  • このセキュリティ定義 では 、 ヘッダーを x-ms-client-id 使用して、アプリケーションがアクセスを要求している Azure Maps リソースを示す必要があります。 これは、 Maps 管理 API から取得できます。

Authorization URLは、Azure パブリック クラウド インスタンスに固有です。 ソブリン クラウドには、一意の承認 URL と Microsoft Entra ID 構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーン から構成されます。 * Azure Maps Web SDK を使用すると、複数のユース ケースに対するアプリケーションの構成ベースのセットアップが可能になります。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンを介して Azure Maps リソース を作成するときにプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスする権限が与えられている。 つまり、これらは現在、発行先のアカウントのマスター キーとして扱うことができます。

公開されているアプリケーションの場合、このキーを安全に格納できる Azure Maps REST API のサーバー間アクセスを使用することをお勧めします。

型: apiKey
/: header

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して、Azure 管理プレーンを介して Azure Maps リソース の SAS の一覧表示操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンをきめ細かく制御できます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。

公開されているアプリケーションの場合、 Map アカウント リソース で許可される配信元の特定の一覧を構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

型: apiKey
/: header

例

Successful Tileset Request

要求のサンプル

GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId=microsoft.base

応答のサンプル

状態コード:
200 
{
  "tilejson": "2.2.0",
  "version": "1.0.0",
  "attribution": "<a data-azure-maps-attribution-tileset=\"microsoft.base\">&copy;2022 TomTom</a>",
  "scheme": "xyz",
  "tiles": [
    "https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}"
  ],
  "minzoom": 0,
  "maxzoom": 22,
  "bounds": [
    -180,
    -90,
    180,
    90
  ]
}

定義

名前 説明
ErrorAdditionalInfo

リソース管理エラーの追加情報。
ErrorDetail

エラーの詳細。
ErrorResponse

エラー応答
MapTileset

TileJSON 形式のタイルセットのメタデータ。
TilesetID

タイルセットは、事前設定されたズーム レベルで、正方形のタイルの均一なグリッドに分割されたラスターまたはベクター データのコレクションです。 すべてのタイルセットには、要求を行うときに使用する tilesetId があります。 Azure Maps Creator を使用して作成されたタイルセットの tilesetId は、Tileset Create API を使用して生成されます。 Azure Maps によって提供されるすぐに使用できるタイルセットを次に示します。 たとえば、microsoft.base です。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細です。
message

string

エラー メッセージ。
target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 型 説明
error

ErrorDetail

error オブジェクト。

MapTileset

TileJSON 形式のタイルセットのメタデータ。

名前 型 説明
attribution

string

マップに表示される著作権属性。 実装では、これを HTML またはリテラル テキストとして扱う場合があります。 セキュリティ上の理由から、このフィールドが XSS またはビーコン追跡のベクトルとして悪用されないようにしてください。
bounds

number[]

使用可能なマップ タイルの最大範囲。 境界は、すべてのズーム レベルでカバーされる領域を定義する必要があります。 境界は WGS:84 緯度と経度の値で、左、下、右、上の順で表されます。 値には、整数または浮動小数点数を指定できます。
center

number[]

[経度、緯度、ズーム] 形式のタイルセットの既定の場所。 ズーム レベルは、minzoom と maxzoom の間にする必要があります。 実装では、この値を使用して既定の場所を設定できます。
data

string[]

GeoJSON 形式のデータ ファイルの配列。
description

string

タイルセットのテキストの説明。 説明には任意の有効な文字を含めることができます。 実装では、説明を HTML として解釈しないでください。
grids

string[]

対話機能エンドポイントの配列。
legend

string

マップと共に表示される凡例。 実装では、これを HTML またはリテラル テキストとして扱う場合があります。 セキュリティ上の理由から、このフィールドが XSS またはビーコン追跡のベクトルとして悪用されないようにしてください。
maxzoom

integer

最大ズーム レベル。
minzoom

integer

最小ズーム レベル。
name

string

タイルセットを説明する名前。 名前には任意の有効な文字を含めることができます。 実装では、名前を HTML として解釈しないでください。
scheme

string

既定値: "xyz" "xyz" または "tms" のいずれか。 タイル座標の y 方向に影響します。 グローバル メルカトル (球面メルカトル) プロファイルが想定されます。
template

string

相互作用のためにグリッドからデータを書式設定するために使用される口ひげテンプレート。
tilejson

string

この JSON オブジェクトによって実装される TileJSON 仕様のバージョンについて説明します。
tiles

string[]

タイル エンドポイントの配列。 複数のエンドポイントが指定されている場合、クライアントはエンドポイントの任意の組み合わせを使用できます。 すべてのエンドポイントは、同じ URL に対して同じコンテンツを返す必要があります。 配列には、少なくとも 1 つのエンドポイントが含まれている必要があります。
version

string

タイルセット内に含まれるタイルの semver.org スタイルのバージョン番号。 タイル間の変更が導入されると、マイナー バージョンが変更される必要があります。

TilesetID

タイルセットは、事前設定されたズーム レベルで、正方形のタイルの均一なグリッドに分割されたラスターまたはベクター データのコレクションです。 すべてのタイルセットには、要求を行うときに使用する tilesetId があります。 Azure Maps Creator を使用して作成されたタイルセットの tilesetId は、Tileset Create API を使用して生成されます。 Azure Maps によって提供されるすぐに使用できるタイルセットを次に示します。 たとえば、microsoft.base です。

名前 型 説明
microsoft.base

string

ベース マップは、道路、自然フィーチャ、人工フィーチャ、およびそれらのフィーチャのラベルをベクター タイルに表示する標準マップです。

ズーム レベル 0 ~ 22 をサポートします。 形式: vector (pbf)。
microsoft.base.darkgrey

string

私たちのダークグレーのスタイルを持つすべての層。

ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。
microsoft.base.hybrid

string

道路、境界、ラベルのデータをベクター タイルに表示します。

ズーム レベル 0 ~ 22 をサポートします。 形式: vector (pbf)。
microsoft.base.hybrid.darkgrey

string

濃い灰色のスタイルの道路、境界、ラベルのデータ。

ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。
microsoft.base.hybrid.road

string

メイン スタイルの道路、境界、ラベル データ。

ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。
microsoft.base.labels

string

ベクター タイル内の道路、自然フィーチャ、人工フィーチャのラベルを表示します。

ズーム レベル 0 ~ 22 をサポートします。 形式: vector (pbf)。
microsoft.base.labels.darkgrey

string

濃い灰色のスタイルでデータにラベルを付けます。

ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。
microsoft.base.labels.road

string

メイン スタイルでデータにラベルを付けます。

ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。
microsoft.base.road

string

私たちのメインスタイルを持つすべてのレイヤー。

ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。
microsoft.imagery

string

衛星画像と航空画像の組み合わせ。 S1 価格 SKU でのみ使用できます。

ズーム レベル 1 ~ 19 をサポートします。 形式: ラスター (jpeg)。
microsoft.terra.main

string

影付きレリーフとテラレイヤー。

ズーム レベル 0 ~ 6 をサポートします。 形式: ラスター (png)。
microsoft.traffic.absolute

string

ベクター内の絶対トラフィック タイル
microsoft.traffic.absolute.main

string

メインスタイルのラスターの絶対トラフィック タイル。
microsoft.traffic.delay

string

ベクター内のトラフィック タイル
microsoft.traffic.delay.main

string

メイン スタイルのラスター内のトラフィック タイル
microsoft.traffic.incident

string

ベクター内のインシデント タイル
microsoft.traffic.reduced.main

string

メイン スタイルのラスター内のトラフィック タイルの削減
microsoft.traffic.relative

string

ベクター内の相対トラフィック タイル
microsoft.traffic.relative.dark

string

ダーク スタイルのラスター内の相対トラフィック タイル。
microsoft.traffic.relative.main

string

メイン スタイルのラスター内の相対トラフィック タイル。
microsoft.weather.infrared.main

string

赤外線タイルを天気。 最新の赤外線衛星画像は、温度によって雲を示しています。 詳細については、「 Azure Maps の天気予報サービスのカバレッジ」を参照してください。 返されるサテライト データの詳細については、「 Azure Maps の天気予報サービス」を参照してください。

ズーム レベル 0 ~ 15 をサポートします。 形式: ラスター (png)。
microsoft.weather.radar.main

string

気象レーダータイル。 雨、雪、氷、混合条件の領域を含む最新の気象レーダー画像。 Azure Maps Weather Service のカバレッジの詳細については、「 Azure Maps の天気予報サービスのカバレッジ」を参照してください。 レーダー データの詳細については、「 Azure Maps の天気予報サービス」を参照してください。

ズーム レベル 0 ~ 15 をサポートします。 形式: ラスター (png)。