Render - Get Map State Tile

を使用して、ベクター形式で状態タイルを取得し、それを使用して屋内マップに特徴状態情報を表示できます。

Get Map State Tile API は、状態タイルをベクター形式でフェッチする HTTP GET 要求です。通常は、マップ コントロールまたは SDK の屋内マップ モジュールに統合されます。 マップ コントロールは、動的スタイル設定が有効になった後にこの API を呼び出します。 詳細については、「 ズーム レベルとタイル グリッド」を参照してください。

GET https://atlas.microsoft.com/map/statetile?api-version=2022-08-01&zoom={zoom}&x={x}&y={y}&statesetId={statesetId}

URI パラメーター

名前 / 必須 説明
api-version
query True

string

Azure Maps API のバージョン番号。 現在のバージョンは 2022-08-01 です

statesetId
query True

string

stateset ID。

x
query True

integer

int32

ズーム グリッド上のタイルの X 座標。 値は [0, 2zoom -1] の範囲内である必要があります。

詳細については、「 ズーム レベルとタイル グリッド 」を参照してください。

y
query True

integer

int32

ズーム グリッド上のタイルの Y 座標。 値は [0, 2zoom -1] の範囲内である必要があります。

詳細については、「 ズーム レベルとタイル グリッド 」を参照してください。

zoom
query True

integer

int32

目的のタイルのズーム レベル。

詳細については、「 ズーム レベルとタイル グリッド 」を参照してください。

要求ヘッダー

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

string

Microsoft Entra ID セキュリティ モデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーン アカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、ガイダンスについては、次の記事を参照してください。

応答

名前 説明
200 OK

object

このタイルは、マップ状態タイルの取得に成功した呼び出しから返されます

Media Types: "application/vnd.mapbox-vector-tile", "application/json"

Headers

Content-Type: string

Other Status Codes

ErrorResponse

予期しないエラーが発生しました。

Media Types: "application/vnd.mapbox-vector-tile", "application/json"

セキュリティ

AADToken

これらは OAuth 2.0 フロー Microsoft Entraです。 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 とMicrosoft Entra ID構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユース ケースに対してアプリケーションを構成ベースで設定できます。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前 説明
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 のサーバー間アクセスを使用することをお勧めします。

Type: apiKey
In: header

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンに対するきめ細かい制御が許可されます。 言い換えると、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できます。

公開されているアプリケーションの場合、 Map アカウント リソース で許可される配信元の特定のリストを構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

Type: apiKey
In: header

Successful State Tile Request

Sample Request

GET https://atlas.microsoft.com/map/statetile?api-version=2022-08-01&zoom=6&x=10&y=22&statesetId=[statesetId]

Sample Response

Content-Type: application/vnd.mapbox-vector-tile
"{file}"

定義

名前 説明
ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。