Weather - Get Weather Along Route

Verwenden Sie diese Option, um eine standortgenaue, up-tominutengenaue Vorhersage zu erhalten, die Wettergefahrenbewertungen und Benachrichtigungen entlang einer Route enthält.
Bei der Get Weather Along Route API handelt es sich um eine HTTP-Anforderung GET , die hyperlokale (einen Kilometer oder weniger), up-tominutengenaue Wetter-Nowcasts, Wettergefahrenbewertungen und Benachrichtigungen entlang einer Route zurückgibt, die als Abfolge von Wegpunkten beschrieben wird. Dazu gehört eine Liste von Wettergefahren, die sich auf den Wegpunkt oder die Route auswirken, und der aggregierte Gefahrenindex für jeden Wegpunkt kann verwendet werden, um jeden Teil einer Route entsprechend der Sicherheit für den Fahrer zu malen. Beim Einreichen der Wegpunkte wird empfohlen, innerhalb oder nahe an der Entfernung zu bleiben, die innerhalb von 120 Minuten oder kurz danach zurückgelegt werden kann. Die Daten werden alle fünf Minuten aktualisiert.

Der Service ergänzt Azure Maps Route Service das es ermöglicht, zunächst eine Route zwischen Ausgangspunkt und Ziel anzufordern und diese als Eingabe für den Weather Along Route-Endpunkt zu verwenden.

Darüber hinaus unterstützt der Dienst Szenarien zum Generieren von Wetterbenachrichtigungen für Wegpunkte, bei denen die Intensität einer Wettergefahr zunimmt. Wenn beispielsweise erwartet wird, dass das Fahrzeug beim Erreichen eines Wegpunkts starkem Regen ausgesetzt ist, wird für diesen Wegpunkt eine Wetterbenachrichtigung für starken Regen generiert, sodass das Endprodukt eine Starkregenbenachrichtigung anzeigen kann, bevor der Fahrer diesen Wegpunkt erreicht. Der Auslöser für die Anzeige der Benachrichtigung für einen Wegpunkt kann z. B. auf einem Geofence oder einer wählbaren Entfernung zum Wegpunkt basieren.

Die API deckt alle Regionen des Planeten ab, mit Ausnahme der Breitengrade über Grönland und der Antarktis.

GET {endpoint}/weather/route/json?api-version=1.1&query={query}

GET {endpoint}/weather/route/json?api-version=1.1&query={query}&language={language}

URI-Parameter

Anforderungsheader

Antworten

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.

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

Bereiche

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

Successfully retrieve detailed weather casts along a route described as a sequence of waypoints

GET https://atlas.microsoft.com/weather/route/json?api-version=1.1&query=38.907,-77.037,0:38.907,-77.009,10:38.926,-76.928,20:39.033,-76.852,30:39.168,-76.732,40:39.269,-76.634,50:39.287,-76.612,60

