Style - Create
Azure Maps スタイルを作成するには、 を使用します。
作成要求を送信する
Style Create
API は、スタイル情報を含む JSON ファイルまたは ZIP ファイルを渡すことによって、Azure Maps スタイルを作成するために使用される HTTP POST
要求です。
スタイルの作成 API は、 実行時間の長い操作です。
POST https://{geography}.atlas.microsoft.com/styles?api-version=2023-03-01-preview
POST https://{geography}.atlas.microsoft.com/styles?api-version=2023-03-01-preview&description={description}&alias={alias}
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"
名前 | 型 | 説明 |
---|---|---|
CreateContent |
object |
アップロードするスタイル コンテンツ。 JSON データ形式が指定されている場合、要求本文は MapLibre スタイル 仕様の Layers 仕様 に従う必要があります。 ZIP データ形式が指定されている場合は、スタイル構成 json ファイルで使用されるアイコンを含むスプライト シートと関連するインデックス ファイルも指定する必要があります。 |
応答
名前 | 型 | 説明 |
---|---|---|
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 Style by providing an azure maps style json file
要求のサンプル
POST https://us.atlas.microsoft.com/styles?api-version=2023-03-01-preview&alias=test-alias
{
"layers": [
{
"id": "background",
"type": "background",
"source-layer": "bg-source",
"minzoom": 18,
"maxzoom": 20,
"layout": {
"visibility": "none",
"symbol-placement": "point",
"symbol-avoid-edges": true,
"text-field": "{name}",
"text-keep-upright": true,
"text-font": [
"SegoeUi-SemiBold"
],
"text-letter-spacing": 0.1,
"text-size": {
"stops": [
[
18.5,
6.5
],
[
19,
8
],
[
19.5,
9.5
],
[
20,
11
]
]
},
"text-anchor": "center"
},
"paint": {
"text-color": "rgb(0, 0, 0)",
"text-halo-color": "rgb(255, 255, 255)",
"text-halo-width": 1,
"text-halo-blur": 0.5
}
}
]
}
応答のサンプル
Operation-Location: https://us.atlas.microsoft.com/styles/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location
定義
名前 | 説明 |
---|---|
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |