Conversion - Convert

Service:

Maps Creator

API Version:

2.0

Verwenden Sie , um ein zuvor importiertes Zeichnungspaket in Kartendaten zu konvertieren.

Die Conversion API ist eine HTTP-AnforderungPOST, mit der der Aufrufer eine Reihe von DWG-Entwurfsdateien als gezipptes Zeichnungspaket in Azure Maps importieren kann. Auf das Zeichnungspaket wird durch die referenziert, die udid beim Hochladen in die Datenregistrierung verwendet wurde. Weitere Informationen zum Datenregistrierungsdienst finden Sie unter Erstellen einer Datenregistrierung.

Konvertieren des DWG-Pakets

Die Konvertierungs-API führt einen Vorgang mit langer Ausführungszeit aus.

Debuggen von DWG-Paketproblemen

Wenn während des Konvertierungsprozesses Probleme mit dem DWG-Paket auftreten, werden in der Antwort Fehler und Warnungen zusammen mit einem Diagnosepaket bereitgestellt, um diese Probleme zu visualisieren und zu diagnostizieren. Falls Probleme mit Ihrem DWG-Paket auftreten, gibt der Konvertierungsvorgang status Prozess wie hier beschrieben den Speicherort des Diagnosepakets zurück, das vom Aufrufer heruntergeladen werden kann, um diese Probleme zu visualisieren und zu diagnostizieren. Der Speicherort des Diagnosepakets befindet sich im Abschnitt eigenschaften des Konvertierungsvorgangs status Antwort und sieht wie folgt aus:

{
    "properties": {
        "diagnosticPackageLocation": "https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0"                
    }            
}

Das Diagnosepaket kann heruntergeladen werden, indem eine HTTP GET Anforderung für ausgeführt wird diagnosticPackageLocation. Weitere Informationen zur Verwendung des Tools zum Visualisieren und Diagnostizieren aller Fehler und Warnungen finden Sie unter Zeichnungsfehlerschnellansicht.

Ein Konvertierungsvorgang wird als erfolgreich markiert, wenn keine oder mehr Warnungen vorhanden sind, wird jedoch als fehlgeschlagen markiert, wenn Fehler auftreten.

POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0

With optional parameters:

POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0&description={description}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
geography	path	True	string	Dieser Parameter gibt an, wo sich die Azure Maps Creator-Ressource befindet. Gültige Werte sind "us" und "eu".
api-version	query	True	string	Versionsnummer der Azure Maps API.
outputOntology	query	True	OutputOntology	Ausgabeontologieversion. "facility-2.0" ist derzeit der einzige unterstützte Wert. Weitere Informationen zu Azure Maps Creator-Ontologien finden Sie in diesem Artikel.
udid	query	True	string	Die eindeutige Daten-ID (udid) für den Inhalt. Muss identisch udid sein, die beim Erstellen der Datenregistrierung verwendet wird.
description	query		string	Vom Benutzer bereitgestellte Beschreibung des Inhalts, der konvertiert wird.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell verwendet werden soll. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Azure Maps-Verwaltungsebenen-API abgerufen werden. Informationen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Antworten

Name	Typ	Beschreibung
200 OK	LongRunningOperationResult	Der Vorgang wird ausgeführt oder abgeschlossen. Wenn der Vorgang erfolgreich war, verwenden Sie den Resource-Location-Header, um den Pfad zum Ergebnis abzurufen. Headers Resource-Location: string
202 Accepted		Anforderung akzeptiert: Die Anforderung wurde für die Verarbeitung akzeptiert. Verwenden Sie die URL im Operation-Location-Header, um status zu erhalten. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0-Flows. In Kombination mit der rollenbasierten Zugriffssteuerung in Azure kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

Hinweise

• Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

ist Authorization URL spezifisch für die öffentliche Azure-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen. * Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

• Weitere Informationen zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API bereitgestellt wird.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Anders ausgedrückt: Dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen für den Zugriff auf Azure Maps REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

SAS Token

Dies ist ein Shared Access Signature-Token, das aus dem Sas-Listenvorgang auf der Azure Maps-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 präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

Convert previously uploaded DWG Package

Sample Request

HTTP

POST https://us.atlas.microsoft.com/conversions?api-version=2.0&udid=25084fb7-307a-4720-8f91-7952a0b91012&outputOntology=facility-2.0

Sample Response

Status code:

200

Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0

Response Body

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Status code:

202

Operation-Location: https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
LongRunningOperationResult	Das Antwortmodell für eine Long-Running Operations-API.
LroStatus	Der status Status der Anforderung.
OutputOntology	Ausgabeontologieversion. "facility-2.0" ist derzeit der einzige unterstützte Wert. Weitere Informationen zu Azure Maps Creator-Ontologien finden Sie in diesem Artikel.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

LongRunningOperationResult

Das Antwortmodell für eine Long-Running Operations-API.

Name	Typ	Beschreibung
created	string	Der erstellte Zeitstempel.
error	ErrorDetail	Die Fehlerdetails.
operationId	string	Die ID für diesen vorgang mit langer Ausführungsdauer.
status	LroStatus	Der status Status der Anforderung.
warning	ErrorDetail	Die Fehlerdetails.

LroStatus

Der status Status der Anforderung.

Name	Typ	Beschreibung
Failed	string	Die Anforderung weist einen oder mehrere Fehler auf.
NotStarted	string	Die Verarbeitung der Anforderung wurde noch nicht gestartet.
Running	string	Die Verarbeitung der Anforderung wurde gestartet.
Succeeded	string	Die Anforderung wurde erfolgreich abgeschlossen.

OutputOntology

Ausgabeontologieversion. "facility-2.0" ist derzeit der einzige unterstützte Wert. Weitere Informationen zu Azure Maps Creator-Ontologien finden Sie in diesem Artikel.

Name	Typ	Beschreibung
facility-2.0	string	Die Einrichtungsontologie definiert die interne Speicherung der Daten von Einrichtungen in einem Creator-Dataset durch Azure Maps Creator.