Weather - Get Current Air Quality

Use para obter informações atualizadas sobre a qualidade do ar que incluem 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 de í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 de URI

Nome Em Obrigatório Tipo Description
endpoint
path True

string (uri)

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

format
path True

JsonFormat

Formato desejado da resposta. Há suporte apenas para json formato.

api-version
query True

string

minLength: 1

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

query
query True

number[]

A consulta aplicável especificada como uma cadeia de caracteres separada por vírgula composta por latitude seguida por longitude, por exemplo, "47,641268,-122,125679".

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

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 de idiomas com suporte para obter detalhes.

pollutants
query

boolean

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

Cabeçalho da Solicitação

Nome Obrigatório Tipo Description
x-ms-client-id

string

Indica a conta destinada a ser usada com o modelo de segurança do Microsoft Entra ID. Esse ID único para a conta Azure Mapas pode ser obtido a partir da API de Conta Azure Mapas plano de gerenciamento. Para mais informações sobre o uso da segurança Microsoft Entra ID em Azure Mapas, veja Gerencie autenticação em Azure Mapas.

Respostas

Nome Tipo Description
200 OK

AirQualityResult

A solicitação foi bem-sucedida.

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 o controle de acesso baseado em funções Azure , pode ser usado para controlar o acesso às APIs REST Azure Mapas. Controles de acesso baseados em função do Azure são usados para designar acesso a uma ou mais contas ou subrecursos de recursos do Azure Mapas. 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 Mapas.

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 controlar o 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 Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.
  • O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas possuem URLs de Autorização e configurações de Microsoft Entra ID únicas.
  • O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
  • O uso do SDK da Web do do 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 a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

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

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada quando você Criar uma conta do 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 mestra na conta em que elas são emitidas.

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

Tipo: apiKey
Em: header

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) 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 protegida 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 de mapa de para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Get Current Air Quality

Solicitação de exemplo

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

Resposta de exemplo

