Weather - Get Current Air Quality

Service:: Maps

Versione API:: 1.1

Utilizzare per ottenere informazioni aggiornate sulla qualità dell'aria che includono i potenziali rischi e le precauzioni suggerite.
L'API Get Current Air Quality è una richiesta HTTP GET che restituisce informazioni dettagliate sulla concentrazione di inquinanti e sullo stato generale dell'attuale qualità dell'aria, inclusi i livelli di inquinamento, i valori dell'indice di qualità dell'aria, l'inquinante dominante e una breve dichiarazione che riassume il livello di rischio e le precauzioni suggerite.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (uri)	Il nome host del servizio Mappe di Azure. Usa `https://atlas.microsoft.com` per il cloud pubblico Azure. Per puntare a una specifica Mappe di Azure geografica o a una nuvola sovrana, vedi Mappe di Azure ambito geografico.
format	path	True	JsonFormat	Formato desiderato della risposta. È supportato solo `json` formato.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
query	query	True	number[]	La query applicabile specificata come stringa delimitata da virgole composta da latitudine seguita da longitudine, ad esempio "47.641268,-122.125679". Le informazioni meteorologiche sono generalmente disponibili per le località sulla terraferma, i corpi idrici circondati dalla terraferma e le aree dell'oceano che si trovano entro circa 50 miglia nautiche da una costa.
language	query		string	Lingua in cui devono essere restituiti i risultati della ricerca. Deve essere uno dei tag di lingua IETF supportati, senza distinzione tra maiuscole e minuscole. Quando i dati nella lingua specificata non sono disponibili per un campo specifico, viene usata la lingua predefinita. Per informazioni dettagliate, vedere lingue supportate.
pollutants	query		boolean	Valore booleano che restituisce informazioni dettagliate su ciascun inquinante. Per impostazione predefinita è True.

Intestazione di richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-id		string	Indica l'account destinato all'uso con il modello di sicurezza Microsoft Entra ID. Questo ID univoco per l'account Mappe di Azure può essere ottenuto dall'Account API Mappe di Azure piano di gestione. Per maggiori informazioni sull'uso della sicurezza Microsoft Entra ID in Mappe di Azure, vedi Gestire l'autenticazione in Mappe di Azure.

Risposte

Nome	Tipo	Descrizione
200 OK	AirQualityResult	La richiesta ha avuto esito positivo.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

AadToken

Questi sono i flussi Microsoft Entra OAuth 2.0. Quando abbinata al controllo Azure basato su ruolo può essere utilizzata per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso basati su ruoli di Azure sono utilizzati per designare l'accesso a uno o più account o sottorisorse risorse di Mappe di Azure. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per le API REST di Mappe di Azure.

Per implementare scenari, è consigliabile visualizzare concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.

Note

Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare a quale risorsa di Mappe di Azure l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione di mappe .
Il Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione unici e configurazioni Microsoft Entra ID.
Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
L'utilizzo della Sdk Web di Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.
Per altre informazioni su Microsoft Identity Platform, vedere panoramica di Microsoft Identity Platform.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://atlas.microsoft.com/.default

subscription-key

Si tratta di una chiave condivisa di cui viene effettuato il provisioning quando si Creare un account di Mappe di Azure nel portale di Azure o usando PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o l'API REST.

Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere usata come chiave master nell'account in cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'approccio applicazioni client riservate per accedere alle API REST di Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.

Tipo: apiKey
In: header

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione List SAS nell'risorsa di Mappe di Azure tramite il piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere ai controlli di accesso in base al ruolo di Azure e al controllo granulare per la scadenza, la frequenza e le aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.

Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

Get Current Air Quality

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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
        }
      ]
    }
  ]
}

Definizioni

