Weather - Get Current Air Quality
Utilisez pour obtenir des informations actuelles sur la qualité de l’air qui incluent les risques potentiels et les précautions suggérées.
L’API Get Current Air Quality
est une requête HTTP GET
qui retourne des informations détaillées sur la concentration des polluants et l’état global 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, ainsi qu’une brève déclaration résumant le niveau de risque et les précautions suggérées.
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}
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
format
|
path | True |
Format souhaité de la réponse. Seul le format |
|
api-version
|
query | True |
string |
Numéro de version de l’API Azure Maps. |
query
|
query | True |
number[] |
Requête applicable spécifiée sous la forme d’une chaîne séparée par des virgules composée par latitude suivie de longitude, par exemple « 47.641268,-122.125679 ». |
language
|
query |
string |
Langue dans laquelle les résultats de la recherche doivent être retournés. Doit être l’une des balises de langue IETF prises en charge, ne respectant pas 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 retourne des informations détaillées sur chaque polluant. Par défaut, a la valeur True. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
x-ms-client-id |
string |
Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité d’ID Microsoft Entra. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte du plan de gestion Azure Maps. Pour utiliser la sécurité des ID Microsoft Entra dans Azure Maps, consultez les articles suivants pour obtenir des conseils. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Ok |
|
Other Status Codes |
Une erreur inattendue s’est produite. |
Sécurité
AADToken
Il s’agit des flux OAuth Microsoft Entra 2.0 . Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure , il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Ou sous-ressources Azure Maps. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations aux API REST Azure Maps.
Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.
Notes
- Cette définition de sécurité nécessite l’utilisation de l’en-tête
x-ms-client-id
pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion maps .
est Authorization URL
spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra.
* Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via le portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.
* L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une 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 | https://atlas.microsoft.com/.default |
subscription-key
Il s’agit d’une clé partagée qui est provisionnée lorsque vous créez un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, cli, kits SDK Azure ou API REST.
Avec cette clé, n’importe quelle 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 elle est émise.
Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’approche des applications clientes confidentielles pour accéder aux API REST Azure Maps afin que votre clé puisse être stockée en toute sécurité.
Type:
apiKey
Dans:
query
SAS Token
Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération Répertorier les SAP sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, kits SDK Azure ou 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 à la ou les régions d’utilisation du 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 Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAS.
Type:
apiKey
Dans:
header
Exemples
Get Current Air Quality
Exemple de requête
GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&query=47.632346,-122.13887
Exemple de réponse
{
"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
}
}
]
}
]
}
Définitions
Nom | Description |
---|---|
Air |
Informations sur la qualité de l’air dans un endroit spécifique à un moment précis. |
Air |
Cet objet est retourné à partir d’un appel Obtenir la qualité de l’air réussi. |
Dominant |
Type de polluant. Notez que d’autres peuvent être ajoutés à tout moment. |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Json |
Format souhaité de la réponse. Seul le format |
Pollutant |
Informations détaillées sur un polluant individuel. Non retourné si |
Pollutant |
Type de polluant. Notez que d’autres peuvent être ajoutés à tout moment. |
Unit |
Valeur d’ID numérique associée au type d’unité affichée. Peut être utilisé pour la traduction d’unités. Pour plus d’informations, reportez-vous aux services météorologiques dans Azure Maps . |
Weather |
Valeur spécifique d’une unité donnée liée à la météo. |
AirQuality
Informations sur la qualité de l’air dans un endroit spécifique à un moment précis.
Nom | Type | Description |
---|---|---|
category |
string |
Description en un mot de la qualité de l’air dans la langue demandée. Par exemple, « Excellent ». |
categoryColor |
string |
Couleur unique correspondant à la catégorie de ce résultat de qualité de l’air. |
dateTime |
string |
Date et heure de l’observation actuelle affichées au format ISO 8601, par exemple 2019-10-27T19:39:57-08:00. |
description |
string |
Une explication textuelle de ce résultat de la qualité de l’air dans la langue demandée. |
dominantPollutant |
Polluant ayant la concentration la plus élevée. |
|
globalIndex |
number |
Normalisation internationale de la qualité de l’air sur une échelle de 0 à 300 et plus, avec des chiffres plus élevés représentant une qualité de l’air moins bonne. |
index |
number |
Évaluation de la qualité de l’air sur une échelle par les organismes de réglementation locaux. Les échelles peuvent varier considérablement en fonction de l’emplacement. Pour plus d’informations, consultez Wikipédia . |
pollutants |
Informations sur les polluants individuels. |
AirQualityResult
Cet objet est retourné à partir d’un appel Obtenir la qualité de l’air réussi.
Nom | Type | Description |
---|---|---|
nextLink |
string |
est le lien vers la page suivante des fonctionnalités retournées. S’il s’agit de la dernière page, non ce champ. |
results |
Liste de tous les résultats de qualité de l’air pour l’emplacement interrogé. |
DominantPollutant
Type de polluant. Notez que d’autres peuvent être ajoutés à tout moment.
Nom | Type | Description |
---|---|---|
Carbon Monoxide |
string |
Monoxyde de carbone (« CO ») |
Nitrogen Dioxide |
string |
Dioxyde d’azote (« NO2 ») |
Ozone |
string |
Ozone (« O3 ») |
Particulate Matter 10 |
string |
Matière particulaire 10 (« PM10 ») |
Particulate Matter 2.5 |
string |
Matière particulaire 2,5 (« PM2.5 ») |
Sulfur Dioxide |
string |
Dioxyde de soufre (« SO2 ») |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
Nom | Type | Description |
---|---|---|
info |
object |
Informations supplémentaires |
type |
string |
Type d’informations supplémentaires. |
ErrorDetail
Détail de l’erreur.
Nom | Type | Description |
---|---|---|
additionalInfo |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d'erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
Nom | Type | Description |
---|---|---|
error |
Objet error. |
JsonFormat
Format souhaité de la réponse. Seul le format json
est pris en charge.
Nom | Type | Description |
---|---|---|
json |
string |
Pollutant
Informations détaillées sur un polluant individuel. Non retourné si pollutants
=false.
Nom | Type | Description |
---|---|---|
concentration |
Objet contenant le nombre de particules de polluants par volume d’air. |
|
globalIndex |
number |
Normalisation internationale de la qualité de l’air sur une échelle de 0 à 300 et plus, avec des chiffres plus élevés représentant une qualité de l’air moins bonne. |
index |
number |
Évaluation de la qualité de l’air sur une échelle par les organismes de réglementation locaux. Les échelles peuvent varier considérablement en fonction de l’emplacement. Pour plus d’informations, consultez Wikipédia . |
name |
string |
Nom du polluant en anglais. |
type |
Type de polluant. Notez que d’autres peuvent être ajoutés à tout moment. |
PollutantType
Type de polluant. Notez que d’autres peuvent être ajoutés à tout moment.
Nom | Type | Description |
---|---|---|
CO |
string |
Monoxyde de carbone (« CO ») |
NO2 |
string |
Dioxyde d’azote (« NO2 ») |
O3 |
string |
Ozone (« O3 ») |
PM10 |
string |
Matière particulaire 10 (« PM10 ») |
PM2.5 |
string |
Matière particulaire 2,5 (« PM2.5 ») |
SO2 |
string |
Dioxyde de soufre (« SO2 ») |
UnitType
Valeur d’ID numérique associée au type d’unité affichée. Peut être utilisé pour la traduction d’unités. Pour plus d’informations, reportez-vous aux services météorologiques dans Azure Maps .
Nom | Type | Description |
---|---|---|
0 |
Integer |
|
1 |
Integer |
|
10 |
Integer |
|
11 |
Integer |
|
12 |
Integer |
|
13 |
Integer |
|
14 |
Integer |
|
15 |
Integer |
|
16 |
Integer |
|
17 |
Integer |
|
18 |
Integer |
|
19 |
Integer |
|
2 |
Integer |
|
20 |
Integer |
|
21 |
Integer |
|
22 |
Integer |
|
3 |
Integer |
|
31 |
Integer |
|
4 |
Integer |
|
5 |
Integer |
|
6 |
Integer |
|
7 |
Integer |
|
8 |
Integer |
|
9 |
Integer |
WeatherUnit
Valeur spécifique d’une unité donnée liée à la météo.
Nom | Type | Description |
---|---|---|
unit |
string |
Type d’unité pour la valeur retournée. |
unitType |
Valeur d’ID numérique associée au type d’unité affichée. Peut être utilisé pour la traduction d’unités. Pour plus d’informations, reportez-vous aux services météorologiques dans Azure Maps . |
|
value |
number |
Valeur arrondie. |