Weather - Get Minute Forecast

  • Referência
Service:
Maps
API Version:
1.1

Utilize para obter uma previsão minuto a minuto para os próximos 120 minutos em intervalos de 1, 5 e 15 minutos.

A Get Minute Forecast API é um pedido HTTP GET que devolve previsões minuto a minuto para uma determinada localização durante os próximos 120 minutos. Os utilizadores podem pedir previsões meteorológicas em intervalos de 1, 5 e 15 minutos. A resposta incluirá detalhes como o tipo de precipitação (incluindo chuva, neve ou uma mistura de ambos), hora de início e valor de intensidade de precipitação (dBZ). Para obter mais informações, veja Pedir dados de previsão meteorológica minuto a minuto.

GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query={query}
With optional parameters: 
GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query={query}&interval={interval}&language={language}

Parâmetros do URI

Name Em Necessário Tipo Description
format
 path True

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.
api-version
 query True

string

Número da versão da API Azure Maps.
query
 query True

number[]

A consulta aplicável especificada como uma cadeia separada por vírgulas composta por latitude seguida de longitude, por exemplo, "47.641268,-122.125679".
interval
 query

integer

Especifica o intervalo de tempo em minutos para a previsão meteorológica devolvida. Os valores suportados são

  • 1 - Obtenha a previsão para intervalos de 1 minuto. Devolvido por predefinição.
  • 5 - Obter previsões para intervalos de 5 minutos.
  • 15 - Obter previsões para intervalos de 15 minutos.
language
 query

string

Idioma no qual os resultados da pesquisa devem ser devolvidos. Deve ser uma das etiquetas de linguagem IETF suportadas, não sensível a maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, é utilizado o idioma predefinido.

Consulte idiomas suportados para obter detalhes.

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-id

string

Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps veja os seguintes artigos para obter orientações.

Respostas

Name Tipo Description
200 OK

MinuteForecastResult

OK
Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

  • Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas .

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

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

Esta é uma chave partilhada que é aprovisionada quando Create uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Type: apiKey
In: header

Exemplos

Successfully retrieve minute-by-minute forecasts for a given location

Sample Request

GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query=47.632346,-122.138874&interval=15

Sample Response

Status code:
200 
{
  "summary": {
    "briefPhrase60": "Rain ending in 25 min",
    "shortPhrase": "Rain ending in 25 min",
    "briefPhrase": "Rain ending in 25 min",
    "longPhrase": "Rain ending in 25 min",
    "iconCode": 12
  },
  "intervalSummaries": [
    {
      "startMinute": 0,
      "endMinute": 24,
      "totalMinutes": 25,
      "shortPhrase": "Rain ending in %minute_value min",
      "briefPhrase": "Rain ending in %minute_value min",
      "longPhrase": "Rain ending in %minute_value min",
      "iconCode": 12
    },
    {
      "startMinute": 25,
      "endMinute": 119,
      "totalMinutes": 95,
      "shortPhrase": "No precip for %MINUTE_VALUE min",
      "briefPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "longPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "iconCode": 7
    }
  ],
  "intervals": [
    {
      "startTime": "2019-11-14T15:18:00-08:00",
      "minute": 0,
      "dbz": 23,
      "shortPhrase": "Light Rain",
      "threshold": "LIGHT",
      "color": {
        "red": 8,
        "green": 98,
        "blue": 2,
        "hex": "#086202"
      },
      "simplifiedColor": {
        "red": 35,
        "green": 190,
        "blue": 39,
        "hex": "#23BE27"
      },
      "precipitationType": "Rain",
      "iconCode": 12,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T15:33:00-08:00",
      "minute": 15,
      "dbz": 18,
      "shortPhrase": "Light Rain",
      "threshold": "LIGHT",
      "color": {
        "red": 32,
        "green": 133,
        "blue": 9,
        "hex": "#208509"
      },
      "simplifiedColor": {
        "red": 35,
        "green": 190,
        "blue": 39,
        "hex": "#23BE27"
      },
      "precipitationType": "Rain",
      "iconCode": 12,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T15:48:00-08:00",
      "minute": 30,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:03:00-08:00",
      "minute": 45,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:18:00-08:00",
      "minute": 60,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:33:00-08:00",
      "minute": 75,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:48:00-08:00",
      "minute": 90,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T17:03:00-08:00",
      "minute": 105,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    }
  ]
}

Definições

Name Description
ColorValue
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta a erros
ForecastInterval
IconCode

Valor numérico que representa uma imagem que apresenta o iconPhrase. Veja Serviços de meteorologia no Azure Maps para obter detalhes.
IntervalSummary
JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.
MinuteForecastResult
MinuteForecastSummary

Resumos de expressões para todo o período de previsão.
PrecipitationType

