Weather - Get Severe Weather Alerts

Referenz

Dienst:: Maps

API-Version:: 1.1

Verwenden Sie, um Informationen über schwere Wetterbedingungen wie Hurrikane, Gewitter, Überschwemmungen, Blitze, Hitzewellen oder Waldbrände für einen bestimmten Standort zu erhalten.

Unwetter können unseren Alltag und geschäftsbetrieb erheblich beeinflussen. So können beispielsweise Unwetter wie tropische Stürme, starke Winde oder Überschwemmungen Straßen sperren und Logistikunternehmen dazu zwingen, ihre Flotte umzuleiten, was zu Verzögerungen beim Erreichen von Zielen und zum Durchbrechen der Kühlkette von gekühlten Lebensmitteln führt.

Die Get Severe Weather Alerts API ist eine HTTP-Anforderung GET , die die Unwetterwarnungen zurückgibt, die weltweit von offiziellen Staatlichen Meteorologischen Agenturen und führenden globalen bis regionalen Wetterwarnungsanbietern verfügbar sind. Der Dienst kann Details wie Warnungstyp, Kategorie, Ebene und detaillierte Beschreibung der aktiven schwerwiegenden Warnungen für den angeforderten Standort zurückgeben, z. B. Hurrikane, Gewitter, Blitze, Hitzewellen oder Waldbrände. Weitere Informationen finden Sie unter Anfordern von Unwetterwarnungen.

GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query={query}

Mit optionalen Parametern:

GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query={query}&language={language}&details={details}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	JsonFormat	Gewünschtes Format der Antwort. Nur das `json`-Format wird unterstützt.
api-version	query	True	string	Versionsnummer der Azure Maps API.
query	query	True	number[]	Die anwendbare Abfrage, die als kommagetrennte Zeichenfolge angegeben ist, die nach Breitengrad gefolgt von Längengrad besteht, z. B. "47.641268,-122.125679".
details	query		string	Geben Sie alle Details für die Unwetterwarnungen zurück. Verfügbare Werte sind `true` – Gibt vollständige Details zurück. Standardmäßig werden alle Details zurückgegeben. `false` – Gibt eine gekürzte Version der Warnungsdaten zurück, die die bereichsspezifische vollständige Beschreibung der Warnungsdetails (`alertDetails`) ausschließt.
language	query		string	Sprache, in der Suchergebnisse zurückgegeben werden sollen. Sollte eines der unterstützten IETF-Sprachtags sein, wobei die Groß-/Kleinschreibung nicht beachtet wird. Wenn Daten in der angegebenen Sprache für ein bestimmtes Feld nicht verfügbar sind, wird die Standardsprache verwendet. Weitere Informationen finden Sie unter Unterstützte Sprachen .

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie in den folgenden Artikeln .

Antworten

Name	Typ	Beschreibung
200 OK	SevereWeatherAlertsResult	OKAY
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 von 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-Ressourcenkonten 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-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen. * Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die 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.

Weitere Informationen zu Microsoft Identity Platform finden Sie unter Übersicht über 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 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 Hauptschlü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.

Typ: apiKey
In: query

SAS Token

Dies ist ein Shared Access Signature-Token, das aus dem SAS-Listenvorgang für die Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die 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 zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Successfully retrieve severe weather alerts

Beispielanforderung

HTTP

GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query=48.057,-81.091

Beispiel für eine Antwort

Statuscode:: 200

