Weather - Get Current Air Quality

Servicio:: Maps

Versión de la API:: 1.1

Úselo para obtener información actualizada sobre la calidad del aire que incluya los riesgos potenciales y las precauciones sugeridas.
La Get Current Air Quality API es una solicitud HTTP GET que devuelve información detallada sobre la concentración de contaminantes y el estado general de la calidad del aire actual, incluidos los niveles de contaminación, los valores del índice de calidad del aire, el contaminante dominante y una breve declaración que resume el nivel de riesgo y las precauciones sugeridas.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	El nombre de host del servicio Azure Maps. Usa `https://atlas.microsoft.com` para la nube pública Azure. Para dirigirse a una geografía Azure Maps específica o a una nube soberana, véase Azure Maps alcance geográfico.
format	path	True	JsonFormat	Formato deseado de la respuesta. Solo se admite `json` formato.
api-version	query	True	string minLength: 1	La versión de API que se va a utilizar para esta operación.
query	query	True	number[]	La consulta aplicable especificada como una cadena separada por comas compuesta por latitud seguida de longitud, por ejemplo, "47.641268,-122.125679". La información meteorológica generalmente está disponible para ubicaciones en tierra, cuerpos de agua rodeados de tierra y áreas del océano que se encuentran dentro de aproximadamente 50 millas náuticas de una costa.
language	query		string	Idioma en el que se deben devolver los resultados de la búsqueda. Debe ser una de las etiquetas de idioma IETF admitidas, sin distinción entre mayúsculas y minúsculas. Cuando los datos del idioma especificado no están disponibles para un campo específico, se usa el idioma predeterminado. Consulte idiomas admitidos para obtener más información.
pollutants	query		boolean	Valor booleano que devuelve información detallada sobre cada contaminante. De forma predeterminada es True.

Encabezado de solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-id		string	Indica la cuenta destinada a usarse con el modelo de seguridad Microsoft Entra ID. Este ID único para la cuenta de Azure Maps puede obtenerse desde la API de la cuenta Azure Maps plano de gestión. Para más información sobre el uso de la seguridad Microsoft Entra ID en Azure Maps, consulte Gestionar la autenticación en Azure Maps.

Respuestas

Nombre	Tipo	Description
200 OK	AirQualityResult	La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

AadToken

Estos son los flujos Microsoft Entra OAuth 2.0. Cuando se combina con el control de acceso basado en roles Azure puede usarse para controlar el acceso a Azure Maps APIs REST. Los controles de acceso basados en roles de Azure se utilizan para designar el acceso a una o más cuentas o subrecursos de recursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o de un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Note

Esta definición de seguridad requiere el uso del encabezado x-ms-client-id para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.
El Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen URLs de Autorización y configuraciones de Microsoft Entra ID únicas.
El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
El uso de SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
Para obtener más información sobre la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

subscription-key

Se trata de una clave compartida que se aprovisiona al Creación de una cuenta de Azure Maps en Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

Para las aplicaciones expuestas públicamente, nuestra recomendación es usar las aplicaciones cliente confidenciales enfoque acceder a las API REST de Azure Maps para que la clave se pueda almacenar de forma segura.

Tipo: apiKey
En: header

SAS Token

Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Get Current Air Quality

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "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
        }
      ]
    }
  ]
}

Definiciones

Nombre	Description
AirQuality	La lectura actual de calidad del aire en un lugar, devuelto como la entrada en `AirQualityResult.results`. Combina el índice de calidad del aire reportado por el organismo regulador local (`index`) con un índice normalizado internacionalmente (`globalIndex`), identifica el `dominantPollutant` que impulsa el resultado y los empareja con una cualitativa `category` localizada y una coincidencia `categoryColor` adecuada para la interfaz de usuario codificada por colores. Un breve `description` detalle explica qué significa la lectura para las actividades cotidianas y cualquier precaución sanitaria, y —cuando la solicitud pide detalles sobre contaminantes— el `pollutants` panel muestra un desglose por contaminante.
AirQualityResult	La respuesta devolvida por la operación Get Current Air Quality proporcionando las condiciones actuales de calidad del aire en una ubicación especificada. El `results` array contiene una única `AirQuality` entrada que resume los índices locales y globalmente normalizados de calidad del aire, el contaminante dominante, una categoría cualitativa y el color correspondiente, una breve descripción de las implicaciones para la salud y (cuando se solicite) detalles por contaminante.
DominantPollutant	Identifica el contaminante con mayor concentración.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. (Esto también sigue el formato de respuesta de error de OData).
JsonFormat	Formato deseado de la respuesta. Solo se admite `json` formato.
Pollutant	Un solo contaminante medido en la ubicación consultada, devuelto como una entrada en `AirQuality.pollutants`. Cada entrada identifica el contaminante (por código y nombre en inglés), informa de que se mide `concentration` en el aire y da la contribución individual del contaminante al AQI local (`index`) y al índice normalizado internacionalmente (`globalIndex`) - las mismas dos escalas reportadas en la lectura global sobre `AirQuality`, pero restringidas a este contaminante. Una lectura típica de calidad del aire incluye una entrada por contaminante: dióxido de nitrógeno, ozono, partículas en suspensión 10, partículas en 2,5, monóxido de carbono y dióxido de azufre , para que los llamantes puedan ver qué sustancias están presentes y cuánto contribuye cada una.
PollutantType	Una descripción de los seis tipos de contaminantes monitorizados por el servicio meteorológico de Azure Maps.
UnitType	Un valor entero asociado al tipo de unidad que se está mostrando. Por ejemplo, 17 para Celsius, 18 para Fahrenheit. Se puede utilizar para la traducción de unidades. Para más información, consulte Servicios meteorológicos en Azure Maps.
WeatherValue	Valores para métricas relacionadas con el clima, como temperatura, punto de rocío y velocidad del viento, presentados en unidades métricas o imperiales, según se especifica en el parámetro unitario URI. Para más información, véase Tipos de unidades en el artículo Servicios meteorológicos en Azure Maps.

AirQuality

Objeto

La lectura actual de calidad del aire en un lugar, devuelto como la entrada en AirQualityResult.results. Combina el índice de calidad del aire reportado por el organismo regulador local (index) con un índice normalizado internacionalmente (globalIndex), identifica el dominantPollutant que impulsa el resultado y los empareja con una cualitativa category localizada y una coincidencia categoryColor adecuada para la interfaz de usuario codificada por colores. Un breve description detalle explica qué significa la lectura para las actividades cotidianas y cualquier precaución sanitaria, y —cuando la solicitud pide detalles sobre contaminantes— el pollutants panel muestra un desglose por contaminante.

Nombre Tipo Description

AirQualityResult

Objeto

La respuesta devolvida por la operación Get Current Air Quality proporcionando las condiciones actuales de calidad del aire en una ubicación especificada. El results array contiene una única AirQuality entrada que resume los índices locales y globalmente normalizados de calidad del aire, el contaminante dominante, una categoría cualitativa y el color correspondiente, una breve descripción de las implicaciones para la salud y (cuando se solicite) detalles por contaminante.

