Weather - Get Tropical Storm Forecast

Référence

Service:: Maps

Version d'API:: 1.1

Utilisez pour obtenir une liste des tempêtes tropicales prévues par les agences météorologiques nationales.

L’API Get Tropical Storm Forecasts est une requête HTTP GET qui retourne des prévisions de tempête tropicale émises par le gouvernement. Les informations sur les tempêtes tropicales prévues incluent, l’emplacement, l’état, la date de création de la prévision, la fenêtre, la vitesse du vent et les rayons du vent.

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

Avec des paramètres facultatifs:

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}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
format	path	True	JsonFormat	Format souhaité de la réponse. Seul le format `json` est pris en charge.
api-version	query	True	string	Numéro de version de l’API Azure Maps.
basinId	query	True	basinId	Identificateur de bassin
govId	query	True	integer int32	ID de tempête du gouvernement
year	query	True	integer int32	Année du ou des cyclones
details	query		boolean	Lorsque la valeur est true, les données récapitulatives des rayons du vent sont incluses dans la réponse
radiiGeometry	query		boolean	Lorsque la valeur est true, les données récapitulatives des rayons du vent et les détails geoJSON sont inclus dans la réponse
unit	query		WeatherDataUnit	Spécifie de renvoyer les données en unités métriques ou en unités impériales. La valeur par défaut est métrique.
windowGeometry	query		boolean	Lorsque la valeur est true, les données géométriques de fenêtre (geoJSON) sont incluses dans la réponse

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Spécifie quel compte est destiné à être utilisé conjointement avec le modèle de sécurité de l’ID Microsoft Entra. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API Compte du plan de gestion Azure Maps. Pour utiliser la sécurité des ID Microsoft Entra dans Azure Maps, consultez les articles suivants pour obtenir des conseils.

Réponses

Nom	Type	Description
200 OK	StormForecastResult	Ok
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux OAuth Microsoft Entra 2.0 . Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure , il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Ou sous-ressources Azure Maps. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations aux API REST Azure Maps.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion Maps .

Authorization URL est spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST. * L’utilisation du KIT de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

Pour plus d’informations sur la plateforme d’identités Microsoft, consultez Vue d’ensemble de la plateforme d’identités Microsoft.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

subscription-key

Il s’agit d’une clé partagée qui est provisionnée lorsque vous créez un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, de l’interface CLI, des SDK Azure ou de l’API REST.

Avec cette clé, n’importe quelle application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé principale dans le compte dans lequel elle est émise.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’approche des applications clientes confidentielles pour accéder aux API REST Azure Maps afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
Dans: query

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle de grain précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, notre recommandation est de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

Get Tropical Storm Forecasts

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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
        }
      }
    }
  ]
}

Définitions

Nom	Description
basinId	Identificateur de bassin
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
GeoJsonGeometry	Objet geometry valide `GeoJSON` . Le type doit être l’un des sept types géométriques GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon et GeometryCollection. Pour plus d’informations, consultez RFC 7946 .
GeoJsonGeometryCollection	Type d’objet valide `GeoJSON GeometryCollection` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonLineString	Type de géométrie valide `GeoJSON LineString` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonMultiLineString	Type de géométrie valide `GeoJSON MultiLineString` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonMultiPoint	Type de géométrie valide `GeoJSON MultiPoint` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonMultiPolygon	Type d’objet valide `GeoJSON MultiPolygon` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonPoint	Type de géométrie valide `GeoJSON Point` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonPolygon	Type de géométrie valide `GeoJSON Polygon` . Pour plus d’informations, consultez RFC 7946 .
JsonFormat	Format souhaité de la réponse. Seul le format `json` est pris en charge.
LatLongPair	Emplacement représenté sous la forme d’une latitude et d’une longitude.
RadiusSector	Portant 0 à 90 = quadrant NE ; 90 à 180 = quadrant SE ; 180 à 270 = quadrant SW ; 270 à 360 = quadrant NW.
StormForecast	Prévisions de tempête émises par le gouvernement
StormForecastResult	Liste des prévisions émises par le gouvernement
StormWindRadiiSummary	Affiché lorsque details=true ou radiiGeometry=true dans la requête.
UnitType	Valeur d’ID numérique associée au type d’unité affichée. Peut être utilisé pour la traduction d’unités. Pour plus d’informations, reportez-vous aux services météorologiques dans Azure Maps .
WeatherDataUnit	Spécifie de retourner les données en unités métriques ou en unités impériales. La valeur par défaut est métrique.
WeatherUnit	Valeur spécifique d’une unité donnée liée à la météo.
WeatherWindow	Fenêtre de prévision de la tempête

