Weather - Get Tropical Storm Forecast

Referenz

Dienst:: Maps

API-Version:: 1.1

Verwenden Sie, um eine Liste der tropischen Stürme zu erhalten, die von nationalen Wettervorhersageagenturen vorhergesagt werden.

Die Get Tropical Storm Forecasts API ist eine HTTP-Anforderung GET , die einzelne von der Regierung ausgegebene Tropische Sturmprognosen zurückgibt. Informationen zu den vorhergesagten tropischen Stürmen umfassen, Standort, Status, Datum der Erstellung der Vorhersage, Fenster, Windgeschwindigkeit und Windradien.

GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}

Mit optionalen Parametern:

GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}&unit={unit}&details={details}&radiiGeometry={radiiGeometry}&windowGeometry={windowGeometry}

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.
basinId	query	True	basinId	Beckenbezeichner
govId	query	True	integer int32	Regierungssturm-ID
year	query	True	integer int32	Jahr des Zyklons
details	query		boolean	Wenn true, sind Zusammenfassungsdaten für Windradien in der Antwort enthalten.
radiiGeometry	query		boolean	Wenn "true", windradi summary data and geoJSON details are included in the response
unit	query		WeatherDataUnit	Gibt an, dass die Daten entweder in Metrikeinheiten oder imperialen Einheiten zurückgegeben werden sollen. Der Standardwert ist Metrik.
windowGeometry	query		boolean	Bei true sind fenstergeometriedaten (geoJSON) in der Antwort enthalten.

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	StormForecastResult	OK
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, 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 jedem 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.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

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.

Der Authorization URL ist spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen. * Die rollenbasierte Zugriffssteuerung in 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 das konfigurationsbasierte Einrichten 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 freigegebener Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal erstellen oder PowerShell, die CLI, Azure SDKs oder die REST-API verwenden.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, den Ansatz vertraulicher Clientanwendungen zu verwenden, um auf Azure Maps-REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Hierbei handelt es sich um 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 autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

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

Get Tropical Storm Forecasts

Beispielanforderung

HTTP

GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year=2021&basinId=NP&govId=2

Beispiel für eine Antwort

Statuscode:: 200

{
  "results": [
    {
      "dateTime": "2021-04-25T06:00:00+00:00",
      "initializedDateTime": "2021-04-24T18:00:00+00:00",
      "location": {
        "latitude": 22,
        "longitude": 137.8
      },
      "maxWindGust": {
        "value": 92.6,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 74.1,
        "unit": "km/h",
        "unitType": 7
      },
      "status": "Tropical Storm",
      "window": {
        "left": {
          "latitude": 22.56387,
          "longitude": 137.739517
        },
        "right": {
          "latitude": 21.4361,
          "longitude": 137.860489
        }
      }
    },
    {
      "dateTime": "2021-04-25T18:00:00+00:00",
      "initializedDateTime": "2021-04-24T18:00:00+00:00",
      "location": {
        "latitude": 23.7,
        "longitude": 142.4
      },
      "maxWindGust": {
        "value": 92.6,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 74.1,
        "unit": "km/h",
        "unitType": 7
      },
      "status": "Tropical Storm",
      "window": {
        "left": {
          "latitude": 24.45283,
          "longitude": 142.055313
        },
        "right": {
          "latitude": 22.94641,
          "longitude": 142.744675
        }
      }
    }
  ]
}

Definitionen

Name	Beschreibung
basinId	Beckenbezeichner
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
GeoJsonGeometry	Ein gültiges `GeoJSON` Geometrieobjekt. Der Typ muss einer der sieben gültigen GeoJSON-Geometrietypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon und GeometryCollection. Weitere Informationen finden Sie unter RFC 7946 .
GeoJsonGeometryCollection	Ein gültiger `GeoJSON GeometryCollection` Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .
GeoJsonLineString	Ein gültiger `GeoJSON LineString` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
GeoJsonMultiLineString	Ein gültiger `GeoJSON MultiLineString` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
GeoJsonMultiPoint	Ein gültiger `GeoJSON MultiPoint` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
GeoJsonMultiPolygon	Ein gültiger `GeoJSON MultiPolygon` Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .
GeoJsonPoint	Ein gültiger `GeoJSON Point` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
GeoJsonPolygon	Ein gültiger `GeoJSON Polygon` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
JsonFormat	Gewünschtes Format der Antwort. Nur das `json`-Format wird unterstützt.
LatLongPair	Ein Standort, der als Breiten- und Längengrad dargestellt wird.
RadiusSector	Lager 0–90 = NE-Quadrant; 90–180 = SE-Quadrant; 180–270 = SW-Quadrant; 270–360 = NW-Quadrant.
StormForecast	Von der Regierung ausgestellte Sturmprognose
StormForecastResult	Liste der von der Regierung ausgegebenen Prognosen
StormWindRadiiSummary	Wird angezeigt, wenn details=true oder radiiGeometry=true in der Anforderung enthalten ist.
UnitType	Numerischer ID-Wert, der dem Typ der angezeigten Einheit zugeordnet ist. Kann für die Einheitsübersetzung verwendet werden. Weitere Informationen finden Sie unter Wetterdienste in Azure Maps .
WeatherDataUnit	Gibt an, dass die Daten entweder in Metrikeinheiten oder imperialen Einheiten zurückgegeben werden sollen. Der Standardwert ist Metrik.
WeatherUnit	Spezifischer Wert einer bestimmten Einheit im Zusammenhang mit dem Wetter.
WeatherWindow	Vorhersagefenster für den Sturm

