Conversion - Delete

Referenz

Service:: Maps Creator

API Version:: 2.0

Gilt für: siehe Tarife.

Creator ermöglicht die Entwicklung von Anwendungen basierend auf Ihren privaten Raumplandaten mithilfe der Azure Karten-API und des SDK. In diesem Artikel werden Konzepte und Tools für Azure Karten Creator beschrieben.

Mit dieser API kann der Aufrufer alle Datenkonvertierungen löschen, die zuvor mithilfe der Konvertierungs-API erstellt wurden.

Senden einer Löschanforderung

Um Ihre Konvertierungsdaten zu löschen, geben Sie eine Anforderung DELETE aus conversionId , in der der Pfad die der zu löschenden Daten enthält.

Antwort zum Löschen der Konvertierung

Die Konvertierungslösch-API gibt eine HTTP-Antwort 204 No Content mit einem leeren Text zurück, wenn die konvertierten Datenressourcen erfolgreich gelöscht wurden.

Eine HTTP-Fehlerantwort 400 Bad Request wird zurückgegeben, wenn keine Ressource gefunden wird, die dem übergebenen conversionId zugeordnet ist.

DELETE https://{geography}.atlas.microsoft.com/conversions/{conversionId}?api-version=2.0

URI-Parameter

Name	In	Required	Type	Description
conversionId	path	True	string	Die Konvertierungs-ID für den Inhalt. Der `conversionId` muss von einem erfolgreichen Konvertierungs-API-Aufruf erhalten worden sein.
geography	path	True	string	Dieser Parameter gibt an, wo sich die Azure Karten Creator-Ressource befindet. Gültige Werte sind us und eu.
api-version	query	True	string	Versionsnummer der Azure Karten-API.

Anforderungsheader

Name	Required	Type	Description
x-ms-client-id		string	Gibt an, welches Konto für die Verwendung in Verbindung mit dem Azure AD vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Karten-Konto dar und kann aus der Konto-API Karten Azure-Verwaltungsebene abgerufen werden. Informationen zur Azure AD in Azure Karten finden Sie in den folgenden Artikeln.

Antworten

Name	Type	Description
204 No Content		Die Konvertierungslöschanforderung wurde erfolgreich abgeschlossen. Der Inhalt für `conversionId` wurde auf dem Server gelöscht.
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Azure Active Directory OAuth2-Flows. In Kombination mit der rollenbasierten Zugriffssteuerung in Azure kann sie verwendet werden, um den Zugriff auf Azure Karten REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Karten-Ressourcenkonto oder untergeordnete Ressourcen zu bestimmen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann der Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus mindestens einer Berechtigung für Azure Karten REST-APIs besteht.

Um Szenarien zu implementieren, wird empfohlen, Authentifizierungskonzepte zu betrachten. Zusammenfassend stellt diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte zur Zugriffssteuerung für bestimmte APIs und Bereiche dar.

Notizen

Diese Sicherheitsdefinition erfordert die Verwendung des -Headersx-ms-client-id, um anzugeben, auf Karten Azure-Ressource die Anwendung Zugriff anfordert. Dies kann über die verwaltungs Karten-API erworben werden.

ist Authorization URL spezifisch für die Instanz der öffentlichen Azure-Cloud. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen. * Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Karten Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Arbeits-, Schul- und Gastkonten, aber keine persönlichen Konten.

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

Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen einer Azure Karten-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.

Mit diesem Schlüssel ist jede Anwendung für den Zugriff auf alle REST-APIs autorisiert. Anders ausgedrückt: Diese können derzeit als Hauptschlüssel für das Konto behandelt werden, für das sie ausgestellt werden.

Bei öffentlich verfügbar gemachten Anwendungen wird empfohlen, den Server-zu-Server-Zugriff von Azure Karten-REST-APIs zu verwenden, in denen dieser Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

SAS Token

Dies ist ein Shared Access Signature-Token, das über den Vorgang SAS auflisten für die Azure Karten-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer fein abgrenzenden Steuerung des Ablaufs, der Rate und der Region(en) der Verwendung für das bestimmte Token autorisiert. Mit anderen Worten: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sichere Weise zu ermöglichen, als mit dem gemeinsam verwendeten Schlüssel.

Bei öffentlich verfügbar gemachten Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge für die Map-Kontoressource zu konfigurieren, um den Rendering-Missbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

Delete previously converted content

Sample Request

DELETE https://us.atlas.microsoft.com/conversions/99884fb7-87a9-0920-7f93-7952a0b91012?api-version=2.0

Sample Response

Status code:: 204

Definitionen

ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Type	Description
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Die Fehlerdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen zum Fehler.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Type	Description
error	ErrorDetail	Das Fehlerobjekt.