Nome	Descrizione
AirQuality	La lettura attuale della qualità dell'aria in una posizione, restituita come voce in `AirQualityResult.results`. Combina l'indice di qualità dell'aria riportato dall'ente regolatore locale (`index`) con un indice normalizzato a livello internazionale (`globalIndex`), identifica il `dominantPollutant` risultato che guida il risultato e li abbina a una qualità `category` localizzata e a una corrispondenza `categoryColor` adatta per un'interfaccia utente codificata a colori. Un breve `description` spiega cosa significa la lettura per le attività quotidiane e per eventuali precauzioni sanitarie e - quando la richiesta richiede dettagli sugli inquinanti - l'array `pollutants` mostra una suddivisione per inquinante.
AirQualityResult	La risposta è stata restituita dall'operazione Get Current Air Quality che fornisce le condizioni attuali di qualità dell'aria in una posizione specificata. L'array `results` contiene una singola `AirQuality` voce che riassume gli indici di qualità dell'aria locali e globalmente normalizzati, l'inquinante dominante, una categoria qualitativa e un colore corrispondente, una breve descrizione delle implicazioni per la salute e (quando richiesto) dettagli per inquinante.
DominantPollutant	Identifica l'inquinante con la più alta concentrazione.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta comune all'errore per tutte le API di Azure Resource Manager per restituire dettagli di errore per operazioni fallite. Questo segue anche il formato di risposta di errore OData.
JsonFormat	Formato desiderato della risposta. È supportato solo `json` formato.
Pollutant	Un singolo inquinante misurato nella posizione interrogata restituiva come una voce in `AirQuality.pollutants`. Ogni voce identifica l'inquinante (per codice e nome inglese), riporta che è misurato `concentration` nell'aria e riporta il contributo individuale dell'inquinante all'AQI locale (`index`) e all'indice normalizzato a livello internazionale (`globalIndex`) - le stesse due scale riportate nella lettura complessiva su `AirQuality`, ma limitate a questo inquinante. Una tipica lettura della qualità dell'aria riporta una voce per ogni inquinante - Biossido di azoto, Ozono, Particolato 10, Particolato 2,5, Monossido di Carbonio e Anidride Solforosa - così chi chiama può vedere quali sostanze sono presenti e quanto ciascuna contribue.
PollutantType	Una descrizione dei sei tipi di inquinanti tracciati dal servizio Mappe di Azure Weather.
UnitType	Un valore intero associato al tipo di unità visualizzata. Ad esempio, 17 per i gradi Celsius, 18 per i gradi Fahrenheit. Può essere utilizzato per la traslazione di unità. Per maggiori informazioni, vedi Servizi meteorologici a Mappe di Azure.
WeatherValue	Valori per metriche legate al meteo come temperatura, punto di rugiada e velocità del vento, presentati in unità metriche o imperiali, come specificato nel parametro URI unitario. Per ulteriori informazioni, vedi Tipi di unità nell'articolo Weather services in Mappe di Azure.

AirQuality

Oggetto

La lettura attuale della qualità dell'aria in una posizione, restituita come voce in AirQualityResult.results. Combina l'indice di qualità dell'aria riportato dall'ente regolatore locale (index) con un indice normalizzato a livello internazionale (globalIndex), identifica il dominantPollutant risultato che guida il risultato e li abbina a una qualità category localizzata e a una corrispondenza categoryColor adatta per un'interfaccia utente codificata a colori. Un breve description spiega cosa significa la lettura per le attività quotidiane e per eventuali precauzioni sanitarie e - quando la richiesta richiede dettagli sugli inquinanti - l'array pollutants mostra una suddivisione per inquinante.

Nome Tipo Descrizione

AirQualityResult

Oggetto

La risposta è stata restituita dall'operazione Get Current Air Quality che fornisce le condizioni attuali di qualità dell'aria in una posizione specificata. L'array results contiene una singola AirQuality voce che riassume gli indici di qualità dell'aria locali e globalmente normalizzati, l'inquinante dominante, una categoria qualitativa e un colore corrispondente, una breve descrizione delle implicazioni per la salute e (quando richiesto) dettagli per inquinante.

Nome	Tipo	Descrizione
nextLink	string	L'URL per recuperare la pagina successiva dei risultati quando la risposta è paginata, adatta per navigare tra set di risultati troppo grandi per essere restituiti in una singola chiamata. Vuoto quando non ci sono altre pagine.
results	AirQuality[]	La lettura attuale della qualità dell'aria in quella posizione, restituita come array a singolo elemento. L'inserimento riporta l'indice locale di qualità dell'aria (`index`), l'indice normalizzato a livello internazionale (`globalIndex`), il `dominantPollutant` (ad esempio, ozono), un elemento qualitativo `category` (come Fair) con corrispondenza `categoryColor` (ad esempio, #FFC300), un ricordo `description` delle implicazioni per la salute e - quando la richiesta richiede dettagli sugli inquinanti - un `pollutants` array con una voce per ogni inquinante misurato.

