共用方式為

Tileset - Create

  • 參考
服務:
Maps Creator
API 版本:
2.0

使用 來建立圖格集。

備註

Azure 地圖服務 Creator 淘汰

Azure 地圖服務 Creator 室內地圖服務現在已被取代，且將於 2025/9/30 淘汰。 如需詳細資訊，請參閱 Azure 地圖服務 Creator 的生命周期結束公告。

Create API 是 HTTP POST 要求，用來從指定的數據集建立磚集。 如需詳細資訊，請參閱 建立磚集。 圖格集包含一組磚，可使用 取得地圖底圖 擷取自定義磚。 若要建立資料集，請使用 資料集建立。 如需適用於 Azure 地圖服務建立者的概念和工具簡介，請參閱 Creator for 室內地圖。

建立磚集 API 是 長時間執行的作業。

提交建立要求

若要建立磚集，您將使用空白本文提出 POST 要求。 datasetId 查詢參數將做為磚集數據的來源。

POST https://{geography}.atlas.microsoft.com/tilesets?api-version=2.0&datasetId={datasetId}
含選擇性參數: 
POST https://{geography}.atlas.microsoft.com/tilesets?api-version=2.0&datasetId={datasetId}&description={description}

URI 參數

名稱 位於 必要 類型 Description
geography
 path True

string

此參數會指定 Azure 地圖服務建立者資源所在的位置。 有效值為我們和 eu。
api-version
 query True

string

Azure 地圖服務 API 的版本號碼。
datasetId
 query True

string

磚集建立 API 的唯一 datasetId 用來擷取功能來產生磚。 datasetId 必須已從成功的 數據集建立 API 呼叫取得。
description
 query

string

使用者提供磚集的描述。

要求標頭

名稱 必要 類型 Description
x-ms-client-id

string

指定要與 Microsoft Entra ID 安全性模型搭配使用的帳戶。 它代表 Azure 地圖服務帳戶的唯一標識碼，而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。 若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性，請參閱下列 文章 以取得指引。

回應

名稱 類型 Description
200 OK

LongRunningOperationResult

作業正在執行或完成。 如果作業成功，請使用 Resource-Location 標頭來取得結果的路徑。

標題

Resource-Location: string
202 Accepted

要求已接受：要求已接受進行處理。 請使用 Operation-Location 標頭中的 URL 來取得狀態。

標題

Operation-Location: string
Other Status Codes

ErrorResponse

發生未預期的錯誤。

安全性

AADToken

這些是 Entra OAuth 2.0 流程 Microsoft。 與 Azure 角色型存取配對時， 控制它可用來控制 Azure 地圖服務 REST API 的存取。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。 任何使用者、群組或服務主體都可以透過內建角色或由一或多個 Azure 地圖服務 REST API 許可權所組成的自定義角色來授與存取權。

若要實作案例，建議您檢視 驗證概念。 總而言之，此安全性定義會透過能夠針對特定 API 和範圍進行訪問控制的物件，提供模型化應用程式的解決方案。

備註

  • 此安全性定義 需要 使用 x-ms-client-id 標頭來指出應用程式要求存取的 Azure 地圖服務資源。 這可以從 地圖管理 API取得。

Authorization URL 專屬於 Azure 公用雲端實例。 主權雲端具有唯一的授權 URL，Microsoft Entra ID 設定。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 管理 平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

這是當您 在 Azure 入口網站或使用 PowerShell、CLI、Azure SDK 或 REST API 建立 Azure 地圖服務帳戶時所佈建的共用密鑰。

使用此金鑰，任何應用程式都可以存取所有 REST API。 換句話說，此金鑰可用來做為帳戶中核發的主要密鑰。

針對公開的應用程式，我們建議使用 機密用戶端應用程式 方法來存取 Azure 地圖服務 REST API，以便安全地儲存您的密鑰。

類型: apiKey
位於: query

SAS Token

這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 azure 地圖服務資源 列表 SAS 作業建立共用存取簽章令牌。

使用此令牌時，任何應用程式都有權使用 Azure 角色型訪問控制進行存取，並更精細地控制特定令牌的到期、速率和區域。 換句話說，SAS 令牌可用來讓應用程式以比共用密鑰更安全的方式控制存取。

對於公開的應用程式，我們建議在 對應帳戶資源上設定允許的來源特定清單， 以限制轉譯濫用，並定期更新 SAS 令牌。

類型: apiKey
位於: header

範例

Create Tileset by providing a Dataset Id

範例要求

POST https://us.atlas.microsoft.com/tilesets?api-version=2.0&datasetId=[dataset-Id]

範例回覆

狀態碼:
200 
Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0
{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}
狀態碼:
202 
Operation-Location: https://us.atlas.microsoft.com/tilesets/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

定義

名稱 Description
ErrorAdditionalInfo

資源管理錯誤其他資訊。
ErrorDetail

錯誤詳細數據。
ErrorResponse

錯誤回應
LongRunningOperationResult

Long-Running Operations API 的回應模型。
LroStatus

要求的狀態狀態。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。
type

string

其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。
code

string

錯誤碼。
details

ErrorDetail[]

錯誤詳細數據。
message

string

錯誤訊息。
target

string

錯誤目標。

ErrorResponse

Object

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

LongRunningOperationResult

Object

Long-Running Operations API 的回應模型。

名稱 類型 Description
created

string (date-time)

建立的時間戳。
error

ErrorDetail

錯誤詳細數據。
operationId

string

此長時間執行作業的識別碼。
status

LroStatus

要求的狀態狀態。
warning

ErrorDetail

錯誤詳細數據。

LroStatus

列舉型別

要求的狀態狀態。

值 Description
Failed

要求有一或多個失敗。
NotStarted

要求尚未開始處理。
Running

要求已開始處理。
Succeeded

要求已順利完成。