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 https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&query={query}
GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&language={language}&query={query}&pollutants={pollutants}
Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
format
|
path | True |
Formato desejado da resposta. Apenas |
|
|
api-version
|
query | True |
string |
Número da versão da API do Azure Maps. |
|
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. |
|
|
pollutants
|
query |
boolean |
Valor booleano que retorna informações detalhadas sobre cada poluente. Por padrão, é True. |
Cabeçalho do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Indica a conta destinada a ser usada com o modelo de segurança Microsoft Entra ID. Essa ID exclusiva para a conta do Azure Maps pode ser obtida na API de Conta do plano de gerenciamento do Azure Maps. Para obter mais informações sobre como usar a segurança do Microsoft Entra ID no Azure Maps, consulte Gerenciar autenticação no Azure Maps. |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Ocorreu um erro inesperado. |
Segurança
AADToken
Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos 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.
Notes
- Essa definição de segurança requer o uso do cabeçalho
x-ms-client-idpara indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento de do Maps.
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 ID do Microsoft Entra.
* 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
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default | 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:
query
SAS Token
Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do
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
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": [
{
"dateTime": "2021-07-19T02:00:00+00:00",
"index": 21.6,
"globalIndex": 22.1,
"dominantPollutant": "Ozone",
"category": "Fair",
"categoryColor": "#FFC300",
"description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure.",
"pollutants": [
{
"type": "NO2",
"name": "Nitrogen Dioxide",
"index": 6.7,
"globalIndex": 6.7,
"concentration": {
"value": 13.4,
"unit": "µg/m³",
"unitType": 31
}
},
{
"type": "O3",
"name": "Ozone",
"index": 21.6,
"globalIndex": 22.1,
"concentration": {
"value": 53.5,
"unit": "µg/m³",
"unitType": 31
}
},
{
"type": "PM10",
"name": "Particulate Matter 10",
"index": 11.3,
"globalIndex": 12.2,
"concentration": {
"value": 12.2,
"unit": "µg/m³",
"unitType": 31
}
},
{
"type": "PM2.5",
"name": "Particulate Matter 2.5",
"index": 13.5,
"globalIndex": 6.5,
"concentration": {
"value": 3.2,
"unit": "µg/m³",
"unitType": 31
}
},
{
"type": "CO",
"name": "Carbon Monoxide",
"index": 1.2,
"globalIndex": 0.6,
"concentration": {
"value": 118.4,
"unit": "µg/m³",
"unitType": 31
}
},
{
"type": "SO2",
"name": "Sulfur Dioxide",
"index": 0.6,
"globalIndex": 1.1,
"concentration": {
"value": 1.1,
"unit": "µg/m³",
"unitType": 31
}
}
]
}
]
}
Definições
| Name | Description |
|---|---|
|
Air |
O objeto Qualidade do Ar fornece informações abrangentes sobre a qualidade atual do ar no local especificado. Isto inclui os níveis de concentração de vários poluentes, valores numéricos do Índice de Qualidade do Ar (AQI) que indicam a qualidade geral do ar e a identificação do poluente dominante que afeta a qualidade do ar. Além disso, oferece um resumo do nível de risco, que descreve brevemente os potenciais riscos para a saúde e sugere precauções. |
|
Air |
Uma variedade de objetos de qualidade do ar , cada um fornecendo informações abrangentes sobre a qualidade atual do ar no local especificado. |
|
Dominant |
Identifica o poluente com maior concentração. |
|
Error |
O erro de gerenciamento de recursos informações adicionais. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta de erro |
|
Json |
Formato desejado da resposta. Apenas |
| Pollutant |
Informações detalhadas sobre um poluente individual. Não retornado se |
|
Pollutant |
Especifica os seis tipos de poluentes rastreados pelo serviço Meteorologia do Azure Maps. |
|
Unit |
Um inteiro que representa o tipo de unidade. Por exemplo, 17 para Celsius, 18 para Fahrenheit. Pode ser usado para tradução de unidades. Para obter uma lista completa, consulte Serviços meteorológicos no Azure Maps. |
|
Weather |
Valor específico de uma dada unidade relacionado com o clima. |
AirQuality
O objeto Qualidade do Ar fornece informações abrangentes sobre a qualidade atual do ar no local especificado. Isto inclui os níveis de concentração de vários poluentes, valores numéricos do Índice de Qualidade do Ar (AQI) que indicam a qualidade geral do ar e a identificação do poluente dominante que afeta a qualidade do ar. Além disso, oferece um resumo do nível de risco, que descreve brevemente os potenciais riscos para a saúde e sugere precauções.
| Name | Tipo | Description |
|---|---|---|
| category |
string |
Fornece uma descrição de uma palavra da qualidade do ar para o período de previsão na linguagem especificada, como Pobre, Razoável ou Excelente. |
| categoryColor |
string |
Fornece um código de cor hexadecimal único correspondente à categoria de qualidade do ar para cada dia no período de previsão. Esta cor ajuda os utilizadores a identificar rapidamente o nível de qualidade do ar visualmente, com cada cor a corresponder a uma categoria como Fraca, Razoável ou Excelente. |
| dateTime |
string (date-time) |
Data e hora da observação atual, apresentadas no formato ISO 8601 (yyy-mm-ddThh:mm:ss-hh:mm). Por exemplo, 2025-04-29T07:00:00-07:00. |
| description |
string |
Uma explicação textual desta qualidade do ar resulta na língua solicitada. |
| dominantPollutant |
Identifica o poluente com maior concentração. |
|
| globalIndex |
number (float) |
Fornece uma forma internacionalmente padronizada de compreender a concentração de poluentes no ar. As classificações variam de 0 a 300 ou mais, sendo que números mais altos indicam pior qualidade do ar. Os poluentes medidos incluem PM2.5, PM10, NO2, SO2, CO e O3. |
| index |
number (float) |
O índice de qualidade do ar (AQI) é uma escala de avaliação da qualidade do ar definida pelos órgãos reguladores locais. As escalas podem variar muito de acordo com a localização. Para mais informações, consulte o índice de qualidade do ar na Wikipédia. |
| pollutants |
Um array contendo informações detalhadas sobre cada poluente na resposta. Devolvido quando o |
AirQualityResult
Uma variedade de objetos de qualidade do ar , cada um fornecendo informações abrangentes sobre a qualidade atual do ar no local especificado.
| Name | Tipo | Description |
|---|---|---|
| nextLink |
string |
Contém o URL para obter a página seguinte de resultados se a resposta for paginada. Isto é útil quando a resposta é demasiado grande para ser devolvida numa única chamada, permitindo aos utilizadores navegar por várias páginas de resultados. |
| results |
Resultados detalhados da qualidade do ar dentro do local especificado, incluindo propriedades como o índice de qualidade do ar (AQI), poluente dominante, níveis de poluentes, nível de risco e precauções sugeridas. |
DominantPollutant
Identifica o poluente com maior concentração.
| Valor | Description |
|---|---|
| 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 |
O material particulado 2,5 (PM2,5) refere-se a partículas finas com diâmetros geralmente de 2,5 micrômetros e 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 |
O material particulado 10 (PM10) refere-se a partículas com diâmetros geralmente de 10 micrômetros e 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.
| 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 |
O erro informações adicionais. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
| Name | Tipo | Description |
|---|---|---|
| error |
O objeto de erro. |
JsonFormat
Formato desejado da resposta. Apenas json formato é suportado.
| Valor | Description |
|---|---|
| json |
O formato de intercâmbio de dados de notação de objeto JavaScript |
Pollutant
Informações detalhadas sobre um poluente individual. Não retornado se pollutants=false.
| Name | Tipo | Description |
|---|---|---|
| concentration |
Um objeto que contém o número de partículas poluentes por volume de ar. |
|
| globalIndex |
number (float) |
Classificação da qualidade do ar normalizada internacionalmente em uma escala de 0 a 300 e acima, com números mais altos representando pior qualidade do ar. |
| index |
number (float) |
Classificação da qualidade do ar numa escala definida pelas entidades reguladoras locais. As escalas podem variar muito de acordo com a localização. Veja a Wikipédia para mais informações. |
| name |
string |
O nome do poluente em inglês. |
| type |
Tipo de poluente. Por favor, note que mais podem ser adicionados a qualquer momento. |
PollutantType
Especifica os seis tipos de poluentes rastreados pelo serviço Meteorologia do Azure Maps.
| Valor | Description |
|---|---|
| CO |
Monóxido de carbono |
| NO2 |
Dióxido de azoto |
| O3 |
Ozono |
| PM2.5 |
Partículas em suspensão 2.5 |
| PM10 |
Partículas em suspensão 10 |
| SO2 |
Dióxido de enxofre |
UnitType
Um inteiro que representa o tipo de unidade. Por exemplo, 17 para Celsius, 18 para Fahrenheit. Pode ser usado para tradução de unidades. Para obter uma lista completa, consulte Serviços meteorológicos no Azure Maps.
| 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 |
float |
| 22 |
número inteiro |
| 31 |
MicrogramsPerCubicMeterOfAir |
WeatherUnit
Valor específico de uma dada unidade relacionado com o clima.
| Name | Tipo | Description |
|---|---|---|
| unit |
string |
Tipo de unidade para o valor retornado. |
| unitType |
Unit |
Um inteiro que representa o tipo de unidade. Por exemplo, 17 para Celsius, 18 para Fahrenheit. Pode ser usado para tradução de unidades. Para obter uma lista completa, consulte Serviços meteorológicos no Azure Maps. |
| value |
number (float) |
Valor arredondado. |