Dataset - Create

Service:

Maps Creator

API Version:

2023-03-01-preview

Verwenden Sie , um ein Dataset zu erstellen.

Die Create API ist eine HTTP-AnforderungPOST, die es dem Aufrufer ermöglicht, ein Dataset aus Daten zu erstellen, die in die Azure Maps-Datenregistrierung hochgeladen und mithilfe des Azure Maps Konvertierungsdiensts konvertiert wurden. Sie können ein Dataset auch direkt mithilfe von Daten erstellen, die in die Azure Maps-Datenregistrierung hochgeladen wurden, vorausgesetzt, dass die hochgeladenen Daten eine ZIP-Datei mit GeoJSON-Dateien sind, die dem Gebäudeontologieformat entsprechen. Weitere Informationen zum Datenregistrierungsdienst finden Sie unter Erstellen einer Datenregistrierung.

Weitere Informationen finden Sie unter Erstellen eines Datasets mit einem GeoJson-Paket.

Übermitteln der Erstellungsanforderung

Um Ihr Dataset zu erstellen, geben Sie eine POST Anforderung mit den erforderlichen Parametern aus. Die Erstellungs-API ist ein Vorgang mit langer Ausführungsdauer.

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2023-03-01-preview

With optional parameters:

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&udid={udid}&outputOntology=facility-2.0&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 "us" und "eu".
api-version	query	True	string	Versionsnummer der Azure Maps API.
conversionId	query		string	ID zum Erstellen des Datasets. Muss conversionId von einem erfolgreichen Aufruf der Konvertierungsdienst-API abgerufen werden. Pro API-Aufruf kann nur eine conversionId bereitgestellt werden. conversionId und udid schließen sich gegenseitig aus.
datasetId	query		string	Die ID des Datasets, mit dem angefügt werden soll.
description	query		string	Die Beschreibung, die dem Dataset zugewiesen werden soll.
outputOntology	query		outputOntology	Die Ontologie für das hochgeladene ZIP-Paket, das GeoJSON-Dateien enthält. outputOntology ist erforderlich, wenn udid angegeben wird, schließt sich jedoch mit conversionId gegenseitig aus. Derzeit wird nur der Wert facility-2.0 unterstützt.
udid	query		string	Die eindeutige Daten-ID (udid) zum Erstellen des Datasets. Muss identisch udid sein, die beim Erstellen der Datenregistrierung verwendet wird. Pro API-Aufruf kann nur eine udid bereitgestellt werden. Der outputOntology-Parameter muss mit udid angegeben werden. conversionId und udid schließen sich gegenseitig aus.

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
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 Azure Active Directory OAuth2-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 Azure Active Directory-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.

• Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Arbeit, Schule und Gäste, aber keine persönlichen Konten.

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

Create dataset from a converted CAD file provided by conversionId

Create dataset from a zip of GeoJSON files provided by udid

Create dataset with Udid and append to it a dataset created with conversionId

Create dataset with Udid and append to it a dataset created with udid

Create dataset from a converted CAD file provided by conversionId

Sample Request

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&outputOntology=facility-2.0

Sample Response

Status code:

202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

Create dataset from a zip of GeoJSON files provided by udid

Sample Request

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&udid={udid}&outputOntology=facility-2.0

Sample Response

Status code:

202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

Create dataset with Udid and append to it a dataset created with conversionId

Sample Request

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&udid={udid}&outputOntology=facility-2.0&datasetId={conversionId}

Sample Response

Status code:

202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

Create dataset with Udid and append to it a dataset created with udid

Sample Request

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&udid={udid}&outputOntology=facility-2.0&datasetId={udid}

Sample Response

Status code:

202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
outputOntology	Die Ontologie für das hochgeladene ZIP-Paket, das GeoJSON-Dateien enthält. outputOntology ist erforderlich, wenn udid angegeben wird, schließt sich jedoch mit conversionId gegenseitig aus. Derzeit wird nur der Wert facility-2.0 unterstützt.

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.

outputOntology

Die Ontologie für das hochgeladene ZIP-Paket, das GeoJSON-Dateien enthält. outputOntology ist erforderlich, wenn udid angegeben wird, schließt sich jedoch mit conversionId gegenseitig aus. Derzeit wird nur der Wert facility-2.0 unterstützt.

Name	Typ	Beschreibung
facility-2.0	string