Dataset - Get Operation

  • Referenz
Service:
Maps Creator
API Version:
2.0

Verwenden Sie , um die status des Dataseterstellungsprozesses zu überprüfen.

Die Get Operation API ist eine HTTP-AnforderungGET, die verwendet wird, um die status des Dataseterstellungsprozesses zu überprüfen und den datasetId Wert abzurufen.

Senden einer Vorgangsanforderung

Um den aktuellen Fortschritt eines Datasetvorgangs anzuzeigen, verwenden Sie eine GET Anforderung, bei der der operationId angegebene Pfad die ID ist, die den Vorgang darstellt.

Vorgangsantwort

Während der Ausführung wird ein 200-OK HTTP-status Code ohne zusätzliche Header zurückgegeben. Wenn der Vorgang erfolgreich ist, wird ein 200-OK HTTP-status-Code mit Resource-Location-Header zurückgegeben.

GET https://{geography}.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2.0

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".
operationId
 path True

string

Die ID zum Abfragen der status für die Anforderung zum Erstellen/Importieren des Datasets.
api-version
 query True

string

Versionsnummer der Azure Maps API.

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

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

Get the status of an operation which has finished successfully
Get the status of an operation which is still running

Get the status of an operation which has finished successfully

Sample Request

GET https://us.atlas.microsoft.com/datasets/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0

Sample Response

Status code:
200 
Resource-Location: https://us.atlas.microsoft.com/datasets/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"
}

Get the status of an operation which is still running

Sample Request

GET https://us.atlas.microsoft.com/datasets/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0

Sample Response

Status code:
200 
{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-23T19:14:03.2452596+00:00",
  "status": "Running"
}

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.

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.