Nombre	Tipo	Description
nextLink	string	La URL para recuperar la siguiente página de resultados cuando la respuesta está paginada, adecuada para navegar por conjuntos de resultados demasiado grandes para devolverlos en una sola llamada. Vacío cuando no quedan más páginas.
results	AirQuality[]	La lectura actual de calidad del aire en la ubicación se devolvió como una matriz de un solo elemento. La entrada informa del índice local de calidad del aire (`index`), el índice normalizado internacionalmente (`globalIndex`), el `dominantPollutant` (por ejemplo, ozono), una cualitativa `category` (como Fair) con coincidencia `categoryColor` (por ejemplo, #FFC300), una reducción `description` de las implicaciones para la salud y —cuando la solicitud solicita detalles sobre contaminantes— un `pollutants` array con una entrada por contaminante medido.

DominantPollutant

Enumeración

Identifica el contaminante con mayor concentración.

Valor	Description
Carbon Monoxide	El monóxido de carbono (CO) es un gas incoloro, inodoro e insípido pero altamente tóxico, producido por la combustión incompleta de combustibles que contienen carbono. Las fuentes comunes incluyen gases de escape de vehículos, estufas de gas, hornos y fuegos de leña.
Nitrogen Dioxide	El dióxido de nitrógeno (NO2) es un contaminante atmosférico significativo. Está regulado y sujeto a las pautas de límite recomendadas establecidas por la Organización Mundial de la Salud (OMS).
Ozone	El ozono (O3) es un componente clave del smog fotoquímico, la neblina marrón y dañina que envuelve muchas grandes ciudades, resultante de una reacción fotoquímica entre la luz solar y ciertos contaminantes específicos.
Particulate Matter 2.5	Las partículas en partícula 2,5 (PM2,5) se refieren a partículas finas con diámetros generalmente de 2,5 micrómetros o menores. Estas partículas son más de 100 veces más finas que un cabello humano y pueden permanecer suspendidas en el aire durante largos periodos.
Particulate Matter 10	La materia particulada 10 (PM10) se refiere a partículas con diámetros generalmente de 10 micrómetros o menores. Estas partículas pueden incluir polvo, polen, hollín, humo y gotas de líquido.
Sulfur Dioxide	El dióxido de azufre (SO2) es un gas inorgánico pesado e incoloro con un olor penetrante e irritante. Se produce principalmente mediante la quema de combustibles fósiles en centrales eléctricas e instalaciones industriales, pero también puede ser emitido por fuentes naturales como los volcanes.

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info		Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

JsonFormat

Enumeración

Formato deseado de la respuesta. Solo se admite json formato.

Valor	Description
json	el formato de intercambio de datos de notación de objetos JavaScript

Pollutant

Objeto

Un solo contaminante medido en la ubicación consultada, devuelto como una entrada en AirQuality.pollutants. Cada entrada identifica el contaminante (por código y nombre en inglés), informa de que se mide concentration en el aire y da la contribución individual del contaminante al AQI local (index) y al índice normalizado internacionalmente (globalIndex) - las mismas dos escalas reportadas en la lectura global sobre AirQuality, pero restringidas a este contaminante. Una lectura típica de calidad del aire incluye una entrada por contaminante: dióxido de nitrógeno, ozono, partículas en suspensión 10, partículas en 2,5, monóxido de carbono y dióxido de azufre , para que los llamantes puedan ver qué sustancias están presentes y cuánto contribuye cada una.

Nombre	Tipo	Description
concentration	WeatherValue	La concentración medida del contaminante en el aire, en microgramos por metro cúbico (μg/m³) para NO2, O3, PM10, PM2.5, CO y SO2 —por ejemplo, 53,5 μg/m³ para ozono o 13,4 μg/m³ para dióxido de nitrógeno — o en partes por millón (ppm) cuando se reporta en esa unidad. La concentración es la medida en bruto que alimenta y `indexglobalIndex`.
globalIndex	number (float)	La contribución de este contaminante al índice de calidad del aire normalizado internacionalmente, en la misma escala de 0 a 300+ para `AirQuality.globalIndex` que los valores por contaminante puedan compararse entre diferentes ubicaciones. Valores más altos denotan una mayor contribución a la mala calidad del aire. Por ejemplo, 22,1 para ozono o 6,7 para dióxido de nitrógeno.
index	number (float)	La contribución de este contaminante al índice global de calidad del aire (AQI) en la escala establecida por el organismo regulador local para la ubicación consultada. Utiliza la misma escala local que `AirQuality.index`, por lo que el número bruto es comparable a la lectura global en la misma ubicación pero no directamente comparable entre ubicaciones — por ejemplo, 21,6 para ozono en una lectura con 21,6 global `index` (el ozono es el contaminante dominante). Para contexto, véase Índice de calidad del aire en Wikipedia.
name	string	El nombre inglés del contaminante se combina con `type` : por ejemplo, Nitrogen Dioxid para NO2, Ozono para O3, Particulate Matter 10 para PM10, Particulate Matter 2,5 para PM2,5, Carbon Monoxide para CO, o Sulfur Dioxide para SO2. Siempre devuelta en inglés independientemente del idioma solicitado, lo que la hace adecuada como etiqueta de visualización estable cuando no se requiere texto localizado.
type	PollutantType	El código contaminante, utilizado como identificador estable e independiente del idioma, es uno de los `PollutantType` valores (PM2.5, PM10, O3, NO2, SO2 o CO). En el futuro se pueden añadir tipos adicionales de contaminantes.

PollutantType

Enumeración

Una descripción de los seis tipos de contaminantes monitorizados por el servicio meteorológico de Azure Maps.

Valor	Description
CO	La concentración media de monóxido de carbono (CO) en microgramos por metro cúbico (μg/m³) durante la última hora. El CO es un gas incoloro, inodoro e insípido pero altamente tóxico, producido por la combustión incompleta de combustibles que contienen carbono. Las fuentes comunes incluyen gases de escape de vehículos, estufas de gas, hornos y fuegos de leña.
NO2	La concentración media de dióxido de nitrógeno (NO2) en microgramos por metro cúbico (μg/m³) durante la última hora. El NO2 es un contaminante atmosférico significativo. Está regulado y sujeto a las pautas de límite recomendadas establecidas por la Organización Mundial de la Salud (OMS).
O3	La concentración media de ozono (O3) en microgramos por metro cúbico (μg/m³) durante la última hora. El O3 es un componente clave del smog fotoquímico, la neblina marrón y dañina que envuelve muchas grandes ciudades, resultado de una reacción fotoquímica entre la luz solar y ciertos contaminantes.
PM2.5	La concentración media de partículas menor a 2,5 micras de diámetro, medida en microgramos por metro cúbico (μg/m³), durante la última hora. El PM2.5, también conocido como aerosoles, consiste en polvo fino y diminutas gotas líquidas suspendidas en el aire.
PM10	La concentración media de partículas con diámetros entre 2,5 y 10 micras, medida en microgramos por metro cúbico (μg/m³) durante la última hora. Las partículas en suspensión 10 (PM10), también conocidas como aerosoles, consisten en polvo fino y diminutas gotas líquidas suspendidas en el aire.
SO2	La concentración media de dióxido de azufre (SO2) en microgramos por metro cúbico (μg/m³) durante la última hora. El SO2 es un gas inorgánico denso e incoloro con un olor penetrante e irritante. Se produce principalmente mediante la combustión de combustibles fósiles en centrales eléctricas e instalaciones industriales, pero también puede emitirse desde fuentes naturales como volcanes.

UnitType

Enumeración

Un valor entero asociado al tipo de unidad que se está mostrando. Por ejemplo, 17 para Celsius, 18 para Fahrenheit. Se puede utilizar para la traducción de unidades. Para más información, consulte Servicios meteorológicos en Azure Maps.

Valor	Description
0	feet
1	inches
2	miles
3	millimeter
4	centimeter
5	meter
6	kilometer
7	kilometersPerHour
8	knots
9	milesPerHour
10	metersPerSecond
11	hectoPascals
12	inchesOfMercury
13	kiloPascals
14	millibars
15	millimetersOfMercury
16	poundsPerSquareInch
17	Grados centígrados
18	Fahrenheit
19	kelvin
20	percent
21	flotante
22	entero
31	MicrogramsPerCubicMeterOfAir

WeatherValue

Objeto

Valores para métricas relacionadas con el clima, como temperatura, punto de rocío y velocidad del viento, presentados en unidades métricas o imperiales, según se especifica en el parámetro unitario URI. Para más información, véase Tipos de unidades en el artículo Servicios meteorológicos en Azure Maps.

Nombre	Tipo	Description
unit	string	La unidad de medida utilizada en el valor de retorno, como "C" para Celsius, "F" para Fahrenheit.
unitType	UnitType	Un entero que representa el tipo de unidad. Por ejemplo, 0 para pies, 1 para pulgadas, 2 para millas. Para una lista completa, véase Tipos de unidades en el artículo Servicios meteorológicos en Azure Maps.
value	number (float)	El valor medido expresado en la unidad especificada.