Data Registry - Unregister

Service:

Maps

API Version:

2023-06-01

Gebruik om de registratie van gegevens op te heffen die zijn opgeslagen in een Azure Storage-account dat is geregistreerd bij een Azure Maps-account.

De Unregister API is een HTTP-aanvraag DELETE waarmee een gegevensregister wordt verwijderd zonder de onderliggende inhoud uit het Azure-opslagaccount te verwijderen.

Handig in scenario's zoals het ongedaan maken van de registratie van geofence-bestanden die eerder zijn geregistreerd met behulp van de REGISTER- of Replace-API voor gebruik in de Azure Maps Geofencing Service, of het ongedaan maken van de registratie van een gecomprimeerd (ZIP)-bestand met DWG-ontwerpbestanden die worden gebruikt door de Azure Maps Creator Conversion Service.

Het service-eindpunt van het gegevensregister is beperkt tot de regio van uw Azure Maps-account en is niet beschikbaar voor globale Azure Maps-accounts.

Aanvraag voor ongedaan maken van registratie indienen

Gebruik een HTTP-aanvraag DELETE met de udid van het gegevensregister om de registratie ongedaan te maken.

Registratie van het antwoord ongedaan maken

De Unregister aanvraag retourneert een HTTP-antwoord '204 Geen inhoud' met een lege hoofdtekst, als het gegevensregister is verwijderd.

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

URI-parameters

Name	In	Vereist	Type	Description
geography	path	True	string	Deze parameter geeft aan waar het Azure Maps-account zich bevindt. Geldige waarden zijn us (VS - oost, VS - west-centraal, VS - west 2) en eu (Europa - noord, Europa - west).
udid	path	True	string	De gebruikersgegevens-id van het gegevensregister. Regex pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
api-version	query	True	string	Het versienummer van Azure Maps API.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID-beveiliging in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Antwoorden

Name	Type	Description
204 No Content		De Unregister aanvraag is voltooid. Het gegevensregister wordt verwijderd, maar de gegevens zijn niet verwijderd uit het opslagaccount.
Other Status Codes	MapsErrorResponse	Er is een onverwachte fout opgetreden. Headers x-ms-error-code: string

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. In combinatie met op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Als u scenario's wilt implementeren, raden we u aan om verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

• Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id header om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksscenario's.

• Zie Microsoft identity platform overzicht voor meer informatie over 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

Dit is een gedeelde sleutel die wordt ingericht bij het maken van een Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met deze sleutel wordt elke toepassing gemachtigd voor toegang tot alle REST API's. Met andere woorden, deze kunnen momenteel worden behandeld als hoofdsleutels voor het account waarvoor ze zijn uitgegeven.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om server-naar-servertoegang te gebruiken voor Azure Maps REST API's waar deze sleutel veilig kan worden opgeslagen.

Type: apiKey
In: header

SAS Token

Dit is een shared access signature-token dat wordt gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle over het verloop, de snelheid en de gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane oorsprongen te configureren op de resource Van het account toewijzen om misbruik van het genereren te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Unregister a data registry without deleting the underlying contents

Sample Request

HTTP

DELETE https://us.atlas.microsoft.com/dataRegistries/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2023-06-01

Sample Response

Status code:

204

Definities

Name	Description
MapsErrorDetail	De foutdetails.
MapsErrorResponse	Veelvoorkomende foutreacties voor Azure Maps API's om foutdetails voor mislukte bewerkingen te retourneren.
MapsInnerError	Een object met specifiekere informatie dan het huidige object over de fout.

MapsErrorDetail

De foutdetails.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	MapsErrorDetail[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	MapsInnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de fout.

MapsErrorResponse

Veelvoorkomende foutreacties voor Azure Maps API's om foutdetails voor mislukte bewerkingen te retourneren.

Name	Type	Description
error	MapsErrorDetail	De foutdetails.

MapsInnerError

Een object met specifiekere informatie dan het huidige object over de fout.

Name	Type	Description
code	string	De foutcode.
innererror	MapsInnerError	Een object met specifiekere informatie dan het huidige object over de fout.