Dataset - Create

Dienst:

Maps Creator

API-Version:

2.0

Dient zum Erstellen eines Datasets.

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 Create-API ist eine HTTP-POST-Anforderung, die den conversionId Wert des konvertierten Zeichnungspakets annimmt und die datasetId Eigenschaft des neu erstellten Datasets zurückgibt. Weitere Informationen finden Sie unter Erstellen eines Datasets.

Sie können diese Anforderung in einem Szenario verwenden, z. B. das Hochladen eines DWG-ZIP-Pakets für ein Gebäude, das Konvertieren des ZIP-Pakets mithilfe des Azure Maps-Konvertierungs--Diensts und das Erstellen eines Datasets aus dem konvertierten ZIP-Paket. Das erstellte Dataset kann zum Erstellen von Kachelsets mithilfe des Azure Maps -Kachelsets-Diensts verwendet werden und über den Azure Maps-WFS--Dienst abgefragt werden.

Anforderung zum Senden einer Create-Anforderung

Zum Erstellen des Datasets verwenden Sie eine POST Anforderung, bei der der conversionId Abfrageparameter eine ID ist, die das konvertierte DWG-ZIP-Paket darstellt, der datasetId Parameter ist die ID eines zuvor erstellten Datasets, das mit dem aktuellen Dataset angefügt werden soll, und optional enthält der description Abfrageparameter eine Beschreibung (wenn keine Beschreibung angegeben wird).

Die Create-API ist ein lang ausgeführten Vorgang.

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}

Mit optionalen Parametern:

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}&datasetId={datasetId}&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.
conversionId	query	True	string	Die eindeutige ID, die zum Erstellen des Datasets verwendet wird. Die conversionId muss von einem erfolgreichen Aufruf des Konvertierungsdiensts Convert-API- abgerufen werden und kann mit mehreren Abfrageparametern mit demselben Namen bereitgestellt werden (wenn mehrere bereitgestellt werden).
datasetId	query		string	Die ID für das anzufügende Dataset. Das Dataset muss aus einem vorherigen Aufruf der Dataseterstellung stammen, der mit der DatasetId übereinstimmt.
description	query		string	Die Beschreibung, die dem Dataset zugewiesen werden soll.

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.

• Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die Microsoft Identity Platform.

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

Create dataset from a converted CAD file provided by conversionId

Beispielanforderung

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2.0&conversionId=[conversionId]

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/datasets/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.

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.