{
  "summary": {
    "hazards": {
      "maxHazardIndex": 0
    },
    "iconCode": 35
  },
  "waypoints": [
    {
      "cloudCover": 70,
      "hazards": {
        "maxHazardIndex": 0
      },
      "iconCode": 38,
      "isDayTime": false,
      "lightningCount": 0,
      "notifications": [],
      "precipitation": {
        "type": "SNOW",
        "dbz": 0
      },
      "shortPhrase": "Mostly cloudy",
      "sunGlare": {
        "calculatedVehicleHeading": 90,
        "glareIndex": 0
      },
      "temperature": {
        "unit": "C",
        "unitType": 17,
        "value": 3.4
      },
      "wind": {
        "direction": {
          "degrees": 142
        },
        "speed": {
          "unit": "km/h",
          "unitType": 7,
          "value": 2
        }
      },
      "windGust": {
        "speed": {
          "unit": "km/h",
          "unitType": 7,
          "value": 3
        }
      }
    },
    {
      "cloudCover": 65,
      "hazards": {
        "maxHazardIndex": 0
      },
      "iconCode": 38,
      "isDayTime": false,
      "lightningCount": 0,
      "notifications": [],
      "precipitation": {
        "type": "SNOW",
        "dbz": 0
      },
      "shortPhrase": "Mostly cloudy",
      "sunGlare": {
        "calculatedVehicleHeading": 77,
        "glareIndex": 0
      },
      "temperature": {
        "unit": "C",
        "unitType": 17,
        "value": 3.4
      },
      "wind": {
        "direction": {
          "degrees": 166
        },
        "speed": {
          "unit": "km/h",
          "unitType": 7,
          "value": 1
        }
      },
      "windGust": {
        "speed": {
          "unit": "km/h",
          "unitType": 7,
          "value": 2
        }
      }
    },
    {
      "cloudCover": 43,
      "hazards": {
        "maxHazardIndex": 0
      },
      "iconCode": 35,
      "isDayTime": false,
      "lightningCount": 0,
      "notifications": [],
      "precipitation": {
        "type": "SNOW",
        "dbz": 0
      },
      "shortPhrase": "Partly cloudy",
      "sunGlare": {
        "calculatedVehicleHeading": 44,
        "glareIndex": 0
      },
      "temperature": {
        "unit": "C",
        "unitType": 17,
        "value": 3.2
      },
      "wind": {
        "direction": {
          "degrees": 163
        },
        "speed": {
          "unit": "km/h",
          "unitType": 7,
          "value": 2
        }
      },
      "windGust": {
        "speed": {
          "unit": "km/h",
          "unitType": 7,
          "value": 2
        }
      }
    },
    {
      "cloudCover": 34,
      "hazards": {
        "maxHazardIndex": 0
      },
      "iconCode": 35,
      "isDayTime": false,
      "lightningCount": 0,
      "notifications": [],
      "precipitation": {
        "type": "SNOW",
        "dbz": 0
      },
      "shortPhrase": "Partly cloudy",
      "sunGlare": {
        "calculatedVehicleHeading": 32,
        "glareIndex": 0
      },
      "temperature": {
        "unit": "C",
        "unitType": 17,
        "value": 1.6
      },
      "wind": {
        "direction": {
          "degrees": 189
        },
        "speed": {
          "unit": "km/h",
          "unitType": 7,
          "value": 2
        }
      },
      "windGust": {
        "speed": {
          "unit": "km/h",
          "unitType": 7,
          "value": 4
        }
      }
    },
    {
      "cloudCover": 54,
      "hazards": {
        "maxHazardIndex": 0
      },
      "iconCode": 38,
      "isDayTime": false,
      "lightningCount": 0,
      "notifications": [],
      "precipitation": {
        "type": "SNOW",
        "dbz": 0
      },
      "shortPhrase": "Mostly cloudy",
      "sunGlare": {
        "calculatedVehicleHeading": 36,
        "glareIndex": 0
      },
      "temperature": {
        "unit": "C",
        "unitType": 17,
        "value": 0.5
      },
      "wind": {
        "direction": {
          "degrees": 202
        },
        "speed": {
          "unit": "km/h",
          "unitType": 7,
          "value": 4
        }
      },
      "windGust": {
        "speed": {
          "unit": "km/h",
          "unitType": 7,
          "value": 5
        }
      }
    },
    {
      "cloudCover": 46,
      "hazards": {
        "maxHazardIndex": 0
      },
      "iconCode": 35,
      "isDayTime": false,
      "lightningCount": 0,
      "notifications": [],
      "precipitation": {
        "type": "SNOW",
        "dbz": 0
      },
      "shortPhrase": "Partly cloudy",
      "sunGlare": {
        "calculatedVehicleHeading": 38,
        "glareIndex": 0
      },
      "temperature": {
        "unit": "C",
        "unitType": 17,
        "value": 2.4
      },
      "wind": {
        "direction": {
          "degrees": 222
        },
        "speed": {
          "unit": "km/h",
          "unitType": 7,
          "value": 4
        }
      },
      "windGust": {
        "speed": {
          "unit": "km/h",
          "unitType": 7,
          "value": 5
        }
      }
    },
    {
      "cloudCover": 39,
      "hazards": {
        "maxHazardIndex": 0
      },
      "iconCode": 35,
      "isDayTime": false,
      "lightningCount": 0,
      "notifications": [],
      "precipitation": {
        "type": "SNOW",
        "dbz": 0
      },
      "shortPhrase": "Partly cloudy",
      "sunGlare": {
        "calculatedVehicleHeading": 43,
        "glareIndex": 0
      },
      "temperature": {
        "unit": "C",
        "unitType": 17,
        "value": 2.3
      },
      "wind": {
        "direction": {
          "degrees": 231
        },
        "speed": {
          "unit": "km/h",
          "unitType": 7,
          "value": 4
        }
      },
      "windGust": {
        "speed": {
          "unit": "km/h",
          "unitType": 7,
          "value": 5
        }
      }
    }
  ]
}

