Weather - Get Current Air Quality

Use para obter informações atualizadas sobre a qualidade do ar que incluam riscos potenciais e precauções sugeridas.
A Get Current Air Quality API é uma solicitação HTTP GET que retorna informações detalhadas sobre a concentração de poluentes e o status geral da qualidade do ar atual, incluindo níveis de poluição, valores do índice de qualidade do ar, o poluente dominante e uma breve declaração resumindo o nível de risco e as precauções sugeridas.

GET {endpoint}/weather/airQuality/current/json?api-version=1.1&query={query}
GET {endpoint}/weather/airQuality/current/json?api-version=1.1&language={language}&query={query}&pollutants={pollutants}

Parâmetros do URI

Nome Em Obrigatório Tipo Descrição
endpoint
path True

string (uri)

O nome de host do serviço Azure Maps. Usa https://atlas.microsoft.com para a Azure cloud pública. Para direcionar uma geografia Azure Maps específica ou uma nuvem soberana, veja Azure Maps âmbito geográfico.

format
path True

JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

query
query True

number[]

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

As informações meteorológicas estão geralmente disponíveis para locais em terra, corpos de água cercados por terra e áreas do oceano que estão a aproximadamente 50 milhas náuticas de uma costa.

language
query

string

Idioma em que os resultados da pesquisa devem ser retornados. Deve ser uma das tags de idioma IETF suportadas, sem distinção entre maiúsculas e 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 de idiomas suportados para obter detalhes.

pollutants
query

boolean

Valor booleano que retorna informações detalhadas sobre cada poluente. Por padrão, é True.

Cabeçalho do Pedido

Nome Obrigatório Tipo Descrição
x-ms-client-id

string

Indica a conta destinada a ser utilizada com o modelo de segurança do Microsoft Entra ID. Este ID único para a conta Azure Maps pode ser obtido a partir da API da conta Azure Maps plano de gestão. Para mais informações sobre o uso da segurança Microsoft Entra ID em Azure Maps, consulte Gerir autenticação em Azure Maps.

Respostas

Nome Tipo Descrição
200 OK

AirQualityResult

O pedido foi bem-sucedido.

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

AadToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando combinado com controlo Azure baseado em funções, pode ser usado para controlar o acesso a APIs REST Azure Maps. Os controlos de acesso baseados em papéis do Azure são usados para designar o acesso a uma ou mais contas ou subrecursos de recursos do Azure Maps. 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 Maps.

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

Note

  • Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento do Maps.
  • O Authorization URL é específico para a instância de nuvem pública do Azure. As clouds soberanas têm URLs de Autorização e configurações de Microsoft Entra ID únicas.
  • O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
  • O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
  • Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

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

Âmbitos

Nome Descrição
https://atlas.microsoft.com/.default

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

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

Tipo: apiKey
Em: header

SAS Token

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

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(õ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 forma mais segura do que a chave compartilhada.

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

Tipo: apiKey
Em: header

Exemplos

Get Current Air Quality

Pedido de amostra

GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&query=47.632346,-122.13887

Resposta da amostra

{
  "results": [
    {
      "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure.",
      "category": "Fair",
      "categoryColor": "#FFC300",
      "dateTime": "2021-07-19T02:00:00+00:00",
      "dominantPollutant": "Ozone",
      "globalIndex": 22.1,
      "index": 21.6,
      "pollutants": [
        {
          "name": "Nitrogen Dioxide",
          "type": "NO2",
          "concentration": {
            "unit": "µg/m³",
            "unitType": 31,
            "value": 13.4
          },
          "globalIndex": 6.7,
          "index": 6.7
        },
        {
          "name": "Ozone",
          "type": "O3",
          "concentration": {
            "unit": "µg/m³",
            "unitType": 31,
            "value": 53.5
          },
          "globalIndex": 22.1,
          "index": 21.6
        },
        {
          "name": "Particulate Matter 10",
          "type": "PM10",
          "concentration": {
            "unit": "µg/m³",
            "unitType": 31,
            "value": 12.2
          },
          "globalIndex": 12.2,
          "index": 11.3
        },
        {
          "name": "Particulate Matter 2.5",
          "type": "PM2.5",
          "concentration": {
            "unit": "µg/m³",
            "unitType": 31,
            "value": 3.2
          },
          "globalIndex": 6.5,
          "index": 13.5
        },
        {
          "name": "Carbon Monoxide",
          "type": "CO",
          "concentration": {
            "unit": "µg/m³",
            "unitType": 31,
            "value": 118.4
          },
          "globalIndex": 0.6,
          "index": 1.2
        },
        {
          "name": "Sulfur Dioxide",
          "type": "SO2",
          "concentration": {
            "unit": "µg/m³",
            "unitType": 31,
            "value": 1.1
          },
          "globalIndex": 1.1,
          "index": 0.6
        }
      ]
    }
  ]
}

Definições

Nome Descrição
AirQuality

A leitura atual da qualidade do ar num local retornou como a entrada em AirQualityResult.results. Combina o índice de qualidade do ar reportado pelo órgão regulador local (index) com um índice internacionalmente normalizado (globalIndex), identifica o dominantPollutant que motiva o resultado e emparelha-os com uma qualidade category localizada e uma correspondência categoryColor adequada para UI codificada por cores. Uma breve description explicação explica o que a leitura significa para as atividades do dia a dia e quaisquer precauções de saúde, e – quando o pedido pede detalhes sobre poluentes – a pollutants matriz apresenta uma análise por poluente.

AirQualityResult

A resposta foi dada pela operação Get Current Air Quality (Get Current Air Quality Quality), fornecendo as condições atuais de qualidade do ar num local especificado. O results array contém uma única AirQuality entrada que resume os índices locais e globalmente normalizados de qualidade do ar, o poluente dominante, uma categoria qualitativa e cor correspondente, uma breve descrição das implicações para a saúde e (quando solicitado) detalhes por poluente.

DominantPollutant

Identifica o poluente com maior concentração.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)

JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.

Pollutant

Um único poluente medido na localização consultada, devolvido como uma entrada em AirQuality.pollutants. Cada entrada identifica o poluente (por código e nome em inglês), reporta a medida concentration no ar e indica a contribuição individual do poluente para o AQI local (index) e o índice internacionalmente normalizado (globalIndex) - as mesmas duas escalas reportadas na leitura global em AirQuality, mas restrita a este poluente. Uma leitura típica de qualidade do ar inclui uma entrada por poluente – Dióxido de Azoto, Ozono, Material Particulado 10, Material Particulado 2,5, Monóxido de Carbono e Dióxido de Enxofre – para que os ouvintes possam ver que substâncias estão presentes e quanto cada uma contribui.

PollutantType

Uma descrição dos seis tipos de poluentes monitorizados pelo serviço meteorológico Azure Maps.

UnitType

Um valor inteiro associado ao tipo de unidade que está a ser apresentada. Por exemplo, 17 para Celsius, 18 para Fahrenheit. Pode ser usado para tradução de unidades. Para mais informações, consulte Serviços meteorológicos em Azure Maps.

WeatherValue

Valores para métricas relacionadas com o clima, como temperatura, ponto de orvalho e velocidade do vento, apresentados em unidades métricas ou imperiais, conforme especificado no parâmetro unitário URI. Para mais informações, veja Tipos de Unidades no artigo Serviços meteorológicos no Azure Maps.

AirQuality

A leitura atual da qualidade do ar num local retornou como a entrada em AirQualityResult.results. Combina o índice de qualidade do ar reportado pelo órgão regulador local (index) com um índice internacionalmente normalizado (globalIndex), identifica o dominantPollutant que motiva o resultado e emparelha-os com uma qualidade category localizada e uma correspondência categoryColor adequada para UI codificada por cores. Uma breve description explicação explica o que a leitura significa para as atividades do dia a dia e quaisquer precauções de saúde, e – quando o pedido pede detalhes sobre poluentes – a pollutants matriz apresenta uma análise por poluente.

Nome Tipo Descrição
category

string

Um breve resumo qualitativo da qualidade atual do ar, devolvido na linguagem especificada no pedido. Os valores típicos incluem Bom, Razoável, Moderado, Pobre e Perigoso; o conjunto exato depende do órgão regulador da localização consultada.

categoryColor

string

Um código de cor hexadecimal que corresponde category, adequado para codificar por cores a leitura da qualidade do ar numa interface de utilizador – por exemplo, #FFC300 para Fair. Cada category valor tem uma cor distinta para que a leitura possa ser reconhecida de relance.

dateTime

string (date-time)

A data e hora a que a leitura da qualidade do ar se aplica, no formato ISO 8601 (yyy-mm-ddThh:mm:ss+hh:mm). Por exemplo, 2021-07-19T02:00:00+00:00.

description

string

Uma ou duas frases livres a explicar a qualidade atual do ar e quaisquer precauções que grupos sensíveis devam considerar, devolvidas na linguagem especificada no pedido. Por exemplo, a qualidade do ar é geralmente aceitável para a maioria dos indivíduos. No entanto, grupos sensíveis podem apresentar sintomas ligeiros a moderados devido à exposição prolongada.

dominantPollutant

DominantPollutant

O poluente que impulsiona a corrente index e globalIndex - um dos DominantPollutant valores, como ozono ou NO2. Útil para identificar qual substância é mais responsável pela qualidade atual do ar.

globalIndex

number (float)

Um índice de qualidade do ar normalizado, concebido para ser comparável entre localizações, independente de qualquer escala local de AQI. O valor é o subíndice individual mais elevado entre os seis poluentes medidos (PM2.5, PM10, NO2, SO2, CO, O3); o poluente que produz esse máximo é devolvido em dominantPollutant.

Variedade e categorias:

Valor Category
0-20 Excelente
21-50 Razoável
51-100 Fraco
101-150 Insalubridade
151-250 Muito pouco saudável
251+ Perigoso

Por exemplo, dados subíndices CO 0,6, SO2 1,1, PM2,5 6,5, NO2 6,7, PM10 12,2, O3 22,1, globalIndex é 22,1 e dominantPollutant é ozono.

index

number (float)

O índice de qualidade do ar (AQI) na escala definida pelo organismo regulador local para a localização consultada. As escalas AQI variam muito entre países e regiões, por isso o mesmo valor numérico pode significar coisas diferentes em diferentes locais – use category para um rótulo consistente entre locais. Por exemplo, 21,6 na escala usada para a localização consultada. Para contextualizar, veja Índice de qualidade do ar na Wikipédia.

pollutants

Pollutant[]

Detalhe por poluente por detrás da leitura global, com uma Pollutant entrada por espécie medida (tipicamente Dióxido de Azoto, Ozono, Partículas 10, Partículas 2,5, Monóxido de Carbono e Dióxido de Enxofre). Cada entrada reporta a concentração do poluente e as suas contribuições individuais indexglobalIndex . Devolvido apenas quando o pedido pede detalhes sobre poluentes.

AirQualityResult

A resposta foi dada pela operação Get Current Air Quality (Get Current Air Quality Quality), fornecendo as condições atuais de qualidade do ar num local especificado. O results array contém uma única AirQuality entrada que resume os índices locais e globalmente normalizados de qualidade do ar, o poluente dominante, uma categoria qualitativa e cor correspondente, uma breve descrição das implicações para a saúde e (quando solicitado) detalhes por poluente.

Nome Tipo Descrição
nextLink

string

A URL para recuperar a página seguinte de resultados quando a resposta for paginada, adequada para navegar por conjuntos de resultados demasiado grandes para serem retornados numa única chamada. Vazio quando não há mais páginas.

results

AirQuality[]