basinId

Beckenbezeichner

Name	Typ	Beschreibung
AL	string	Atlantik
CP	string	Zentralpazifik
EP	string	Ostpazifik
NI	string	Nordindischer Ozean
NP	string	Nordwestpazifik
SI	string	Südwestindischer Ozean
SP	string	Südpazifik

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.

GeoJsonGeometry

Ein gültiges GeoJSON Geometrieobjekt. Der Typ muss einer der sieben gültigen GeoJSON-Geometrietypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon und GeometryCollection. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
type	GeoJsonObjectType	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonGeometryCollection

Ein gültiger GeoJSON GeometryCollection Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Enthält eine Liste mit gültigen `GeoJSON` Geometrieobjekten. Beachten Sie , dass die Koordinaten in GeoJSON in x,y-Reihenfolge (Längengrad, Breitengrad) liegen.
type	string: GeometryCollection	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonLineString

Ein gültiger GeoJSON LineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
coordinates	number[]	Koordinaten für die `GeoJson LineString` Geometrie.
type	string: LineString	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonMultiLineString

Ein gültiger GeoJSON MultiLineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
coordinates	number[]	Koordinaten für die `GeoJson MultiLineString` Geometrie.
type	string: MultiLineString	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonMultiPoint

Ein gültiger GeoJSON MultiPoint Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
coordinates	number[]	Koordinaten für die `GeoJson MultiPoint` Geometrie.
type	string: MultiPoint	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonMultiPolygon

Ein gültiger GeoJSON MultiPolygon Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
coordinates	number[]	Enthält eine Liste gültiger `GeoJSON Polygon` Objekte. Beachten Sie , dass die Koordinaten in GeoJSON in x,y-Reihenfolge (Längengrad, Breitengrad) liegen.
type	string: MultiPolygon	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonPoint

Ein gültiger GeoJSON Point Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
coordinates	number[]	A `Position` ist ein Array von Zahlen mit zwei oder mehr Elementen. Die ersten beiden Elemente sind Längen- und Breitengrad, genau in dieser Reihenfolge. Altitude/Elevation ist ein optionales drittes Element. Weitere Informationen finden Sie unter RFC 7946 .
type	string: Point	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonPolygon

Ein gültiger GeoJSON Polygon Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
coordinates	number[]	Koordinaten für den `GeoJson Polygon` Geometrietyp.
type	string: Polygon	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

JsonFormat

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

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation

LatLongPair

Ein Standort, der als Breiten- und Längengrad dargestellt wird.

Name	Typ	Beschreibung
latitude	number	Latitude-Eigenschaft
longitude	number	Längengradeigenschaft

RadiusSector

Lager 0–90 = NE-Quadrant; 90–180 = SE-Quadrant; 180–270 = SW-Quadrant; 270–360 = NW-Quadrant.

Name	Typ	Beschreibung
beginBearing	number	Mit dem Anfang des Quadranten in Grad.
endBearing	number	Mit dem Ende des Quadranten in Grad.
range	number	Der Radius des Quadranten in Nautikmeilen.

StormForecast

Von der Regierung ausgestellte Sturmprognose

