Weather - Get Current Air Quality

Referenz

Dienst:: 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-Anforderung GET , die detaillierte Informationen über die Konzentration von Schadstoffen und den Gesamtstatus der aktuellen Luftqualität zurückgibt, einschließlich Verschmutzungsstufen, Luftqualitätsindexwerten, 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}

Mit optionalen Parametern:

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	Das gewünschte 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. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Informationen zur Verwendung der 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 . In Kombination mit der rollenbasierten Zugriffssteuerung von Azure 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-Ressourcenkonten oder -Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem 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.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

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.

Ist Authorization URL spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen. * Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die 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 Übersicht über Microsoft Identity Platform.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

subscription-key

Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API bereitgestellt wird.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Anders ausgedrückt: Dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

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

Typ: apiKey
In: query

SAS Token

Dies ist ein Shared Access Signature-Token, das aus dem SAS-Listenvorgang für die Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Get Current Air Quality

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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 über die Luftqualität an einem bestimmten Ort zu einem bestimmten Zeitpunkt.
AirQualityResult	Dieses Objekt wird von einem erfolgreichen Get Air Quality-Aufruf 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	Das gewünschte 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 über die 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 textuelle Erklärung dieser Luftqualität führt in 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 schlechtere Luftqualität darstellen.
index	number	Luftqualitätsbewertung auf einer Skala, die von lokalen Regulierungsstellen festgelegt wird. Die Skalierungen können je nach Standort stark variieren. Weitere Informationen finden Sie unter Wikipedia .
pollutants	Pollutant[]	Informationen über einzelne Schadstoffe.

AirQualityResult

Dieses Objekt wird von einem erfolgreichen Get Air Quality-Aufruf 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	Feinstaub 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

Das gewünschte 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 schlechtere Luftqualität darstellen.
index	number	Luftqualitätsbewertung auf einer Skala, die von lokalen Regulierungsstellen 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