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 (uri) |
Der Hostname des Azure Maps-Dienstes. Verwenden Sie |
|
id
|
path | True |
string minLength: 36maxLength: 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 |
Die Anforderung ist erfolgreich. |
|
| 404 Not Found |
Der Server kann die angeforderte Ressource nicht finden. |
|
| Other Status Codes |
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. 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.
Note
- 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 URList spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über einzigartige 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 |
subscription-key
Dies ist ein freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.
Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr 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
{
"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 |
|---|---|
|
Common |
Das Fehlerdetails. |
|
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
|
Maps |
Das Fehlerdetails. |
|
Maps |
Übliche Fehlerantwort für Azure Maps-APIs zur Rückgabe von Fehlerdetails bei fehlgeschlagenen Operationen. |
|
Maps |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
|
Route |
Dieses Objekt wird von einer erfolgreichen Get Operation-Anfrage zurückgegeben. |
|
Route |
Typ des asynchronen Vorgangs |
|
Route |
Das Ergebnis asynchroner Operation |
|
Status |
Aktueller Status der asynchronen Operation. |
CommonErrorDetail
Das Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
| code |
string |
Der Fehlercode. |
| details |
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 |
Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben. |
|
| innererror |
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 |
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 |
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 |
Das Fehlerdetails. |
|
| id |
string |
Eindeutige Kennung für die asynchrone Operation. |
| kind |
Typ des asynchronen Vorgangs |
|
| lastActionAt |
string (date-time) |
Zeitstempel, wenn der Operationsstatus aktualisiert wurde. |
| result |
Das Ergebnis asynchroner Operation |
|
| status |
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. |