Data Registry - Unregister
用來取消註冊已向 Azure 地圖服務帳戶註冊之 Azure 記憶體帳戶中儲存的數據。
Unregister API 是 HTTP DELETE 要求，可移除數據登錄，而不需從 Azure 儲存器帳戶刪除基礎內容。
適用於先前使用 註冊或取代 API 註冊的地理柵欄檔案，以用於 Azure 地圖服務地理柵欄服務，或取消註冊壓縮 (ZIP) 檔案，其中包含 Azure 地圖服務建立者 轉換服務所使用的 DWG 設計檔案。
數據登錄服務端點的範圍僅限於 Azure 地圖服務帳戶的區域，不適用於全域 Azure 地圖服務帳戶。
提交取消註冊要求
使用 HTTP DELETE 要求搭配 udid 數據登錄的 來取消註冊。
取消註冊回應
如果已成功刪除數據登錄，要求 Unregister 會傳回具有空白主體的 HTTP '204 No Content' 回應。
DELETE https://{geography}.atlas.microsoft.com/dataRegistries/{udid}?api-version=2023-06-01URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
geography
|
path | True |
string |
此參數會指定 Azure 地圖服務帳戶所在的位置。 有效值為 (美國東部、美國中西部、美國西部 2) 和歐盟 (北歐、西歐) 。 |
|
udid
|
path | True |
string |
數據登錄的用戶數據識別碼。 Regex 模式: |
|
api-version
|
query | True |
string |
Azure 地圖服務 API 的版本號碼。 |
要求標頭
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| x-ms-client-id |
string |
指定哪一個帳戶用於搭配 Microsoft Entra ID 安全性模型使用。 它代表 Azure 地圖服務帳戶的唯一標識碼，而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。 若要在 Azure 地圖服務中使用 Microsoft 專案標識碼安全性，請參閱下列 文章 以取得指引。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 204 No Content |
要求 |
|
| Other Status Codes |
發生意外錯誤。 標題 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 的使用方式允許針對多個使用案例設定應用程式。
- 如需Microsoft身分識別平臺的詳細資訊，請參閱 Microsoft身分識別平臺概觀。
類型:
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 入口網站、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
範例
Unregister a data registry without deleting the underlying contents
Sample request
DELETE https://us.atlas.microsoft.com/dataRegistries/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2023-06-01
Sample response
定義
| 名稱 | Description |
|---|---|
|
Maps |
錯誤詳細數據。 |
|
Maps |
Azure 地圖服務 API 的常見錯誤回應，可傳回失敗作業的錯誤詳細數據。 |
|
Maps |
物件，包含比目前對象有關錯誤更具體的資訊。 |
MapsErrorDetail
錯誤詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| code |
string |
其中一組伺服器定義的錯誤碼。 |
| details |
導致此錯誤之特定錯誤的詳細數據陣列。 |
|
| innererror |
物件，包含比目前對象有關錯誤更具體的資訊。 |
|
| message |
string |
人類可讀取的錯誤表示法。 |
| target |
string |
錯誤的目標。 |
MapsErrorResponse
Azure 地圖服務 API 的常見錯誤回應，可傳回失敗作業的錯誤詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| error |
錯誤詳細數據。 |
MapsInnerError
物件，包含比目前對象有關錯誤更具體的資訊。
| 名稱 | 類型 | Description |
|---|---|---|
| code |
string |
錯誤碼。 |
| innererror |
物件，包含比目前對象有關錯誤更具體的資訊。 |