Weather - Get Current Air Quality

Service:: Maps

Version d’API:: 1.1

À utiliser pour obtenir des informations à jour sur la qualité de l’air qui comprennent les risques potentiels et les précautions suggérées.
L’API Get Current Air Quality est une requête HTTP GET qui renvoie des informations détaillées sur la concentration de polluants et l’état général de la qualité de l’air actuelle, y compris les niveaux de pollution, les valeurs de l’indice de qualité de l’air, le polluant dominant, et une brève déclaration résumant le niveau de risque et les précautions suggérées.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	Le nom d’hôte du service Azure Maps. Utilisez `https://atlas.microsoft.com` pour le Azure cloud public. Pour cibler une géographie Azure Maps spécifique ou un nuage souverain, voir Azure Maps portée géographique.
format	path	True	JsonFormat	Format souhaité de la réponse. Seul `json` format est pris en charge.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
query	query	True	number[]	Requête applicable spécifiée en tant que chaîne séparée par des virgules composée par latitude suivie de longitude, par exemple « 47,641268,-1222.125679 ». Les informations météorologiques sont généralement disponibles pour les emplacements sur terre, les plans d’eau entourés de terre et les zones de l’océan qui se trouvent à environ 50 milles marins d’un littoral.
language	query		string	Langue dans laquelle les résultats de recherche doivent être retournés. Doit être l’une des balises de langage IETF prises en charge, sans respect de la casse. Lorsque les données dans la langue spécifiée ne sont pas disponibles pour un champ spécifique, la langue par défaut est utilisée. Pour plus d’informations, consultez langues prises en charge.
pollutants	query		boolean	Valeur booléenne qui renvoie des informations détaillées sur chaque polluant. La valeur par défaut est True.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Indique le compte destiné à être utilisé avec le modèle de sécurité Microsoft Entra ID. Cet ID unique pour le compte Azure Maps peut être obtenu depuis l’API de compte Azure Maps plan de gestion. Pour plus d’informations sur l’utilisation de la sécurité Microsoft Entra ID dans Azure Maps, voir Gérer l’authentification dans Azure Maps.

Réponses

Nom	Type	Description
200 OK	AirQualityResult	La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

AadToken

Ce sont les flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé au contrôle d’accès basé sur Azure par rôle, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès basés sur les rôles Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes ou sous-ressources de ressources Azure Maps. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.

Pour implémenter des scénarios, nous vous recommandons d’afficher concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Note

Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer la ressource Azure Maps à laquelle l’application demande l’accès. Cela peut être acquis à partir de l’API de gestion Maps.
La Authorization URL est spécifique à l’instance de cloud public Azure. Les clouds souverains disposent d’URL d’autorisation uniques et de configurations d’identifiants Microsoft Entra ID.
Le contrôle d’accès en fonction du rôle Azure est configuré à partir de l'plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.
L’utilisation du kit de développement logiciel (SDK) web Azure Maps permet la configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
Pour plus d’informations sur la plateforme d’identités Microsoft, consultez vue d’ensemble de la plateforme d’identités Microsoft.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

subscription-key

Il s’agit d’une clé partagée provisionnée lorsque vous créer un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, CLI, sdk Azure ou API REST.

Avec cette clé, toute application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé principale dans le compte dans lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser les applications clientes confidentielles approche permettant d’accéder aux API REST Azure Maps afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
Dans: header

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, azure SDK ou LES API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

Get Current Air Quality

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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
        }
      ]
    }
  ]
}

Définitions

Nom	Description
AirQuality	La lecture actuelle de la qualité de l’air à un endroit, renvoyée comme l’entrée dans `AirQualityResult.results`. Combine l’indice de qualité de l’air rapporté par l’organisme de régulation local (`index`) avec un indice normalisé internationalement (`globalIndex`), identifie l’élément `dominantPollutant` à l’origine du résultat, et les associe à une qualitative `category` localisée et une correspondance `categoryColor` adaptée à l’interface utilisateur codée par couleur. Un court `description` texte explique ce que la lecture signifie pour les activités quotidiennes et les précautions sanitaires, et – lorsque la demande demande des détails sur les polluants – le `pollutants` réseau présente une répartition par polluant.
AirQualityResult	La réponse est revenue par l’opération Get Current Air Quality en fournissant les conditions actuelles de qualité de l’air à un endroit spécifié. Le `results` tableau contient une seule `AirQuality` entrée résumant les indices locaux et globalement normalisés de la qualité de l’air, le polluant dominant, une catégorie qualitative et une couleur correspondante, une brève description des implications sanitaires et (sur demande) les détails par polluant.
DominantPollutant	Identifie le polluant avec la concentration la plus élevée.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).
JsonFormat	Format souhaité de la réponse. Seul `json` format est pris en charge.
Pollutant	Un seul polluant mesuré à l’emplacement interrogé est retourné comme une entrée dans `AirQuality.pollutants`. Chaque entrée identifie le polluant (par code et nom anglais), indique sa mesure `concentration` dans l’air, et donne la contribution individuelle du polluant à l’AQI local (`index`) et à l’indice internationalement normalisé (`globalIndex`) - les mêmes deux échelles rapportées à la lecture globale sur `AirQuality`, mais limitées à ce polluant. Une lecture typique de la qualité de l’air indique une entrée par polluant – Dioxyde d’azote, Ozone, Particules 10, Particules 2,5, Monoxyde de carbone et Dioxyde de soufre – afin que les appelants puissent voir quelles substances sont présentes et dans quelle mesure chacune y contribue.
PollutantType	Une description des six types de polluants suivis par le service météo Azure Maps.
UnitType	Une valeur entière associée au type d’unité affichée. Par exemple, 17 pour Celsius, 18 pour Fahrenheit. Peut être utilisé pour la traduction unitaire. Pour plus d’informations, voir Services météorologiques en Azure Maps.
WeatherValue	Valeurs pour les indicateurs météorologiques tels que la température, le point de rosée et la vitesse du vent, présentées en unités métriques ou impériales, telles que spécifiées dans le paramètre unité URI. Pour plus d’informations, voir Types d’unités dans l’article Services météo dans Azure Maps.

AirQuality

Objet

La lecture actuelle de la qualité de l’air à un endroit, renvoyée comme l’entrée dans AirQualityResult.results. Combine l’indice de qualité de l’air rapporté par l’organisme de régulation local (index) avec un indice normalisé internationalement (globalIndex), identifie l’élément dominantPollutant à l’origine du résultat, et les associe à une qualitative category localisée et une correspondance categoryColor adaptée à l’interface utilisateur codée par couleur. Un court description texte explique ce que la lecture signifie pour les activités quotidiennes et les précautions sanitaires, et – lorsque la demande demande des détails sur les polluants – le pollutants réseau présente une répartition par polluant.

Nom Type Description

AirQualityResult

Objet

La réponse est revenue par l’opération Get Current Air Quality en fournissant les conditions actuelles de qualité de l’air à un endroit spécifié. Le results tableau contient une seule AirQuality entrée résumant les indices locaux et globalement normalisés de la qualité de l’air, le polluant dominant, une catégorie qualitative et une couleur correspondante, une brève description des implications sanitaires et (sur demande) les détails par polluant.