Name	Typ	Beschreibung
dateTime	string	Datetime ist die Vorhersage gültig und wird im ISO8601 Format angezeigt.
initializedDateTime	string	Datum der Erstellung der Vorhersage, die in ISO8601 Format angezeigt wird.
location	LatLongPair	Koordinaten des Sturms
maxWindGust	WeatherUnit	Maximale Windböengeschwindigkeit im Zusammenhang mit dem Sturm. Kann NULL sein.
status	string	Mögliche Statuswerte sind: Zyklonsturm Sturmtief Depression Extrem schwerer Zyklonsturm Hurrikankategorie (1-5) Intensiver tropischer Zyklon Moderater tropischer Sturm Posttropischer Zyklon Potenzieller tropischer Zyklon Schwerer Zyklonsturm Schwerer tropischer Sturm Subtropisch Superzyklonsturm Tropischer Zyklon Kategorie tropischer Zyklon (1-5) Tropisches Tiefdruckgebiet Tropische Störung Tropischer Sturm Taifun Sehr intensiver tropischer Zyklon Sehr schwerer Zyklonsturm Sehr starker Taifun Heftiger Taifun
sustainedWind	WeatherUnit	Maximale anhaltende Windgeschwindigkeit im Zusammenhang mit dem Sturm. Kann NULL sein.
windRadiiSummary	StormWindRadiiSummary[]	Wird angezeigt, wenn details=true oder radiiGeometry=true in der Anforderung enthalten ist.
window	WeatherWindow	Enthält Informationen zum Vorhersagefenster für den Sturm während des angegebenen Zeitraums (nicht den gesamten Kegel). Wenn windowGeometry=true in der Anforderung enthalten ist, enthält dieses Objekt geoJSON-Details für die Fenstergeometrie.

StormForecastResult

Liste der von der Regierung ausgegebenen Prognosen

Name	Typ	Beschreibung
nextLink	string	Ist der Link zur nächsten Seite der zurückgegebenen Features. Wenn es sich um die letzte Seite handelt, ist dieses Feld nicht vorhanden.
results	StormForecast[]	Liste der von der Regierung ausgegebenen Prognosen

StormWindRadiiSummary

Wird angezeigt, wenn details=true oder radiiGeometry=true in der Anforderung enthalten ist.

Name	Typ	Beschreibung
dateTime	string	DateTime, für die die Windradienzusammenfassungsdaten gültig sind, wird in ISO8601 Format angezeigt.
radiiGeometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	GeoJSON-Objekt. Wird angezeigt, wenn radiiGeometry=true in der Anforderung. Beschreibt die Gliederung der Windradienquadranten.
radiusSectorData	RadiusSector[]	Enthält die Informationen, die zum Zeichnen von Windradienquadranten erforderlich sind. Lager 0–90 = NE-Quadrant; 90–180 = SE-Quadrant; 180–270 = SW-Quadrant; 270–360 = NW-Quadrant.
windSpeed	WeatherUnit	Windgeschwindigkeit, die dem radiusSectorData zugeordnet ist.

UnitType

Numerischer ID-Wert, der dem Typ der angezeigten Einheit zugeordnet ist. Kann für die Einheitsübersetzung verwendet werden. Weitere Informationen finden Sie unter Wetterdienste in Azure Maps .

Name	Typ	Beschreibung
0	Integer
1	Integer
10	Integer
11	Integer
12	Integer
13	Integer
14	Integer
15	Integer
16	Integer
17	Integer
18	Integer
19	Integer
2	Integer
20	Integer
21	Integer
22	Integer
3	Integer
31	Integer
4	Integer
5	Integer
6	Integer
7	Integer
8	Integer
9	Integer

WeatherDataUnit

Gibt an, dass die Daten entweder in Metrikeinheiten oder imperialen Einheiten zurückgegeben werden sollen. Der Standardwert ist Metrik.

Name	Typ	Beschreibung
imperial	string	Gibt Daten in imperialen Einheiten zurück. Einige Beispieleinheiten des imperialen Systems sind Fahrenheit und Meile.
metric	string	Gibt Daten in Metrikeinheiten zurück. Einige Beispieleinheiten des Metriksystems sind Celsius und Kilometer.

WeatherUnit

Spezifischer Wert einer bestimmten Einheit im Zusammenhang mit dem Wetter.

Name	Typ	Beschreibung
unit	string	Einheitstyp für den zurückgegebenen Wert.
unitType	UnitType	Numerischer ID-Wert, der dem Typ der angezeigten Einheit zugeordnet ist. Kann für die Einheitsübersetzung verwendet werden. Weitere Informationen finden Sie unter Wetterdienste in Azure Maps .
value	number	Gerundeter Wert.

WeatherWindow

Vorhersagefenster für den Sturm

Name	Typ	Beschreibung
beginDateTime	string	DateTime des Beginns des Bewegungsfensters, das in ISO8601 Format angezeigt wird.
beginStatus	string	Stormstatus am Anfang des Fensters.
endDateTime	string	DateTime des Endes des Bewegungsfensters, das in ISO8601 Format angezeigt wird.
endStatus	string	Stormstatus am Ende des Fensters.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Wird angezeigt, wenn windowGeometry=true in der Anforderung. GeoJSON-Objekt, das Koordinaten enthält, die das Bewegungsfenster während des angegebenen Zeitrahmens beschreiben.
left	LatLongPair	Position des Punkts auf der linken Seite des Fensters zum Zeitpunkt des Zeitrahmens.
right	LatLongPair	Position des Punkts auf der rechten Seite des Fensters am Ende des Zeitrahmens.

Freigeben über