Route - Get Route Operations Status

Erhalten Sie den Status einer asynchronen Operation anhand ihrer Operations-ID.

GET {endpoint}/route/operations/{id}?api-version=2025-01-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string

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}$

Der vom System generierte eindeutige Bezeichner für den asynchronen Vorgang, nachdem er übermittelt wurde.

api-version
query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name Typ Beschreibung
200 OK

RouteOperation

Die Anforderung ist erfolgreich.

404 Not Found

MapsErrorResponse

Der Server kann die angeforderte Ressource nicht finden.

Other Status Codes

MapsErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

AadToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. In Kombination mit Azure rollenbasierten Zugriffs Steuerung kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Azure-rollenbasierte Zugriffskontrollen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jeder Benutzer, jede Gruppe oder jeder Service-Principal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle erhalten, die aus einer oder mehreren Berechtigungen besteht, REST-APIs zu Azure Maps.\n\nUm Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepte anzusehen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zur Modellierung von Anwendungen über Objekte, die Zugriff auf spezifische APIs und Scopes ermöglichen.\n\n#### Anmerkungen\n* Diese Sicherheitsdefinition re die Verwendung des x-ms-client-id Headers, um anzuzeigen, auf welche Azure Maps Ressource die Anwendung Zugriff bittet. Dies kann über die Maps Management API erworben werden.\n* \nDas Authorization URL ist spezifisch für die Azure Public Cloud-Instanz. Souveräne Clouds verfügen über einzigartige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen. \n* \nDie Azure rollenbasierte Zugriffskontrolle wird von der Azure Managementebene über Azure Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.\n* \nNutzung der Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.\n* Für weitere Informationen zu Microsoft Identity Platform siehe Microsoft Identity Platform Übersicht.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
https://atlas.microsoft.com/.default

subscription-key

Dies ist ein gemeinsamer Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps Konto im Azure Portal oder mit PowerShell, CLI, Azure SDKs oder REST API erstellen.\n\n Mit diesem Schlüssel kann jede Anwendung auf alle REST-APIs zugreifen. Mit anderen Worten: Dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgegeben werden.\n\n Für öffentlich zugängliche Anwendungen empfehlen wir, den Ansatz confidential Client Applications zu verwenden, um auf Azure Maps REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: header

SAS Token

Dies ist ein Shared-Access-Signaturtoken, das aus der List SAS-Operation auf der Azure Maps Ressource über die Azure Managementebene über Azure Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.\n\n Mit diesem Token ist jede Anwendung autorisiert, mit Azure rollenbasierte Zugriffskontrollen und feine Kontrolle über Ablauf, Rate und Nutzungsregion des jeweiligen Tokens. Mit anderen Worten: Der SAS-Token kann verwendet werden, um Anwendungen die Zugriffskontrolle auf sicherere Weise als der gemeinsame Schlüssel zu ermöglichen.\n\n Für öffentlich zugängliche Anwendungen empfehlen wir, eine spezielle Liste erlaubter Ursprünge auf der Map-Konto-Ressource zu konfigurieren, um Rendering-Missbrauch zu begrenzen, und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Retrieve the async matrix operation status

Beispielanforderung

GET {endpoint}/route/operations/bc3f9365-3ee0-4564-aa27-825016325557?api-version=2025-01-01

Beispiel für eine Antwort

{
  "createdAt": "2023-01-01T00:00:00Z",
  "kind": "RouteMatrix",
  "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"
  },
  "status": "Completed"
}
{
  "error": {
    "code": "NotFound",
    "message": "Not Found: the requested resource could not be found."
  }
}

Definitionen

Name Beschreibung
CommonErrorDetail

Das Fehlerdetails.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

MapsErrorDetail

Das Fehlerdetails.

MapsErrorResponse

Übliche Fehlerantwort für Azure Maps-APIs zur Rückgabe von Fehlerdetails bei fehlgeschlagenen Operationen.

MapsInnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

RouteOperation

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

RouteOperationKindEnum

Typ des asynchronen Vorgangs

RouteOperationResult

Das Ergebnis asynchroner Operation

StatusEnum

Aktueller Status der asynchronen Operation.

CommonErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

code

string

Der Fehlercode.

details

CommonErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

MapsErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.

details

MapsErrorDetail[]

Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.

innererror

MapsInnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

message

string

Eine lesbare Darstellung des Fehlers.

target

string

Das Ziel des Fehlers.

MapsErrorResponse

Übliche Fehlerantwort für Azure Maps-APIs zur Rückgabe von Fehlerdetails bei fehlgeschlagenen Operationen.

Name Typ Beschreibung
error

MapsErrorDetail

Das Fehlerdetails.

MapsInnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

Name Typ Beschreibung
code

string

Der Fehlercode.

innererror

MapsInnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

RouteOperation

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

Name Typ Beschreibung
createdAt

string (date-time)

Zeitstempel, als die Operation erstellt wurde.

error

CommonErrorDetail

Das Fehlerdetails.

id

string

Eindeutige Kennung für die asynchrone Operation.

kind

RouteOperationKindEnum

Typ des asynchronen Vorgangs

lastActionAt

string (date-time)

Zeitstempel, wenn der Operationsstatus aktualisiert wurde.

result

RouteOperationResult

Das Ergebnis asynchroner Operation

status

StatusEnum

Aktueller Status der asynchronen Operation.

RouteOperationKindEnum

Typ des asynchronen Vorgangs

Wert Beschreibung
RouteMatrix

Asynchroner Auftrag für die Routenmatrix.

RouteOperationResult

Das Ergebnis asynchroner Operation

Name Typ Beschreibung
resultUrl

string (uri)

URL, um das Ergebnis einer asynchronen Operation zu erhalten.

StatusEnum

Aktueller Status der asynchronen Operation.

Wert Beschreibung
NotStarted

Die Operation hat noch nicht begonnen.

Running

Die Operation läuft.

Completed

Der Vorgang wurde erfolgreich abgeschlossen.

Failed

Fehler beim Vorgang.