Render - Get Map State Tile

サービス:: Maps

API バージョン:: 2024-04-01

ベクター形式で状態タイルを取得するために使用します。これを使用して、屋内マップに特徴状態情報を表示できます。
通常、マップコントロールまたは SDK の屋内マップモジュールに統合するために、ベクター形式で状態タイルをフェッチします。マップコントロールは、ユーザーが動的スタイル設定を有効にした後、この API を呼び出します。詳細については、「ズームレベルとタイルグリッドのをする」を参照してください。

GET {endpoint}/map/statetile?api-version=2024-04-01&zoom={zoom}&x={x}&y={y}&statesetId={statesetId}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	Azure Mapsサービスのホストネーム。 Azureパブリッククラウドには`https://atlas.microsoft.com`を使いましょう。特定のAzure Maps地理やソブリンクラウドをターゲットにする場合は、Azure Maps地理的範囲を参照してください。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
statesetId	query	True	string	stateset ID。
x	query	True	integer (int32)	ズームグリッド上のタイルの X 座標。値は、[0, 2^zoom -1] の範囲内である必要があります。詳細については、「ズームレベルとタイルグリッドの」を参照してください。
y	query	True	integer (int32)	ズームグリッド上のタイルの Y 座標。値は、[0, 2^zoom -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セキュリティの使用についての詳細は、Azure Mapsの認証管理Manage certificationをご覧ください。

応答

名前	型	説明
200 OK	string	要求は成功しました。 Media Types: "application/json", "application/vnd.mapbox-vector-tile"
Other Status Codes	ErrorResponse	予期しないエラー応答。 Media Types: "application/json", "application/vnd.mapbox-vector-tile"

名前

型

説明

200 OK

string

要求は成功しました。

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

Other Status Codes

ErrorResponse

予期しないエラー応答。

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

セキュリティ

AadToken

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

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

Note

このセキュリティ定義使用して、アプリケーションがアクセスを要求している 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

subscription-key

これは、Azure portal で、または PowerShell、CLI、Azure SDK、または REST API を使用して Azure Maps アカウントを作成場合にプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。つまり、このキーは、発行されたアカウントのマスターキーとして使用できます。

パブリックに公開されているアプリケーションの場合は、キーを安全に格納できるように、機密クライアントアプリケーションアプローチを使用して Azure Maps REST API にアクセスすることをお勧めします。

型: apiKey
/: header

SAS Token

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

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

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

型: apiKey
/: header

例

Successful State Tile Request

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

Content-Type: application/vnd.mapbox-vector-tile

"{file}"

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

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