共用方式為

Data Registry - Get Data Registry

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

使用 來取得指定的數據登錄資訊。

Get Data Registry API 是 HTTP GET 要求，會在成功時，以 JSON 格式傳回數據登錄資訊作為 JSON 格式的 AzureBlob 物件，以及 HTTP 狀態代碼 200。 如果 Azure 地圖服務無法存取基礎內容或完整性檢查失敗，則會 status 設定為 Failed ，並傳回錯誤。

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

提交取得數據登錄要求

數據登錄 GET 要求會傳回所要求之數據登錄的詳細數據，由指定的 udid所決定。 詳細數據會以 JSON 格式的響應主體傳回。

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

URI 參數

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

string

此參數會指定 Azure 地圖服務帳戶所在的位置。 有效值為 (美國東部、美國中西部、美國西部 2) 和歐盟 (北歐、西歐) 。
udid
 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
x-ms-client-id

string

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

回應

名稱 類型 Description
200 OK

DataRegistry

要求 Get Data Registry 已順利完成。 回應本文包含指定 udid的數據登錄。
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 data registry of a completed udid
Get the data registry of a failed udid

Get the data registry of a completed udid

範例要求

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

範例回覆

狀態碼:
200 
{
  "udid": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "description": "Contoso Geofence GeoJSON",
  "kind": "AzureBlob",
  "azureBlob": {
    "dataFormat": "geojson",
    "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
    "linkedResource": "my-storage-account",
    "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json",
    "sizeInBytes": 1339,
    "contentMD5": "sOJMJvFParkSxBsvvrPOMQ=="
  },
  "status": "Completed"
}

Get the data registry of a failed udid

範例要求

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

範例回覆

狀態碼:
200 
{
  "udid": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "description": "Contoso Geofence GeoJSON",
  "kind": "AzureBlob",
  "azureBlob": {
    "dataFormat": "geojson",
    "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
    "linkedResource": "my-storage-account",
    "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json"
  },
  "status": "Failed",
  "error": {
    "code": "AuthorizationPermissionMismatch",
    "message": "Not authorized to perform this operation on resource: https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json."
  }
}

定義

名稱 Description
AzureBlob

Azure Blob 數據登錄詳細數據。
DataFormat

用於驗證之上傳內容的數據格式。
DataRegistry

Azure 地圖服務中的數據登錄。
DataRegistryKind

數據登錄種類。
LongRunningOperationStatus

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

錯誤詳細數據。
MapsErrorResponse

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

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

AzureBlob

Azure Blob 數據登錄詳細數據。

名稱 類型 Description
blobUrl

string

Blob URL 包含所註冊檔案的路徑。
contentMD5

string

用於數據驗證的內容 MD5 內容。
dataFormat

DataFormat

用於驗證之上傳內容的數據格式。
linkedResource

string

Azure 地圖服務帳戶中數據存放區的標識碼。
msiClientId

string

使用者指派受控識別的用戶端標識碼。 如果未提供，請使用系統指派的受控識別。
sizeInBytes

integer

以位元組為單位的內容大小。

DataFormat

用於驗證之上傳內容的數據格式。

名稱 類型 Description
geojson

string

GeoJSON 是以 JSON 為基礎的地理空間數據交換格式。
zip

string

壓縮的數據格式。

DataRegistry

Azure 地圖服務中的數據登錄。

名稱 類型 Description
azureBlob

AzureBlob

Azure Blob 數據登錄詳細數據。
description

string

提供給數據登錄的描述。 最大長度為 1024 個字元。
error

MapsErrorDetail

錯誤詳細數據。
kind

DataRegistryKind

數據登錄種類。
status

LongRunningOperationStatus

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

string

數據登錄的用戶數據識別碼。

DataRegistryKind

數據登錄種類。

名稱 類型 Description
AzureBlob

string

Azure Blob

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

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