共用方式為

Data Registry - Get Operation

  • 參考
服務:
Maps
API 版本:
2023-06-01

用來檢查 數據快取器的狀態或取代 要求。
Get Operation API 是用來取得數據緩存器或取代要求狀態的 HTTP GET 要求，會在緩存器標頭中傳回，或取代回應做為索引鍵的值Operation-Location。 進行中時， 200 OK HTTP 回應會以 Retry-After 標頭傳回 -後面 200 OK 接著 HTTP，完成後不會有額外的標頭。

數據登錄服務端點的範圍僅限於 Azure 地圖服務帳戶的區域，不適用於全域 Azure 地圖服務帳戶。

GET https://{geography}.atlas.microsoft.com/dataRegistries/operations/{operationId}?api-version=2023-06-01

URI 參數

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

string

此參數會指定 Azure 地圖服務帳戶所在的位置。 有效值為 (美國東部、美國中西部、美國西部 2) 和歐盟 (北歐、西歐) 。
operationId
 path True

string

用來查詢數據快取器要求狀態的標識碼。

Regex 模式: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
api-version
 query True

string

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

回應

名稱 類型 Description
200 OK

LongRunningOperationResult

長時間執行作業的狀態。

標題

Retry-After: integer
Other Status Codes

MapsErrorResponse

發生意外錯誤。

標題

x-ms-error-code: string

安全性

AADToken

這些是 entra OAuth 2.0 Flow 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 管理平面建立 Azure 地圖服務資源 時所佈建的共用密鑰。

使用此金鑰時，任何應用程式都會獲得存取所有 REST API 的授權。 換句話說，這些目前可視為發行帳戶的主要密鑰。

對於公開的應用程式，我們建議使用 Azure 地圖服務 REST API 的伺服器對伺服器存取，以便安全地儲存此密鑰。

類型: apiKey
位於: header

SAS Token

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

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

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

類型: apiKey
位於: header

範例

Get the status of an operation that failed
Get the status of an operation that finished successfully
Get the status of an operation that is still running

Get the status of an operation that failed

範例要求

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

範例回覆

狀態碼:
200 
{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Failed",
  "error": {
    "code": "InvalidData",
    "message": "The data is not a valid GeoJSON."
  }
}

Get the status of an operation that finished successfully

範例要求

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

範例回覆

狀態碼:
200 
{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Completed"
}

Get the status of an operation that is still running

範例要求

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

範例回覆

狀態碼:
200 
Retry-After: 10
{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Running"
}

定義

名稱 Description
LongRunningOperationResult

長時間執行作業的回應模型。
LongRunningOperationStatus

長時間執行作業的狀態。
MapsErrorDetail

錯誤詳細數據。
MapsErrorResponse

Azure 地圖服務 API 的常見錯誤回應，可傳回失敗作業的錯誤詳細數據。
MapsInnerError

物件，包含比目前對象有關錯誤更具體的資訊。

LongRunningOperationResult

長時間執行作業的回應模型。

名稱 類型 Description
error

MapsErrorDetail

錯誤詳細數據。
id

string

operationId
status

LongRunningOperationStatus

長時間執行作業的狀態。

LongRunningOperationStatus

長時間執行作業的狀態。

名稱 類型 Description
Completed

string

要求已順利完成。
Failed

string

要求有一或多個失敗。
Running

string

要求目前正在處理。

MapsErrorDetail

錯誤詳細數據。

名稱 類型 Description
code

string

其中一組伺服器定義的錯誤碼。
details

MapsErrorDetail[]

導致此錯誤之特定錯誤的詳細數據陣列。
innererror

MapsInnerError

物件，包含比目前對象有關錯誤更具體的資訊。
message

string

人類可讀取的錯誤表示法。
target

string

錯誤的目標。

MapsErrorResponse

Azure 地圖服務 API 的常見錯誤回應，可傳回失敗作業的錯誤詳細數據。

名稱 類型 Description
error

MapsErrorDetail

錯誤詳細數據。

MapsInnerError

物件，包含比目前對象有關錯誤更具體的資訊。

名稱 類型 Description
code

string

錯誤碼。
innererror

MapsInnerError

物件，包含比目前對象有關錯誤更具體的資訊。