Data Registry - List

參考

Service:: Maps

API Version:: 2023-06-01

使用來取得 Azure 地圖服務帳戶中所有數據登錄的清單。

List API 是一個 HTTP GET 要求，會傳回數位列，其中包含先前使用緩存器或取代 API 註冊的所有數據登錄。

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

提交清單要求

若要列出所有數據登錄，請發出 GET 沒有其他參數的要求。

列出回應

要求會 List 以 JSON 回應主體的格式傳回數據登錄陣列。

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

URI 參數

名稱	位於	必要	類型	Description
geography	path	True	string	此參數會指定 Azure 地圖服務帳戶所在的位置。有效值為 (美國東部、美國中西部、美國西部 2) 和歐盟 (北歐、西歐) 。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。

要求標頭

名稱	必要	類型	Description
x-ms-client-id		string	指定哪一個帳戶用於搭配 Microsoft Entra ID 安全性模型使用。它代表 Azure 地圖服務帳戶的唯一標識符，可以從 Azure 地圖服務管理平面帳戶 API 擷取。若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性，請參閱下列文章以取得指引。

回應

名稱類型 Description

200 OK

名稱	類型	Description
200 OK	DataRegistryList	要求 `List` 已順利完成。回應本文包含數據登錄的陣列。
Other Status Codes	MapsErrorResponse	發生意外錯誤。 Headers x-ms-error-code: string

DataRegistryList

要求 List 已順利完成。回應本文包含數據登錄的陣列。

Other Status Codes

MapsErrorResponse

發生意外錯誤。

Headers

x-ms-error-code: string

安全性

AADToken

以下是 Microsoft Entra OAuth 2.0 流程。與 Azure 角色型存取控制配對時，可用來控制對 REST API 的存取 Azure 地圖服務。 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 管理平面透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 地圖服務資源上的清單 SAS 作業建立共用存取簽章令牌。

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

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

Type: apiKey
In: header

範例

List all previously registered data registries

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries?api-version=2023-06-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "description": "Contoso Indoor Design",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "zip",
        "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path1.zip",
        "sizeInBytes": 29920,
        "contentMD5": "CsFxZ2YSfxw3cRPlqokV0w=="
      },
      "status": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "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/path2.geojson",
        "sizeInBytes": 1339
      },
      "status": "Running"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "description": "Contoso Geofence GeoJSON",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "geojson",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path3.geojson",
        "sizeInBytes": 1650,
        "contentMD5": "rYpEfIeLbWZPyaICGEGy3A=="
      },
      "status": "Failed",
      "error": {
        "code": "ContentMD5Mismatch",
        "message": "Actual content MD5: sOJMJvFParkSxBsvvrPOMQ== doesn't match expected content MD5: CsFxZ2YSfxw3cRPlqokV0w==."
      }
    }
  ]
}

定義

名稱	Description
AzureBlob	Azure Blob 數據登錄詳細數據。
DataFormat	用於驗證之上傳內容的數據格式。
DataRegistry	Azure 地圖服務中的數據登錄。
DataRegistryKind	數據登錄種類。
DataRegistryList	數據登錄清單 API 的回應模型。傳回所有先前註冊的數據清單。
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