Weather - Get Severe Weather Alerts

Referência

Service:: Maps

API Version:: 1.1

Use para obter informações sobre condições climáticas severas, como furacões, tempestades, inundações, raios, ondas de calor ou incêndios florestais para um determinado local.

Fenômenos climáticos severos podem afetar significativamente nossa vida cotidiana e operações de negócios. Por exemplo, condições climáticas severas, como tempestades tropicais, ventos fortes ou inundações podem fechar estradas e forçar as empresas de logística a redirecionar sua frota causando atrasos no alcance dos destinos e quebrando a cadeia fria de produtos alimentícios refrigerados.

A Get Severe Weather Alerts API é uma solicitação HTTP GET que retorna os alertas meteorológicos severos que estão disponíveis em todo o mundo de agências meteorológicas oficiais do governo e que levam os provedores globais de alertas meteorológicos regionais. O serviço pode retornar detalhes como tipo de alerta, categoria, nível e descrição detalhada sobre os alertas severos ativos para o local solicitado, como furacões, tempestades, raios, ondas de calor ou incêndios florestais. Para obter mais informações, consulte Solicitar alertas meteorológicos severos

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 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".
details	query		string	Retorne detalhes completos para os alertas meteorológicos severos. Os valores disponíveis são `true` – Retorna detalhes completos. Por padrão, todos os detalhes são retornados. `false` – Retorna 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 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	SevereWeatherAlertsResult	OKEY
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 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

Nome	Description
AlertArea	Informações sobre um alerta meteorológico severo emitido em uma área afetada. Se vários alertas estiverem ativos para o mesmo local, os alertas serão retornados na ordem de dentro da resposta da `priority` API, com o alerta de prioridade mais alta sendo retornado na parte superior da resposta.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.
LatestStatus	O status mais recente no alerta na área atual.
LatestStatusKeyword	Palavra-chave para o status mais recente do alerta.
SevereWeatherAlert	Informações sobre um alerta meteorológico severo.
SevereWeatherAlertDescription	Descrição de um alerta meteorológico severo.
SevereWeatherAlertsResult	Esse objeto é retornado de uma chamada bem-sucedida obter alertas meteorológicos severos.

AlertArea

Informações sobre um alerta meteorológico severo emitido em uma área afetada. Se vários alertas estiverem ativos para o mesmo local, os alertas serão retornados na ordem de dentro da resposta da priority API, com o alerta de prioridade mais alta sendo retornado na parte superior da resposta.

Nome	Tipo	Description
alertDetails	string	Detalhes completos associados ao alerta. Retornado se `details`=True. Esse campo sempre é retornado nos idiomas escolhidos pelo provedor emissor e Azure Mapas retorna apenas o que é criado pelo provedor. Observe que alguns países/regiões podem oferecer seu idioma nativo e inglês. O parâmetro de linguagem não se aplicará a esse campo.
alertDetailsLanguageCode	string	Idioma do `alertDetails`. Esse campo ajuda a apontar que o idioma do `alertDetails` pode ser diferente do parâmetro de linguagem solicitado. Retornado se `details`=True. O código de linguagem foi derivado dos códigos ISO 639-1 Alpha-2.
endTime	string	A data e a hora de término do alerta no formato ISO 8601, por exemplo, 2019-10-27T19:39:57-08:00. Se o alerta cruzar vários fusos horários, a hora retornada na resposta será a hora local para o local da coordenada solicitada.
latestStatus	LatestStatus	O status mais recente do alerta na área atual.
name	string	O nome de uma área afetada pelo alerta. O local solicitado está sob a área de alerta.
startTime	string	A data e a hora de início do alerta no formato ISO 8601, por exemplo, 2019-10-27T19:39:57-08:00. Se o alerta cruzar vários fusos horários, a hora retornada na resposta será a hora local para o local da coordenada solicitada.
summary	string	Texto resumindo o alerta na área retornada.

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.

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

LatestStatus

O status mais recente no alerta na área atual.

Nome	Tipo	Description
english	LatestStatusKeyword	As últimas status palavra-chave para o alerta, em inglês (en-US).
localized	string	O status palavra-chave mais recente para o alerta, no idioma especificado. Por padrão, retornado em inglês (en-US).

LatestStatusKeyword

Palavra-chave para o status mais recente do alerta.

Nome	Tipo	Description
Cancel	string	"Cancelar" – o alerta foi cancelado antes do tempo de expiração original.
Continue	string	"Continuar" – o alerta foi atualizado desde sua emissão inicial, mas nenhuma alteração foi feita em `alertDetails`, `startTime`, `endTime`ou `class`.
Correct	string	"Correto" – o alerta foi modificado para corrigir um erro anterior.
Expire	string	"Expirar" – o alerta expirou e não está mais ativo.
Extend	string	"Estender" – o alerta foi estendido a tempo, na área ou em ambos desde sua emissão inicial.
New	string	"Novo" – o status de um alerta após a emissão inicial.
Update	string	"Atualização" – o alerta foi atualizado desde sua emissão inicial.
Upgrade	string	"Upgrade" – o alerta foi atualizado para uma classe ou categoria mais alta desde sua emissão inicial.

SevereWeatherAlert

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

Nome	Tipo	Description
alertAreas	AlertArea[]	Informações sobre o alerta específico para as á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. Esse campo não está disponível para todos os países e, portanto, nem sempre é retornado.
countryCode	string	Código de país ISO 3166-1 Alpha-2 de 2 caracteres, por exemplo, "EUA".
description	SevereWeatherAlertDescription	Descrição do alerta.
disclaimer	string	Um aviso de isenção de responsabilidade sobre a origem das informações de alerta. Esse campo nem sempre está disponível. Por exemplo, isenção de responsabilidade pode incluir detalhes sobre os atrasos ou possíveis problemas relacionados ao alarme.
level	string	Nível de severidade do alerta. Esse campo não está disponível para todos os países e, portanto, nem sempre é retornado.
priority	integer	Número que significa a importância ou a ordem de classificação do alerta especificado dentro do país/região originado. Um número menor significa uma prioridade mais alta. Por exemplo, 1 é a prioridade mais alta. O número varia de acordo com o país/região e pode mudar ao longo do tempo à medida que cada país/região evolui seus sistemas de alerta.
source	string	O provedor das informações de alerta. Por padrão, a origem é retornada em inglês (en-US). Os alertas são de agências meteorológicas oficiais do governo e dos principais provedores globais de alertas meteorológicos.
sourceId	integer	Um identificador numérico associado ao nome do provedor de origem dos dados de alerta.

SevereWeatherAlertDescription

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

Nome	Tipo	Description
english	string	Descrição do alerta em inglês (en-US).
localized	string	Descrição do alerta no idioma especificado. Por padrão, o inglês (en-US) será retornado se o parâmetro de idioma não for especificado na solicitação.

SevereWeatherAlertsResult

Esse objeto é retornado de uma chamada bem-sucedida obter alertas meteorológicos severos.

Nome	Tipo	Description
results	SevereWeatherAlert[]	Uma lista de todos os alertas meteorológicos severos para o local consultado.