{
  "results": [
    {
      "countryCode": "CA",
      "alertId": 242621,
      "description": {
        "localized": "Heat Warning",
        "english": "Heat Warning"
      },
      "category": "NON-PRECIPITATION",
      "priority": 31,
      "source": "Environment Canada",
      "sourceId": 3,
      "alertAreas": [
        {
          "name": "Kirkland Lake - Englehart",
          "summary": "Heat Warning in effect until Thursday, 3:16 AM EDT.  Source: Environment Canada",
          "startTime": "2020-06-29T19:44:00+00:00",
          "endTime": "2020-07-02T07:16:03+00:00",
          "latestStatus": {
            "localized": "Continue",
            "english": "Continue"
          },
          "alertDetails": "\nA heat event continues through Thursday.\n\nDaytime high temperatures in the low thirties with overnight lows near 18 degrees Celsius are expected to continue until Thursday. Humidex values are expected to reach between 36 and 40 today. Cooler air will move into the region Thursday night. \n\nPlease refer to your public forecast for further details on expected temperatures.\n\nHot and humid air can also bring deteriorating air quality and can result in the air quality health index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nWatch for the effects of heat illness: swelling, rash, cramps, fainting, heat exhaustion, heat stroke and the worsening of some health conditions.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n",
          "alertDetailsLanguageCode": "en-CA"
        }
      ]
    },
    {
      "countryCode": "CA",
      "alertId": 242633,
      "description": {
        "localized": "Heat Warning",
        "english": "Heat Warning"
      },
      "category": "NON-PRECIPITATION",
      "priority": 31,
      "source": "Environment Canada",
      "sourceId": 3,
      "alertAreas": [
        {
          "name": "Kirkland Lake - Englehart",
          "summary": "Heat Warning in effect until 9:25 PM EDT.  Source: Environment Canada",
          "startTime": "2020-07-01T09:25:59+00:00",
          "endTime": "2020-07-02T01:25:59+00:00",
          "latestStatus": {
            "localized": "New",
            "english": "New"
          },
          "alertDetails": "\nA heat event is expected through Thursday.  \n\nDaytime high temperatures in the low thirties on Wednesday and Thursday with overnight lows near 18 degrees Celsius are expected. This heat event may be extended into the weekend with daytime high temperatures near 30 degrees Celsius. \n\nPlease refer to your public forecast for further details on expected temperatures.  \n\nHot and humid air can also bring deteriorating air quality and can result in the Air Quality Health Index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n",
          "alertDetailsLanguageCode": "en-CA"
        }
      ]
    }
  ]
}

Definitionen

Name	Beschreibung
AlertArea	Informationen zu einer Unwetterwarnung, die in einem/den betroffenen Gebiet(en) ausgegeben wird. Wenn mehrere Warnungen für denselben Speicherort aktiv sind, werden die Warnungen in der Reihenfolge innerhalb der `priority` API-Antwort zurückgegeben, wobei die Warnung mit der höchsten Priorität am Anfang der Antwort zurückgegeben wird.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
JsonFormat	Das gewünschte Format der Antwort. Nur das `json`-Format wird unterstützt.
LatestStatus	Der aktuelle Status der Warnung im aktuellen Bereich.
LatestStatusKeyword	Schlüsselwort für den aktuellen Status der Warnung.
SevereWeatherAlert	Informationen zu einer Unwetterwarnung.
SevereWeatherAlertDescription	Beschreibung einer Unwetterwarnung.
SevereWeatherAlertsResult	Dieses Objekt wird von einem erfolgreichen Aufruf Get Unwetterwarnungen zurückgegeben.

AlertArea

Informationen zu einer Unwetterwarnung, die in einem/den betroffenen Gebiet(en) ausgegeben wird. Wenn mehrere Warnungen für denselben Speicherort aktiv sind, werden die Warnungen in der Reihenfolge innerhalb der priority API-Antwort zurückgegeben, wobei die Warnung mit der höchsten Priorität am Anfang der Antwort zurückgegeben wird.

Name	Typ	Beschreibung
alertDetails	string	Vollständige Details, die der Warnung zugeordnet sind. Wird zurückgegeben, wenn `details`=True. Dieses Feld wird immer in den Sprachen der Wahl vom ausstellenden Anbieter zurückgegeben, und Azure Maps gibt nur das zurück, was vom Anbieter erstellt wird. Bitte beachten Sie, dass einige Länder/Regionen möglicherweise ihre Muttersprache und Englisch anbieten. Der Language-Parameter gilt nicht für dieses Feld.
alertDetailsLanguageCode	string	Sprache von `alertDetails`. Dieses Feld weist darauf hin, dass sich die Sprache von `alertDetails` vom angeforderten Sprachparameter unterscheiden kann. Wird zurückgegeben, wenn `details`=True. Der Sprachcode wurde von den ISO 639-1 Alpha-2-Codes abgeleitet.
endTime	string	Das Enddatum und die Uhrzeit der Warnung im ISO 8601-Format, z. B. 2019-10-27T19:39:57-08:00. Wenn die Warnung mehrere Zeitzonen überschreitet, ist die in der Antwort zurückgegebene Zeit die Ortszeit zum angeforderten Koordinatenstandort.
latestStatus	LatestStatus	Der aktuelle Status der Warnung im aktuellen Bereich.
name	string	Der Name eines Bereichs, der von der Warnung betroffen ist. Der angeforderte Standort fällt unter den Warnungsbereich.
startTime	string	Das Startdatum und die Uhrzeit der Warnung im ISO 8601-Format, z. B. 2019-10-27T19:39:57-08:00. Wenn die Warnung mehrere Zeitzonen überschreitet, ist die in der Antwort zurückgegebene Zeit die Ortszeit zum angeforderten Koordinatenstandort.
summary	string	Text, der die Warnung im zurückgegebenen Bereich zusammenfasst.

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.

