Weather - Get Tropical Storm Active

Référence

Service:: Maps

Version d'API:: 1.1

Utilisez pour obtenir une liste des tempêtes tropicales actives émises par les agences nationales de prévision météorologique.

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

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

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.

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	ActiveStormResult	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 Active

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "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	Tempête active émise par le gouvernement
ActiveStormResult	Toutes les tempêtes actives émises par le gouvernement
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 le format `json` est pris en charge.

ActiveStorm

Tempête active émise par le gouvernement

Nom	Type	Description
basinId	basinId	Identificateur de bassin (AL, EP, SI, NI, CP, NP, SP)
govId	integer	ID de tempête du gouvernement. Cela correspond au nombre de dépression.
isActive	boolean	True si la dépression a été mise à jour récemment.
isSubtropical	boolean	Vrai quand la dépression est classée comme un cyclone subtropical.
name	string	Nom de la dépression.
year	string	Année d’origine

ActiveStormResult

Toutes les tempêtes actives é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	ActiveStorm[]	Toutes les tempêtes actives émises par le gouvernement

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

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

Partager via