Tileset - List
タイルセットの一覧を取得するには、 を使用します。
リスト要求の送信
List
API は、既存のすべてのタイルセットの一覧をフェッチするために使用される HTTP GET
要求です。
GET https://{geography}.atlas.microsoft.com/tilesets?api-version=2023-03-01-preview
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
これらは Azure Active Directory OAuth2 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタム ロールを使用して、任意のユーザー、グループ、またはサービス プリンシパルにアクセス権 Azure Mapsを付与できます。
シナリオを実装するには、 認証の概念を表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。
メモ
- このセキュリティ定義では、 ヘッダーを使用して、
x-ms-client-id
アプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。 これは、 Maps 管理 API から取得できます。
Authorization URL
は、Azure パブリック クラウド インスタンスに固有です。 ソブリン クラウドには、一意の承認 URL と Azure Active Directory 構成があります。
* Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。
* Azure Maps Web SDK を使用すると、複数のユース ケースに対してアプリケーションを構成ベースで設定できます。
- 現在、Azure Active Directory v1.0 または v2.0 は職場、学校、ゲストをサポートしていますが、個人用アカウントはサポートしていません。
型:
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でAzure Maps アカウントを作成するとき、または PowerShell、CLI、Azure SDK、または REST API を使用するときにプロビジョニングされる共有キーです。
このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。 つまり、このキーは、発行されたアカウントのマスター キーとして使用できます。
公開されているアプリケーションの場合は、機密クライアント アプリケーションのアプローチを使用して、キーを安全に格納できるように、Azure Maps REST API にアクセスすることをお勧めします。
型:
apiKey
/:
query
SAS Token
これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して、Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。
このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンをきめ細かく制御できます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。
公開されているアプリケーションの場合、 Map アカウント リソース で許可される配信元の特定の一覧を構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。
型:
apiKey
/:
header
例
Get a list of all tilesets
要求のサンプル
GET https://us.atlas.microsoft.com/tilesets?api-version=2023-03-01-preview
応答のサンプル
{
"tilesets": [
{
"tilesetId": "{tilesetId}",
"datasetId": "{datasetId}",
"description": "My first tileset",
"minZoom": 16,
"maxZoom": 18,
"bbox": [
-122.13595,
47.636524,
-122.1329,
47.637525
],
"ontology": "facility-2.0",
"tilesetConfiguration": {
"version": 1,
"layers": {
"Indoor facility": {
"minZoom": 13,
"maxZoom": 20,
"features": {
"featureClasses": [
"facility"
]
}
},
"Indoor unit": {
"minZoom": 16,
"maxZoom": 19,
"features": {
"featureClasses": [
"unit"
]
}
}
}
},
"defaultMapConfigurationId": "{defaultMapConfigurationId}"
},
{
"tilesetId": "{tilesetId}",
"datasetId": "{datasetId}",
"description": "My second tileset",
"minZoom": 19,
"maxZoom": 19,
"bbox": [
-122.13595,
47.636524,
-122.1329,
47.637525
],
"ontology": "facility-2.0",
"tilesetConfiguration": {
"version": 1,
"layers": {
"Indoor facility": {
"minZoom": 13,
"maxZoom": 20,
"features": {
"featureClasses": [
"facility"
]
}
},
"Indoor unit": {
"minZoom": 16,
"maxZoom": 19,
"features": {
"featureClasses": [
"unit"
]
}
},
"Indoor opening": {
"minZoom": 16,
"maxZoom": 19,
"features": {
"featureClasses": [
"opening"
]
}
}
}
},
"defaultMapConfigurationId": "{defaultMapConfigurationId}"
}
]
}
定義
名前 | 説明 |
---|---|
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Feature |
タイルセット構成の機能構成。 |
Layer |
タイルセット構成用のレイヤー オブジェクト。 |
Tileset |
データの詳細情報。 |
Tileset |
タイルセット構成の最上位フィールド。 タイルセット構成は、次の最上位フィールドを含む必要がある JSON オブジェクトです。 |
Tileset |
Tileset List API の応答モデル。 すべてのタイルセットの一覧を返します。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
Feature
タイルセット構成の機能構成。
名前 | 型 | 説明 |
---|---|---|
featureClasses |
string[] |
レイヤーの構築に使用されるフィーチャクラスの一覧。 有効なフィーチャクラスはオントロジ定義にあります。 たとえば、 ファシリティ オントロジ |
filter |
object |
パターンに一致しないフィーチャを削除します。 MapLibre フィルター式を参照してください |
LayerObject
タイルセット構成用のレイヤー オブジェクト。
名前 | 型 | 説明 |
---|---|---|
features |
フィーチャ クラスとフィルターを指定します。 |
|
maxZoom |
integer |
レイヤーが構築する最も高いズーム レベル。 |
minZoom |
integer |
レイヤーが構築する最も低いズーム レベル。 |
Tileset
データの詳細情報。
名前 | 型 | 説明 |
---|---|---|
bbox |
number[] |
タイルセットのすべてのフィーチャが配置されている境界ボックス。 使用されるプロジェクション - EPSG:3857。 形式: 'minLon、minLat、maxLon、maxLat' |
datasetId |
string |
タイルセットの作成に使用される一意のデータセット ID。 |
defaultMapConfigurationId |
string |
タイルセットの既定で生成されたマップ構成 ID |
description |
string |
タイルセットの作成時に呼び出し元が指定した説明。 最大長は 1024 文字です。 |
maxZoom |
integer |
タイルセットに対して生成されたタイル ズーム レベルの最上位タイル。 |
minZoom |
integer |
タイルセットに対して生成された最も低いタイル ズーム レベルのタイル。 |
ontology |
string |
このデータセットのオントロジ バージョン。 |
tilesetConfiguration |
タイルセットのビルドに使用されるタイルセット構成。 |
|
tilesetId |
string |
タイルセットの一意のタイルセット ID。 |
TilesetConfiguration
タイルセット構成の最上位フィールド。 タイルセット構成は、次の最上位フィールドを含む必要がある JSON オブジェクトです。
名前 | 型 | 説明 |
---|---|---|
layers |
<string,
Layer |
レイヤーの名前とその構成オプション。 構成レイヤー オブジェクトには、タイル レイヤーの名前とその構成を関連付けるキーと値のペアが含まれています。 キーと値のペアごとに、キーはレイヤーの名前であり、値はレイヤーの構成とオプションを含む LayerObject です。 各レイヤーには名前が必要です。 これは、最終的なタイルセット内のデータレイヤーの一意識別子です。 どのタイルセットでも、各レイヤー名は一意である必要があります。 レイヤー名は、アンダースコア (_) と英数字のみを含む文字列である必要があります。 各レイヤー名に対応する LayerObject は、そのベクター タイル レイヤーの作成方法を説明します。 特徴データを取得するフィーチャクラス、ズーム レベルによるデータの精度、およびフィーチャを変換してタイルにレンダリングする方法を指定します。 |
version |
integer |
タイルセット構成Azure Maps使用するタイル サービス構成参照のバージョン。 現在、バージョン 1 のみが許可されています。 現在のバージョンまたは以前のバージョンの他のバージョンを使用すると、エラーが発生します。 |
TilesetListResult
Tileset List API の応答モデル。 すべてのタイルセットの一覧を返します。
名前 | 型 | 説明 |
---|---|---|
nextLink |
string |
存在する場合は、データの次のページの場所。 |
tilesets |
Tileset[] |
すべてのタイルセットの一覧。 |