Definitionen

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

HazardDetail

Ein Eintrag zur WeatherHazards.hazardDetails Beschreibung einer einzelnen Wettergefahr am Ort (Routenniveau bei Transport auf WeatherAlongRouteSummary.hazards, oder pro Wegpunkt bei Transport auf WaypointForecast.hazards). Kombiniert eine hazardCode Identifizierung des spezifischen Gefahrentyps, eine hazardIndex Bewertung der individuellen Schwere auf der 0-4-Skala und eine shortPhrase geeignete Anzeige in einer Benutzeroberfläche.

HazardIndex

Der aggregierte Schweregrad/Gefahrenindex für jeden Wegpunkt kann verwendet werden, um Abschnitte einer Strecke farblich zu codieren und so das Sicherheitsniveau für Fahrer anzuzeigen.

• 0: Keine Gefahr
• 1: Sei informiert, sei aufmerksam
• 2: Pass auf, sei vorbereitet
• 3: Handeln Sie
• 4: Lebensbedrohlich, Notfall

IconCode

Der numerische Wettercode, der angibt, welches Symbol angezeigt werden soll. Jeder Wert in dieser Aufzählung entspricht einem Azure Maps-Wettersymbol (wie Sunny, Cloudy oder Thunderstorms) und wird mit einem von Menschen lesbaren Symbol iconPhrase kombiniert, das dazu zurückgegeben wird. Derselbe Code kann in aktuellen, stündlichen, täglichen, vierteltags- und minuten-für-minuten-Antworten erscheinen, sodass Anwendungen ein konsistentes Symbol für alle Wetterdienste darstellen können.

Für die vollständige Liste der Codes, die zugeordneten Symbole und Beispielbilder siehe Weather Services in Azure Maps.

JsonFormat

Gewünschtes Format der Antwort. Nur json Format wird unterstützt.

SunGlare

Die Sonnenblendungsfahrgefahr an einem einzelnen Wegpunkt wurde als WaypointForecast.sunGlare. Berichte glareIndex von 0 bis 100 , die die Intensität der Blendung missen, die ein Fahrer am Wegpunkt erleben würde, zusammen mit der calculatedVehicleHeading zur Berechnung verwendeten – der Kurs ist entweder der für den Wegpunkt angegebene Wert in der Anfrage oder, falls keiner angegeben wurde, einer, der aus den benachbarten Wegpunkten abgeleitet wird.

UnitType

Ein ganzzahliger Wert, der mit dem Typ der angezeigten Einheit assoziiert ist. Zum Beispiel 17 für Celsius, 18 für Fahrenheit. Kann für die Einheitenumrechnung verwendet werden. Weitere Informationen finden Sie unter Wetterdienste in Azure Maps.

WaypointForecast

Die detaillierte Prognose für einen Wegpunkt entlang einer Straßenroute wurde als ein Eintrag pro angeforderter Wegpunkt in WeatherAlongRouteResult.waypoints (gleiche Reihenfolge wie die in der Anfrage angegebenen Wegpunkte) zurückgegeben. Gibt die Bedingungen an diesem Ort an: ein repräsentativer iconCode und shortPhrase, egal ob Tag oder Nacht, Wolkenbedeckung, Temperatur, Wind- und Windböendetails, Niederschlagsart und -intensität, eine Blitzanzahl, die Sonnenblendungsgefahr für den Fahrer, die WeatherHazards aggregierten am Wegpunkt und etwaige freie Gefahr notifications.

WeatherAlongRoutePrecipitation

