Weather - Get Severe Weather Alerts

Referência

Service:: Maps

API Version:: 1.1

Utilize para obter informações sobre condições meteorológicas severas, como furacões, trovoadas, inundações, relâmpagos, ondas de calor ou incêndios florestais para um determinado local.

O fenómeno meteorológico severo pode afetar significativamente a nossa vida quotidiana e as nossas operações comerciais. Por exemplo, condições meteorológicas severas como tempestades tropicais, ventos fortes ou inundações podem fechar estradas e forçar as empresas de logística a reencaminhar a sua frota causando atrasos em chegar a destinos e quebrando a cadeia fria de produtos alimentares frigoríficos.

A Get Severe Weather Alerts API é um pedido HTTP GET que devolve os alertas meteorológicos severos que estão disponíveis em todo o mundo das Agências Meteorológicas oficiais do Governo e dos principais fornecedores globais de alertas meteorológicos regionais. O serviço pode devolver detalhes como o tipo de alerta, categoria, nível e descrição detalhada sobre os alertas graves ativos para a localização pedida, como furacões, trovoadas, relâmpagos, ondas de calor ou incêndios florestais. Para obter mais informações, veja Pedir alertas meteorológicos graves

GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query={query}

With optional parameters:

GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query={query}&language={language}&details={details}

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".
details	query		string	Devolva todos os detalhes dos alertas meteorológicos severos. Os valores disponíveis são `true` - Devolve todos os detalhes. Por predefinição, todos os detalhes são devolvidos. `false` - Devolve uma versão truncada dos dados de alertas, que exclui a descrição completa específica da área dos detalhes do alerta (`alertDetails`).
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	SevereWeatherAlertsResult	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.

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

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 severe weather alerts

Sample Request

HTTP

GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query=48.057,-81.091

Sample Response

Status code:: 200

{
  "results": [
    {
      "countryCode": "CA",
      "alertId": 242621,
      "description": {
        "localized": "Heat Warning",
        "english": "Heat Warning"
      },
      "category": "NON-PRECIPITATION",
      "priority": 31,
      "source": "Environment Canada",
      "sourceId": 3,
      "alertAreas": [
        {
          "name": "Kirkland Lake - Englehart",
          "summary": "Heat Warning in effect until Thursday, 3:16 AM EDT.  Source: Environment Canada",
          "startTime": "2020-06-29T19:44:00+00:00",
          "endTime": "2020-07-02T07:16:03+00:00",
          "latestStatus": {
            "localized": "Continue",
            "english": "Continue"
          },
          "alertDetails": "\nA heat event continues through Thursday.\n\nDaytime high temperatures in the low thirties with overnight lows near 18 degrees Celsius are expected to continue until Thursday. Humidex values are expected to reach between 36 and 40 today. Cooler air will move into the region Thursday night. \n\nPlease refer to your public forecast for further details on expected temperatures.\n\nHot and humid air can also bring deteriorating air quality and can result in the air quality health index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nWatch for the effects of heat illness: swelling, rash, cramps, fainting, heat exhaustion, heat stroke and the worsening of some health conditions.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n",
          "alertDetailsLanguageCode": "en-CA"
        }
      ]
    },
    {
      "countryCode": "CA",
      "alertId": 242633,
      "description": {
        "localized": "Heat Warning",
        "english": "Heat Warning"
      },
      "category": "NON-PRECIPITATION",
      "priority": 31,
      "source": "Environment Canada",
      "sourceId": 3,
      "alertAreas": [
        {
          "name": "Kirkland Lake - Englehart",
          "summary": "Heat Warning in effect until 9:25 PM EDT.  Source: Environment Canada",
          "startTime": "2020-07-01T09:25:59+00:00",
          "endTime": "2020-07-02T01:25:59+00:00",
          "latestStatus": {
            "localized": "New",
            "english": "New"
          },
          "alertDetails": "\nA heat event is expected through Thursday.  \n\nDaytime high temperatures in the low thirties on Wednesday and Thursday with overnight lows near 18 degrees Celsius are expected. This heat event may be extended into the weekend with daytime high temperatures near 30 degrees Celsius. \n\nPlease refer to your public forecast for further details on expected temperatures.  \n\nHot and humid air can also bring deteriorating air quality and can result in the Air Quality Health Index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n",
          "alertDetailsLanguageCode": "en-CA"
        }
      ]
    }
  ]
}

Definições

Name	Description
AlertArea	Informações sobre um alerta meteorológico grave emitido numa(s) área(s) afetada(s). Se vários alertas estiverem ativos para a mesma localização, os alertas serão devolvidos por ordem da `priority` resposta da API, com o alerta de prioridade mais alta a ser devolvido na parte superior da resposta.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
JsonFormat	Formato pretendido da resposta. Apenas `json` o formato é suportado.
LatestStatus	O estado mais recente do alerta na área atual.
LatestStatusKeyword	Palavra-chave para o estado mais recente do alerta.
SevereWeatherAlert	Informações sobre um alerta meteorológico severo.
SevereWeatherAlertDescription	Descrição de um alerta meteorológico severo.
SevereWeatherAlertsResult	Este objeto é devolvido a partir de uma chamada receber alertas de mau tempo com êxito.

AlertArea