basinId

Identificateur de bassin

Nom	Type	Description
AL	string	Atlantique
CP	string	Pacifique centre
EP	string	Pacifique Est
NI	string	Océan Indien nord
NP	string	Pacifique Nord-Ouest
SI	string	Sud-Ouest de l’océan Indien
SP	string	Pacifique Sud

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet error.

GeoJsonGeometry

Objet geometry valide GeoJSON . Le type doit être l’un des sept types géométriques GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon et GeometryCollection. Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
type	GeoJsonObjectType	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonGeometryCollection

Type d’objet valide GeoJSON GeometryCollection . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Contient une liste d’objets geometry valides `GeoJSON` . Notez que les coordonnées dans GeoJSON sont dans l’ordre x, y (longitude, latitude).
type	string: GeometryCollection	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonLineString

Type de géométrie valide GeoJSON LineString . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées de la `GeoJson LineString` géométrie.
type	string: LineString	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonMultiLineString

Type de géométrie valide GeoJSON MultiLineString . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées de la `GeoJson MultiLineString` géométrie.
type	string: MultiLineString	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonMultiPoint

Type de géométrie valide GeoJSON MultiPoint . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées de la `GeoJson MultiPoint` géométrie.
type	string: MultiPoint	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonMultiPolygon

Type d’objet valide GeoJSON MultiPolygon . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Contient une liste d’objets valides `GeoJSON Polygon` . Notez que les coordonnées dans GeoJSON sont dans l’ordre x, y (longitude, latitude).
type	string: MultiPolygon	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonPoint

Type de géométrie valide GeoJSON Point . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Un `Position` est un tableau de nombres avec au moins deux éléments. Les deux premiers éléments sont la longitude et la latitude, précisément dans cet ordre. Altitude/Altitude est un troisième élément facultatif. Pour plus d’informations, consultez RFC 7946 .
type	string: Point	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonPolygon

Type de géométrie valide GeoJSON Polygon . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées du `GeoJson Polygon` type geometry.
type	string: Polygon	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

JsonFormat

Format souhaité de la réponse. Seul le format json est pris en charge.

Nom	Type	Description
json	string	Format d’échange de données de notation d’objet JavaScript

LatLongPair

Emplacement représenté sous la forme d’une latitude et d’une longitude.

Nom	Type	Description
latitude	number	Latitude, propriété
longitude	number	Longitude, propriété

RadiusSector

Portant 0 à 90 = quadrant NE ; 90 à 180 = quadrant SE ; 180 à 270 = quadrant SW ; 270 à 360 = quadrant NW.

Nom	Type	Description
beginBearing	number	Portant, en degrés, du début du quadrant.
endBearing	number	Portant, en degrés, de la fin du quadrant.
range	number	Rayon du quadrant, en milles marins.

StormForecast

Prévisions de tempête émises par le gouvernement

