Tileset - Validate Configuration
タイルセットの構成を検証するには、 を使用します。
構成の検証要求を送信する
Validate Configuration
API は、指定された に基づいて指定されたタイルセット構成を検証するために使用される HTTP POST
要求ですdatasetId
。
POST https://{geography}.atlas.microsoft.com/tilesets:validateConfiguration?api-version=2023-03-01-preview&datasetId={datasetId}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
geography
|
path | True |
string |
このパラメーターは、Azure Maps Creator リソースの場所を指定します。 有効な値は、us と eu です。 |
api-version
|
query | True |
string |
Azure Maps API のバージョン番号。 |
dataset
|
query | True |
string |
タイルセット作成 API がタイルを生成する機能を取得するために使用する一意 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
x-ms-client-id |
string |
Microsoft Entra ID セキュリティ モデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーン アカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、ガイダンスについては、次の記事を参照してください。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
layers | True |
<string,
Layer |
レイヤーの名前とその構成オプション。 構成レイヤー オブジェクトには、タイル レイヤーの名前とその構成を関連付けるキーと値のペアが含まれています。 キーと値のペアごとに、キーはレイヤーの名前、値はレイヤーの構成とオプションを含む LayerObject です。 各レイヤーには名前が必要です。 これは、最終的なタイルセット内のデータレイヤーの一意識別子です。 どのタイルセットでも、各レイヤー名は一意である必要があります。 レイヤー名は、アンダースコア (_) と英数字のみを含む文字列である必要があります。 各レイヤー名に対応する LayerObject は、そのベクター タイル レイヤーを作成する方法を説明します。 特徴データを取得するフィーチャクラス、ズーム レベルによるデータの精度、およびフィーチャを変換してタイルにレンダリングする方法を指定します。 |
version | True |
integer |
タイルセット構成で使用Azure Mapsタイル サービス構成参照のバージョン。 現在、バージョン 1 のみが許可されています。 現在のバージョンまたは以前のバージョンの他のバージョンを使用すると、エラーが発生します。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
タイルセット構成要求が正常に完了したことを検証します。 応答本文には、検証結果が含まれています。 |
|
Other Status Codes |
予期しないエラーが発生しました。 |
セキュリティ
AADToken
これらは Azure Active Directory OAuth2 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API をAzure Mapsするための 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタム ロールを使用して、ユーザー、グループ、またはサービス プリンシパルにアクセス権を付与できます。
シナリオを実装するには、 認証の概念を表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の 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
例
Validates the correctness of a tileset configuration
要求のサンプル
POST https://us.atlas.microsoft.com/tilesets:validateConfiguration?api-version=2023-03-01-preview&datasetId=[datasetId]
{
"version": 1,
"layers": {
"Indoor test": {
"minZoom": 10,
"maxZoom": 18,
"features": {
"featureClasses": [
"unit"
],
"filter": [
"any",
[
"!=",
[
"get",
"featureType"
],
"conference"
],
[
"!=",
[
"get",
"featureType"
],
"restroom"
]
]
}
}
}
}
応答のサンプル
{
"valid": false,
"warnings": [],
"errors": [
{
"code": "CustomLayerNameNotSupported",
"message": "Custom layerName 'Indoor test' is not supported yet.",
"target": "Indoor test"
}
]
}
定義
名前 | 説明 |
---|---|
Error |
リソース管理エラーの追加情報。 |
Error |
検証エラー コード。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Feature |
タイルセット構成の機能構成。 |
Layer |
タイルセット構成のレイヤー オブジェクト。 |
Tileset |
タイルセット構成の最上位フィールド。 タイルセット構成は、次の最上位フィールドを含む必要がある JSON オブジェクトです。 |
Tileset |
タイルセット構成の検証結果。 |
Validation |
タイルセット構成の検証エラー。 |
Validation |
タイルセット構成の検証エラー。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorCode
検証エラー コード。
名前 | 型 | 説明 |
---|---|---|
CustomLayerNameNotSupported |
string |
カスタム レイヤー名は現在サポートされていません。 |
CustomOntologyNotSupported |
string |
カスタム オントロジは現在サポートされていません。'Facility-2.0' はサポートされているオントロジです。 |
DuplicateFeatureClassFound |
string |
フィーチャ クラス名は一意である必要があります。 |
DuplicateLayerNameFound |
string |
レイヤー名は一意である必要があります。 |
UndefinedFeatureClasses |
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 |
作成するレイヤーの最も低いズーム レベル。 |
TilesetConfiguration
タイルセット構成の最上位フィールド。 タイルセット構成は、次の最上位フィールドを含む必要がある JSON オブジェクトです。
名前 | 型 | 説明 |
---|---|---|
layers |
<string,
Layer |
レイヤーの名前とその構成オプション。 構成レイヤー オブジェクトには、タイル レイヤーの名前とその構成を関連付けるキーと値のペアが含まれています。 キーと値のペアごとに、キーはレイヤーの名前、値はレイヤーの構成とオプションを含む LayerObject です。 各レイヤーには名前が必要です。 これは、最終的なタイルセット内のデータレイヤーの一意識別子です。 どのタイルセットでも、各レイヤー名は一意である必要があります。 レイヤー名は、アンダースコア (_) と英数字のみを含む文字列である必要があります。 各レイヤー名に対応する LayerObject は、そのベクター タイル レイヤーを作成する方法を説明します。 特徴データを取得するフィーチャクラス、ズーム レベルによるデータの精度、およびフィーチャを変換してタイルにレンダリングする方法を指定します。 |
version |
integer |
タイルセット構成で使用Azure Mapsタイル サービス構成参照のバージョン。 現在、バージョン 1 のみが許可されています。 現在のバージョンまたは以前のバージョンの他のバージョンを使用すると、エラーが発生します。 |
TilesetConfigurationValidationResult
タイルセット構成の検証結果。
名前 | 型 | 説明 |
---|---|---|
errors |
検証エラーの一覧。 |
|
valid |
boolean |
検証結果。 |
warnings |
検証警告の一覧。 |
ValidationError
タイルセット構成の検証エラー。
名前 | 型 | 説明 |
---|---|---|
code |
検証エラー コード。 |
|
message |
string |
検証エラー メッセージ。 |
target |
string |
検証エラーのターゲット要素。 |
ValidationWarning
タイルセット構成の検証エラー。
名前 | 型 | 説明 |
---|---|---|
code |
string |
検証の警告コード。 |
message |
string |
検証の警告メッセージ。 |
target |
string |
検証警告のターゲット要素。 |