Compartilhar via

Weather - Get Tropical Storm Forecast

  • Referência
Serviço:
Maps
Versão da API:
1.1

Use para obter uma lista de tempestades tropicais previstas por agências nacionais de previsão do tempo.

A Get Tropical Storm Forecasts API é uma solicitação HTTP GET que retorna previsões individuais de tempestade tropical emitidas pelo governo. Informações sobre as tempestades tropicais previstas incluem, localização, status, data em que a previsão foi criada, janela, velocidade do vento e raios de vento.

GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}
Com parâmetros opcionais: 
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}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
format
 path True

JsonFormat

Formato desejado da resposta. Há suporte apenas para o formato json.
api-version
 query True

string

Número de versão da API de Mapas Azure.
basinId
 query True

basinId

Identificador de bacia
govId
 query True

integer

int32

ID da tempestade do governo
year
 query True

integer

int32

Ano do ciclone
details
 query

boolean

Quando true, os dados de resumo de raios de vento são incluídos na resposta
radiiGeometry
 query

boolean

Quando true, dados de resumo de raios de vento e detalhes geoJSON são incluídos na resposta
unit
 query

WeatherDataUnit

Especifica para retornar os dados em unidades de métrica ou em unidades imperiais. O valor padrão é métrica.
windowGeometry
 query

boolean

Quando true, os dados de geometria de janela (geoJSON) são incluídos na resposta

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-client-id

string

Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança da ID do Microsoft Entra. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança do Microsoft Entra ID no Azure Mapas, confira os artigos a seguir para obter diretrizes .

Respostas

Nome Tipo Description
200 OK

StormForecastResult

OK
Other Status Codes

ErrorResponse

Erro inesperado.

Segurança

AADToken

Estes são os Fluxos do Microsoft Entra OAuth 2.0 . Quando emparelhado com o controle de acesso baseado em função do Azure , ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Mapas.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observações

  • Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas .

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada quando você cria uma conta do Azure Mapas no portal do Azure ou usa o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar APIs REST do Azure Mapas para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado à expiração, taxa e regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta do Mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Get Tropical Storm Forecasts

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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
        }
      }
    }
  ]
}

Definições

Nome Description
basinId

Identificador de bacia
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail

Os detalhes do erro.
ErrorResponse

Resposta de erro
GeoJsonGeometry

Um objeto de geometria válido GeoJSON . O tipo deve ser um dos sete tipos de geometria GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
GeoJsonGeometryCollection

Um tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obter detalhes.
GeoJsonLineString

Um tipo de geometria válido GeoJSON LineString . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiLineString

Um tipo de geometria válido GeoJSON MultiLineString . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPoint

Um tipo de geometria válido GeoJSON MultiPoint . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPolygon

Um tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obter detalhes.
GeoJsonPoint

Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.
GeoJsonPolygon

Um tipo de geometria válido GeoJSON Polygon . Consulte RFC 7946 para obter detalhes.
JsonFormat

Formato desejado da resposta. Há suporte apenas para o formato json.
LatLongPair

Um local representado como latitude e longitude.
RadiusSector

Rolamento de 0 a 90 = quadrante NE; 90 a 180 = quadrante SE; 180 a 270 = quadrante SW; 270–360 = quadrante NW.
StormForecast

Previsão de tempestade emitida pelo governo
StormForecastResult

A lista de previsões emitidas pelo governo
StormWindRadiiSummary

Exibido quando details=true ou radiiGeometry=true na solicitação.
UnitType

Valor de ID numérica associado ao tipo de unidade que está sendo exibida. Pode ser usado para tradução de unidade. Consulte Serviços meteorológicos no Azure Mapas para obter detalhes.
WeatherDataUnit

Especifica para retornar os dados em unidades de métrica ou em unidades imperiais. O valor padrão é métrica.
WeatherUnit

Valor específico de uma determinada unidade relacionada ao clima.
WeatherWindow

Janela de previsão para a tempestade

basinId

Identificador de bacia

Nome Tipo Description
AL

string

Atlântico
CP

string

Pacífico Central
EP

string

Pacífico Oriental
NI

string

Oceano Índico Norte
NP

string

Noroeste do Pacífico
SI

string

Sudoeste do Oceano Índico
SP

string

Sul do Pacífico

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Os detalhes do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

GeoJsonGeometry

Um objeto de geometria válido GeoJSON . O tipo deve ser um dos sete tipos de geometria GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
type

GeoJsonObjectType

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonGeometryCollection

Um tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
geometries GeoJsonGeometry[]:

Contém uma lista de objetos de geometria válidos GeoJSON . Observe que as coordenadas em GeoJSON estão em ordem x, y (longitude, latitude).
type string:

GeometryCollection

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonLineString

Um tipo de geometria válido GeoJSON LineString . Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[]

Coordenadas para a GeoJson LineString geometria.
type string:

LineString

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiLineString

Um tipo de geometria válido GeoJSON MultiLineString . Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[]

Coordenadas para a GeoJson MultiLineString geometria.
type string:

MultiLineString

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPoint

Um tipo de geometria válido GeoJSON MultiPoint . Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[]

Coordenadas para a GeoJson MultiPoint geometria.
type string:

MultiPoint

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPolygon

Um tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[]

Contém uma lista de objetos válidos GeoJSON Polygon . Observe que as coordenadas em GeoJSON estão em ordem x, y (longitude, latitude).
type string:

MultiPolygon

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPoint

Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[]

