Data Registry - Unregister
Använd för att avregistrera data som lagras i ett Azure Storage-konto som är registrerat med ett Azure Maps-konto.
API:et Unregister är en HTTP-begäran DELETE som tar bort ett dataregister utan att ta bort det underliggande innehållet från Azure Storage-kontot.
Användbart i scenarier som att avregistrera geofence-filer som tidigare registrerats med hjälp av register- eller ersätt-API :et för användning i Azure Maps Geofencing-tjänsten eller avregistrera en komprimerad (ZIP)-fil som innehåller DWG-designfiler som används av Azure Maps Creator Conversion Service.
Tjänstslutpunkten för dataregistret är begränsad i omfånget till regionen för ditt Azure Maps-konto och är inte tillgänglig för globala Azure Maps-konton.
Skicka avregistrera begäran
Använd en HTTP-begäran DELETE med udid dataregistret för att avregistrera.
Avregistrera svar
Begäran Unregister returnerar ett HTTP -svar "204 inget innehåll" med en tom brödtext, om dataregistret har tagits bort.
DELETE https://{geography}.atlas.microsoft.com/dataRegistries/{udid}?api-version=2023-06-01URI-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
geography
|
path | True |
string |
Den här parametern anger var Azure Maps-kontot finns. Giltiga värden är vi (USA, östra; USA, västra centrala, USA, västra 2) och eu (Europa, norra; Europa, västra). |
|
udid
|
path | True |
string |
Användardata-ID för dataregistret. Reguljärt uttrycksmönster: |
|
api-version
|
query | True |
string |
Versionsnumret för Azure Maps API. |
Begärandehuvud
| Name | Obligatorisk | Typ | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID-säkerhetsmodellen. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i följande artiklar . |
Svar
| Name | Typ | Description |
|---|---|---|
| 204 No Content |
Begäran |
|
| Other Status Codes |
Det uppstod ett oväntat fel. Sidhuvuden x-ms-error-code: string |
Säkerhet
AADToken
Det här är Microsoft Entra OAuth 2.0-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till REST-API:er för Azure Maps. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Rest-API:er för Azure Maps.
För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.
Kommentarer
- Den här säkerhetsdefinitionen
x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API:et.
Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer.
* Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
* Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
- Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Det här är en delad nyckel som etableras när du skapar en Azure Maps-resurs via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Med den här nyckeln har alla program behörighet att komma åt alla REST-API:er. Med andra ord kan dessa för närvarande behandlas som huvudnycklar till det konto som de har utfärdats för.
För offentligt exponerade program rekommenderar vi att du använder server-till-server-åtkomst för Rest-API:er för Azure Maps där den här nyckeln kan lagras på ett säkert sätt.
Typ:
apiKey
I:
header
SAS Token
Det här är en signaturtoken för delad åtkomst som skapas från åtgärden List SAS på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett säkrare sätt än den delade nyckeln.
För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.
Typ:
apiKey
I:
header
Exempel
Unregister a data registry without deleting the underlying contents
Exempelbegäran
DELETE https://us.atlas.microsoft.com/dataRegistries/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2023-06-01
Exempelsvar
Definitioner
| Name | Description |
|---|---|
|
Maps |
Felinformationen. |
|
Maps |
Vanligt felsvar för Azure Maps-API:er för att returnera felinformation för misslyckade åtgärder. |
|
Maps |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
MapsErrorDetail
Felinformationen.
| Name | Typ | Description |
|---|---|---|
| code |
string |
En av en serverdefinierad uppsättning felkoder. |
| details |
En matris med information om specifika fel som ledde till det rapporterade felet. |
|
| innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
|
| message |
string |
En läsbar återgivning av felet. |
| target |
string |
Målet för felet. |
MapsErrorResponse
Vanligt felsvar för Azure Maps-API:er för att returnera felinformation för misslyckade åtgärder.
| Name | Typ | Description |
|---|---|---|
| error |
Felinformationen. |
MapsInnerError
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
| Name | Typ | Description |
|---|---|---|
| code |
string |
Felkoden. |
| innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |