Weather - Get Current Air Quality

潜在的なリスクと推奨される予防措置を含む現在の大気質情報を取得するために使用します。

Get Current Air Quality API は、汚染物質の濃度と現在の大気質の全体的なステータスに関する詳細情報 (汚染レベル、大気質指数値、主要な汚染物質、リスク レベルと推奨される予防措置をまとめた簡単なステートメントなど) を返す HTTP GET 要求です。

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}

URI パラメーター

要求ヘッダー

応答

セキュリティ

AADToken

これらはMicrosoft Entra OAuth 2.0フローです。 Azureロールベースアクセス制御と組み合わせることで、Azure Maps REST APIへのアクセス制御に利用できます。 Azure ロールベースのアクセス制御は、1つ以上の Azure Maps リソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 任意のユーザー、グループ、またはサービスプリンシパルは、組み込みの役割やAzure Maps REST APIに対する1つ以上の権限で構成されたカスタムロールを通じてアクセス権を付与できます。

シナリオを実装するには、認証の概念表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。

注記

• このセキュリティ定義要求アプリケーションがどのAzure Mapsリソースにアクセスを要求しているかを示すためにx-ms-client-idヘッダーを使用します。 これは、Maps 管理 API から取得できます。

Authorization URLはAzureパブリッククラウドインスタンス専用です。 ソブリンクラウドは固有の認可URLとMicrosoft Entra IDの設定を持っています。 * Azureロールベースのアクセス制御は、Azureポータル、PowerShell、CLI、Azure SDKs、REST APIを通じてAzure管理プレーンから設定されます。 * Azure Maps Web SDKの利用により、複数のユースケース向けにアプリケーションの設定が可能になります。

• Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

subscription-key

これは共有キーで、AzureポータルでAzure Mapsアカウント作成するか、PowerShell、CLI、Azure SDKs、REST APIを使ってプロビジョニングされます。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。 つまり、このキーは、発行されたアカウントのマスター キーとして使用できます。

公開されているアプリケーションについては、confidentialクライアントアプリケーションアプローチを用いてREST API Azure Mapsにアクセスし、キーを安全に保存することを推奨します。

型: apiKey
/: query

SAS Token

これは共有アクセス署名トークンで、Azure MapsリソースのList SAS操作からAzureポータル、PowerShell、CLI、Azure SDKs、REST APIを通じてAzure管理プレーンを経由して作成されます。

このトークンにより、どのアプリケーションもAzureの役割ベースのアクセス制御と細かい制御で、そのトークンの有効期限、速度、使用地域へのアクセスが許可されます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。

パブリックに公開されているアプリケーションの場合は、Map アカウント リソースの許可された配信元の特定の一覧を構成し、レンダリングの不正使用を制限し、SAS トークンを定期的に更新するように することをお勧めします。

型: apiKey
/: header

例

Get Current Air Quality

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

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

定義

AirQuality

大気質オブジェクトは、指定された場所における現在の大気質に関する包括的な情報を提供します。 これには、さまざまな汚染物質の濃度レベル、全体的な大気質を示す数値的な大気質指数(AQI)値、そして大気質に影響を与える支配的な汚染物質の特定が含まれます。 さらに、リスクレベルの概要も提供しており、潜在的な健康リスクを簡単にまとめ、注意点を提案しています。

AirQualityResult

指定された場所の現在の大気質に関する包括的な情報を提供する複数の 大気質 オブジェクトの配列です。

DominantPollutant

濃度が最も高い汚染物質を識別します。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

JsonFormat

応答の目的の形式。 json 形式のみがサポートされています。

Pollutant

個々の汚染物質に関する詳細情報。 pollutants=falseの場合、返されません。

PollutantType

Azure Maps Weather Serviceが追跡する6種類の汚染物質を指定しています。

UnitType

単位型を表す整数。 たとえば、摂氏の場合は 17、華氏の場合は 18 です。 単位の翻訳に使用できます。 完全なリストについては、Azure Mapsの気象サービスをご覧ください。

WeatherUnit

天候に関連する特定のユニットの特定の値。