Um Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são longitude e latitude, precisamente nessa ordem. Altitude/Elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.
type string:

Point

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPolygon

Um tipo de geometria válido GeoJSON Polygon . Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[]

Coordenadas para o GeoJson Polygon tipo de geometria.
type string:

Polygon

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

JsonFormat

Formato desejado da resposta. Há suporte apenas para o formato json.

Nome Tipo Description
json

string

O formato de intercâmbio de dados de notação de objeto JavaScript

LatLongPair

Um local representado como latitude e longitude.

Nome Tipo Description
latitude

number

Propriedade Latitude
longitude

number

Propriedade Longitude

RadiusSector

Rolamento de 0 a 90 = quadrante NE; 90 a 180 = quadrante SE; 180 a 270 = quadrante SW; 270–360 = quadrante NW.

Nome Tipo Description
beginBearing

number

Rolamento, em graus, do início do quadrante.
endBearing

number

Rolamento, em graus, do final do quadrante.
range

number

O raio do quadrante, em milhas náuticas.

StormForecast

Previsão de tempestade emitida pelo governo

Nome Tipo Description
dateTime

string

Datetime a previsão é válida, exibida no formato ISO8601.
initializedDateTime

string

Datetime a previsão foi criada, exibida no formato ISO8601.
location

LatLongPair

Coordenadas da tempestade
maxWindGust

WeatherUnit

Velocidade máxima de rajadas de vento associadas à tempestade. Pode ser NULL.
status

string

Os valores de status possíveis incluem:

  • Tempestade ciclônica
  • Depressão profunda
  • Depressão
  • Tempestade ciclônica extremamente severa
  • Categoria de furacão (1-5)
  • Ciclone tropical intenso
  • Tempestade tropical moderada
  • Ciclone pós-tropical
  • Potencial ciclone tropical
  • Tempestade ciclônica severa
  • Tempestade tropical severa
  • Subtropical
  • Tempestade super ciclônica
  • Ciclone tropical
  • Categoria de ciclone tropical (1-5)
  • Depressão tropical
  • Perturbação tropical
  • Tempestade tropical
  • Tufão
  • Ciclone tropical muito intenso
  • Tempestade ciclônica muito severa
  • Tufão muito forte
  • Tufão violento
sustainedWind

WeatherUnit

Velocidade máxima sustentada do vento associada à tempestade. Pode ser NULL.
windRadiiSummary

StormWindRadiiSummary[]

Exibido quando details=true ou radiiGeometry=true na solicitação.
window

WeatherWindow

Contém informações sobre a janela de previsão para o storm durante o período de tempo especificado (não o cone inteiro). Se windowGeometry=true na solicitação, esse objeto incluirá detalhes geoJSON para geometria da janela.

StormForecastResult

A lista de previsões emitidas pelo governo

Nome Tipo Description
nextLink

string

O é o link para a próxima página dos recursos retornados. Se for a última página, não este campo.
results

StormForecast[]

A lista de previsões emitidas pelo governo

StormWindRadiiSummary

Exibido quando details=true ou radiiGeometry=true na solicitação.

Nome Tipo Description
dateTime

string

DateTime para o qual os dados de resumo de raios de vento são válidos, exibidos no formato ISO8601.
radiiGeometry GeoJsonGeometry:

Objeto GeoJSON. Exibido quando radiiGeometry=true na solicitação. Descreve a estrutura de tópicos dos quadrantes de raio de vento.
radiusSectorData

RadiusSector[]

Contém as informações necessárias para plotar quadrantes de raio de vento. Rolamento de 0 a 90 = quadrante NE; 90–180 = quadrante SE; 180–270 = quadrante SW; 270–360 = quadrante NW.
windSpeed

WeatherUnit

Velocidade do vento associada ao radiusSectorData.

UnitType

Valor de ID numérica associado ao tipo de unidade que está sendo exibida. Pode ser usado para tradução de unidade. Consulte Serviços meteorológicos no Azure Mapas para obter detalhes.

Nome Tipo 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

Especifica para retornar os dados em unidades de métrica ou em unidades imperiais. O valor padrão é métrica.

Nome Tipo Description
imperial

string

Retornar dados em unidades imperiais. Algumas unidades de exemplo do sistema imperial são Fahrenheit e mile.
metric

string

Retornar dados em unidades de métrica. Algumas unidades de exemplo do sistema de métricas são Celsius e km.

WeatherUnit

Valor específico de uma determinada unidade relacionada ao clima.

Nome Tipo Description
unit

string

Tipo de unidade para o valor retornado.
unitType

UnitType

Valor de ID numérica associado ao tipo de unidade que está sendo exibida. Pode ser usado para tradução de unidade. Consulte Serviços meteorológicos no Azure Mapas para obter detalhes.
value

number

Valor arredondado.

WeatherWindow

Janela de previsão para a tempestade

Nome Tipo Description
beginDateTime

string

DateTime do início da janela de movimento, exibido no formato ISO8601.
beginStatus

string

Status do storm no início da janela.
endDateTime

string

DateTime do final da janela de movimento, exibido no formato ISO8601.
endStatus

string

Status do storm no final da janela.
geometry GeoJsonGeometry:

Exibido quando windowGeometry=true na solicitação. Objeto GeoJSON que contém coordenadas que descrevem a janela de movimento durante o período especificado.
left

LatLongPair

Local do ponto no lado esquerdo da janela no momento do período de tempo.
right

LatLongPair

Local do ponto no lado direito da janela no final do período de tempo.