Data Registry - Unregister
Slouží k zrušení registrace dat uložených v účtu služby Azure Storage, který je zaregistrovaný pomocí účtu Azure Maps.
Rozhraní Unregister API je požadavek HTTP DELETE , který odebere registr dat bez odstranění podkladového obsahu z účtu úložiště Azure.
Užitečné ve scénářích, jako je zrušení registrace souborů geografické zóny, které byly dříve registrovány pomocí rozhraní API Register nebo Replace pro použití ve službě Azure Maps Geofencing, nebo zrušení registrace komprimovaného souboru (ZIP) obsahujícího soubory návrhu DWG používané službou Azure Maps Creator Conversion Service.
Rozsah koncového bodu služby registru dat je omezený na oblast vašeho účtu Azure Maps a není k dispozici pro globální účty Azure Maps.
Odeslat žádost o zrušení registrace
K zrušení registrace použijte požadavek HTTP DELETE s udid registrem dat.
Zrušit registraci odpovědi
Požadavek Unregister vrátí odpověď HTTP 204 No Content s prázdným textem, pokud byl registr dat úspěšně odstraněn.
DELETE https://{geography}.atlas.microsoft.com/dataRegistries/{udid}?api-version=2023-06-01Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
geography
|
path | True |
string |
Tento parametr určuje, kde se nachází účet Azure Maps. Platné hodnoty jsou my (USA – východ, USA – středozápad, USA – západ 2) a eu (Severní Evropa, Západní Evropa). |
|
udid
|
path | True |
string |
ID uživatelských dat registru dat. Regex pattern: |
|
api-version
|
query | True |
string |
Číslo verze rozhraní API Azure Maps. |
Hlavička požadavku
| Name | Vyžadováno | Typ | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích. |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 204 No Content |
Požadavek se |
|
| Other Status Codes |
Došlo k neočekávané chybě. Headers x-ms-error-code: string |
Zabezpečení
AADToken
Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.
Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a obory.
Poznámky
- Tato definice zabezpečení vyžaduje použití hlavičky
x-ms-client-idk označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API.
Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID.
* Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
* Použití sady AZURE MAPS Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
- Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Jedná se o sdílený klíč, který se zřizuje při vytváření prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto klíčem má každá aplikace autorizaci pro přístup ke všem rozhraním REST API. Jinými slovy, ty je v současné době možné považovat za hlavní klíče k účtu, pro který jsou vystavené.
U veřejně vystavených aplikací doporučujeme použít přístup mezi servery Azure Maps rozhraní REST API, kde je možné tento klíč bezpečně uložit.
Type:
apiKey
In:
header
SAS Token
Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v Azure Maps prostředku prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto tokenem má každá aplikace autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečeným způsobem než sdílený klíč.
U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.
Type:
apiKey
In:
header
Příklady
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
Definice
| Name | Description |
|---|---|
|
Maps |
Podrobnosti o chybě |
|
Maps |
Běžná chybová odpověď pro rozhraní API Azure Maps, která vrací podrobnosti o chybě pro neúspěšné operace. |
|
Maps |
Objekt obsahující konkrétnější informace o chybě než aktuální objekt. |
MapsErrorDetail
Podrobnosti o chybě
| Name | Typ | Description |
|---|---|---|
| code |
string |
Jeden ze serverem definovaných chybových kódů. |
| details |
Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě. |
|
| innererror |
Objekt obsahující konkrétnější informace o chybě než aktuální objekt. |
|
| message |
string |
Lidsky čitelná reprezentace chyby. |
| target |
string |
Cíl chyby. |
MapsErrorResponse
Běžná chybová odpověď pro rozhraní API Azure Maps, která vrací podrobnosti o chybě pro neúspěšné operace.
| Name | Typ | Description |
|---|---|---|
| error |
Podrobnosti o chybě |
MapsInnerError
Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
| Name | Typ | Description |
|---|---|---|
| code |
string |
Kód chyby |
| innererror |
Objekt obsahující konkrétnější informace o chybě než aktuální objekt. |