Data Registry - Unregister
使用 來取消註冊儲存在已向 Azure 地圖服務 帳戶註冊之 Azure 記憶體帳戶中的數據。
Unregister
API 是 HTTP DELETE
要求,可移除數據登錄,而不需從 Azure 儲存器帳戶刪除基礎內容。
適用於取消註冊先前使用註冊或取代 API 註冊的地理柵欄檔案,以用於 Azure 地圖服務 地理柵欄服務,或取消註冊壓縮 (ZIP) 檔案,其中包含 Azure 地圖服務 Creator Conversion Service 所使用的 DWG 設計檔案。
數據登錄服務端點的範圍僅限於您 Azure 地圖服務 帳戶的區域,不適用於全域 Azure 地圖服務 帳戶。
提交取消註冊要求
使用 HTTP DELETE
要求搭配 udid
數據登錄的 來取消註冊。
取消註冊回應
如果已成功刪除數據登錄,則 Unregister
要求會傳回 HTTP '204 No Content' 回應,其中包含空的主體。
DELETE https://{geography}.atlas.microsoft.com/dataRegistries/{udid}?api-version=2023-06-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
geography
|
path | True |
string |
此參數會指定 Azure 地圖服務 Account 所在的位置。 有效值為 (美國東部、美國中西部、美國西部 2) 和歐盟 (北歐、西歐) 。 |
udid
|
path | True |
string |
數據登錄的用戶數據識別碼。 Regex pattern: |
api-version
|
query | True |
string |
Azure 地圖服務 API 的版本號碼。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
x-ms-client-id |
string |
指定哪個帳戶與 Microsoft Entra ID 安全性模型搭配使用。 它代表 Azure 地圖服務 帳戶的唯一標識符,而且可以從 Azure 地圖服務 管理平面帳戶 API 擷取。 若要在 Azure 地圖服務 中使用 Microsoft Entra ID 安全性,請參閱下列文章以取得指引。 |
回應
名稱 | 類型 | Description |
---|---|---|
204 No Content |
|
|
Other Status Codes |
發生意外錯誤。 Headers x-ms-error-code: string |
安全性
AADToken
這些是 Microsoft Entra OAuth 2.0 流程。 與 Azure 角色型存取控制配對時,可用來控制對 #D772B3C90C4C94B9DB95ED64101B6BF33 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 管理平面透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 Azure 地圖服務 資源上的列出 SAS 作業建立的共用存取簽章令牌。
使用此令牌時,任何應用程式都有權使用 Azure 角色型訪問控制進行存取,並更精細地控制到期、速率和區域 (特定令牌的使用) 。 換句話說,SAS 令牌可用來允許應用程式以比共用密鑰更安全的方式來控制存取。
對於公開的應用程式,我們建議在 地圖帳戶資源 上設定允許的來源特定清單,以限制轉譯濫用,並定期更新 SAS 令牌。
Type:
apiKey
In:
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 |
物件,包含比目前對象有關錯誤的更特定資訊。 |