A leitura atual da qualidade do ar no local, devolvida como um conjunto de elemento único. A entrada reporta o índice local de qualidade do ar (index), o índice internacionalmente normalizado (globalIndex), o dominantPollutant (por exemplo, Ozono), um item qualitativo category (como Justo) com correspondência categoryColor (por exemplo, #FFC300), um resumo description das implicações para a saúde e – quando o pedido pede detalhes sobre poluentes – um pollutants array com uma entrada por poluente medido.

DominantPollutant

Identifica o poluente com maior concentração.

Valor Descrição
Carbon Monoxide

O monóxido de carbono (CO) é um gás incolor, inodoro e insípido, mas altamente tóxico, produzido pela combustão incompleta de combustíveis contendo carbono. As fontes comuns incluem escapamento de veículos, fogões a gás, fornos e incêndios a lenha.

Nitrogen Dioxide

O dióxido de azoto (NO2) é um poluente atmosférico significativo. É regulada e sujeita às diretrizes de limite recomendadas estabelecidas pela Organização Mundial da Saúde (OMS).

Ozone

O ozono (O3) é um componente chave do smog fotoquímico, a névoa castanha e nociva que envolve muitas grandes cidades, resultante de uma reação fotoquímica entre a luz solar e certos poluentes específicos.

Particulate Matter 2.5

A matéria particulada 2,5 (PM2,5) refere-se a partículas finas com diâmetros geralmente de 2,5 micrómetros ou menores. Estas partículas são mais de 100 vezes mais finas do que um cabelo humano e podem permanecer suspensas no ar por longos períodos.

Particulate Matter 10

Material particulado 10 (PM10) refere-se a partículas com diâmetros geralmente de 10 micrómetros ou menores. Essas partículas podem incluir poeira, pólen, fuligem, fumaça e gotículas líquidas.

Sulfur Dioxide

O dióxido de enxofre (SO2) é um gás inorgânico pesado e incolor, com um odor pungente e irritante. É produzido principalmente pela queima de combustíveis fósseis em centrais elétricas e instalações industriais, mas também pode ser emitido a partir de fontes naturais, como vulcões.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Nome Tipo Descrição
info

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Descrição
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

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 comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)

Nome Tipo Descrição
error

ErrorDetail

O objeto de erro.

JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.

Valor Descrição
json

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

Pollutant

Um único poluente medido na localização consultada, devolvido como uma entrada em AirQuality.pollutants. Cada entrada identifica o poluente (por código e nome em inglês), reporta a medida concentration no ar e indica a contribuição individual do poluente para o AQI local (index) e o índice internacionalmente normalizado (globalIndex) - as mesmas duas escalas reportadas na leitura global em AirQuality, mas restrita a este poluente. Uma leitura típica de qualidade do ar inclui uma entrada por poluente – Dióxido de Azoto, Ozono, Material Particulado 10, Material Particulado 2,5, Monóxido de Carbono e Dióxido de Enxofre – para que os ouvintes possam ver que substâncias estão presentes e quanto cada uma contribui.

Nome Tipo Descrição
concentration

WeatherValue

A concentração medida pelo poluente no ar, em microgramas por metro cúbico (μg/m³) para NO2, O3, PM10, PM2,5, CO e SO2 – por exemplo, 53,5 μg/m³ para Ozono ou 13,4 μg/m³ para Dióxido de Azoto – ou em partes por milhão (ppm) quando reportado nessa unidade. A concentração é a medição bruta que alimenta e indexglobalIndex.

globalIndex

number (float)

A contribuição deste poluente para o índice internacionalmente normalizado de qualidade do ar, na mesma escala de 0 a 300+ para AirQuality.globalIndex que os valores por poluente possam ser comparados entre locais. Valores mais elevados indicam uma contribuição maior para a má qualidade do ar. Por exemplo, 22,1 para ozono ou 6,7 para dióxido de azoto.

index

number (float)

A contribuição deste poluente para o índice global de qualidade do ar (AQI) na escala definida pelo organismo regulador local para a localização consultada. Usa a mesma escala local que AirQuality.index, pelo que o número bruto é comparável à leitura global no mesmo local, mas não diretamente comparável entre locais – por exemplo, 21,6 para ozono numa leitura com total index21,6 (ozono é o poluente dominante). Para contextualizar, veja Índice de qualidade do ar na Wikipédia.

name

string

