Freigeben über


Route - Get Route Operations Status

Rufen Sie den Status eines asynchronen Vorgangs anhand der Vorgangs-ID ab.

GET https://atlas.microsoft.com/route/operations/{id}?api-version=2025-01-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
id
path True

string

minLength: 36
maxLength: 36
pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

Vom System generierter eindeutiger Bezeichner für den asynchronen Vorgang, nachdem er übermittelt wurde.

api-version
query True

string

Versionsnummer der Azure Maps-API.

Antworten

Name Typ Beschreibung
200 OK

RouteOperation

OKAY

404 Not Found

ErrorResponse

Die Einsatzressource wurde nicht gefunden.

Header

x-ms-error-code: string

Other Status Codes

ErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Header

x-ms-error-code: string

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.

Hinweis

  • 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 das konfigurationsbasierte Einrichten 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 gemeinsam genutzter Schlüssel, der beim Erstellen einer Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.

Mit diesem Schlüssel ist jede Anwendung berechtigt, auf alle REST-APIs zuzugreifen. Mit anderen Worten, diese können derzeit als Hauptschlüssel für das Konto behandelt werden, für das sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, den Server-zu-Server-Zugriff von Azure Maps-REST-APIs zu verwenden, bei denen dieser Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: header

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

Retrieve the async matrix operation status

Beispielanforderung

GET https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557?api-version=2025-01-01

Beispiel für eine Antwort

{
  "kind": "RouteMatrix",
  "status": "Completed",
  "createdAt": "2023-01-01T00:00:00Z",
  "lastActionAt": "2023-01-01T00:05:00Z",
  "result": {
    "resultUrl": "https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01"
  }
}
{
  "error": {
    "code": "NotFound",
    "message": "Not Found: the requested resource could not be found."
  }
}

Definitionen

Name Beschreibung
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Fehlerantwort

Result

Das Ergebnis eines asynchronen Vorgangs

RouteOperation

Dieses Objekt wird von einer erfolgreichen Get Operation-Anforderung zurückgegeben.

RouteOperationKindEnum

Typ des asynchronen Vorgangs

StatusEnum

Aktueller Status des asynchronen Vorgangs.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

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

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

Result

Das Ergebnis eines asynchronen Vorgangs

Name Typ Beschreibung
resultUrl

string (uri)

URL zum Abrufen des Ergebnisses des asynchronen Vorgangs

RouteOperation

Dieses Objekt wird von einer erfolgreichen Get Operation-Anforderung zurückgegeben.

Name Typ Beschreibung
createdAt

string (date-time)

Zeitstempel beim Erstellen des Vorgangs.

error

ErrorDetail

Das Fehlerdetails.

id

string

Eindeutiger Bezeichner für den asynchronen Vorgang.

kind

RouteOperationKindEnum

Typ des asynchronen Vorgangs

lastActionAt

string (date-time)

Zeitstempel, zu dem der Vorgangsstatus aktualisiert wurde.

result

Result

Das Ergebnis eines asynchronen Vorgangs

status

StatusEnum

Aktueller Status des asynchronen Vorgangs.

RouteOperationKindEnum

Typ des asynchronen Vorgangs

Wert Beschreibung
RouteMatrix

Asynchroner Auftrag für die Routenmatrix.

StatusEnum

Aktueller Status des asynchronen Vorgangs.

Wert Beschreibung
NotStarted

Der Vorgang wurde noch nicht gestartet.

Running

Der Vorgang wird ausgeführt.

Completed

Der Vorgang wurde erfolgreich abgeschlossen.

Failed

Beim Vorgang ist ein Fehler aufgetreten.