Features - Get Landing Page

リファレンス

サービス:: Maps Creator

API バージョン:: 2023-03-01-preview

特定の機能コレクションの API 定義、準拠ステートメント、およびメタデータへのリンクを取得するために使用します。

注

Azure Maps Creator の提供終了

Azure Maps Creator のフロアガイドサービスは現在非推奨となっており、2025 年 9 月 30 日付けで提供が終了します。詳細については、Azure Maps Creator のサポート終了のお知らせを参照してください。

Features API は、Creatorの一部であり、Azure Maps API と SDK を使用して、プライベート屋内マップデータに基づいてアプリケーションを開発できます。機能 GET API は、Open Geospatial Consortium API - Features - Part 1: Core corrigendum 標準に従って、データセットクエリを実行します。データセットは、共通スキーマによって定義特徴のグループである複数の特徴コレクションで構成されます。

ランディングページの取得要求を送信する

Get Landing Page API は、指定されたデータセット内の機能に関する API 定義、準拠ステートメント、およびメタデータへのリンクを提供する HTTP GET 要求です。

GET https://{geography}.atlas.microsoft.com/features/datasets/{datasetId}?api-version=2023-03-01-preview

URI パラメーター

名前	/	必須	型	説明
datasetId	path	True	string	クエリの対象となるデータセットの識別子。
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	LandingPageResult	わかりました
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

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

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

注記

このセキュリティ定義使用して、アプリケーションがアクセスを要求している 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、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンを介して 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

例

GetLandingPage

要求のサンプル

HTTP

GET https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4?api-version=2023-03-01-preview

応答のサンプル

状態コード:: 200

{
  "ontology": "Facility-2.0",
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4",
      "rel": "self",
      "title": "Azure Maps Features"
    },
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/api",
      "rel": "service-desc",
      "title": "The API definition"
    },
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/conformance",
      "rel": "conformance",
      "title": "Conformance classes implemented by Features APIs"
    },
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections",
      "rel": "data",
      "title": "Information about the feature collections"
    }
  ]
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
FeaturesEndpointLink	他の機能エンドポイントへのリンク。リンク関係の詳細については、OGC API - 機能 - パート 1 標準を参照してください。
LandingPageResult	ランディングページへの要求が成功した後の応答。

ErrorAdditionalInfo

Object

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

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

FeaturesEndpointLink

Object

他の機能エンドポイントへのリンク。リンク関係の詳細については、OGC API - 機能 - パート 1 標準を参照してください。

名前	型	説明
href	string (uri)	リンク先。
rel	string	リレーションシップの種類。
title	string	リンクの宛先にラベルを付けるために使用され、コンテンツ言語ヘッダーフィールド (存在する場合) によって示される言語で、人間が判読できる識別子 (メニューエントリなど) として使用できます。

LandingPageResult

Object

ランディングページへの要求が成功した後の応答。

名前	型	説明
links	FeaturesEndpointLink[]	他の機能エンドポイントへのリンク。
ontology	string	このデータセットのオントロジバージョン。

次の方法で共有

Features - Get Landing Page

ランディング ページの取得要求を送信する

URI パラメーター

要求ヘッダー

応答

セキュリティ

AADToken

注記

スコープ

subscription-key

SAS Token

例

GetLandingPage

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeaturesEndpointLink

LandingPageResult

ランディングページの取得要求を送信する