Map Configuration - Create
マップ構成を作成するには、 を使用します。
マップ構成の詳細については、屋内マップの概念 の作成者 に関する記事を参照してください。
作成要求を送信する
Map Configuration Create
API は、新しいマップ構成を作成するために使用される HTTP POST
要求です。
POST https://{geography}.atlas.microsoft.com/styles/mapconfigurations?api-version=2023-03-01-preview
POST https://{geography}.atlas.microsoft.com/styles/mapconfigurations?api-version=2023-03-01-preview&alias={alias}&description={description}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
geography
|
path | True |
string |
このパラメーターは、Azure Maps Creator リソースの場所を指定します。 有効な値は、us と eu です。 |
api-version
|
query | True |
string |
Azure Maps API のバージョン番号。 |
alias
|
query |
string |
マップ構成のエイリアス。 最大長は 1024 文字です。 エイリアスは、予約済みプレフィックスである で始 |
|
description
|
query |
string |
ユーザーが提供したマップ構成の説明。 最大長は 1024 文字です。 |
要求ヘッダー
Media Types: "application/json", "application/zip"
名前 | 必須 | 型 | 説明 |
---|---|---|---|
x-ms-client-id |
string |
Microsoft Entra ID セキュリティ モデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーン アカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、次の記事を参照してください。 |
要求本文
Media Types: "application/json", "application/zip"
名前 | 必須 | 型 | 説明 |
---|---|---|---|
version | True |
number |
マップ構成のバージョン (現在はバージョン 1.0 のみ) がサポートされています。 |
configurations |
'Configurations' 配列を使用すると、お客様はタイルセットのさまざまなマップ表現を構成できます。 ここで構成された各構成は、クライアント SDK のスタイル ピッカーで 1 つのマップ スタイルとして反映されます。 名前は configurations 配列で一意である必要があります。 |
||
defaultConfiguration |
string |
マップ構成の既定の構成。 値は、ConfigurationObject の 'configurations' 配列の 'name' フィールドのいずれかである必要があります。 指定しない場合は、'configurations' リストの最初のエントリが使用されます。 |
|
description |
string |
マップ構成の作成時に呼び出し元が指定した説明。 最大長は 1024 文字です。 |
応答
名前 | 型 | 説明 |
---|---|---|
202 Accepted |
[Request Accepted]\(要求の承諾\): 要求は処理のために受け入れ済みです。 状態を取得するには、Operation-Location ヘッダーの URL を使用してください。 ヘッダー Operation-Location: string |
|
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
例
Create a map configuration by providing a configuration file
要求のサンプル
POST https://us.atlas.microsoft.com/styles/mapconfigurations?api-version=2023-03-01-preview&alias=sample-alias&description=This is my first map configuration.
{
"version": 1,
"description": "This is Microsoft default indoor map configuration",
"defaultConfiguration": "microsoft_light",
"configurations": [
{
"name": "indoor_light",
"displayName": "Indoor light",
"description": "A base style for Azure Maps.",
"theme": "light",
"baseMap": "microsoft_light",
"layers": [
{
"tilesetId": "{tilesetId}",
"styleId": "microsoft-maps:indoor_2022-01-01"
}
]
},
{
"name": "indoor_dark",
"displayName": "Indoor dark",
"description": "A base style for Azure Maps.",
"theme": "dark",
"baseMap": "microsoft_dark",
"layers": [
{
"tilesetId": "{tilesetId}",
"styleId": "microsoft-maps:indoor_dark_2022-01-01"
}
]
}
]
}
応答のサンプル
Operation-Location: https://us.atlas.microsoft.com/styles/mapConfigurations/operations/{operationId}?api-version=2022-01-01-preview
Access-Control-Expose-Headers: Operation-Location
定義
名前 | 説明 |
---|---|
Base |
ベース マップは、プライベート 屋内マップの背景レイヤーです。 このプロパティは省略可能です。指定しない場合、ベース マップは表示されません。 最大長は 100 文字です。 |
Configuration |
クライアント SDK でスタイル ピッカーと関連付けられたマップを構成する形式を定義します。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Map |
マップ構成 json 形式を記述するマップ構成オブジェクト。 |
theme |
クライアント SDK ウィジェットのテーマ (スタイル ピッカー、ズーム、レベル ピッカー)。 |
Tileset |
TilesetId と StyleId タプル |
BaseMap
ベース マップは、プライベート 屋内マップの背景レイヤーです。 このプロパティは省略可能です。指定しない場合、ベース マップは表示されません。 最大長は 100 文字です。
名前 | 型 | 説明 |
---|---|---|
microsoft_dark |
string |
ベースのダーク ロード マップ スタイル。 |
microsoft_grayscale_dark |
string |
グレースケールのダーク マップ スタイル。 |
microsoft_grayscale_light |
string |
グレースケールライトマップスタイル。 |
microsoft_high_contrast_dark |
string |
ハイ コントラストのダーク マップ スタイル。 |
microsoft_high_contrast_light |
string |
ハイ コントラストのライト マップ スタイル。 |
microsoft_light |
string |
基本道路マップ のスタイル。 |
microsoft_satellite |
string |
衛星画像マップ のスタイル。 |
microsoft_satellite_road |
string |
衛星とロードマップのスタイル。 |
microsoft_shaded_relief |
string |
網掛けされたレリーフ マップ スタイル。 |
ConfigurationObject
クライアント SDK でスタイル ピッカーと関連付けられたマップを構成する形式を定義します。
名前 | 型 | 説明 |
---|---|---|
baseMap |
ベース マップは、プライベート 屋内マップの背景レイヤーです。 このプロパティは省略可能です。指定しない場合、ベース マップは表示されません。 最大長は 100 文字です。 |
|
description |
string |
スタイルの説明。 最大長は 500 文字です。 |
displayName |
string |
クライアント SDK のスタイル ピッカーの表示名。 最大長は 255 文字です。 |
layers |
タイルセットのスタイルを構成するには。 タイルセット全体に対して 1 つのスタイルを使用できます。 また、1 つのタイルセット内のレイヤーごとに異なるスタイルを使用できます(たとえば、レイヤーのスタイルとレイヤーの |
|
name |
string |
スタイルの名前。 最大長は 255 文字です。 |
theme |
クライアント SDK ウィジェットのテーマ (スタイル ピッカー、ズーム、レベル ピッカー)。 |
|
thumbnail |
string |
クライアント SDK のスタイル ピッカーのサムネイル 画像ファイル。 最大長は 255 文字です。 サイズ制限は 400 KB、ピクセル制限は 512*512 です。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
MapConfiguration
マップ構成 json 形式を記述するマップ構成オブジェクト。
名前 | 型 | 説明 |
---|---|---|
configurations |
'Configurations' 配列を使用すると、お客様はタイルセットのさまざまなマップ表現を構成できます。 ここで構成された各構成は、クライアント SDK のスタイル ピッカーで 1 つのマップ スタイルとして反映されます。 名前は configurations 配列で一意である必要があります。 |
|
defaultConfiguration |
string |
マップ構成の既定の構成。 値は、ConfigurationObject の 'configurations' 配列の 'name' フィールドのいずれかである必要があります。 指定しない場合は、'configurations' リストの最初のエントリが使用されます。 |
description |
string |
マップ構成の作成時に呼び出し元が指定した説明。 最大長は 1024 文字です。 |
version |
number |
マップ構成のバージョン (現在はバージョン 1.0 のみ) がサポートされています。 |
theme
クライアント SDK ウィジェットのテーマ (スタイル ピッカー、ズーム、レベル ピッカー)。
名前 | 型 | 説明 |
---|---|---|
dark |
string |
クライアント SDK ウィジェットのダーク テーマ (スタイル ピッカー、ズーム、レベル ピッカー)。 |
light |
string |
クライアント SDK ウィジェットのライト テーマ (スタイル ピッカー、ズーム、レベル ピッカー)。 |
TilesetStyleTuple
TilesetId と StyleId タプル
名前 | 型 | 説明 |
---|---|---|
styleId |
string |
Azure マップ スタイルの一意の ID。 2 つの定義済みの styleId エイリアスは、 |
tilesetId |
string |
タイルセットの一意の ID。 |