Data Registry - Get Operation

參考

Service:: Maps

API Version:: 2023-06-01

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

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

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

URI 參數

名稱位於必要類型 Description

名稱	位於	必要	類型	Description
geography	path	True	string	此參數會指定 Azure 地圖服務帳戶所在的位置。有效值為 (美國東部、美國中西部、美國西部 2) 和歐盟 (北歐、西歐) 。
operationId	path	True	string	用來查詢數據快取器要求狀態的標識碼。 Regex pattern: `^[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 的版本號碼。

geography

path

True

string

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

operationId

path

True

string

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

Regex pattern: ^[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	長時間執行作業的狀態。 Headers Retry-After: integer
Other Status Codes	MapsErrorResponse	發生意外錯誤。 Headers x-ms-error-code: string

名稱

類型

Description

200 OK

LongRunningOperationResult

長時間執行作業的狀態。

Headers

Retry-After: integer

Other Status Codes

MapsErrorResponse

發生意外錯誤。

Headers

x-ms-error-code: string

安全性

AADToken

這些是 Microsoft Entra OAuth 2.0 流程。與 Azure 角色型存取控制配對時，可用來控制對 #D06DD3B604C2E4905A5100742F02BD8EE 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 的使用方式允許針對多個使用案例設定應用程式設定。

如需 Microsoft 身分識別平台的詳細資訊，請參閱 Microsoft 身分識別平台概觀。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

這是透過 Azure 管理平面透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API 建立 Azure 地圖服務資源時所佈建的共用密鑰。

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

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

Type: apiKey
In: header

SAS Token

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

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

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

Type: apiKey
In: 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

Sample Request

HTTP

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

Sample Response

Status code:: 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

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Get the status of an operation that is still running

Sample Request

HTTP

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

Sample Response

Status code:: 200

Retry-After: 10

Response Body

{
  "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	物件，包含比目前對象有關錯誤的更特定資訊。

Share via

Data Registry - Get Operation

URI 參數

回應

安全性

AADToken

備註

Scopes

subscription-key

SAS Token

範例

Get the status of an operation that failed

Sample Request

Sample Response

Get the status of an operation that finished successfully

Sample Request

Sample Response

Get the status of an operation that is still running

Sample Request

Sample Response

定義

LongRunningOperationResult

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

其他資源