Tileset - List
タイルセットの一覧を取得するために使用します。
注
Azure Maps Creator の提供終了
Azure Maps Creator のフロア ガイド サービスは現在非推奨となっており、2025 年 9 月 30 日付けで提供が終了します。 詳細については、Azure Maps Creator のサポート終了のお知らせを参照してください。
リスト要求の送信
List
API は、既存のすべてのタイルセットの一覧をフェッチするために使用される HTTP GET
要求です。
GET https://{geography}.atlas.microsoft.com/tilesets?api-version=2.0
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
geography
|
path | True |
string |
このパラメーターは、Azure Maps Creator リソースが配置されている場所を指定します。 有効な値は us と eu です。 |
api-version
|
query | True |
string |
Azure Maps API のバージョン番号。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
x-ms-client-id |
string |
Microsoft Entra ID セキュリティ モデルと組み合わせて使用するアカウントを指定します。 これは Azure Maps アカウントの一意の ID を表し、Azure Maps 管理プレーン アカウント API から取得できます。 Azure Maps で Microsoft Entra ID セキュリティを使用するには、ガイダンス 次の |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
正常に完了したタイルセット要求を一覧表示します。 応答本文には、すべてのタイルセットの一覧が含まれています。 |
|
Other Status Codes |
予期しないエラーが発生しました。 |
セキュリティ
AADToken
これらは、Microsoft Entra OAuth 2.0 フロー
シナリオを実装するには、認証の概念表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。
注記
- このセキュリティ定義 使用して、アプリケーションがアクセスを要求している 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 を使用すると、複数のユース ケースに対するアプリケーションの構成ベースのセットアップが可能になります。
- Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。
型:
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 Maps アカウント を作成 場合にプロビジョニングされる共有キーです。
このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。 つまり、このキーは、発行されたアカウントのマスター キーとして使用できます。
パブリックに公開されているアプリケーションの場合は、キーを安全に格納できるように、機密クライアント アプリケーション アプローチを使用して Azure Maps REST API にアクセスすることをお勧めします。
型:
apiKey
/:
query
SAS Token
これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソース のリスト SAS 操作から作成される Shared Access Signature トークンです。
このトークンを使用すると、すべてのアプリケーションは、Azure ロールベースのアクセス制御と、特定のトークンに対する使用の有効期限、レート、およびリージョンに対するきめ細かな制御を使用してアクセスすることが承認されます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。
パブリックに公開されているアプリケーションの場合は、Map アカウント リソースの許可された配信元の特定の一覧を構成し、レンダリングの不正使用を制限し、SAS トークンを定期的に更新するように することをお勧めします。
型:
apiKey
/:
header
例
Get a list of all tilesets
要求のサンプル
GET https://us.atlas.microsoft.com/tilesets?api-version=2.0
応答のサンプル
{
"tilesets": [
{
"tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84",
"datasetId": "63b18a6b-ac35-4b23-a1d9-ffa1003ad50b",
"description": "My first tileset",
"minZoom": 16,
"maxZoom": 18,
"bbox": [
-122.13595,
47.636524,
-122.1329,
47.637525
]
},
{
"tilesetId": "b8dca8b3-8aad-4afe-abd6-0efe37b5a2e3",
"datasetId": "c0a01139-662e-4d5a-bf5f-92ea4a292aad",
"description": "My second tileset",
"minZoom": 19,
"maxZoom": 19,
"bbox": [
-122.13595,
47.636524,
-122.1329,
47.637525
]
}
]
}
定義
名前 | 説明 |
---|---|
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Tileset |
データの詳細情報。 |
Tileset |
Tileset List API の応答モデル。 すべてのタイルセットの一覧を返します。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
エラー オブジェクト。 |
Tileset
データの詳細情報。
名前 | 型 | 説明 |
---|---|---|
bbox |
number[] (double) |
タイルセットのすべての機能が配置されている境界ボックス。 使用されるプロジェクション - EPSG:3857。 形式: 'minLon、minLat、maxLon、maxLat'。 |
datasetId |
string |
タイルセットの作成に使用される一意のデータセット ID。 |
description |
string |
タイルセットの作成時に呼び出し元が指定した説明。 最大長 1024 文字。 |
maxZoom |
integer |
タイルセットに対して生成された最も高いタイル ズーム レベルのタイル。 |
minZoom |
integer |
タイルセットに対して生成された最も低いタイル ズーム レベルのタイル。 |
ontology |
string |
このデータセットのオントロジ バージョン。 |
tilesetId |
string |
タイルセットの一意のタイルセット ID。 |
TilesetListResult
Tileset List API の応答モデル。 すべてのタイルセットの一覧を返します。
名前 | 型 | 説明 |
---|---|---|
nextLink |
string |
存在する場合は、データの次のページの場所。 |
tilesets |
Tileset[] |
すべてのタイルセットの一覧。 |