{
  "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 Description
AirQuality

A leitura atual da qualidade do ar em um 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 impulsiona o resultado e os emparela com uma qualidade category localizada e uma correspondência categoryColor adequada para UI codificada por cores. Um breve description resumo explica o que a leitura significa para as atividades diárias e quaisquer precauções de saúde e – quando o pedido pede detalhes sobre poluentes – o pollutants array traz uma análise por poluente.

AirQualityResult

A resposta retornada pela operação Get Current Air Quality fornece, fornecendo as condições atuais de qualidade do ar em um local especificado. O results array contém uma única AirQuality entrada resumindo 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 a maior concentração.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

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

JsonFormat

Formato desejado da resposta. Há suporte apenas para json formato.

Pollutant

Um único poluente medido no local consultado retornou como uma entrada em AirQuality.pollutants. Cada entrada identifica o poluente (por código e nome em inglês), relata que ele é medido concentration no ar e apresenta a contribuição individual do poluente para o AQI local (index) e o índice internacionalmente normalizado (globalIndex) - as mesmas duas escalas reportadas na leitura geral em AirQuality, mas restrita a esse poluente. Uma leitura típica de qualidade do ar traz uma entrada por poluente - Dióxido de Nitrogênio, Ozônio, Material Particulado 10, Material Particulado 2,5, Monóxido de Carbono e Dióxido de Enxofre - para que os chamantes possam ver quais substâncias estão presentes e quanto cada uma contribui.

PollutantType

Uma descrição dos seis tipos de poluentes monitorados pelo serviço Azure Mapas Weather.

UnitType

Um valor inteiro associado ao tipo de unidade exibida. Por exemplo, 17 para Celsius, 18 para Fahrenheit. Pode ser usado para tradução de unidades. Para mais informações, veja Serviços meteorológicos em Azure Mapas.

WeatherValue

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

AirQuality

A leitura atual da qualidade do ar em um 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 impulsiona o resultado e os emparela com uma qualidade category localizada e uma correspondência categoryColor adequada para UI codificada por cores. Um breve description resumo explica o que a leitura significa para as atividades diárias e quaisquer precauções de saúde e – quando o pedido pede detalhes sobre poluentes – o pollutants array traz uma análise por poluente.

Nome Tipo Description
category

string

Um breve resumo qualitativo da qualidade atual do ar, retornado na linguagem especificada no pedido. 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 de qualidade do ar em uma interface de usuário – por exemplo, #FFC300 para Fair. Cada category valor tem uma cor distinta para que a leitura possa ser reconhecida rapidamente.

dateTime

string (date-time)

A data e hora à qual a leitura de 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 explicando a qualidade atual do ar e quaisquer precauções que grupos sensíveis devam considerar, retornadas na linguagem especificada no pedido. Por exemplo, a qualidade do ar é geralmente aceitável para a maioria das pessoas. No entanto, grupos sensíveis podem apresentar sintomas leves a moderados devido à exposição prolongada.

dominantPollutant

DominantPollutant

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

globalIndex

number (float)

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

Variedade e categorias:

Valor Category
0-20 Excelente
21-50 Razoável
51-100 Pobre
101-150 Não saudável
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 é ozônio.

index

number (float)

O índice de qualidade do ar (AQI) na escala definida pelo órgão regulador local para a localização consultada. As escalas AQI variam muito entre países e regiões, então o mesmo valor numérico pode significar coisas diferentes em locais distintos – use category para um rótulo consistente entre os 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 valor da leitura geral, com uma Pollutant entrada por espécie medida ( tipicamente Dióxido de Nitrogênio, Ozônio, Partículas 10, Partículas 2,5, Monóxido de Carbono e Dióxido de Enxofre). Cada entrada relata a concentração do poluente e suas contribuições individuais indexglobalIndex . Retornado apenas quando o pedido pede detalhes sobre poluentes.

AirQualityResult

A resposta retornada pela operação Get Current Air Quality fornece, fornecendo as condições atuais de qualidade do ar em um local especificado. O results array contém uma única AirQuality entrada resumindo 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 Description
nextLink

string

A URL para recuperar a próxima página de resultados quando a resposta for paginada, adequada para navegar por conjuntos de resultados grandes demais para serem retornados em uma única chamada. Vazios quando não há mais páginas.

results

AirQuality[]

A leitura atual da qualidade do ar no local retornou como um conjunto de elemento único. A entrada relata o índice local de qualidade do ar (index), o índice internacionalmente normalizado (globalIndex), o dominantPollutant (por exemplo, Ozônio), 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 solicita detalhes sobre poluentes – um pollutants array com uma entrada por poluente medido.

DominantPollutant

Identifica o poluente com a maior concentração.

Valor Description
Carbon Monoxide

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. Fontes comuns incluem escapamento de veículos, fogões a gás, fornos e fogueiras a lenha.

Nitrogen Dioxide

O dióxido de nitrogênio (NO2) é um poluente atmosférico significativo. É regulamentado e sujeito às diretrizes de limite recomendadas pela Organização Mundial da Saúde (OMS).

Ozone

O ozônio (O3) é um componente chave do smog fotoquímico, a névoa marrom e prejudicial 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

Material particulado 2,5 (PM2,5) refere-se a partículas finas com diâmetros geralmente de 2,5 micrômetros ou menores. Essas partículas são mais de 100 vezes mais finas que um cabelo humano e podem permanecer suspensas no ar por longos períodos.

Particulate Matter 10

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

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 usinas de energia e instalações industriais, mas também pode ser emitido por fontes naturais, como vulcões.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

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

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

JsonFormat

Formato desejado da resposta. Há suporte apenas para json formato.

Valor Description
json

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

Pollutant

Um único poluente medido no local consultado retornou como uma entrada em AirQuality.pollutants. Cada entrada identifica o poluente (por código e nome em inglês), relata que ele é medido concentration no ar e apresenta a contribuição individual do poluente para o AQI local (index) e o índice internacionalmente normalizado (globalIndex) - as mesmas duas escalas reportadas na leitura geral em AirQuality, mas restrita a esse poluente. Uma leitura típica de qualidade do ar traz uma entrada por poluente - Dióxido de Nitrogênio, Ozônio, Material Particulado 10, Material Particulado 2,5, Monóxido de Carbono e Dióxido de Enxofre - para que os chamantes possam ver quais substâncias estão presentes e quanto cada uma contribui.

Nome Tipo Description
concentration

WeatherValue

A concentração medida do 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 Ozônio ou 13,4 μg/m³ para Dióxido de Nitrogênio – ou em partes por milhão (ppm) quando reportado nessa unidade. Concentração é a medição bruta que alimenta index e globalIndex.

globalIndex

number (float)

A contribuição desse poluente para o índice de qualidade do ar internacionalmente normalizado, na mesma escala de 0 a 300+ para AirQuality.globalIndex que os valores por poluente possam ser comparados entre locais. Valores mais altos indicam uma contribuição maior para a má qualidade do ar. Por exemplo, 22,1 para Ozônio ou 6,7 para Dióxido de Nitrogênio.

index

number (float)

A contribuição desse poluente para o índice geral de qualidade do ar (AQI) na escala estabelecida pelo órgão regulador local para o local consultado. Usa a mesma escala local que AirQuality.index, então o número bruto é comparável à leitura geral no mesmo local, mas não diretamente comparável entre locais – por exemplo, 21,6 para ozônio em uma leitura com 21,6 (indexozônio é 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, Ozone para O3, Particulate Matter 10 para PM10, Particulate Matter 2,5 para PM2,5, Carbon Monoxide para CO, ou Sulfur Dioxide para SO2. Sempre retornado em inglês, independentemente do idioma solicitado, o que o torna adequado como um rótulo de exibição estável quando texto localizado não é necessário.

type

PollutantType

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

PollutantType

Uma descrição dos seis tipos de poluentes monitorados pelo serviço Azure Mapas Weather.

Valor Description
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. Fontes comuns incluem escapamento de veículos, fogões a gás, fornos e fogueiras a lenha.

NO2

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

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

O3

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

O O3 é um componente chave do smog fotoquímico, a névoa marrom 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 menor que 2,5 micrômetros de diâmetro, medida em microgramas por metro cúbico (μg/m³), na última hora.

PM2.5, também conhecido como aerossóis, consiste em poeira fina 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.

SO2 é um gás denso e incômodo, incolor, com um odor pungente e irritante. É produzido principalmente pela combustão de combustíveis fósseis em usinas de energia e instalações industriais, mas também pode ser emitido de fontes naturais, como vulcões.

UnitType

Um valor inteiro associado ao tipo de unidade exibida. Por exemplo, 17 para Celsius, 18 para Fahrenheit. Pode ser usado para tradução de unidades. Para mais informações, veja Serviços meteorológicos em Azure Mapas.

Valor Description
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

derivar

22

inteiro

31

MicrogramsPerCubicMeterOfAir

WeatherValue

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

Nome Tipo Description
unit

string

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

unitType

UnitType

Um inteiro representando 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 Mapas.

value

number (float)

O valor medido expresso na unidade especificada.