Dataset - Create

  • Referenz
Service:
Maps Creator
API Version:
2.0

Verwenden Sie zum Erstellen eines Datasets.

Die Create API ist eine HTTP-Anforderung POST , die den conversionId Wert des konvertierten Zeichnungspakets übernimmt 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 wie dem Hochladen eines DWG-ZIP-Pakets für eine Erstellung, dem Konvertieren des ZIP-Pakets mithilfe des Azure Maps Konvertierungsdiensts und dem Erstellen eines Datasets aus dem konvertierten ZIP-Paket verwenden. Das erstellte Dataset kann zum Erstellen von Kachelsätzen mit dem Azure Maps Tileset-Dienst verwendet und über den Azure Maps WFS-Dienst abgefragt werden.

Erstellen einer Anforderung übermitteln

Zum Erstellen Ihres Datasets verwenden Sie eine POST Anforderung, bei der der conversionId Abfrageparameter eine ID ist, die das konvertierte DWG-ZIP-Paket darstellt, der datasetId Parameter 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 die Beschreibung nicht bereitgestellt wird, wird eine Standardbeschreibung angegeben).

Die Erstellungs-API ist ein Vorgang mit langer Ausführungsdauer.

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}
With optional parameters: 
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 wir 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 aus einem erfolgreichen Aufruf der Konvertierungsdienst-Konvertierungs-API abgerufen worden sein und kann mit mehreren Abfrageparametern mit demselben Namen bereitgestellt werden (wenn mehrere bereitgestellt werden).
datasetId
 query

string

Die ID für das Dataset, mit dem angefügt werden soll. Das Dataset muss aus einem vorherigen Aufruf der Dataseterstellung stammen, der der datasetId entspricht.
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 für die Verwendung in Verbindung mit dem Microsoft Entra ID Sicherheitsmodell vorgesehen ist. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der konto-API auf Azure Maps Verwaltungsebene abgerufen werden. Anleitungen 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 zur 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. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, 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 jedem 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.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

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.

Der Authorization URL ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID 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 Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

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 genutzter Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal erstellen oder PowerShell, CLI, Azure SDKs oder REST-API verwenden.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, 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 zu verwenden, um auf Azure Maps REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

SAS Token

Hierbei handelt es sich um 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 autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource 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

Sample Request

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

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/datasets/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 Zustand der Anforderung.

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 Zustand der Anforderung.
warning

ErrorDetail

Die Fehlerdetails.

LroStatus

Der status Zustand der Anforderung.

Name Typ Beschreibung
Failed

string

Die Anforderung weist mindestens einen Fehler auf.
NotStarted

string

Die Verarbeitung der Anforderung wurde noch nicht gestartet.
Running

string

Die Anforderung hat mit der Verarbeitung begonnen.
Succeeded

string

Die Anforderung wurde erfolgreich abgeschlossen.