Der erwartete Niederschlag an einem einzelnen Wegpunkt entlang der Route wurde als WaypointForecast.precipitation. Meldet die vorhergesagte Intensität als Radarreflektivität (dbz) zusammen mit Niederschlag type (Regen, Schnee, Eis, Hagel oder Mischung). A dbz von 0 zeigt keinen Niederschlag an, in diesem Fall type kann er dennoch zurückgegeben werden, um die Niederschlagsart anzuzeigen, die auftreten würde , wenn am Wegpunkt Niederschlag fallen würde (zum Beispiel Schnee bei kaltem Wetter).

WeatherAlongRouteResult

Die Antwort erfolgte durch die Get Weather Along Route, die die Prognose für eine Abfolge von Wegpunkten entlang einer Straßenroute lieferte. Beinhaltet eine oberste Ebene summary mit dem höchsten Gefahrenindex entlang der Strecke und einem repräsentativen Wettersymbol sowie ein waypoints Array mit einer detaillierten Prognose pro angefordertem Wegpunkt – Wolkenbedeckung, Temperatur, Wind, Niederschlag, Blitzzählung, Sonnenblendung, Gefahren und Benachrichtigungen.

WeatherAlongRouteSummary

Die Streckenübersicht auf WeatherAlongRouteResult.summary, gibt einen einzigen übergeordneten Überblick über die Bedingungen auf der gesamten Strecke. Enthält ein repräsentatives Wetter iconCode für die Route und einen aggregierten hazards Block, der den maximalen Gefahrenindex sowie die spezifischen Gefahrentypen an jedem Wegpunkt angibt. Verwenden Sie dies, wenn ein einzelner Streckenindikator benötigt wird; für Details pro Wegpunkt verwenden WeatherAlongRouteResult.waypointsSie .

WeatherHazards

Eine Zusammenfassung der bedeutenden Wettergefahren an einem einzelnen Ort. Die gleiche Form wird an zwei Stellen von der Get Weather Along Route-Antwort verwendet: auf WeatherAlongRouteSummary.hazards, wo sie sich über die gesamte Route aggregiert (maximale Schweregrad an jedem Wegpunkt), und auf WaypointForecast.hazards, wo sie die Gefahren an einem bestimmten Wegpunkt beschreibt. Vermittelt sowohl eine höchste maxHazardIndex Bewertung der schlimmsten Gefahr im Umfang (von 0 – keine Gefahr – bis 4 – lebensbedrohlich) als auch ein hazardDetails Array, das jede spezifische Gefahrenart aufzählt (Regen, Schnee, Eis, Hagel, Sonnenschein, Blitz, Wind und Unwetterwarnungen wie Überschwemmungen, Tornados, Tsunamis und schwere Gewitter).

WeatherNotification

Eine freie Gefahrenbenachrichtigung, die an einem einzelnen Wegpunkt entlang der Route ausgelöst wurde, wurde als Eintrag in WaypointForecast.notifications. Jede Benachrichtigung kombiniert eine type Klassifizierung der Benachrichtigung, eine hazardCode Identifizierung der spezifischen Gefahr, eine hazardIndex Bewertung der Schwere auf der Skala 0–4 und eine shortPhrase geeignete Anzeige. Benachrichtigungskomplement WaypointForecast.hazards – letztere zählt alle aktiven Gefahren am Wegpunkt auf, während notifications sie nur diejenigen enthält, die der Dienst als lohnenswert für den Fahrer markiert hat.

WeatherValue

Werte für wetterbezogene Metriken wie Temperatur, Taupunkt und Windgeschwindigkeit, präsentiert entweder in metrischen oder imperialen Einheiten, wie im Einheits-URI-Parameter angegeben. Weitere Informationen finden Sie unter Einheitstypen im Artikel Wetterdienste in Azure Maps.

WindDetails

Liefert die prognostizierte Windgeschwindigkeit, gemessen in Einheiten wie Kilometer pro Stunde (km/h) oder Meilen pro Stunde (mph), je nach in der Anfrage angegebener Einheit. Gibt außerdem die Windrichtung an, gemessen in Azimutgrad, beginnend im wahren Norden und im Uhrzeigersinn bewegend. Nord entspricht 0°, Ost 90°, Süden 180° und Westen 270°. Mögliche Werte reichen von 0° bis 359°.

WindDirection

Liefert Details zur Windrichtung, einschließlich der Richtung in Azimutgraden und einer lokalisierten Abkürzung der Windrichtung.