Weather - Get Tropical Storm Forecast

Referentie

Service:: Maps

API Version:: 1.1

Gebruik om een lijst op te halen met tropische stormen die zijn voorspeld door nationale weersvoorspellingsbureaus.

De Get Tropical Storm Forecasts API is een HTTP-aanvraag GET die individuele door de overheid uitgegeven tropische stormvoorspellingen retourneert. Informatie over de voorspelde tropische stormen omvat, locatie, status, datum waarop de prognose is gemaakt, venster, windsnelheid en windstralen.

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

With optional parameters:

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-parameters

Name	In	Vereist	Type	Description
format	path	True	JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.
api-version	query	True	string	Versienummer van Azure Maps API.
basinId	query	True	basinId	Bekken-id
govId	query	True	integer int32	Storm-id van overheid
year	query	True	integer int32	Jaar van de cycloon(en)
details	query		boolean	Als waar is, worden de samenvattingsgegevens van de windradii opgenomen in het antwoord
radiiGeometry	query		boolean	Indien waar, worden samenvattingsgegevens van windradii en geoJSON-details opgenomen in het antwoord
unit	query		WeatherDataUnit	Hiermee geeft u op om de gegevens in metrische eenheden of imperiale eenheden te retourneren. De standaardwaarde is metrische waarde.
windowGeometry	query		boolean	Als dit waar is, worden de gegevens van de venstergeometrie (geoJSON) opgenomen in het antwoord

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID-beveiliging in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Antwoorden

Name	Type	Description
200 OK	StormForecastResult	OK
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. In combinatie met op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Als u scenario's wilt implementeren, raden we u aan om verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id header om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps .

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksscenario's.

Zie Microsoft identity platform overzicht voor meer informatie over Microsoft identity platform.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account Creatie in de Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een shared access signature-token dat wordt gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle over het verloop, de snelheid en de gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane oorsprongen te configureren op de resource Van het account toewijzen om misbruik van het genereren te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Get Tropical Storm Forecasts

Sample Request

HTTP

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

Sample Response

Status code:: 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
        }
      }
    }
  ]
}

Definities

Name	Description
basinId	Bekken-id
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GeoJsonGeometry	Een geldig `GeoJSON` geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonGeometryCollection	Een geldig `GeoJSON GeometryCollection` objecttype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonLineString	Een geldig `GeoJSON LineString` geometrietype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonMultiLineString	Een geldig `GeoJSON MultiLineString` geometrietype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonMultiPoint	Een geldig `GeoJSON MultiPoint` geometrietype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonMultiPolygon	Een geldig `GeoJSON MultiPolygon` objecttype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonPoint	Een geldig `GeoJSON Point` geometrietype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonPolygon	Een geldig `GeoJSON Polygon` geometrietype. Raadpleeg RFC 7946 voor meer informatie.
JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.
LatLongPair	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad.
RadiusSector	Dragend 0-90 = NE kwadrant; 90-180 = KWAdrant SE; 180–270 = ZW-kwadrant; 270–360 = NW kwadrant.
StormForecast	Door de overheid uitgegeven stormprognose
StormForecastResult	De lijst met door de overheid uitgegeven prognoses
StormWindRadiiSummary	Weergegeven wanneer details=true of radiiGeometry=true in de aanvraag.
UnitType	Numerieke id-waarde die is gekoppeld aan het type eenheid dat wordt weergegeven. Kan worden gebruikt voor eenheidsvertaling. Raadpleeg Weerservices in Azure Maps voor meer informatie.
WeatherDataUnit	Hiermee geeft u op om de gegevens in metrische eenheden of imperiale eenheden te retourneren. De standaardwaarde is metrische waarde.
WeatherUnit	Specifieke waarde van een bepaalde eenheid met betrekking tot het weer.
WeatherWindow	Prognosevenster voor de storm

basinId

Bekken-id

Name	Type	Description
AL	string	Atlantic
CP	string	Centraal-Pacific
EP	string	Oostelijke Stille Oceaan
NI	string	Noord-Indische Oceaan
NP	string	Noordwest-Pacific
SI	string	Zuidwestelijke Indische Oceaan
SP	string	Australië en Oceanië

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

GeoJsonGeometry

Een geldig GeoJSON geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
type	GeoJsonObjectType	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonGeometryCollection

Een geldig GeoJSON GeometryCollection objecttype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Bevat een lijst met geldige `GeoJSON` geometrieobjecten. Houd er rekening mee dat coördinaten in GeoJSON in de volgorde x, y (lengtegraad, breedtegraad) staan.
type	string: GeometryCollection	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonLineString

Een geldig GeoJSON LineString geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
coordinates	number[]	Coördinaten voor de `GeoJson LineString` geometrie.
type	string: LineString	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonMultiLineString

Een geldig GeoJSON MultiLineString geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
coordinates	number[]	Coördinaten voor de `GeoJson MultiLineString` geometrie.
type	string: MultiLineString	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonMultiPoint

Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
coordinates	number[]	Coördinaten voor de `GeoJson MultiPoint` geometrie.
type	string: MultiPoint	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonMultiPolygon

Een geldig GeoJSON MultiPolygon objecttype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
coordinates	number[]	Bevat een lijst met geldige `GeoJSON Polygon` objecten. Houd er rekening mee dat coördinaten in GeoJSON in de volgorde x, y (lengtegraad, breedtegraad) staan.
type	string: MultiPolygon	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonPoint

Een geldig GeoJSON Point geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
coordinates	number[]	A `Position` is een matrix met getallen met twee of meer elementen. De eerste twee elementen zijn lengtegraad en breedtegraad, precies in die volgorde. Hoogte/hoogte is een optioneel derde element. Raadpleeg RFC 7946 voor meer informatie.
type	string: Point	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonPolygon

Een geldig GeoJSON Polygon geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
coordinates	number[]	Coördinaten voor het `GeoJson Polygon` geometrietype.
type	string: Polygon	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

JsonFormat

Gewenste indeling van het antwoord. Alleen json de indeling wordt ondersteund.

Name	Type	Description
json	string	De JavaScript Object Notation Data Interchange-indeling

LatLongPair

Een locatie die wordt weergegeven als een breedtegraad en lengtegraad.

Name	Type	Description
latitude	number	De eigenschap Breedtegraad
longitude	number	De eigenschap Lengtegraad

RadiusSector

Dragend 0-90 = NE kwadrant; 90-180 = KWAdrant SE; 180–270 = ZW-kwadrant; 270–360 = NW kwadrant.

Name	Type	Description
beginBearing	number	Het dragen, in graden, van het begin van het kwadrant.
endBearing	number	Het dragen, in graden, van het einde van het kwadrant.
range	number	De straal van het kwadrant, in zeemijlen.

StormForecast

Door de overheid uitgegeven stormprognose

Name	Type	Description
dateTime	string	Datum/tijd de prognose geldig is, weergegeven in ISO8601 indeling.
initializedDateTime	string	De datum waarop de prognose is gemaakt, weergegeven in ISO8601 indeling.
location	LatLongPair	Coördinaten van de storm
maxWindGust	WeatherUnit	Maximale windvlaagsnelheid in verband met de storm. Kan NULL zijn.
status	string	Mogelijke statuswaarden zijn: Cyclonische storm Diepe depressie Depressie Extreem zware cyclonische storm Orkaancategorie (1-5) Intense tropische cycloon Gematigde tropische storm Posttropische cycloon Potentiële tropische cycloon Ernstige cyclonische storm Zware tropische storm Subtropische Super cyclonische storm Tropische cycloon Categorie tropische cycloon (1-5) Tropische depressie Tropische verstoring Tropische storm Typhoon Zeer intense tropische cycloon Zeer ernstige cyclonische storm Zeer sterke tyfoon Gewelddadige typhoon
sustainedWind	WeatherUnit	Maximale aanhoudende windsnelheid in verband met de storm. Kan NULL zijn.
windRadiiSummary	StormWindRadiiSummary[]	Weergegeven wanneer details=true of radiiGeometry=true in de aanvraag.
window	WeatherWindow	Bevat informatie over het prognosevenster voor de storm tijdens de opgegeven periode (niet de hele kegel). Als windowGeometry=true in de aanvraag staat, bevat dit object geoJSON-details voor de venstergeometrie.

StormForecastResult

De lijst met door de overheid uitgegeven prognoses

Name	Type	Description
nextLink	string	De is de koppeling naar de volgende pagina van de geretourneerde functies. Als het de laatste pagina is, geen dit veld.
results	StormForecast[]	De lijst met door de overheid uitgegeven prognoses

StormWindRadiiSummary

Weergegeven wanneer details=true of radiiGeometry=true in de aanvraag.

Name	Type	Description
dateTime	string	Datum/tijd waarvoor de samenvattingsgegevens van de windstralen geldig zijn, weergegeven in ISO8601 indeling.
radiiGeometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	GeoJSON-object. Weergegeven wanneer radiiGeometry=true in request. Beschrijft de omtrek van de kwadranten van de windstraal.
radiusSectorData	RadiusSector[]	Bevat de informatie die nodig is om windstraalkwadranten uit te tekenen. Dragend 0-90 = NE kwadrant; 90–180 = KWAdrant SE; 180–270 = SW-kwadrant; 270-360 = NW-kwadrant.
windSpeed	WeatherUnit	Windsnelheid die is gekoppeld aan de radiusSectorData.

UnitType

Numerieke id-waarde die is gekoppeld aan het type eenheid dat wordt weergegeven. Kan worden gebruikt voor eenheidsvertaling. Raadpleeg Weerservices in Azure Maps voor meer informatie.

Name	Type	Description
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

Hiermee geeft u op om de gegevens in metrische eenheden of imperiale eenheden te retourneren. De standaardwaarde is metrische waarde.

Name	Type	Description
imperial	string	Gegevens retourneren in imperiale eenheden. Enkele voorbeelden van imperiale systeem zijn Fahrenheit en mijl.
metric	string	Gegevens retourneren in metrische eenheden. Enkele voorbeeldeenheden van een metriek systeem zijn Celsius en kilometer.

WeatherUnit

Specifieke waarde van een bepaalde eenheid met betrekking tot het weer.

Name	Type	Description
unit	string	Type eenheid voor de geretourneerde waarde.
unitType	UnitType	Numerieke id-waarde die is gekoppeld aan het type eenheid dat wordt weergegeven. Kan worden gebruikt voor eenheidsvertaling. Raadpleeg Weerservices in Azure Maps voor meer informatie.
value	number	Afgeronde waarde.

WeatherWindow

Prognosevenster voor de storm

Name	Type	Description
beginDateTime	string	Datum/tijd van het begin van het verplaatsingsvenster, weergegeven in ISO8601 notatie.
beginStatus	string	Stormstatus aan het begin van het venster.
endDateTime	string	Datum/tijd van het einde van het verplaatsingsvenster, weergegeven in ISO8601 indeling.
endStatus	string	Stormstatus aan het einde van het venster.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Weergegeven wanneer windowGeometry=true in aanvraag. GeoJSON-object met coördinaten die het verplaatsingsvenster tijdens de opgegeven periode beschrijven.
left	LatLongPair	Locatie van het punt aan de linkerkant van het venster op het moment van de periode.
right	LatLongPair	Locatie van het punt aan de rechterkant van het venster aan het einde van de periode.