Informações sobre um alerta meteorológico grave emitido numa(s) área(s) afetada(s). Se vários alertas estiverem ativos para a mesma localização, os alertas serão devolvidos por ordem da priority resposta da API, com o alerta de prioridade mais alta a ser devolvido na parte superior da resposta.

Name	Tipo	Description
alertDetails	string	Detalhes completos associados ao alerta. Devolvido se `details`=Verdadeiro. Este campo é sempre devolvido nos idiomas escolhidos pelo fornecedor emissor e Azure Maps devolve apenas o que é criado pelo fornecedor. Tenha em atenção que alguns países/regiões podem oferecer o seu idioma nativo e inglês. O parâmetro idioma não se aplicará a este campo.
alertDetailsLanguageCode	string	Idioma do `alertDetails`. Este campo ajuda a salientar que o idioma do `alertDetails` pode ser diferente do parâmetro de idioma pedido. Devolvido se `details`=Verdadeiro. O código de idioma foi derivado dos códigos ISO 639-1 Alpha-2.
endTime	string	A data e hora de fim do alerta no formato ISO 8601, por exemplo, 2019-10-27T19:39:57-08:00. Se o alerta atravessar vários fusos horários, a hora devolvida na resposta é a hora local para a localização de coordenada pedida.
latestStatus	LatestStatus	O estado mais recente do alerta na área atual.
name	string	O nome de uma área afetada pelo alerta. A localização pedida está na área de alerta.
startTime	string	A data e hora de início do alerta no formato ISO 8601, por exemplo, 2019-10-27T19:39:57-08:00. Se o alerta atravessar vários fusos horários, a hora devolvida na resposta é a hora local para a localização de coordenada pedida.
summary	string	Texto a resumir o alerta na área devolvida.

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.

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

LatestStatus

O estado mais recente do alerta na área atual.

Name	Tipo	Description
english	LatestStatusKeyword	Palavra-chave de estado mais recente para o alerta, em inglês (en-US).
localized	string	A palavra-chave de estado mais recente do alerta, no idioma especificado. Por predefinição, devolvido em inglês (en-US).

LatestStatusKeyword

Palavra-chave para o estado mais recente do alerta.

Name	Tipo	Description
Cancel	string	"Cancelar" – o alerta foi cancelado antes do tempo de expiração original.
Continue	string	"Continue" – o alerta foi atualizado desde a emissão inicial, mas não foram efetuadas alterações a `alertDetails`, `startTime`, `endTime`ou `class`.
Correct	string	"Correto" – o alerta foi modificado para corrigir um erro anterior.
Expire	string	"Expire" – o alerta expirou e já não está ativo.
Extend	string	"Expandir" – o alerta foi expandido no tempo, na área ou ambos desde a emissão inicial.
New	string	"Novo" – o estado de um alerta após a emissão inicial.
Update	string	"Update" - o alerta foi atualizado desde a emissão inicial.
Upgrade	string	"Upgrade" – o alerta foi atualizado para uma classe ou categoria superior desde a emissão inicial.

SevereWeatherAlert

Informações sobre um alerta meteorológico severo.

Name	Tipo	Description
alertAreas	AlertArea[]	Informações sobre o alerta específico das áreas afetadas.
alertId	integer	Um identificador numérico exclusivo para um alerta meteorológico.
category	string	Categoria do alerta.
class	string	Classificação do alerta. Este campo não está disponível para todos os países e, portanto, nem sempre é devolvido.
countryCode	string	Código de país ISO 3166-1 Alfa-2 de 2 carateres, por exemplo, "E.U.A.".
description	SevereWeatherAlertDescription	Descrição do alerta.
disclaimer	string	Uma exclusão de responsabilidade relativamente à origem das informações do alerta. Este campo nem sempre está disponível. Por exemplo, a exclusão de responsabilidade pode incluir detalhes sobre os atrasos ou potenciais problemas relacionados com o alarme.
level	string	Nível de gravidade do alerta. Este campo não está disponível para todos os países e, portanto, nem sempre é devolvido.
priority	integer	Número que significa a importância ou ordem de classificação do alerta indicado no país/região de origem. Um número mais baixo significa uma prioridade mais alta. Por exemplo, 1 é a prioridade mais alta. O número varia de país/região e pode mudar ao longo do tempo à medida que cada país/região evolui os seus sistemas de alertas.
source	string	O fornecedor das informações de alerta. Por predefinição, a origem é devolvida em inglês (en-US). Os alertas são das Agências Meteorológicas oficiais do Governo e dos principais fornecedores globais de alertas meteorológicos.
sourceId	integer	Um identificador numérico associado ao nome do fornecedor de origem dos dados de alerta.

SevereWeatherAlertDescription

Descrição de um alerta meteorológico severo.

Name	Tipo	Description
english	string	Descrição do alerta em inglês (en-US).
localized	string	Descrição do alerta no idioma especificado. Por predefinição, o inglês (en-US) é devolvido se o parâmetro de idioma não for especificado no pedido.

SevereWeatherAlertsResult

Este objeto é devolvido a partir de uma chamada receber alertas de mau tempo com êxito.

Name	Tipo	Description
results	SevereWeatherAlert[]	Uma lista de todos os alertas meteorológicos severos para a localização consultada.