JsonFormat

Das gewünschte Format der Antwort. Nur das json-Format wird unterstützt.

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation

LatestStatus

Der aktuelle Status der Warnung im aktuellen Bereich.

Name	Typ	Beschreibung
english	LatestStatusKeyword	Latest status keyword for the alert, in English (en-US).
localized	string	Das schlüsselwort latest status für die Warnung in der angegebenen Sprache. Standardmäßig wird in Englisch (en-US) zurückgegeben.

LatestStatusKeyword

Schlüsselwort für den aktuellen Status der Warnung.

Name	Typ	Beschreibung
Cancel	string	"Abbrechen": Die Warnung wurde vor der ursprünglichen Ablaufzeit abgebrochen.
Continue	string	"Continue": Die Warnung wurde seit ihrer ersten Veröffentlichung aktualisiert, aber es wurden keine Änderungen an `alertDetails`, `startTime`, `endTime`oder `class`vorgenommen.
Correct	string	"Richtig": Die Warnung wurde geändert, um einen vorherigen Fehler zu korrigieren.
Expire	string	"Ablauf" – Die Warnung ist abgelaufen und nicht mehr aktiv.
Extend	string	"Erweitern": Die Warnung wurde seit ihrer ersten Veröffentlichung zeitlich, im Bereich oder beides erweitert.
New	string	"Neu": Der Status einer Warnung bei der ersten Ausstellung.
Update	string	"Update": Die Warnung wurde seit ihrer ersten Veröffentlichung aktualisiert.
Upgrade	string	"Upgrade": Die Warnung wurde seit ihrer ersten Veröffentlichung auf eine höhere Klasse oder Kategorie aktualisiert.

SevereWeatherAlert

Informationen zu einer Unwetterwarnung.

Name	Typ	Beschreibung
alertAreas	AlertArea[]	Informationen zur Warnung, die für die betroffenen Bereiche spezifisch sind.
alertId	integer	Ein eindeutiger numerischer Bezeichner für eine Wetterwarnung.
category	string	Die Kategorie der Warnung.
class	string	Klassifizierung der Warnung. Dieses Feld ist nicht für alle Länder verfügbar und wird daher nicht immer zurückgegeben.
countryCode	string	2-stellige ISO 3166-1 Alpha-2-Landeskennzahl, z. B. "US".
description	SevereWeatherAlertDescription	Beschreibung der Warnung.
disclaimer	string	Ein Haftungsausschluss in Bezug auf die Quelle der Warnungsinformationen. Dieses Feld ist nicht immer verfügbar. Beispielsweise kann der Haftungsausschluss Details zu den Verzögerungen oder potenziellen Problemen im Zusammenhang mit dem Alarm enthalten.
level	string	Schweregrad der Warnung. Dieses Feld ist nicht für alle Länder verfügbar und wird daher nicht immer zurückgegeben.
priority	integer	Zahl, die die Wichtigkeit oder Rangfolge der angegebenen Warnung innerhalb des Landes/der Region angibt, von dem/der sie stammt. Eine niedrigere Zahl bedeutet eine höhere Priorität. Beispielsweise ist 1 die höchste Priorität. Die Anzahl variiert je nach Land/Region und kann sich im Laufe der Zeit ändern, wenn jedes Land/jede Region seine Warnungssysteme weiterentwickelt.
source	string	Der Anbieter der Warnungsinformationen. Standardmäßig wird die Quelle in Englisch (en-US) zurückgegeben. Die Warnungen stammen von offiziellen staatlichen meteorologischen Behörden und führenden globalen Wetterwarnungsanbietern.
sourceId	integer	Ein numerischer Bezeichner, der dem Quellanbieternamen der Warnungsdaten zugeordnet ist.

SevereWeatherAlertDescription

Beschreibung einer Unwetterwarnung.

Name	Typ	Beschreibung
english	string	Beschreibung der Warnung in Englisch (en-US).
localized	string	Beschreibung der Warnung in der angegebenen Sprache. Standardmäßig wird Englisch (en-US) zurückgegeben, wenn der Sprachparameter in der Anforderung nicht angegeben ist.

SevereWeatherAlertsResult

Dieses Objekt wird von einem erfolgreichen Aufruf Get Unwetterwarnungen zurückgegeben.

Name	Typ	Beschreibung
results	SevereWeatherAlert[]	Eine Liste aller Unwetterwarnungen für den abgefragten Standort.

Freigeben über