Weather - Get Tropical Storm Active

Reference

Service:: Maps

API Version:: 1.1

Use to get a list of the active tropical storms issued by national weather forecasting agencies.

The Get Tropical Storm Active API is an HTTP GET request that returns a list of all government-issued active tropical storms. Information about the tropical storms includes, government ID, basin ID, year of origin, name and if it is subtropical.

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

URI Parameters

Name	In	Required	Type	Description
format	path	True	JsonFormat	Desired format of the response. Only `json` format is supported.
api-version	query	True	string	Version number of Azure Maps API.

Request Header

Name	Required	Type	Description
x-ms-client-id		string	Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following articles for guidance.

Responses

Name	Type	Description
200 OK	ActiveStormResult	OK
Other Status Codes	ErrorResponse	An unexpected error occurred.

Security

AADToken

These are the Microsoft Entra OAuth 2.0 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Notes

This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.

The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. * The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs. * Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.

For more information on Microsoft identity platform, see Microsoft identity platform overview.

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

This is a shared key that is provisioned when you Create an Azure Maps account in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.

With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.

For publicly exposed applications, our recommendation is to use the confidential client applications approach to access Azure Maps REST APIs so your key can be securely stored.

Type: apiKey
In: query

SAS Token

This is a shared access signature token is created from the List SAS operation on the Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.

For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the Map account resource to limit rendering abuse and regularly renew the SAS Token.

Type: apiKey
In: header

Examples

Get Tropical Storm Active

Sample request

HTTP

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

Sample response

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

Definitions

Name	Description
ActiveStorm	Government-issued active storm
ActiveStormResult	All government-issued active storms
basinId	Basin identifier
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
JsonFormat	Desired format of the response. Only `json` format is supported.

ActiveStorm

Government-issued active storm

Name	Type	Description
basinId	basinId	Basin identifier (AL, EP, SI, NI, CP, NP, SP)
govId	integer	Government storm ID. This will match the depression number.
isActive	boolean	True if the depression has been updated recently.
isSubtropical	boolean	True when the depression is classified as a subtropical cyclone.
name	string	The name of the depression.
year	string	Year of origination

ActiveStormResult

All government-issued active storms

Name	Type	Description
nextLink	string	The is the link to the next page of the features returned. If it's the last page, no this field.
results	ActiveStorm[]	All government-issued active storms

basinId

Basin identifier

Name	Type	Description
AL	string	Atlantic
CP	string	Central Pacific
EP	string	Eastern Pacific
NI	string	North Indian Ocean
NP	string	Northwest Pacific
SI	string	Southwest Indian Ocean
SP	string	South Pacific

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

JsonFormat

Desired format of the response. Only json format is supported.

Name	Type	Description
json	string	The JavaScript Object Notation Data Interchange Format

Share via