Weather - Get Minute Forecast

Referência

Service:: Maps

API Version:: 1.1

Use 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 é uma solicitação HTTP GET que retorna previsões minuto a minuto para um determinado local para os próximos 120 minutos. Os usuários podem solicitar previsões do tempo 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, consulte Solicitar dados de previsão do tempo 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 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.
query	query	True	number[]	A consulta aplicável especificada como uma cadeia de caracteres separada por vírgulas composta por latitude seguida por longitude, por exemplo, "47.641268,-122.125679".
interval	query		integer	Especifica o intervalo de tempo em minutos para a previsão do tempo retornada. Os valores com suporte são `1` – Recuperar a previsão para intervalos de 1 minuto. Retornado por padrão. `5` – Recuperar previsões para intervalos de 5 minutos. `15` – Recuperar previsões para intervalos de 15 minutos.
language	query		string	Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de linguagem IETF com suporte, que não diferencia maiúsculas de minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado. Consulte Idiomas com suporte para obter detalhes.

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 Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Nome	Tipo	Description
200 OK	MinuteForecastResult	OK
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

AADToken

Esses são os fluxos 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 Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. 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 Azure Mapas APIs REST.

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 Azure Mapas recurso ao qual 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 Microsoft Entra ID. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Para obter mais informações sobre plataforma de identidade da Microsoft, consulte visão geral plataforma de identidade da Microsoft.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Essa é uma chave compartilhada provisionada quando você Create uma conta Azure Mapas no portal do Azure ou usando 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 master na conta em que elas são emitidas.

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

Type: apiKey
In: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou 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.

Type: apiKey
In: header

Exemplos

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

Sample Request

HTTP

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

Nome	Description
ColorValue
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ForecastInterval
IconCode	Valor numérico que representa uma imagem que exibe o `iconPhrase`. Consulte Serviços meteorológicos em Azure Mapas para obter detalhes.
IntervalSummary
JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.
MinuteForecastResult
MinuteForecastSummary	Resumos de frases para todo o período de previsão.
PrecipitationType	Especifica o tipo de precipitação ("Chuva" "Neve" "Gelo" ou "Mistura"). Se dbz for zero, precipitationType não estará presente na resposta.

ColorValue

Nome	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

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

O detalhe 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.

ForecastInterval

Nome	Tipo	Description
cloudCover	integer	Porcentagem que representa a cobertura de nuvem.
color	ColorValue	A cor do espectro completo que é mapeada para o dBZ (decibéis relativos a Z). Se dbz for zero, a cor não estará 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 exibe o `iconPhrase`. Consulte Serviços meteorológicos em Azure Mapas para obter detalhes.
minute	integer	O primeiro minuto para o intervalo.
precipitationType	PrecipitationType	Especifica o tipo de precipitação ("Chuva" "Neve" "Gelo" ou "Mistura"). Se dbz for zero, precipitationType não estará presente na resposta.
shortPhrase	string	Uma frase 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 o limite. Se dbz for zero, não estará 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 limite. Juntamente com precipitationType, pode ser usado para determinar a simplifiedColor. Se dbz for zero, não estará presente na resposta.

IconCode

Valor numérico que representa uma imagem que exibe o iconPhrase. Consulte Serviços meteorológicos em Azure Mapas para obter detalhes.

Nome	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

Nome	Tipo	Description
briefPhrase	string	Breve frase resumida. O comprimento da frase tem aproximadamente 60 caracteres.
endMinute	integer	O último minuto ao qual o resumo se aplica.
iconCode	IconCode	Valor numérico que representa uma imagem que exibe o `iconPhrase`. Consulte Serviços meteorológicos em Azure Mapas para obter detalhes.
longPhrase	string	Frase resumida longa. O comprimento da frase tem mais de 60 caracteres.
shortPhrase	string	Frase resumida. O comprimento da frase tem aproximadamente 25 caracteres.
startMinute	integer	O primeiro minuto ao qual o resumo se aplica.
totalMinutes	integer	O número de minutos para o qual o resumo se aplica.

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

MinuteForecastResult

Nome	Tipo	Description
intervalSummaries	IntervalSummary[]	Informações resumidas 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 frases para todo o período de previsão.

MinuteForecastSummary

Resumos de frases para todo o período de previsão.

Nome	Tipo	Description
briefPhrase	string	Frase resumida para os próximos 120 minutos. O comprimento da frase tem aproximadamente 60 caracteres.
briefPhrase60	string	Frase resumida para os próximos 60 minutos. O comprimento da frase tem aproximadamente 60 caracteres.
iconCode	IconCode	Valor numérico que representa uma imagem que exibe o `iconPhrase`. Consulte Serviços meteorológicos em Azure Mapas para obter detalhes.
longPhrase	string	Frase resumida longa para os próximos 120 minutos. O comprimento da frase tem mais de 60 caracteres.
shortPhrase	string	Frase resumida curta para os próximos 120 minutos. O comprimento da frase tem aproximadamente 25 caracteres.

PrecipitationType

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

Nome	Tipo	Description
Ice	string	Gelo
Mix	string	Combinação
Rain	string	Chuva
Snow	string	Neve