次の方法で共有


Render - Get Map Tileset

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

GET {endpoint}/map/tileset?api-version=2024-04-01&tilesetId={tilesetId}

URI パラメーター

名前 / 必須 説明
endpoint
path True

string

api-version
query True

string

minLength: 1

この操作に使用する API バージョン。

tilesetId
query True

TilesetID

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

要求ヘッダー

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

string

Microsoft Entra IDセキュリティモデルで使用されることを意図したアカウントを示します。 このAzure Mapsアカウントの一意IDは、Azure Maps管理プレーンのアカウントAPIから取得できます。 Azure MapsにおけるMicrosoft Entra IDセキュリティの使用についての詳細は、Azure Mapsの認証管理Manage certificationをご覧ください。

応答

名前 説明
200 OK

MapTileset

要求は成功しました。

Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

AadToken

これらはMicrosoft Entra OAuth 2.0フローです。 Azureロールベースアクセス制御と組み合わせることで、Azure Maps REST APIへのアクセス制御に利用できます。 Azure ロールベースのアクセス制御は、1つ以上の Azure Maps リソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 任意のユーザー、グループ、またはサービスプリンシパルは、組み込みの役割や1つ以上のREST API権限からなるカスタムロールを通じてアクセス権Azure Maps付与されます。\n\nシナリオを実装するには、authentication conceptsを見ることをお勧めします。 まとめると、このセキュリティ定義は、特定のAPIやスコープでアクセス制御が可能なオブジェクトを通じてアプリケーションをモデリングするソリューションを提供します。\n\n#### 注記\n* このセキュリティ定義要求x-ms-client-idヘッダーを使用してアプリケーションがどのAzure Mapsリソースへのアクセスを要求しているかを示します。 これはMaps管理APIから取得可能です。\n* \nAuthorization URLはAzureパブリッククラウドインスタンス専用です。 ソブリンクラウドは固有の認可URLとMicrosoft Entra IDの設定を持っています。 \n* \nAzureロールベースのアクセス制御は、Azure管理プレーンから、Azureポータル、PowerShell、CLI、Azure SDK、REST APIを通じて構成されます。\n* \nAzure MapsWeb SDKは、複数のユースケース向けにアプリケーションの設定を可能にします。\n* Microsoft ID プラットフォームの詳細については、Microsoft ID プラットフォーム概要をご覧ください。

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

スコープ

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

subscription-key

これは共有キーで、AzureポータルでCreate a Azure Maps accountを行うか、PowerShell、CLI、Azure SDK、REST APIを使ってプロビジョニングされます。\n\n このキーがあれば、どのアプリケーションでもすべてのREST APIにアクセスできます。 つまり、この鍵は発行された口座のマスターキーとして使うことができます。\n\n 公開されているアプリケーションについては、confidential client applications方式を用いてREST API Azure Mapsにアクセスし、鍵を安全に保存できるようにすることをお勧めします。

型: apiKey
/: header

SAS Token

これは共有アクセス署名トークンで、Azure MapsリソースのList SAS操作からAzureポータル、PowerShell、CLI、Azure SDK、REST APIを通じてAzure管理プレーンを経由して作成されます。\n\n このトークンにより、どのアプリケーションでもAzureでアクセスが許可されますロールベースのアクセス制御や、特定のトークンの有効期限、速度、使用領域の細かい制御。 言い換えれば、SASトークンは共有鍵よりも安全な方法でアクセスを制御するために使えます。\n\n 公開されているアプリケーションについては、 Mapアカウントリソース 上で許可された発信元の特定のリストを設定し、レンダリングの乱用を制限し、SASトークンを定期的に更新することを推奨します。

型: apiKey
/: header

Successful Tileset Request

要求のサンプル

GET {endpoint}/map/tileset?api-version=2024-04-01&tilesetId=microsoft.base

応答のサンプル

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

定義

名前 説明
ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

MapTileset

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

TilesetID

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

ErrorAdditionalInfo

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

名前 説明
info

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorResponse

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

名前 説明
error

ErrorDetail

エラー オブジェクト。

MapTileset

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

名前 説明
attribution

string

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

bounds

number[] (float)

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

center

number[] (float)

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

data

string[]

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

description

string

タイルセットのテキストの説明。 説明には、任意の有効な文字を含めることができます。 実装では、説明を HTML として解釈すべきではありません (SHOULD NOT)。

grids

string[]

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

legend

string

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

maxzoom

integer (int32)

minimum: 0
maximum: 30

最大ズーム レベル。

minzoom

integer (int32)

minimum: 0
maximum: 30

最小ズーム レベル。

name

string

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

scheme

string

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

template

string

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

tilejson

string

pattern: \d+\.\d+\.\d+\w?[\w\d]*

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

tiles

string[]

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

version

string

pattern: \d+\.\d+\.\d+\w?[\w\d]*

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

TilesetID

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

説明
microsoft.base

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

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

microsoft.base.labels

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

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

microsoft.base.hybrid

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

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

microsoft.terra.main

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

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

microsoft.base.road

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

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

microsoft.base.darkgrey

濃い灰色のスタイルを持つすべてのレイヤー。

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

microsoft.base.labels.road

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

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

microsoft.base.labels.darkgrey

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

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

microsoft.base.hybrid.road

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

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

microsoft.base.hybrid.darkgrey

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

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

microsoft.imagery

衛星画像または航空写真の組み合わせ。 S1 および G2 価格 SKU でのみ使用できます。

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

microsoft.weather.radar.main

気象レーダー タイル。 雨、雪、氷、混合条件の領域を含む最新の気象レーダー画像。 Azure Maps気象サービスの報道の詳細については、Azure Maps気象サービスの報道をご覧ください。 レーダーデータの詳細については、Azure Maps<>の気象サービスをご覧ください。

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

microsoft.weather.infrared.main

赤外線タイルの天気。 最新の赤外線衛星画像は、その温度によって雲を示しています。 詳細については、Azure Maps気象サービスのカバレッジをご覧ください。 衛星データの詳細については、Azure Maps気象サービスをご覧ください。

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

microsoft.traffic.absolute

ベクトル内の絶対トラフィック タイル

microsoft.traffic.absolute.main

メイン スタイルのラスター内の絶対トラフィック タイル。

microsoft.traffic.relative

ベクター内の相対トラフィック タイル

microsoft.traffic.relative.main

メイン スタイルのラスター内の相対トラフィック タイル。

microsoft.traffic.relative.dark

ダーク スタイルのラスター内の相対トラフィック タイル。

microsoft.traffic.delay

ベクター内のトラフィック タイル

microsoft.traffic.delay.main

メイン スタイルのラスター内のトラフィック タイル

microsoft.traffic.reduced.main

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

microsoft.traffic.incident

ベクター内のインシデント タイル