Nom	Type	Description
dateTime	string	Dateheure de la prévision valide, affichée au format ISO8601.
initializedDateTime	string	Date et heure de création de la prévision, affichée au format ISO8601.
location	LatLongPair	Coordonnées de la tempête
maxWindGust	WeatherUnit	Vitesse maximale des rafales de vent associée à la tempête. Peut être NULL.
status	string	Les valeurs d’état possibles sont les suivantes : Tempête cyclonique Dépression profonde Dépression Tempête cyclonique extrêmement sévère Catégorie ouragan (1-5) Cyclone tropical intense Tempête tropicale modérée Cyclone post-tropical Cyclone tropical potentiel Tempête cyclonique sévère Tempête tropicale sévère Subtropical Super tempête cyclonique Cyclone tropical Catégorie de cyclones tropicaux (1-5) Dépression tropicale Perturbation tropicale Tempête tropicale Typhon Cyclone tropical très intense Tempête cyclonique très sévère Typhon très fort Typhon violent
sustainedWind	WeatherUnit	Vitesse maximale soutenue du vent associée à la tempête. Peut être NULL.
windRadiiSummary	StormWindRadiiSummary[]	Affiché lorsque details=true ou radiiGeometry=true dans la requête.
window	WeatherWindow	Contient des informations sur la fenêtre de prévision de l’orage pendant la période spécifiée (et non le cône entier). Si windowGeometry=true dans la requête, cet objet inclut les détails geoJSON pour la géométrie de la fenêtre.

StormForecastResult

Liste des prévisions émises par le gouvernement

Nom	Type	Description
nextLink	string	est le lien vers la page suivante des fonctionnalités retournées. S’il s’agit de la dernière page, non ce champ.
results	StormForecast[]	Liste des prévisions émises par le gouvernement

StormWindRadiiSummary

Affiché lorsque details=true ou radiiGeometry=true dans la requête.

Nom	Type	Description
dateTime	string	DateTime pour laquelle les données récapitulatives de rayons de vent sont valides, affichées au format ISO8601.
radiiGeometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Objet GeoJSON. Affiché lorsque radiiGeometry=true dans la demande. Décrit le contour des quadrants du rayon du vent.
radiusSectorData	RadiusSector[]	Contient les informations nécessaires pour tracer les quadrants de rayon de vent. Portant 0 à 90 = quadrant NE ; 90 à 180 = quadrant SE ; 180–270 = quadrant SW ; 270–360 = quadrant NW.
windSpeed	WeatherUnit	Vitesse du vent associée à radiusSectorData.

UnitType

Valeur d’ID numérique associée au type d’unité affichée. Peut être utilisé pour la traduction d’unités. Pour plus d’informations, reportez-vous aux services météorologiques dans Azure Maps .

Nom	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

Spécifie de retourner les données en unités métriques ou en unités impériales. La valeur par défaut est métrique.

Nom	Type	Description
imperial	string	Retourner des données en unités impériales. Quelques exemples d’unités du système impérial sont Fahrenheit et mile.
metric	string	Retourner des données en unités métriques. Quelques exemples d’unités de système métrique sont Celsius et km.

WeatherUnit

Valeur spécifique d’une unité donnée liée à la météo.

Nom	Type	Description
unit	string	Type d’unité pour la valeur retournée.
unitType	UnitType	Valeur d’ID numérique associée au type d’unité affichée. Peut être utilisé pour la traduction d’unités. Pour plus d’informations, reportez-vous aux services météorologiques dans Azure Maps .
value	number	Valeur arrondie.

WeatherWindow

Fenêtre de prévision de la tempête

Nom	Type	Description
beginDateTime	string	DateTime du début de la fenêtre de mouvement, affichée au format ISO8601.
beginStatus	string	État storm au début de la fenêtre.
endDateTime	string	DateTime de la fin de la fenêtre de mouvement, affichée au format ISO8601.
endStatus	string	État storm à la fin de la fenêtre.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Affiché lorsque windowGeometry=true dans la demande. Objet GeoJSON contenant des coordonnées décrivant la fenêtre de mouvement pendant la période spécifiée.
left	LatLongPair	Emplacement du point sur le côté gauche de la fenêtre au moment de la période.
right	LatLongPair	Emplacement du point sur le côté droit de la fenêtre à la fin de la période.

Partager via