Especifica o tipo de precipitação ("Chuva" "Neve" "Gelo" ou "Mix"). Se dbz for zero, precipitationType não está presente na resposta.

ColorValue

Name Tipo Description
blue

integer

Componente azul do valor RGB
green

integer

Componente verde do valor RGB.
hex

string

Valor de cor hexadecimal.
red

integer

Componente vermelho do valor RGB.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name 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 a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

ForecastInterval

Name Tipo Description
cloudCover

integer

Percentagem que representa a cobertura da cloud.
color

ColorValue

A cor de espectro completa que mapeia para a dBZ (decibéis relativamente a Z). Se dbz for zero, a cor não está presente na resposta.
dbz

number

Uma unidade que representa a intensidade de precipitação prevista.
iconCode

IconCode

Valor numérico que representa uma imagem que apresenta o iconPhrase. Veja Serviços de meteorologia no Azure Maps para obter detalhes.
minute

integer

O primeiro minuto para o intervalo.
precipitationType

PrecipitationType

Especifica o tipo de precipitação ("Chuva" "Neve" "Gelo" ou "Mix"). Se dbz for zero, precipitationType não está presente na resposta.
shortPhrase

string

Uma expressão curta que descreve a condição de precipitação para o intervalo.
simplifiedColor

ColorValue

A cor da banda que mapeia para o tipo de precipitação e limiar. Se dbz for zero, não está presente na resposta.
startTime

string

A data e hora do início do intervalo no formato ISO 8601, por exemplo, 2019-10-27T19:39:57-08:00.
threshold

string

Chave que especifica o valor do limiar. Juntamente com precipitationType, pode ser utilizado para determinar o simplifiedColor. Se dbz for zero, não está presente na resposta.

IconCode

Valor numérico que representa uma imagem que apresenta o iconPhrase. Veja Serviços de meteorologia no Azure Maps para obter detalhes.

Name Tipo Description
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

23

Integer

24

Integer

25

Integer

26

Integer

27

Integer

28

Integer

29

Integer

3

Integer

30

Integer

31

Integer

32

Integer

33

Integer

34

Integer

35

Integer

36

Integer

37

Integer

38

Integer

39

Integer

4

Integer

40

Integer

41

Integer

42

Integer

43

Integer

44

Integer

5

Integer

6

Integer

7

Integer

8

Integer

9

Integer

IntervalSummary

Name Tipo Description
briefPhrase

string

Breve expressão de resumo. O comprimento da expressão tem aproximadamente 60 carateres.
endMinute

integer

O último minuto ao qual se aplica o resumo.
iconCode

IconCode

Valor numérico que representa uma imagem que apresenta o iconPhrase. Veja Serviços de meteorologia no Azure Maps para obter detalhes.
longPhrase

string

Expressão de resumo longo. O comprimento da expressão tem mais de 60 carateres.
shortPhrase

string

Expressão de resumo abreviada. O comprimento da expressão tem aproximadamente 25 carateres.
startMinute

integer

O primeiro minuto ao qual se aplica o resumo.
totalMinutes

integer

O número de minutos para o qual o resumo se aplica.

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.

Name Tipo Description
json

string

O Formato de Intercâmbio de Dados de Notação de Objetos JavaScript

MinuteForecastResult

Name Tipo Description
intervalSummaries

IntervalSummary[]

Informações de resumo para cada intervalo na previsão. Os Resumos dividem cada intervalo potencial em que a precipitação começa e para.
intervals

ForecastInterval[]

Previsão de dados para cada intervalo na previsão.
summary

MinuteForecastSummary

Resumos de expressões para todo o período de previsão.

MinuteForecastSummary

Resumos de expressões para todo o período de previsão.

Name Tipo Description
briefPhrase

string

Expressão de resumo para os próximos 120 minutos. O comprimento da expressão tem aproximadamente 60 carateres.
briefPhrase60

string

Expressão de resumo para os próximos 60 minutos. O comprimento da expressão tem aproximadamente 60 carateres.
iconCode

IconCode

Valor numérico que representa uma imagem que apresenta o iconPhrase. Veja Serviços de meteorologia no Azure Maps para obter detalhes.
longPhrase

string

Expressão de resumo longo para os próximos 120 minutos. O comprimento da expressão tem mais de 60 carateres.
shortPhrase

string

Expressão de resumo breve para os próximos 120 minutos. O comprimento da expressão tem aproximadamente 25 carateres.

PrecipitationType

Especifica o tipo de precipitação ("Chuva" "Neve" "Gelo" ou "Mix"). Se dbz for zero, precipitationType não está presente na resposta.

Name Tipo Description
Ice

string

Ferreira
Mix

string

Mix
Rain

string

Chuva
Snow

string

Neve