Nom	Type	Description
nextLink	string	L’URL permettant de récupérer la page suivante des résultats lorsque la réponse est paginanée, adaptée pour naviguer à travers des ensembles de résultats trop volumineux pour être retournés en un seul appel. Vide quand il n’y a plus de pages.
results	AirQuality[]	La lecture actuelle de la qualité de l’air à cet endroit est rentrée sous forme d’un réseau à élément unique. L’entrée rapporte l’indice local de qualité de l’air (`index`), l’indice internationalement normalisé (`globalIndex`), le `dominantPollutant` (par exemple, l’ozone), un élément qualitatif `category` (comme Équitable) avec correspondance `categoryColor` (par exemple, #FFC300), un résumé `description` des implications sanitaires, et – lorsque la demande demande un détail sur les polluants – un `pollutants` tableau avec une entrée par polluant mesuré.

DominantPollutant

Énumération

Identifie le polluant avec la concentration la plus élevée.

Valeur	Description
Carbon Monoxide	Le monoxyde de carbone (CO) est un gaz incolore, inodore et insipide, mais hautement toxique, produit par la combustion incomplète de carburants contenant du carbone. Les sources courantes comprennent les gaz d’échappement des véhicules, les cuisinières à gaz, les fournaises et les feux de bois.
Nitrogen Dioxide	Le dioxyde d’azote (NO2) est un polluant atmosphérique important. Il est réglementé et soumis aux directives de limites recommandées par l’Organisation mondiale de la santé (OMS).
Ozone	L’ozone (O3) est un composant clé du smog photochimique, la brume brune et nocive qui enveloppe de nombreuses grandes villes, résultant d’une réaction photochimique entre la lumière du soleil et certains polluants spécifiques.
Particulate Matter 2.5	Les particules particulaires 2,5 (PM2,5) désignent des particules fines dont le diamètre est généralement de 2,5 micromètres ou moins. Ces particules sont plus de 100 fois plus fines qu’un cheveu humain et peuvent rester suspendues dans l’air pendant de longues périodes.
Particulate Matter 10	Les particules particulaires 10 (PM10) désignent des particules dont le diamètre est généralement de 10 micromètres ou moins. Ces particules peuvent inclure de la poussière, du pollen, de la suie, de la fumée et des gouttelettes de liquide.
Sulfur Dioxide	Le dioxyde de soufre (SO2) est un gaz inorganique, lourd et incolore, avec une odeur âcre et irritante. Il est principalement produit en brûlant des combustibles fossiles dans des centrales électriques et des installations industrielles, mais il peut également être émis par des sources naturelles telles que les volcans.

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info		Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

JsonFormat

Énumération

Format souhaité de la réponse. Seul json format est pris en charge.

Valeur	Description
json	le format d’échange de données JavaScript Object Notation

Pollutant

Objet

Un seul polluant mesuré à l’emplacement interrogé est retourné comme une entrée dans AirQuality.pollutants. Chaque entrée identifie le polluant (par code et nom anglais), indique sa mesure concentration dans l’air, et donne la contribution individuelle du polluant à l’AQI local (index) et à l’indice internationalement normalisé (globalIndex) - les mêmes deux échelles rapportées à la lecture globale sur AirQuality, mais limitées à ce polluant. Une lecture typique de la qualité de l’air indique une entrée par polluant – Dioxyde d’azote, Ozone, Particules 10, Particules 2,5, Monoxyde de carbone et Dioxyde de soufre – afin que les appelants puissent voir quelles substances sont présentes et dans quelle mesure chacune y contribue.

Nom	Type	Description
concentration	WeatherValue	La concentration mesurée par le polluant dans l’air, en microgrammes par mètre cube (μg/m³) pour le NO2, O3, PM10, PM2,5, le CO, et le SO2 – par exemple, 53,5 μg/m³ pour l’ozone ou 13,4 μg/m³ pour le dioxyde d’azote – ou en parties par million (ppm) lorsqu’il est indiqué dans cette unité. La concentration est la mesure brute qui alimente et `indexglobalIndex`.
globalIndex	number (float)	La contribution de ce polluant à l’indice de qualité de l’air normalisé internationalement, sur la même échelle de 0 à 300+ afin `AirQuality.globalIndex` que les valeurs par polluant puissent être comparées entre différentes localités. Des valeurs plus élevées indiquent une contribution plus importante à la mauvaise qualité de l’air. Par exemple, 22,1 pour l’ozone ou 6,7 pour le dioxyde d’azote.
index	number (float)	La contribution de ce polluant à l’indice global de qualité de l’air (AQI) sur l’échelle fixée par l’organisme de régulation local pour l’emplacement interrogé. Utilise la même échelle locale que `AirQuality.index`, donc le chiffre brut est comparable à la lecture globale au même endroit mais pas directement comparable entre les emplacements – par exemple, 21,6 pour l’ozone sur une lecture globale de `index`21,6 (l’ozone est le polluant dominant). Pour contexte, voir l’indice de qualité de l’air sur Wikipédia.
name	string	Le nom anglais du polluant s’associe à `type` – par exemple, Nitrogen Dioxyde pour le NO2, Ozone pour l’O3, Particulate Matter 10 pour le PM10, Particulate Matter 2,5 pour le PM2,5, Carbon Monoxyde pour le CO, ou Sulfur Dioxyde pour le SO2. Toujours retourné en anglais, quelle que soit la langue demandée, ce qui le rend adapté comme une étiquette d’affichage stable lorsque le texte localisé n’est pas nécessaire.
type	PollutantType	Le code polluant, utilisé comme identifiant stable et indépendant de la langue – l’une des `PollutantType` valeurs (PM2.5, PM10, O3, NO2, SO2 ou CO). D’autres types de polluants pourraient être ajoutés à l’avenir.

PollutantType

Énumération

Une description des six types de polluants suivis par le service météo Azure Maps.

Valeur	Description
CO	La concentration moyenne de monoxyde de carbone (CO) en microgrammes par mètre cube (μg/m³) au cours de la dernière heure. Le CO est un gaz incolore, inodore et insipide, mais hautement toxique, produit par la combustion incomplète de carburants contenant du carbone. Les sources courantes comprennent les gaz d’échappement des véhicules, les cuisinières à gaz, les fournaises et les feux de bois.
NO2	La concentration moyenne de dioxyde d’azote (NO2) en microgrammes par mètre cube (μg/m³) sur la dernière heure. Le NO2 est un polluant atmosphérique important. Il est réglementé et soumis aux directives de limites recommandées par l’Organisation mondiale de la santé (OMS).
O3	La concentration moyenne d’ozone (O3) en microgrammes par mètre cube (μg/m³) au cours de la dernière heure. L’O3 est un composant clé du smog photochimique, cette brume brune et nuisible qui enveloppe de nombreuses grandes villes, résultant d’une réaction photochimique entre la lumière du soleil et certains polluants.
PM2.5	La concentration moyenne de particules de moins de 2,5 microns de diamètre, mesurée en microgrammes par mètre cube (μg/m³), sur la dernière heure. Le PM2.5, également appelé aérosols, est constitué de fines poussières et de minuscules gouttelettes de liquide en suspension dans l’air.
PM10	La concentration moyenne de particules de diamètre compris entre 2,5 et 10 microns, mesurée en microgrammes par mètre cube (μg/m³) sur l’heure écoulée. Les particules particulaires 10 (PM10), également appelées aérosols, sont constituées de fines poussières et de minuscules gouttelettes de liquide suspendues dans l’air.
SO2	La concentration moyenne de dioxyde de soufre (SO2) en microgrammes par mètre cube (μg/m³) au cours de la dernière heure. Le SO2 est un gaz inorganique dense et incolore avec une odeur âcre et irritante. Il est principalement produit par la combustion de combustibles fossiles dans les centrales électriques et les installations industrielles, mais il peut aussi être émis par des sources naturelles telles que les volcans.

UnitType

Énumération

Une valeur entière associée au type d’unité affichée. Par exemple, 17 pour Celsius, 18 pour Fahrenheit. Peut être utilisé pour la traduction unitaire. Pour plus d’informations, voir Services météorologiques en Azure Maps.

Valeur	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	Celsius
18	Fahrenheit
19	kelvin
20	percent
21	flotter
22	entier
31	MicrogramsPerCubicMeterOfAir

WeatherValue

Objet

Valeurs pour les indicateurs météorologiques tels que la température, le point de rosée et la vitesse du vent, présentées en unités métriques ou impériales, telles que spécifiées dans le paramètre unité URI. Pour plus d’informations, voir Types d’unités dans l’article Services météo dans Azure Maps.

Nom	Type	Description
unit	string	L’unité de mesure utilisée dans la valeur de retour, comme « C » pour Celsius, « F » pour Fahrenheit.
unitType	UnitType	Un entier représentant le type d’unité. Par exemple, 0 pour les pieds, 1 pour les pouces, 2 pour les miles. Pour une liste complète, voir Types d’unités dans l’article Services météo dans Azure Maps.
value	number (float)	La valeur mesurée exprimée dans l’unité spécifiée.