Weather - Get Tropical Storm Active

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 {endpoint}/weather/tropical/storms/active/json?api-version=1.1

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)	The Azure Maps service hostname. Use `https://atlas.microsoft.com` for the Azure public cloud. To target a specific Azure Maps geography or a sovereign cloud, see Azure Maps geographic scope.
format	path	True	JsonFormat	Desired format of the response. Only `json` format is supported.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Header

Name	Required	Type	Description
x-ms-client-id		string	Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the Azure Maps management plane Account API. For more information on using Microsoft Entra ID security in Azure Maps, see Manage authentication in Azure Maps.

Responses

Name	Type	Description
200 OK	ActiveStormResult	The request has succeeded.
Other Status Codes	ErrorResponse	An unexpected error response.

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.

Note

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

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: header

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": [
    {
      "name": "Hilda",
      "basinId": "EP",
      "govId": 8,
      "isActive": true,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "TD 9E",
      "basinId": "EP",
      "govId": 9,
      "isActive": true,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "TWELVE",
      "basinId": "NP",
      "govId": 12,
      "isActive": true,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "LUPIT",
      "basinId": "NP",
      "govId": 13,
      "isActive": true,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "FOURTEEN",
      "basinId": "NP",
      "govId": 14,
      "isActive": true,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "FIFTEEN",
      "basinId": "NP",
      "govId": 15,
      "isActive": true,
      "isSubtropical": false,
      "year": "2021"
    }
  ]
}

Definitions

Name	Description
ActiveStorm	A single tropical storm currently active worldwide, returned as one entry in `ActiveStormResult.results`. Each entry summarizes the storm with the identifiers needed to reference it elsewhere in the Get Tropical Storm APIs - the originating ocean basin (`basinId`), the government-issued identifier (`govId`), and the year of origin (`year`) - together with the storm's official name (for example, Hilda or LUPIT) and flags indicating whether it is still active and whether it is classified as subtropical.
ActiveStormResult	The response returned by the Get Tropical Storm Active operation, listing every tropical storm currently active worldwide as reported by national weather forecasting agencies. Each entry in the `results` array is an `ActiveStorm` carrying the storm's name, originating ocean basin, government-issued identifier, year of origin, and active and subtropical status. When the result set is too large to fit in a single response, `nextLink` carries the URL for the next page.
BasinId	The `basinId` enum categorizes the different ocean basins where tropical storms can originate. Each basin is assigned a unique identifier to help specify the location of the storm's origin.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
JsonFormat	Desired format of the response. Only `json` format is supported.

ActiveStorm

Object

A single tropical storm currently active worldwide, returned as one entry in ActiveStormResult.results. Each entry summarizes the storm with the identifiers needed to reference it elsewhere in the Get Tropical Storm APIs - the originating ocean basin (basinId), the government-issued identifier (govId), and the year of origin (year) - together with the storm's official name (for example, Hilda or LUPIT) and flags indicating whether it is still active and whether it is classified as subtropical.

Name	Type	Description
basinId	BasinId	The ocean basin where the tropical storm originated. One of the `BasinId` values - AL (Atlantic), CP (Central Pacific), EP (Eastern Pacific), NI (North Indian), NP (Northwest Pacific), SI (South Indian), or SP (South Pacific). For example, EP for a storm originating in the Eastern Pacific.
govId	integer (int32)	The government-issued identifier assigned to the storm by its national weather forecasting agency, unique within (`basinId`, `year`). Use this together with `basinId` and `year` to reference the storm in the other Get Tropical Storm operations.
isActive	boolean	`true` if the tropical storm is currently active and still being tracked by the issuing agency; `false` if it is no longer active.
isSubtropical	boolean	`true` if the storm is classified as a subtropical cyclone - a hybrid system with characteristics of both tropical and extratropical cyclones; `false` otherwise.
name	string	The official name of the storm as designated by the relevant national weather forecasting agency - for example, Hilda or LUPIT. Storms that have not yet been formally named are typically identified by a placeholder such as TD 9E or a number-word like TWELVE.
year	string	The four-digit calendar year in which the tropical storm originated - for example, 2021. Combined with `basinId` and `govId`, this uniquely identifies the storm across years.

ActiveStormResult

Object

The response returned by the Get Tropical Storm Active operation, listing every tropical storm currently active worldwide as reported by national weather forecasting agencies. Each entry in the results array is an ActiveStorm carrying the storm's name, originating ocean basin, government-issued identifier, year of origin, and active and subtropical status. When the result set is too large to fit in a single response, nextLink carries the URL for the next page.

Name	Type	Description
nextLink	string	The URL to retrieve the next page of results when the response is paginated, suitable for navigating through result sets too large to return in a single call. Empty when there are no further pages.
results	ActiveStorm[]	The currently active tropical storms, with one entry per storm. Each `ActiveStorm` reports the storm's name (for example, Hilda), the originating ocean basin (for example, EP for the Eastern Pacific), the government-issued identifier and year of origin, and whether the storm is still active and whether it is classified as subtropical.

BasinId

Enumeration

The basinId enum categorizes the different ocean basins where tropical storms can originate. Each basin is assigned a unique identifier to help specify the location of the storm's origin.

Value	Description
AL	The Atlantic Ocean. Crucial for tracking hurricanes that affect the Americas and the Caribbean. It is one of the most active regions for tropical storms.
CP	The Central Pacific Ocean. This basin is used for storms affecting Hawaii and surrounding areas.
EP	The Eastern Pacific Ocean. This basin tracks storms impacting the western coast of the Americas, including Mexico and Central America. It is adjacent to the Central Pacific basin.
NI	The North Indian Ocean. This basin covers storms impacting South Asia, including countries like India and Bangladesh, which are frequently affected by cyclones.
NP	The Northwest Pacific Ocean. This basin is important for tracking typhoons that affect East Asia, including countries like China, Japan, and the Philippines. It is the most active tropical storm regions globally.
SI	The South Indian Ocean. This basin, positioned south of the equator, covers cyclones impacting Madagascar, Africa, and surrounding regions.
SP	The South Pacific Ocean. This basin, positioned south of the equator, is relevant for cyclones affecting Australia and the South Pacific islands.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	maps.weather.gettropicalstormactive	The additional info.
type	string	The additional info type.

ErrorDetail

Object

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

Object

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name	Type	Description
error	ErrorDetail	The error object.

JsonFormat

Enumeration

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

Value	Description
json	The JavaScript Object Notation Data Interchange Format