Weather - Get Current Air Quality

Referenz

Service:: Maps

API Version:: 1.1

Verwenden Sie, um aktuelle Luftqualitätsinformationen zu erhalten, die potenzielle Risiken und vorgeschlagene Vorsichtsmaßnahmen enthalten.

Die Get Current Air Quality API ist eine HTTP-AnforderungGET, die detaillierte Informationen über die Konzentration von Schadstoffen und die gesamt status für die aktuelle Luftqualität zurückgibt, einschließlich Der Schadstoffwerte, der Luftqualitätsindexwerte, des dominierenden Schadstoffs und einer kurzen Erklärung, in der das Risikoniveau und die vorgeschlagenen Vorsichtsmaßnahmen zusammengefasst sind.

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

With optional parameters:

GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&language={language}&query={query}&pollutants={pollutants}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	JsonFormat	Gewünschtes Format der Antwort. Nur das `json`-Format wird unterstützt.
api-version	query	True	string	Versionsnummer der Azure Maps API.
query	query	True	number[]	Die anwendbare Abfrage, die als kommagetrennte Zeichenfolge angegeben ist, die nach Breitengrad gefolgt von Längengrad besteht, z. B. "47.641268,-122.125679".
language	query		string	Sprache, in der Suchergebnisse zurückgegeben werden sollen. Sollte eines der unterstützten IETF-Sprachtags sein, wobei die Groß-/Kleinschreibung nicht beachtet wird. Wenn Daten in der angegebenen Sprache für ein bestimmtes Feld nicht verfügbar sind, wird die Standardsprache verwendet. Weitere Informationen finden Sie unter Unterstützte Sprachen .
pollutants	query		boolean	Boolescher Wert, der detaillierte Informationen zu jedem Schadstoff zurückgibt. Standardmäßig ist True.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID Sicherheitsmodell vorgesehen ist. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der konto-API auf Azure Maps Verwaltungsebene abgerufen werden. Anleitungen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Antworten

Name	Typ	Beschreibung
200 OK	AirQualityResult	OK
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

Hinweise

Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

Der Authorization URL ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen. * Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

Weitere Informationen zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Dies ist ein gemeinsam genutzter Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal oder mithilfe von PowerShell, der CLI, Azure SDKs oder der REST-API Create.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen zu verwenden, um auf Azure Maps REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

SAS Token

Hierbei handelt es sich um ein Shared Access Signature Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

Get Current Air Quality

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Definitionen

Name	Beschreibung
AirQuality	Informationen zur Luftqualität an einem bestimmten Ort zu einem bestimmten Zeitpunkt.
AirQualityResult	Dieses Objekt wird von einem erfolgreichen Aufruf zum Abrufen der Luftqualität zurückgegeben.
DominantPollutant	Art des Schadstoffs. Bitte beachten Sie, dass jederzeit weitere hinzugefügt werden können.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
JsonFormat	Gewünschtes Format der Antwort. Nur das `json`-Format wird unterstützt.
Pollutant	Detaillierte Informationen zu einem einzelnen Schadstoff. Wird nicht zurückgegeben, wenn `pollutants`=false.
PollutantType	Art des Schadstoffs. Bitte beachten Sie, dass jederzeit weitere hinzugefügt werden können.
UnitType	Numerischer ID-Wert, der dem Typ der angezeigten Einheit zugeordnet ist. Kann für die Einheitsübersetzung verwendet werden. Weitere Informationen finden Sie unter Wetterdienste in Azure Maps.
WeatherUnit	Spezifischer Wert einer bestimmten Einheit im Zusammenhang mit dem Wetter.

AirQuality

Informationen zur Luftqualität an einem bestimmten Ort zu einem bestimmten Zeitpunkt.

Name	Typ	Beschreibung
category	string	Ein-Wort-Beschreibung der Luftqualität in der angeforderten Sprache. Beispiel: "Ausgezeichnet".
categoryColor	string	Eine eindeutige Farbe, die der Kategorie dieses Luftqualitätsergebnisses entspricht.
dateTime	string	Datum und Uhrzeit der aktuellen Beobachtung im ISO 8601-Format, z. B. 2019-10-27T19:39:57-08:00.
description	string	Eine textliche Erklärung dieser Luftqualität führt zu der angeforderten Sprache.
dominantPollutant	DominantPollutant	Der Schadstoff mit der höchsten Konzentration.
globalIndex	number	International normalisierte Luftqualitätsbewertung auf einer Skala von 0 bis 300 und höher, wobei höhere Zahlen eine schlechtere Luftqualität darstellen.
index	number	Luftqualitätsbewertung auf einer Skala, die von lokalen Regulierungsbehörden festgelegt wird. Die Skalierungen können je nach Standort stark variieren. Weitere Informationen finden Sie unter Wikipedia .
pollutants	Pollutant[]	Informationen zu einzelnen Schadstoffen.

AirQualityResult

Dieses Objekt wird von einem erfolgreichen Aufruf zum Abrufen der Luftqualität zurückgegeben.

Name	Typ	Beschreibung
nextLink	string	Ist der Link zur nächsten Seite der zurückgegebenen Features. Wenn es sich um die letzte Seite handelt, ist dieses Feld nicht vorhanden.
results	AirQuality[]	Eine Liste aller Luftqualitätsergebnisse für den abgefragten Standort.

DominantPollutant

Art des Schadstoffs. Bitte beachten Sie, dass jederzeit weitere hinzugefügt werden können.

Name	Typ	Beschreibung
Carbon Monoxide	string	Kohlenmonoxid ("CO")
Nitrogen Dioxide	string	Stickstoffdioxid ("NO2")
Ozone	string	Ozon ("O3")
Particulate Matter 10	string	Partikel 10 ("PM10")
Particulate Matter 2.5	string	Feinstaub 2.5 ("PM2.5")
Sulfur Dioxide	string	Schwefeldioxid ("SO2")

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

JsonFormat

Gewünschtes Format der Antwort. Nur das json-Format wird unterstützt.

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation

Pollutant

Detaillierte Informationen zu einem einzelnen Schadstoff. Wird nicht zurückgegeben, wenn pollutants=false.

Name	Typ	Beschreibung
concentration	WeatherUnit	Ein Objekt, das die Anzahl der Schadstoffpartikel pro Luftvolumen enthält.
globalIndex	number	International normalisierte Luftqualitätsbewertung auf einer Skala von 0 bis 300 und höher, wobei höhere Zahlen eine schlechtere Luftqualität darstellen.
index	number	Luftqualitätsbewertung auf einer Skala, die von lokalen Regulierungsbehörden festgelegt wird. Die Skalierungen können je nach Standort stark variieren. Weitere Informationen finden Sie unter Wikipedia .
name	string	Der Name des Schadstoffs auf Englisch.
type	PollutantType	Art des Schadstoffs. Bitte beachten Sie, dass jederzeit weitere hinzugefügt werden können.

PollutantType