Freigeben über

Conversion - Convert

  • Referenz
Dienst:
Maps Creator
API-Version:
2.0

Dient zum Konvertieren eines zuvor importierten Zeichnungspakets in Kartendaten.

Hinweis

Einstellung von Azure Maps Creator

Der Gebäudeplandienst Azure Maps Creator ist veraltet und wird am 30. September 2025 eingestellt. Weitere Informationen finden Sie unter Ankündigung zum Ende des Lebenszyklus von Azure Maps Creator.

Die Conversion-API ist eine HTTP-POST-Anforderung, mit der der Aufrufer eine Reihe von DWG-Entwurfsdateien als zipped Drawing Package in Azure Maps importieren kann. Auf das Zeichnungspaket wird von der udid verwiesen, die beim Hochladen in die -Datenregistrierungverwendet wurde. Weitere Informationen zum Datenregistrierungsdienst finden Sie unter Erstellen der Datenregistrierung.

DWG-Paket konvertieren

Die Konvertierungs-API führt einen lang ausgeführten Vorgangaus.

Debuggen von DWG-Paketproblemen

Wenn während des Konvertierungsprozesses Probleme mit dem DWG-Paket auftreten, Fehler und Warnungen in der Antwort bereitgestellt werden, zusammen mit einem Diagnosepaket, um diese Probleme zu visualisieren und zu diagnostizieren. Falls probleme mit Ihrem DWG-Paket auftreten, gibt der Konvertierungsvorgangsstatusprozess wie hier beschrieben den Speicherort des Diagnosepakets zurück, das vom Aufrufer heruntergeladen werden kann, um diese Probleme zu visualisieren und zu diagnostizieren. Das Diagnosepaket Speicherorts finden Sie im Eigenschaftenabschnitt der Statusantwort des Konvertierungsvorgangs 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 die diagnosticPackageLocationausgeführt wird. Weitere Informationen zum Visualisieren und Diagnostizieren aller Fehler und Warnungen finden Sie unter Drawing Error Visualizer.

Ein Konvertierungsvorgang wird als Erfolg gekennzeichnet, wenn null oder mehr Warnungen vorhanden sind, aber als fehlgeschlagen markiert werden, wenn Fehler aufgetreten sind.

POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0
Mit optionalen Parametern: 
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 uns und eu.
api-version
 query True

string

Versionsnummer der Azure Maps-API.
outputOntology
 query True

OutputOntology

Ausgabe-Ontologieversion. "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 dieselbe udid sein, die beim Erstellen der -Datenregistrierungverwendet wird.
description
 query

string

Vom Benutzer bereitgestellte Beschreibung des zu konvertierenden Inhalts.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-id

string

Gibt an, welches Konto in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell für die Verwendung vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus der Azure Maps-Verwaltungsebenen-Konto-API abgerufen werden. Informationen zur Verwendung der Sicherheit von Microsoft Entra-ID in Azure Maps finden Sie in den folgenden Artikeln anleitungen.

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.

Header

Resource-Location: string
202 Accepted

Anforderung angenommen: Die Anforderung wurde zur Verarbeitung akzeptiert. Verwenden Sie die URL im Operation-Location Header, um den Status zu erhalten.

Header

Operation-Location: string
Other Status Codes

ErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

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 Karten-Verwaltungs-APIerworben werden.

Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen. * Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das 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.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

subscription-key

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

Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.

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

Typ: apiKey
In: query

SAS Token

Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und feinkörniger Kontrolle auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token autorisiert. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen das Steuern des Zugriffs auf eine sicherere Weise zu ermöglichen als der freigegebene Schlüssel.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge auf der Zuordnungskontoressource zu konfigurieren,, um das Rendern von Missbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Convert previously uploaded DWG Package

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200 
Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0
{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}
Statuscode:
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

Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail

Das Fehlerdetails.
ErrorResponse

Fehlerantwort
LongRunningOperationResult

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

Der Statusstatus der Anforderung.
OutputOntology

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

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.
type

string

Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

LongRunningOperationResult

Objekt

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

Name Typ Beschreibung
created

string (date-time)

Der erstellte Zeitstempel.
error

ErrorDetail

Das Fehlerdetails.
operationId

string

Die ID für diesen lang ausgeführten Vorgang.
status

LroStatus

Der Statusstatus der Anforderung.
warning

ErrorDetail

Das Fehlerdetails.

LroStatus

Enumeration

Der Statusstatus der Anforderung.

Wert Beschreibung
Failed

Die Anforderung weist mindestens einen Fehler auf.
NotStarted

Die Anforderung wurde noch nicht verarbeitet.
Running

Die Anforderung hat mit der Verarbeitung begonnen.
Succeeded

Die Anforderung wurde erfolgreich abgeschlossen.

OutputOntology

Enumeration

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

Wert Beschreibung
facility-2.0

Die Einrichtungs-Ontologie definiert, wie Azure Maps Creator Einrichtungsdaten intern in einem Creator-Dataset speichert.