DominantPollutant

Enumerazione

Identifica l'inquinante con la più alta concentrazione.

Valore	Descrizione
Carbon Monoxide	Il monossido di carbonio (CO) è un gas incolore, inodore e insipido ma altamente tossico, prodotto dalla combustione incompleta di combustibili contenenti carbonio. Le fonti comuni includono gas di scarico dei veicoli, stufe a gas, forni e fuochi a legna.
Nitrogen Dioxide	Il biossido di azoto (NO2) è un inquinante atmosferico significativo. È regolamentato e soggetto alle linee guida sui limiti raccomandati stabilite dall'Organizzazione Mondiale della Sanità (OMS).
Ozone	L'ozono (O3) è un componente chiave dello smog fotochimico, la foschia marrone e dannosa che avvolge molte grandi città, risultante da una reazione fotochimica tra la luce solare e alcuni inquinanti specifici.
Particulate Matter 2.5	Il particolato 2,5 (PM2,5) si riferisce a particelle fini con diametri generalmente di 2,5 micrometri o inferiori. Queste particelle sono più di 100 volte più sottili di un capello umano e possono rimanere sospese nell'aria per lunghi periodi.
Particulate Matter 10	Le particelle particolato 10 (PM10) si riferiscono a particelle con diametri generalmente di 10 micrometri o inferiori. Queste particelle possono includere polvere, polline, fuliggine, fumo e goccioline di liquido.
Sulfur Dioxide	L'anidride solforosa (SO2) è un gas inorganico pesante e incolore con un odore pungente e irritante. Viene prodotto principalmente bruciando combustibili fossili in centrali elettriche e impianti industriali, ma può anche essere emesso da fonti naturali come i vulcani.

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info		Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta comune all'errore per tutte le API di Azure Resource Manager per restituire dettagli di errore per operazioni fallite. Questo segue anche il formato di risposta di errore OData.

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

JsonFormat

Enumerazione

Formato desiderato della risposta. È supportato solo json formato.

Valore	Descrizione
json	il formato dell'interscambio dati notazione oggetto JavaScript

Pollutant

Oggetto

Un singolo inquinante misurato nella posizione interrogata restituiva come una voce in AirQuality.pollutants. Ogni voce identifica l'inquinante (per codice e nome inglese), riporta che è misurato concentration nell'aria e riporta il contributo individuale dell'inquinante all'AQI locale (index) e all'indice normalizzato a livello internazionale (globalIndex) - le stesse due scale riportate nella lettura complessiva su AirQuality, ma limitate a questo inquinante. Una tipica lettura della qualità dell'aria riporta una voce per ogni inquinante - Biossido di azoto, Ozono, Particolato 10, Particolato 2,5, Monossido di Carbonio e Anidride Solforosa - così chi chiama può vedere quali sostanze sono presenti e quanto ciascuna contribue.

Nome	Tipo	Descrizione
concentration	WeatherValue	La concentrazione misurata dell'inquinante nell'aria, in microgrammi per metro cubo (μg/m³) per NO2, O3, PM10, PM2,5, CO e SO2 - ad esempio, 53,5 μg/m³ per l'ozono o 13,4 μg/m³ per l'anidride di azoto - o in parti per milione (ppm) quando riportato in quell'unità. La concentrazione è la misura grezza che alimenta `index` e `globalIndex`.
globalIndex	number (float)	Il contributo di questo inquinante all'indice di qualità dell'aria normalizzato a livello internazionale, sulla stessa scala `AirQuality.globalIndex` da 0 a 300+ in modo che i valori per inquinante possano essere confrontati tra le località. Valori più alti indicano un contributo maggiore alla scarsa qualità dell'aria. Ad esempio, 22,1 per l'ozono o 6,7 per l'anidride d'azoto.
index	number (float)	Il contributo di questo inquinante all'indice complessivo di qualità dell'aria (AQI) sulla scala stabilita dall'ente regolatore locale per la località interrogata. Utilizza la scala locale di `AirQuality.index`, quindi il numero grezzo è comparabile alla lettura complessiva nello stesso luogo ma non direttamente comparabile tra le località - ad esempio, 21,6 per l'ozono su una lettura con 21,6 complessivo `index` (l'ozono è l'inquinante dominante). Per contesto, vedi Indice della qualità dell'aria su Wikipedia.
name	string	Il nome inglese dell'inquinante si abbina a `type` - ad esempio, Azogen Dioxyde per NO2, Ozone per O3, Particulate Matter 10 per PM10, Particulate Matter 2.5 per PM2.5, Carbon Monoxide per CO, o Zinc Dishide per SO2. Sempre restituito in inglese indipendentemente dalla lingua richiesta, il che lo rende adatto come etichetta di visualizzazione stabile quando non è necessario un testo localizzato.
type	PollutantType	Il codice inquinante, usato come identificatore stabile e indipendente dalla lingua, è uno dei `PollutantType` valori (PM2.5, PM10, O3, NO2, SO2 o CO). In futuro potrebbero essere aggiunti ulteriori tipi di inquinanti.