O nome inglês do poluente combina com type - por exemplo, Nitrogen Dioxide para NO2, Ozono para O3, Particulate Matter 10 para PM10, Particulate Matter 2.5 para PM2.5, Carbon Monoxide para CO, ou Sulfur Dioxide para SO2. Sempre devolvido em inglês independentemente da língua solicitada, o que o torna adequado como um rótulo de visualização estável quando não é necessário texto localizado.

type

PollutantType

O código poluente, usado como identificador estável e independente da língua – um dos PollutantType valores (PM2.5, PM10, O3, NO2, SO2 ou CO). Poderão ser adicionados tipos adicionais de poluentes no futuro.

PollutantType

Uma descrição dos seis tipos de poluentes monitorizados pelo serviço meteorológico Azure Maps.

Valor Descrição
CO

A concentração média de monóxido de carbono (CO) em microgramas por metro cúbico (μg/m³) na última hora.

O CO é um gás incolor, inodoro e insípido, mas altamente tóxico, produzido pela combustão incompleta de combustíveis contendo carbono. As fontes comuns incluem escapamento de veículos, fogões a gás, fornos e incêndios a lenha.

NO2

A concentração média de dióxido de azoto (NO2) em microgramas por metro cúbico (μg/m³) na última hora.

O NO2 é um poluente atmosférico significativo. É regulada e sujeita às diretrizes de limite recomendadas estabelecidas pela Organização Mundial da Saúde (OMS).

O3

A concentração média de ozono (O3) em microgramas por metro cúbico (μg/m³) na última hora.

O O3 é um componente chave do fumo fotoquímico, a névoa castanha e nociva que envolve muitas grandes cidades, resultante de uma reação fotoquímica entre a luz solar e poluentes específicos.

PM2.5

A concentração média de partículas com menos de 2,5 micrômetros de diâmetro, medida em microgramas por metro cúbico (μg/m³), na última hora.

O PM2.5, também conhecido como aerossóis, consiste em pó fino e pequenas gotículas líquidas suspensas no ar.

PM10

A concentração média de partículas com diâmetros entre 2,5 e 10 micrámetros, medida em microgramas por metro cúbico (μg/m³) na última hora.

A matéria particulada 10 (PM10), também conhecida como aerossóis, consiste em poeira fina e pequenas gotículas líquidas suspensas no ar.

SO2

A concentração média de dióxido de enxofre (SO2) em microgramas por metro cúbico (μg/m³) na última hora.

O SO2 é um gás inorgânico denso e incolor, com um odor pungente e irritante. É produzido principalmente pela combustão de combustíveis fósseis em centrais elétricas e instalações industriais, mas também pode ser emitido por fontes naturais como vulcões.

UnitType

Um valor inteiro associado ao tipo de unidade que está a ser apresentada. Por exemplo, 17 para Celsius, 18 para Fahrenheit. Pode ser usado para tradução de unidades. Para mais informações, consulte Serviços meteorológicos em Azure Maps.

Valor Descrição
0

feet

1

inches

2

miles

3

millimeter

4

centimeter

5

medidor

6

kilometer

7

kilometersPerHour

8

knots

9

milesPerHour

10

metersPerSecond

11

hectoPascals

12

inchesOfMercury

13

kiloPascals

14

millibars

15

millimetersOfMercury

16

poundsPerSquareInch

17

Celsius

18

Fahrenheit

19

kelvin

20

percent

21

float

22

número inteiro

31

MicrogramsPerCubicMeterOfAir

WeatherValue

Valores para métricas relacionadas com o clima, como temperatura, ponto de orvalho e velocidade do vento, apresentados em unidades métricas ou imperiais, conforme especificado no parâmetro unitário URI. Para mais informações, veja Tipos de Unidades no artigo Serviços meteorológicos no Azure Maps.

Nome Tipo Descrição
unit

string

A unidade de medida usada no valor de retorno, como "C" para Celsius, "F" para Fahrenheit.

unitType

UnitType

Um inteiro que representa o tipo de unidade. Por exemplo, 0 para pés, 1 para polegadas, 2 para milhas. Para uma lista completa, veja Tipos de Unidades no artigo Serviços meteorológicos no Azure Maps.

value

number (float)

O valor medido expresso na unidade especificada.