Partager via


Weather - Get Tropical Storm Active

Permet d’obtenir une liste des tempêtes tropicales actives émises par les agences météorologiques nationales.

L’API Get Tropical Storm Active est une requête HTTP GET qui renvoie une liste de toutes les tempêtes tropicales actives émises par le gouvernement. Les informations sur les tempêtes tropicales comprennent, l’identification gouvernementale, l’identification du bassin, l’année d’origine, le nom et s’il s’agit d’une tempête subtropicale.

GET https://atlas.microsoft.com/weather/tropical/storms/active/json?api-version=1.1

Paramètres d’URI

Nom Dans Obligatoire Type Description
format
path True

JsonFormat

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

api-version
query True

string

Numéro de version de l’API Azure Maps.

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-id

string

Indique le compte destiné à être utilisé avec le modèle de sécurité Microsoft Entra ID. Cet ID unique pour le compte Azure Maps peut être obtenu à partir de l’API de compte du plan de gestion Azure Maps. Pour plus d’informations sur l’utilisation de la sécurité Microsoft Entra ID dans Azure Maps, consultez Gérer l’authentification dans Azure Maps.

Réponses

Nom Type Description
200 OK

ActiveStormResult

OK

Other Status Codes

ErrorResponse

Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé à 'accès en fonction du rôle Azure contrôle, 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 Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.

Pour mettre en œuvre 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 la modélisation 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. Celui-ci peut être acquis à partir de l’API de gestion de Maps .

La 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 de l'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 la configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

Type: oauth2
Couler: 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 provisionnée lorsque vous créer un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, CLI, sdk Azure ou API REST.

Avec cette clé, toute 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 elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser les applications clientes confidentielles approche permettant d’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, CLI, azure SDK 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 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, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

Get Tropical Storm Active

Demande d’échantillon

GET https://atlas.microsoft.com/weather/tropical/storms/active/json?api-version=1.1

Exemple de réponse

{
  "results": [
    {
      "year": "2021",
      "basinId": "EP",
      "name": "Hilda",
      "isActive": true,
      "isSubtropical": false,
      "govId": 8
    },
    {
      "year": "2021",
      "basinId": "EP",
      "name": "TD 9E",
      "isActive": true,
      "isSubtropical": false,
      "govId": 9
    },
    {
      "year": "2021",
      "basinId": "NP",
      "name": "TWELVE",
      "isActive": true,
      "isSubtropical": false,
      "govId": 12
    },
    {
      "year": "2021",
      "basinId": "NP",
      "name": "LUPIT",
      "isActive": true,
      "isSubtropical": false,
      "govId": 13
    },
    {
      "year": "2021",
      "basinId": "NP",
      "name": "FOURTEEN",
      "isActive": true,
      "isSubtropical": false,
      "govId": 14
    },
    {
      "year": "2021",
      "basinId": "NP",
      "name": "FIFTEEN",
      "isActive": true,
      "isSubtropical": false,
      "govId": 15
    }
  ]
}

Définitions

Nom Description
ActiveStorm

Fournit des informations essentielles sur les tempêtes tropicales en cours, telles que rapportées par les agences nationales de prévision météorologique.

ActiveStormResult

L’objet ActiveStormResult fournit des informations complètes sur les tempêtes tropicales en cours. Il inclut une série d’objets ActiveStorm , chacun détaillant des attributs spécifiques de chaque tempête. Ces attributs incluent l’identifiant officiel de la tempête, l’identifiant du bassin, l’année d’origine, le nom et le statut subtropical.

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

JsonFormat

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

ActiveStorm

Fournit des informations essentielles sur les tempêtes tropicales en cours, telles que rapportées par les agences nationales de prévision météorologique.

Nom Type Description
basinId

basinId

Classe les différents bassins océaniques où les tempêtes tropicales peuvent se produire. Chaque bassin se voit attribuer un identificateur unique pour aider à spécifier l’emplacement de l’origine de la tempête. Les identifiants valides du bassin incluent AL, CP, EP, NI, NP, SI et SP.

govId

integer (int32)

Un identifiant unique attribué aux tempêtes tropicales par les agences nationales de prévision météorologique. Cet identifiant aide à suivre et à référer précisément des tempêtes spécifiques, y compris leur statut, leur localisation et leur intensité.

isActive

boolean

Indique si la tempête tropicale est actuellement active. Si c’est vrai, la tempête est active ; si faux est fait, la tempête n’est pas active.

isSubtropical

boolean

Une valeur de retour de vrai indique que la tempête est classée comme cyclone subtropical, ce qui signifie qu’elle présente à la fois des caractéristiques tropicales et extratropicales.

name

string

Le nom de la tempête.

year

string

Précise l’année de naissance de la tempête tropicale.

ActiveStormResult

L’objet ActiveStormResult fournit des informations complètes sur les tempêtes tropicales en cours. Il inclut une série d’objets ActiveStorm , chacun détaillant des attributs spécifiques de chaque tempête. Ces attributs incluent l’identifiant officiel de la tempête, l’identifiant du bassin, l’année d’origine, le nom et le statut subtropical.

Nom Type Description
nextLink

string

Contient l’URL pour récupérer la page suivante de résultats si la réponse est paginanée. Cela est utile lorsque la réponse est trop importante pour être retournée en un seul appel, permettant aux utilisateurs de naviguer à travers plusieurs pages de résultats.

results

ActiveStorm[]

Une série d’objets ActiveStorm , chacun fournissant des informations essentielles sur une tempête tropicale en cours, telle que rapportée par les agences nationales de prévision météorologique.

basinId

Identificateur de bassin

Valeur Description
AL

L’océan Atlantique. Crucial pour le suivi des ouragans qui affectent les Amériques et les Caraïbes. C’est l’une des régions les plus actives pour les tempêtes tropicales.

CP

L’océan Pacifique central. Ce bassin est utilisé pour les tempêtes affectant Hawaï et ses environs.

EP

L’est de l’océan Pacifique. Ce bassin suit les tempêtes qui touchent la côte ouest des Amériques, y compris le Mexique et l’Amérique centrale. Il est adjacent au bassin du Pacifique central.

NI

Le nord de l’océan Indien. Ce bassin couvre les tempêtes qui touchent l’Asie du Sud, y compris des pays comme l’Inde et le Bangladesh, qui sont fréquemment touchés par les cyclones.

NP

L’océan Pacifique Nord-Ouest. Ce bassin est important pour le suivi des typhons qui affectent l’Asie de l’Est, y compris des pays comme la Chine, le Japon et les Philippines. C’est la région de tempête tropicale la plus active au monde.

SI

Le sud de l’océan Indien. Ce bassin, positionné au sud de l’équateur, couvre les cyclones qui ont touché Madagascar, l’Afrique et les régions environnantes.

SP

L’océan Pacifique Sud. Ce bassin, situé au sud de l’équateur, est pertinent pour les cyclones affectant l’Australie et les îles du 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émentaire.

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 d’erreur.

JsonFormat

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

Valeur Description
json

le format d’échange de données JavaScript Object Notation