PollutantType

Enumerazione

Una descrizione dei sei tipi di inquinanti tracciati dal servizio Mappe di Azure Weather.

Valore	Descrizione
CO	La concentrazione media di monossido di carbonio (CO) in microgrammi per metro cubo (μg/m³) nell'ultima ora. Il CO è un gas incolore, inodore e insipido ma altamente tossico, prodotto dalla combustione incompleta di combustibili contenenti carbonio. Le fonti comuni includono gas di scarico dei veicoli, stufe a gas, forni e fuochi a legna.
NO2	La concentrazione media di anidride di azoto (NO2) in microgrammi per metro cubo (μg/m³) nell'ultima ora. Il NO2 è un inquinante atmosferico significativo. È regolamentato e soggetto alle linee guida sui limiti raccomandati stabilite dall'Organizzazione Mondiale della Sanità (OMS).
O3	La concentrazione media di ozono (O3) in microgrammi per metro cubo (μg/m³) nell'ultima ora. L'O3 è un componente chiave dello smog fotochimico, la foschia marrone e dannosa che avvolge molte grandi città, risultante da una reazione fotochimica tra la luce solare e specifici inquinanti.
PM2.5	La concentrazione media di particelle inferiore a 2,5 micron di diametro, misurata in microgrammi per metro cubo (μg/m³), nell'ultima ora. Il PM2.5, noto anche come aerosol, è costituito da polvere fine e minuscole gocce di liquido sospese nell'aria.
PM10	La concentrazione media di particelle con diametri compresi tra 2,5 e 10 micron, misurata in microgrammi per metro cubo (μg/m³) nell'ultima ora. Il particolato 10 (PM10), noto anche come aerosol, è costituito da polvere fine e minuscole gocce di liquido sospese nell'aria.
SO2	La concentrazione media di anidride solforosa (SO2) in microgrammi per metro cubo (μg/m³) nell'ultima ora. Il SO2 è un gas denso e incolore e inorganico con un odore pungente e irritante. Viene principalmente prodotto dalla combustione di combustibili fossili nelle centrali elettriche e negli impianti industriali, ma può anche essere emessa da fonti naturali come i vulcani.

UnitType

Enumerazione

Un valore intero associato al tipo di unità visualizzata. Ad esempio, 17 per i gradi Celsius, 18 per i gradi Fahrenheit. Può essere utilizzato per la traslazione di unità. Per maggiori informazioni, vedi Servizi meteorologici a Mappe di Azure.

Valore	Descrizione
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	galleggiare
22	numero intero
31	MicrogramsPerCubicMeterOfAir

WeatherValue

Oggetto

Valori per metriche legate al meteo come temperatura, punto di rugiada e velocità del vento, presentati in unità metriche o imperiali, come specificato nel parametro URI unitario. Per ulteriori informazioni, vedi Tipi di unità nell'articolo Weather services in Mappe di Azure.

Nome	Tipo	Descrizione
unit	string	L'unità di misura utilizzata nel valore di ritorno, come "C" per Celsius, "F" per Fahrenheit.
unitType	UnitType	Un intero che rappresenta il tipo di unità. Per esempio, 0 per piedi, 1 per pollici, 2 per miglia. Per un elenco completo, vedi Tipi di unità nell'articolo Servizi meteorologici in Mappe di Azure.
value	number (float)	Il valore misurato espresso nell'unità specificata.