{ "swagger": "2.0", "info": { "title": "Maps Weather", "version": "1.1", "description": "Azure Maps Weather REST APIs", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "x-ms-parameterized-host": { "hostTemplate": "{endpoint}", "useSchemePrefix": false, "parameters": [ { "name": "endpoint", "in": "path", "description": "The Azure Maps service hostname. Use `https://atlas.microsoft.com` for the Azure public cloud. To target a specific Azure Maps geography or a sovereign cloud, see [Azure Maps geographic scope](https://learn.microsoft.com/azure/azure-maps/geographic-scope).", "required": true, "type": "string", "format": "uri", "default": "https://atlas.microsoft.com", "x-ms-skip-url-encoding": true } ] }, "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "AadToken": [ "https://atlas.microsoft.com/.default" ] }, { "SharedKey": [] }, { "SasToken": [] } ], "securityDefinitions": { "AadToken": { "type": "oauth2", "description": "These are the [Microsoft Entra OAuth 2.0](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n> [!NOTE]\n>\n> * This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n> * The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations.\n> * The Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n> * Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n> * For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "https://atlas.microsoft.com/.default": "" } }, "SasToken": { "type": "apiKey", "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\nWith this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\nFor publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", "name": "SAS Token", "in": "header" }, "SharedKey": { "type": "apiKey", "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\nWith this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\nFor publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "header" } }, "tags": [], "paths": { "/weather/airQuality/current/{format}": { "get": { "operationId": "Weather_GetCurrentAirQuality", "summary": "Use to get current air quality information that includes potential risks and\nsuggested precautions.", "description": "The `Get Current Air Quality` API is an HTTP `GET` request that returns\ndetailed information about the concentration of pollutants and overall status\nfor current air quality, including pollution levels, air quality index values,\nthe dominant pollutant, and a brief statement summarizing risk level and\nsuggested precautions.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "language", "in": "query", "description": "Language in which search results should be returned. Should be one of supported\nIETF language tags, case insensitive. When data in specified language is not\navailable for a specific field, default language is used.\n\nPlease refer to [Supported\nLanguages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for\ndetails.", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "The applicable query specified as a comma separated string composed by latitude\nfollowed by longitude e.g. \"47.641268,-122.125679\".\n\nWeather information is generally available for locations on land, bodies of\nwater surrounded by land, and areas of the ocean that are within approximately\n50 nautical miles of a coastline.", "required": true, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "x-ms-client-name": "coordinates" }, { "name": "pollutants", "in": "query", "description": "Boolean value that returns detailed information about each pollutant. By\ndefault is True.", "required": false, "type": "boolean", "x-ms-client-name": "includePollutantDetails" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AirQualityResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Current Air Quality": { "$ref": "./examples/GetCurrentAirQuality.json" } } } }, "/weather/airQuality/forecasts/daily/{format}": { "get": { "operationId": "Weather_GetAirQualityDailyForecasts", "summary": "Use to get daily air quality forecasts for the next one to seven days that\ninclude pollutant levels, potential risks and suggested precautions.", "description": "The `Get Air Quality Daily Forecasts` API is an HTTP `GET` request that returns\ndetailed information about the concentration of pollutants and overall status\nof forecasted daily air quality. The service can provide forecasted daily air\nquality information for the upcoming 1 to 7 days, including pollution levels,\nair quality index values, the dominant pollutant, and a brief statement\nsummarizing risk level and suggested precautions.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "language", "in": "query", "description": "Language in which search results should be returned. Should be one of supported\nIETF language tags, case insensitive. When data in specified language is not\navailable for a specific field, default language is used.\n\nPlease refer to [Supported\nLanguages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for\ndetails.", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "The applicable query specified as a comma separated string composed by latitude\nfollowed by longitude e.g. \"47.641268,-122.125679\".\n\nWeather information is generally available for locations on land, bodies of\nwater surrounded by land, and areas of the ocean that are within approximately\n50 nautical miles of a coastline.", "required": true, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "x-ms-client-name": "coordinates" }, { "name": "duration", "in": "query", "description": "Defines the duration for the air quality forecast, with options ranging from 1\nto 7 days. The default duration is 1 day.", "required": false, "type": "number", "enum": [ 1, 2, 3, 4, 5, 6, 7 ], "x-ms-enum": { "name": "DailyDuration", "modelAsString": true, "values": [ { "name": "OneDay", "value": 1, "description": "1 day" }, { "name": "TwoDays", "value": 2, "description": "2 days" }, { "name": "ThreeDays", "value": 3, "description": "3 days" }, { "name": "FourDays", "value": 4, "description": "4 days" }, { "name": "FiveDays", "value": 5, "description": "5 days" }, { "name": "SixDays", "value": 6, "description": "6 days" }, { "name": "SevenDays", "value": 7, "description": "7 days" } ] } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DailyAirQualityForecastResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Daily Air Quality Forecasts": { "$ref": "./examples/GetDailyAirQuality.json" } } } }, "/weather/airQuality/forecasts/hourly/{format}": { "get": { "operationId": "Weather_GetAirQualityHourlyForecasts", "summary": "Use to get hourly air quality forecasts for the next one to 96 hours that\ninclude pollutant levels, potential risks and suggested precautions.", "description": "The `Get Air Quality Hourly Forecasts` API is an HTTP `GET` request that\nreturns detailed information about the concentration of pollutants and overall\nstatus for forecasted upcoming hourly air quality. The service can provide\nforecasted hourly air quality information for the upcoming time spans of 1, 12,\n24, 48, 72, and 96 hours, including pollution levels, air quality index values,\nthe dominant pollutant, and a brief statement summarizing risk level and\nsuggested precautions.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "language", "in": "query", "description": "Language in which search results should be returned. Should be one of supported\nIETF language tags, case insensitive. When data in specified language is not\navailable for a specific field, default language is used.\n\nPlease refer to [Supported\nLanguages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for\ndetails.", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "The applicable query specified as a comma separated string composed by latitude\nfollowed by longitude e.g. \"47.641268,-122.125679\".\n\nWeather information is generally available for locations on land, bodies of\nwater surrounded by land, and areas of the ocean that are within approximately\n50 nautical miles of a coastline.", "required": true, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "x-ms-client-name": "coordinates" }, { "name": "duration", "in": "query", "description": "Defines the duration, in hours, for the air quality forecast. Available values\nare 1, 12, 24, 48, 72, and 96. The default value is 1 hour.", "required": false, "type": "number", "enum": [ 1, 12, 24, 48, 72, 96 ], "x-ms-enum": { "name": "HourlyDuration", "modelAsString": true, "values": [ { "name": "OneHour", "value": 1, "description": "1 Hour" }, { "name": "TwelveHours", "value": 12, "description": "12 Hours" }, { "name": "TwentyFourHours", "value": 24, "description": "24 Hours" }, { "name": "FortyEightHours", "value": 48, "description": "48 Hours" }, { "name": "SeventyTwoHours", "value": 72, "description": "72 Hours" }, { "name": "NinetySixHours", "value": 96, "description": "96 Hours" } ] } }, { "name": "pollutants", "in": "query", "description": "Boolean value that returns detailed information about each pollutant. By\ndefault is True.", "required": false, "type": "boolean", "x-ms-client-name": "includePollutantDetails" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AirQualityResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Hourly Air Quality Forecasts": { "$ref": "./examples/GetHourlyAirQuality.json" } } } }, "/weather/currentConditions/{format}": { "get": { "operationId": "Weather_GetCurrentConditions", "summary": "Use to get current weather conditions.", "description": "The `Get Current Conditions` API is an HTTP `GET` request that returns detailed\ncurrent weather conditions such as precipitation, temperature and wind for a\ngiven coordinate location. Also, observations from the past 6 or 24 hours for a\nparticular location can be retrieved. The basic information returned with The\nresponse includes details such as observation date and time, brief description\nof the weather conditions, weather icon, precipitation indicator flags, and\ntemperature. Additional details such as RealFeel™ Temperature and UV index are\nalso returned. For more information, see [Request real-time weather\ndata](/azure/azure-maps/how-to-request-weather-data#request-real-time-weather-data)", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "query", "in": "query", "description": "The applicable query specified as a comma separated string composed by latitude\nfollowed by longitude e.g. \"47.641268,-122.125679\".\n\nWeather information is generally available for locations on land, bodies of\nwater surrounded by land, and areas of the ocean that are within approximately\n50 nautical miles of a coastline.", "required": true, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "x-ms-client-name": "coordinates" }, { "name": "unit", "in": "query", "description": "Specifies to return the data in either metric units or imperial units. Default\nvalue is metric.", "required": false, "type": "string", "enum": [ "imperial", "metric" ], "x-ms-enum": { "name": "WeatherDataUnit", "modelAsString": true, "values": [ { "name": "imperial", "value": "imperial", "description": "Return data using imperial units such as Fahrenheit (F) for temperature and\nmiles (mi) for distance." }, { "name": "metric", "value": "metric", "description": "Return data using metric units such as Celsius (C) for temperature and\nkilometer (km) for distance." } ] } }, { "name": "details", "in": "query", "description": "Return full details for the current conditions. Available values are\n* `true` - Returns full details. By default all details are returned.\n* `false` - Returns a truncated version of the current condition data, which\nincludes observation date time, weather phrase, icon code, precipitation\nindicator flag, and temperature.", "required": false, "type": "string" }, { "name": "duration", "in": "query", "description": "Time frame of the returned weather conditions. By default, the most current\nweather conditions will be returned. Default value is 0. Supported values are:\n* `0` - Return the most current weather conditions.\n* `6` - Return weather conditions from past 6 hours.\n* `24` - Return weather conditions from past 24 hours.", "required": false, "type": "integer", "format": "int32" }, { "name": "language", "in": "query", "description": "Language in which search results should be returned. Should be one of supported\nIETF language tags, case insensitive. When data in specified language is not\navailable for a specific field, default language is used.\n\nPlease refer to [Supported\nLanguages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for\ndetails.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/CurrentConditionsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successfully retrieve detailed current weather conditions for a given coordinate location": { "$ref": "./examples/GetCurrentConditions.json" } } } }, "/weather/forecast/daily/{format}": { "get": { "operationId": "Weather_GetDailyForecast", "summary": "Use to get a daily detailed weather forecast for the next 1, 5, 10, 15, 25, or\n45 days.", "description": "The `Get Daily Forecast` API is an HTTP `GET` request that returns detailed\nweather forecast such as temperature and wind by day for the next 1, 5, 10, 15,\n25, or 45 days for a given coordinate location. The response includes details\nsuch as temperature, wind, precipitation, air quality, and UV index. For more\ninformation, see [Request daily weather forecast\ndata](/azure/azure-maps/how-to-request-weather-data#request-daily-weather-forecast-data).", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "query", "in": "query", "description": "The applicable query specified as a comma separated string composed by latitude\nfollowed by longitude e.g. \"47.641268,-122.125679\".\n\nWeather information is generally available for locations on land, bodies of\nwater surrounded by land, and areas of the ocean that are within approximately\n50 nautical miles of a coastline.", "required": true, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "x-ms-client-name": "coordinates" }, { "name": "unit", "in": "query", "description": "Specifies to return the data in either metric units or imperial units. Default\nvalue is metric.", "required": false, "type": "string", "enum": [ "imperial", "metric" ], "x-ms-enum": { "name": "WeatherDataUnit", "modelAsString": true, "values": [ { "name": "imperial", "value": "imperial", "description": "Return data using imperial units such as Fahrenheit (F) for temperature and\nmiles (mi) for distance." }, { "name": "metric", "value": "metric", "description": "Return data using metric units such as Celsius (C) for temperature and\nkilometer (km) for distance." } ] } }, { "name": "duration", "in": "query", "description": "Specifies for how many days the daily forecast responses are returned.\nAvailable values are\n* `1` - Return forecast data for the next day. Returned by default.\n* `5` - Return forecast data for the next 5 days.\n* `10` - Return forecast data for the next 10 days.\n* `25` - Return forecast data for the next 25 days.\n* `45` - Return forecast data for the next 45 days.", "required": false, "type": "integer", "format": "int32" }, { "name": "language", "in": "query", "description": "Language in which search results should be returned. Should be one of supported\nIETF language tags, case insensitive. When data in specified language is not\navailable for a specific field, default language is used.\n\nPlease refer to [Supported\nLanguages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for\ndetails.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DailyForecastResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successfully retrieve detailed daily weather forecast for a given coordinate location": { "$ref": "./examples/GetDailyForecast.json" } } } }, "/weather/forecast/hourly/{format}": { "get": { "operationId": "Weather_GetHourlyForecast", "summary": "Use to get a detailed hourly weather forecast for up to 24 hours or a daily\nforecast for up to 10 days.", "description": "The `Get Hourly Forecast` API is an HTTP `GET` that Request detailed weather\nforecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days),\nand 240 hours (10 days) for the given the given coordinate location. The API\nreturns details such as temperature, humidity, wind, precipitation, and\nultraviolet (UV) index. For more information, see [Request hourly weather\nforecast\ndata](/azure/azure-maps/how-to-request-weather-data#request-hourly-weather-forecast-data).", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "query", "in": "query", "description": "The applicable query specified as a comma separated string composed by latitude\nfollowed by longitude e.g. \"47.641268,-122.125679\".\n\nWeather information is generally available for locations on land, bodies of\nwater surrounded by land, and areas of the ocean that are within approximately\n50 nautical miles of a coastline.", "required": true, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "x-ms-client-name": "coordinates" }, { "name": "unit", "in": "query", "description": "Specifies to return the data in either metric units or imperial units. Default\nvalue is metric.", "required": false, "type": "string", "enum": [ "imperial", "metric" ], "x-ms-enum": { "name": "WeatherDataUnit", "modelAsString": true, "values": [ { "name": "imperial", "value": "imperial", "description": "Return data using imperial units such as Fahrenheit (F) for temperature and\nmiles (mi) for distance." }, { "name": "metric", "value": "metric", "description": "Return data using metric units such as Celsius (C) for temperature and\nkilometer (km) for distance." } ] } }, { "name": "duration", "in": "query", "description": "Time frame of the returned weather forecast. By default, the forecast data for\nnext hour will be returned. Available values are\n* `1` - Return forecast data for the next hour. Default value.\n* `12` - Return hourly forecast for next 12 hours.\n* `24` - Return hourly forecast for next 24 hours.\n* `72` - Return hourly forecast for next 72 hours (3 days).\n* `120` - Return hourly forecast for next 120 hours (5 days).\n* `240` - Return hourly forecast for next 240 hours (10 days).", "required": false, "type": "integer", "format": "int32" }, { "name": "language", "in": "query", "description": "Language in which search results should be returned. Should be one of supported\nIETF language tags, case insensitive. When data in specified language is not\navailable for a specific field, default language is used.\n\nPlease refer to [Supported\nLanguages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for\ndetails.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/HourlyForecastResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successfully retrieve detailed weather forecast by the hour": { "$ref": "./examples/GetHourlyForecast.json" } } } }, "/weather/forecast/minute/{format}": { "get": { "operationId": "Weather_GetMinuteForecast", "summary": "Use to get a minute-by-minute forecast for the next 120 minutes in intervals of\n1, 5 and 15 minutes.", "description": "The `Get Minute Forecast` API is an HTTP `GET` request that returns\nminute-by-minute forecasts for a given location for the next 120 minutes.\nUsers can request weather forecasts in intervals of 1, 5 and 15 minutes. The\nresponse will include details such as the type of precipitation (including\nrain, snow, or a mixture of both), start time, and precipitation intensity\nvalue (dBZ). For more information, see [Request minute-by-minute weather\nforecast\ndata](/azure/azure-maps/how-to-request-weather-data#request-minute-by-minute-weather-forecast-data).", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "query", "in": "query", "description": "The applicable query specified as a comma separated string composed by latitude\nfollowed by longitude e.g. \"47.641268,-122.125679\".\n\nWeather information is generally available for locations on land, bodies of\nwater surrounded by land, and areas of the ocean that are within approximately\n50 nautical miles of a coastline.", "required": true, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "x-ms-client-name": "coordinates" }, { "name": "interval", "in": "query", "description": "Specifies time interval in minutes for the returned weather forecast. Supported\nvalues are\n* `1` - Retrieve forecast for 1-minute intervals. Returned by default.\n* `5` - Retrieve forecasts for 5-minute intervals.\n* `15` - Retrieve forecasts for 15-minute intervals.", "required": false, "type": "integer", "format": "int32" }, { "name": "language", "in": "query", "description": "Language in which search results should be returned. Should be one of supported\nIETF language tags, case insensitive. When data in specified language is not\navailable for a specific field, default language is used.\n\nPlease refer to [Supported\nLanguages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for\ndetails.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/MinuteForecastResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successfully retrieve minute-by-minute forecasts for a given location": { "$ref": "./examples/GetMinuteForecast.json" } } } }, "/weather/forecast/quarterDay/{format}": { "get": { "operationId": "Weather_GetQuarterDayForecast", "summary": "Use to get a Quarter-Day Forecast for the next 1, 5, 10, or 15 days.", "description": "The `Get Quarter-Day Forecast` API is an HTTP `GET` request that returns a\ndetailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for\na given location. Response data is presented by quarters of the day - morning,\nafternoon, evening, and overnight. Details such as temperature, humidity, wind,\nprecipitation, and UV index are returned.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "query", "in": "query", "description": "The applicable query specified as a comma separated string composed by latitude\nfollowed by longitude e.g. \"47.641268,-122.125679\".\n\nWeather information is generally available for locations on land, bodies of\nwater surrounded by land, and areas of the ocean that are within approximately\n50 nautical miles of a coastline.", "required": true, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "x-ms-client-name": "coordinates" }, { "name": "unit", "in": "query", "description": "Specifies to return the data in either metric units or imperial units. Default\nvalue is metric.", "required": false, "type": "string", "enum": [ "imperial", "metric" ], "x-ms-enum": { "name": "WeatherDataUnit", "modelAsString": true, "values": [ { "name": "imperial", "value": "imperial", "description": "Return data using imperial units such as Fahrenheit (F) for temperature and\nmiles (mi) for distance." }, { "name": "metric", "value": "metric", "description": "Return data using metric units such as Celsius (C) for temperature and\nkilometer (km) for distance." } ] } }, { "name": "duration", "in": "query", "description": "Specifies for how many days the quester-day forecast responses are returned.\nSupported values are:\n* `1` - Return forecast data for the next day. Returned by default.\n* `5` - Return forecast data for the next 5 days.\n* `10` - Return forecast data for next 10 days.\n* `15` - Return forecast data for the next 15 days.", "required": false, "type": "integer", "format": "int32" }, { "name": "language", "in": "query", "description": "Language in which search results should be returned. Should be one of supported\nIETF language tags, case insensitive. When data in specified language is not\navailable for a specific field, default language is used.\n\nPlease refer to [Supported\nLanguages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for\ndetails.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/QuarterDayForecastResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successfully retrieve detailed weather forecast by a given location": { "$ref": "./examples/GetQuarterDayForecast.json" } } } }, "/weather/historical/actuals/daily/{format}": { "get": { "operationId": "Weather_GetDailyHistoricalActuals", "summary": "Use to get climatology data such as past daily actual observed temperatures,\nprecipitation, snowfall and snow depth.", "description": "The `Get Daily Historical Actuals` API is an HTTP `GET` request that returns\nclimatology data such as past daily actual observed temperatures,\nprecipitation, snowfall, snow depth and cooling/heating degree day information,\nfor the day at a given coordinate location. The data is requested for a\nspecified date range, up to 31 days in a single API request. Generally,\nhistorical data may be available as far back as the last 5 to 40+ years,\ndepending on the location.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "query", "in": "query", "description": "The applicable query specified as a comma separated string composed by latitude\nfollowed by longitude e.g. \"47.641268,-122.125679\".\n\nWeather information is generally available for locations on land, bodies of\nwater surrounded by land, and areas of the ocean that are within approximately\n50 nautical miles of a coastline.", "required": true, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "x-ms-client-name": "coordinates" }, { "name": "startDate", "in": "query", "description": "Start date in [ISO\n8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, for\nexample, 2019-10-27. The date range supported is 1 to 31 calendar days, so be\nsure to specify a startDate and endDate that does not exceed a maximum of 31\ndays (i.e.: startDate=2012-01-01&endDate=2012-01-31).", "required": true, "type": "string", "format": "date" }, { "name": "endDate", "in": "query", "description": "End date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)\nformat, for example, 2019-10-28. The date range supported is 1 to 31 calendar\ndays, so be sure to specify a startDate and endDate that does not exceed a\nmaximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).", "required": true, "type": "string", "format": "date" }, { "name": "unit", "in": "query", "description": "Specifies to return the data in either metric units or imperial units. Default\nvalue is metric.", "required": false, "type": "string", "enum": [ "imperial", "metric" ], "x-ms-enum": { "name": "WeatherDataUnit", "modelAsString": true, "values": [ { "name": "imperial", "value": "imperial", "description": "Return data using imperial units such as Fahrenheit (F) for temperature and\nmiles (mi) for distance." }, { "name": "metric", "value": "metric", "description": "Return data using metric units such as Celsius (C) for temperature and\nkilometer (km) for distance." } ] } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DailyHistoricalActualsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Daily Historical Actuals Request": { "$ref": "./examples/GetDailyHistoricalActuals.json" } } } }, "/weather/historical/normals/daily/{format}": { "get": { "operationId": "Weather_GetDailyHistoricalNormals", "summary": "Use to get climatology data such as past daily normal temperatures,\nprecipitation and cooling/heating degree day information for a given location.", "description": "The `Get Daily Historical Normals` API is an HTTP `GET` request that returns\nclimatology data such as past daily normal temperatures, precipitation and\ncooling/heating degree day information for the day at a given coordinate\nlocation. The historical normals are a 30-year average for temperatures and\nprecipitation for a specific location. As is standard practice in climatology,\nthe 30-year average covers years 1991-2020, this data will be used for one\ndecade and then will reset in the year 2030. Generally, historical data may be\navailable as far back as the last 5 to 40+ years, depending on the location.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "query", "in": "query", "description": "The applicable query specified as a comma separated string composed by latitude\nfollowed by longitude e.g. \"47.641268,-122.125679\".\n\nWeather information is generally available for locations on land, bodies of\nwater surrounded by land, and areas of the ocean that are within approximately\n50 nautical miles of a coastline.", "required": true, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "x-ms-client-name": "coordinates" }, { "name": "startDate", "in": "query", "description": "Start date in [ISO\n8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, for\nexample, 2019-10-27. The date range supported is 1 to 31 calendar days, so be\nsure to specify a startDate and endDate that does not exceed a maximum of 31\ndays (i.e.: startDate=2012-01-01&endDate=2012-01-31).", "required": true, "type": "string", "format": "date" }, { "name": "endDate", "in": "query", "description": "End date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)\nformat, for example, 2019-10-28. The date range supported is 1 to 31 calendar\ndays, so be sure to specify a startDate and endDate that does not exceed a\nmaximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).", "required": true, "type": "string", "format": "date" }, { "name": "unit", "in": "query", "description": "Specifies to return the data in either metric units or imperial units. Default\nvalue is metric.", "required": false, "type": "string", "enum": [ "imperial", "metric" ], "x-ms-enum": { "name": "WeatherDataUnit", "modelAsString": true, "values": [ { "name": "imperial", "value": "imperial", "description": "Return data using imperial units such as Fahrenheit (F) for temperature and\nmiles (mi) for distance." }, { "name": "metric", "value": "metric", "description": "Return data using metric units such as Celsius (C) for temperature and\nkilometer (km) for distance." } ] } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DailyHistoricalNormalsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Daily Historical Normals Request": { "$ref": "./examples/GetDailyHistoricalNormals.json" } } } }, "/weather/historical/records/daily/{format}": { "get": { "operationId": "Weather_GetDailyHistoricalRecords", "summary": "Use to get climatology data such as past daily record temperatures,\nprecipitation and snowfall at a given location.", "description": "The `Get Daily Historical Records` API is an HTTP `GET` request that returns\nclimatology data such as past daily record temperatures, precipitation and\nsnowfall at a given coordinate location. Availability of records data will vary\nby location. Generally, historical data may be available as far back as the\nlast 5 to 40+ years, depending on the location.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "query", "in": "query", "description": "The applicable query specified as a comma separated string composed by latitude\nfollowed by longitude e.g. \"47.641268,-122.125679\".\n\nWeather information is generally available for locations on land, bodies of\nwater surrounded by land, and areas of the ocean that are within approximately\n50 nautical miles of a coastline.", "required": true, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "x-ms-client-name": "coordinates" }, { "name": "startDate", "in": "query", "description": "Start date in [ISO\n8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, for\nexample, 2019-10-27. The date range supported is 1 to 31 calendar days, so be\nsure to specify a startDate and endDate that does not exceed a maximum of 31\ndays (i.e.: startDate=2012-01-01&endDate=2012-01-31).", "required": true, "type": "string", "format": "date" }, { "name": "endDate", "in": "query", "description": "End date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)\nformat, for example, 2019-10-28. The date range supported is 1 to 31 calendar\ndays, so be sure to specify a startDate and endDate that does not exceed a\nmaximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).", "required": true, "type": "string", "format": "date" }, { "name": "unit", "in": "query", "description": "Specifies to return the data in either metric units or imperial units. Default\nvalue is metric.", "required": false, "type": "string", "enum": [ "imperial", "metric" ], "x-ms-enum": { "name": "WeatherDataUnit", "modelAsString": true, "values": [ { "name": "imperial", "value": "imperial", "description": "Return data using imperial units such as Fahrenheit (F) for temperature and\nmiles (mi) for distance." }, { "name": "metric", "value": "metric", "description": "Return data using metric units such as Celsius (C) for temperature and\nkilometer (km) for distance." } ] } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DailyHistoricalRecordsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Daily Historical Records Request": { "$ref": "./examples/GetDailyHistoricalRecords.json" } } } }, "/weather/indices/daily/{format}": { "get": { "operationId": "Weather_GetDailyIndices", "summary": "Use when you want to know if the weather conditions are optimal for a specific\nactivity such as outdoor sporting activities, construction, or farming (results\nincludes soil moisture information).", "description": "The `Get Daily Indices` API is an HTTP `GET` request returns index values that\nprovide guidance to help when planning future activities. For example, a health\nmobile application can notify users that today is good weather for running or\nfor other outdoors activities like playing golf or flying a kite. Retail stores\ncan optimize their digital marketing campaigns based on predicted index values.\nThe service returns in daily indices values for current and next 5, 10 and 15\ndays starting from current day.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "query", "in": "query", "description": "The applicable query specified as a comma separated string composed by latitude\nfollowed by longitude e.g. \"47.641268,-122.125679\".\n\nWeather information is generally available for locations on land, bodies of\nwater surrounded by land, and areas of the ocean that are within approximately\n50 nautical miles of a coastline.", "required": true, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "x-ms-client-name": "coordinates" }, { "name": "language", "in": "query", "description": "Language in which search results should be returned. Should be one of supported\nIETF language tags, case insensitive. When data in specified language is not\navailable for a specific field, default language is used.\n\nPlease refer to [Supported\nLanguages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for\ndetails.", "required": false, "type": "string" }, { "name": "duration", "in": "query", "description": "Specifies for how many days the daily indices are returned. By default, the\nindices data for the current day will be returned. When requesting future\nindices data, the current day is included in the response as day 1. Available\nvalues are\n* `1` - Return daily index data for the current day. Default value.\n* `5` - Return 5 days of daily index data starting from the current day.\n* `10` - Return 10 days of daily index data starting from the current day.\n* `15` - Return 15 days of daily index data starting from the current day.", "required": false, "type": "integer", "format": "int32" }, { "name": "indexId", "in": "query", "description": "Numeric index identifier that can be used for restricting returned results to\nthe corresponding index type. Cannot be paired with `indexGroupId`. Please\nrefer to [Weather services in Azure\nMaps](/azure/azure-maps/weather-services-concepts#index-ids-and-index-groups-ids)\nfor details and to see the supported indices.", "required": false, "type": "integer", "format": "int32" }, { "name": "indexGroupId", "in": "query", "description": "Numeric index group identifier that can be used for restricting returned\nresults to the corresponding subset of indices (index group). Cannot be paired\nwith `indexId`. Please refer to [Weather services in Azure\nMaps](/azure/azure-maps/weather-services-concepts#index-ids-and-index-groups-ids)\nfor details and to see the supported index groups.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DailyIndicesResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successfully retrieve daily indices values from current day": { "$ref": "./examples/GetDailyIndices.json" } } } }, "/weather/route/{format}": { "get": { "operationId": "Weather_GetWeatherAlongRoute", "summary": "Use to get a locationally precise, up-to-the-minute forecast that includes\nweather hazard assessments and notifications along a route.", "description": "The `Get Weather Along Route` API is an HTTP `GET` request that returns hyper\nlocal (one kilometer or less), up-to-the-minute weather nowcasts, weather\nhazard assessments, and notifications along a route described as a sequence of\nwaypoints.\nThis includes a list of weather hazards affecting the waypoint or route, and\nthe aggregated hazard index for each waypoint might be used to paint each\nportion of a route according to how safe it is for the driver. When submitting\nthe waypoints, it is recommended to stay within, or close to, the distance that\ncan be traveled within 120-mins or shortly after. Data is updated every five\nminutes.\n\nThe service supplements Azure Maps [Route\nService](https://docs.microsoft.com/rest/api/maps/route) that allows you to\nfirst request a route between an origin and a destination and use that as an\ninput for Weather Along Route endpoint.\n\nIn addition, the service supports scenarios to generate weather notifications\nfor waypoints that experience an increase in intensity of a weather hazard. For\nexample, if the vehicle is expected to begin experiencing heavy rain as it\nreaches a waypoint, a weather notification for heavy rain will be generated for\nthat waypoint allowing the end product to display a heavy rain notification\nbefore the driver reaches that waypoint.\nThe trigger for when to display the notification for a waypoint could be\nbased, for example, on a\n[geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps),\nor selectable distance to the waypoint.\n\nThe API covers all regions of the planet except latitudes above Greenland and\nAntarctica.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "query", "in": "query", "description": "Coordinates through which the route is calculated, separated by colon (:) and\nentered in chronological order. A minimum of two waypoints is required. A\nsingle API call may contain up to 60 waypoints.\nA waypoint indicates location, ETA, and optional heading:\nlatitude,longitude,ETA,heading, where\n* `Latitude` - Latitude coordinate in decimal degrees.\n* `Longitude` - Longitude coordinate in decimal degrees.\n* `ETA (estimated time of arrival)` - The number of minutes from the present\ntime that it will take for the vehicle to reach the waypoint. Allowed range is\nfrom 0.0 to 120.0 minutes.\n* `Heading` - An optional value indicating the vehicle heading as it passes\nthe waypoint. Expressed in clockwise degrees relative to true north. This is\nissued to calculate sun glare as a driving hazard. Allowed range is from 0.0 to\n360.0 degrees. If not provided, a heading will automatically be derived based\non the position of neighboring waypoints.\n\nIt is recommended to stay within, or close to, the distance that can be\ntraveled within 120-mins or shortly after. This way a more accurate assessment\ncan be provided for the trip and prevent isolated events not being captured\nbetween waypoints. Information can and should be updated along the route\n(especially for trips greater than 2 hours) to continuously pull new waypoints\nmoving forward, but also to ensure that forecast information for content such\nas precipitation type and intensity is accurate as storms develop and dissipate\nover time.", "required": true, "type": "string" }, { "name": "language", "in": "query", "description": "Language in which search results should be returned. Should be one of supported\nIETF language tags, case insensitive. When data in specified language is not\navailable for a specific field, default language is used.\n\nPlease refer to [Supported\nLanguages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for\ndetails.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/WeatherAlongRouteResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successfully retrieve detailed weather casts along a route described as a sequence of waypoints": { "$ref": "./examples/GetWeatherAlongRoute.json" } } } }, "/weather/severe/alerts/{format}": { "get": { "operationId": "Weather_GetSevereWeatherAlerts", "summary": "Use to get information about severe weather conditions such as hurricanes,\nthunderstorms, flooding, lightning, heat waves or forest fires for a given\nlocation.", "description": "Severe weather phenomenon can significantly impact our everyday life and\nbusiness operations. For example, severe weather conditions such as tropical\nstorms, high winds or flooding can close roads and force logistics companies to\nreroute their fleet causing delays in reaching destinations and breaking the\ncold chain of refrigerated food products.\n\nThe `Get Severe Weather Alerts` API is an HTTP `GET` request that returns the\nsevere weather alerts that are available worldwide from both official\nGovernment Meteorological Agencies and leading global to regional weather alert\nproviders. The service can return details such as alert type, category, level\nand detailed description about the active severe alerts for the requested\nlocation, like hurricanes, thunderstorms, lightning, heat waves or forest\nfires. For more information, see [Request severe weather\nalerts](/azure/azure-maps/how-to-request-weather-data#request-severe-weather-alerts)", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "query", "in": "query", "description": "The applicable query specified as a comma separated string composed by latitude\nfollowed by longitude e.g. \"47.641268,-122.125679\".\n\nWeather information is generally available for locations on land, bodies of\nwater surrounded by land, and areas of the ocean that are within approximately\n50 nautical miles of a coastline.", "required": true, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "x-ms-client-name": "coordinates" }, { "name": "language", "in": "query", "description": "Language in which search results should be returned. Should be one of supported\nIETF language tags, case insensitive. When data in specified language is not\navailable for a specific field, default language is used.\n\nPlease refer to [Supported\nLanguages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for\ndetails.", "required": false, "type": "string" }, { "name": "details", "in": "query", "description": "Return full details for the severe weather alerts. Available values are\n* `true` - Returns full details. By default all details are returned.\n* `false` - Returns a truncated version of the alerts data, which excludes\nthe area-specific full description of alert details (`alertDetails`).", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/SevereWeatherAlertsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successfully retrieve severe weather alerts": { "$ref": "./examples/GetSevereWeatherAlerts.json" } } } }, "/weather/tropical/storms/{format}": { "get": { "operationId": "Weather_GetTropicalStormSearch", "summary": "Use to get a list of storms issued by national weather forecasting agencies.", "description": "The `Get Tropical Storm Search` API is an HTTP `GET` request that returns a\nlist of government-issued tropical storms by year, basin ID, and government ID.\nInformation about the tropical storms includes, government ID, basin ID,\nstatus, year, name and if it is subtropical.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "year", "in": "query", "description": "Year of the cyclone(s)", "required": true, "type": "integer", "format": "int32" }, { "name": "basinId", "in": "query", "description": "The `basinId` enum categorizes the different ocean basins where tropical storms\ncan originate. Each basin is assigned a unique identifier to help specify the\nlocation of the storm's origin.", "required": false, "type": "string", "enum": [ "AL", "CP", "EP", "NI", "NP", "SI", "SP" ], "x-ms-enum": { "name": "BasinId", "modelAsString": true, "values": [ { "name": "AL", "value": "AL", "description": "**The Atlantic Ocean**. Crucial for tracking hurricanes that affect the\nAmericas and the Caribbean. It is one of the most active regions for\ntropical storms." }, { "name": "CP", "value": "CP", "description": "**The Central Pacific Ocean**. This basin is used for storms affecting Hawaii\nand surrounding areas." }, { "name": "EP", "value": "EP", "description": "**The Eastern Pacific Ocean**. This basin tracks storms impacting the western\ncoast of the Americas, including Mexico and Central America. It is adjacent\nto the Central Pacific basin." }, { "name": "NI", "value": "NI", "description": "**The North Indian Ocean**. This basin covers storms impacting South Asia,\nincluding countries like India and Bangladesh, which are frequently\naffected by cyclones." }, { "name": "NP", "value": "NP", "description": "**The Northwest Pacific Ocean**. This basin is important for tracking typhoons\nthat affect East Asia, including countries like China, Japan, and the\nPhilippines. It is the most active tropical storm regions globally." }, { "name": "SI", "value": "SI", "description": "**The South Indian Ocean**. This basin, positioned south of the equator, covers\ncyclones impacting Madagascar, Africa, and surrounding regions." }, { "name": "SP", "value": "SP", "description": "**The South Pacific Ocean**. This basin, positioned south of the equator, is\nrelevant for cyclones affecting Australia and the South Pacific islands." } ] } }, { "name": "govId", "in": "query", "description": "Government storm Id", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "governmentStormId" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StormSearchResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Tropical Storm Search": { "$ref": "./examples/GetStormSearch.json" }, "Get Tropical Storm Search With Three Properties": { "$ref": "./examples/GetFullStormSearch.json" } } } }, "/weather/tropical/storms/active/{format}": { "get": { "operationId": "Weather_GetTropicalStormActive", "summary": "Use to get a list of the active tropical storms issued by national weather\nforecasting agencies.", "description": "The `Get Tropical Storm Active` API is an HTTP `GET` request that returns a\nlist of all government-issued active tropical storms. Information about the\ntropical storms includes, government ID, basin ID, year of origin, name and if\nit is subtropical.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ActiveStormResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Tropical Storm Active": { "$ref": "./examples/GetActiveStorms.json" } } } }, "/weather/tropical/storms/forecasts/{format}": { "get": { "operationId": "Weather_GetTropicalStormForecast", "summary": "Use to get a list of tropical storms forecasted by national weather forecasting\nagencies.", "description": "The `Get Tropical Storm Forecasts` API is an HTTP `GET` request that returns\nindividual government-issued tropical storm forecasts. Information about the\nforecasted tropical storms includes, location, status, date the forecast was\ncreated, window, wind speed and wind radii.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "year", "in": "query", "description": "Year of the cyclone(s)", "required": true, "type": "integer", "format": "int32" }, { "name": "basinId", "in": "query", "description": "The `basinId` enum categorizes the different ocean basins where tropical storms\ncan originate. Each basin is assigned a unique identifier to help specify the\nlocation of the storm's origin.", "required": true, "type": "string", "enum": [ "AL", "CP", "EP", "NI", "NP", "SI", "SP" ], "x-ms-enum": { "name": "BasinId", "modelAsString": true, "values": [ { "name": "AL", "value": "AL", "description": "**The Atlantic Ocean**. Crucial for tracking hurricanes that affect the\nAmericas and the Caribbean. It is one of the most active regions for\ntropical storms." }, { "name": "CP", "value": "CP", "description": "**The Central Pacific Ocean**. This basin is used for storms affecting Hawaii\nand surrounding areas." }, { "name": "EP", "value": "EP", "description": "**The Eastern Pacific Ocean**. This basin tracks storms impacting the western\ncoast of the Americas, including Mexico and Central America. It is adjacent\nto the Central Pacific basin." }, { "name": "NI", "value": "NI", "description": "**The North Indian Ocean**. This basin covers storms impacting South Asia,\nincluding countries like India and Bangladesh, which are frequently\naffected by cyclones." }, { "name": "NP", "value": "NP", "description": "**The Northwest Pacific Ocean**. This basin is important for tracking typhoons\nthat affect East Asia, including countries like China, Japan, and the\nPhilippines. It is the most active tropical storm regions globally." }, { "name": "SI", "value": "SI", "description": "**The South Indian Ocean**. This basin, positioned south of the equator, covers\ncyclones impacting Madagascar, Africa, and surrounding regions." }, { "name": "SP", "value": "SP", "description": "**The South Pacific Ocean**. This basin, positioned south of the equator, is\nrelevant for cyclones affecting Australia and the South Pacific islands." } ] } }, { "name": "govId", "in": "query", "description": "Government storm Id", "required": true, "type": "integer", "format": "int32", "x-ms-client-name": "governmentStormId" }, { "name": "unit", "in": "query", "description": "Specifies to return the data in either metric units or imperial units. Default\nvalue is metric.", "required": false, "type": "string", "enum": [ "imperial", "metric" ], "x-ms-enum": { "name": "WeatherDataUnit", "modelAsString": true, "values": [ { "name": "imperial", "value": "imperial", "description": "Return data using imperial units such as Fahrenheit (F) for temperature and\nmiles (mi) for distance." }, { "name": "metric", "value": "metric", "description": "Return data using metric units such as Celsius (C) for temperature and\nkilometer (km) for distance." } ] } }, { "name": "details", "in": "query", "description": "When true, wind radii summary data is included in the response", "required": false, "type": "boolean", "x-ms-client-name": "includeDetails" }, { "name": "radiiGeometry", "in": "query", "description": "When true, wind radii summary data and geoJSON details are included in the\nresponse", "required": false, "type": "boolean", "x-ms-client-name": "includeGeometricDetails" }, { "name": "windowGeometry", "in": "query", "description": "When true, window geometry data (geoJSON) is included in the response", "required": false, "type": "boolean", "x-ms-client-name": "includeWindowGeometry" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StormForecastResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Tropical Storm Forecasts": { "$ref": "./examples/GetStormForecast.json" } } } }, "/weather/tropical/storms/locations/{format}": { "get": { "operationId": "Weather_GetTropicalStormLocations", "summary": "Use to get the location of tropical storms from individual national weather\nforecasting agencies.", "description": "The `Get Tropical Storm Locations` API is an HTTP `GET` request that returns\nthe location of individual government-issued tropical storms. Information about\nthe tropical storms includes, location coordinates, geometry, basin ID, date,\nwind details and wind radii.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "format", "in": "path", "description": "Desired format of the response. Only `json` format is supported.", "required": true, "type": "string", "enum": [ "json" ], "x-ms-enum": { "name": "JsonFormat", "modelAsString": true, "values": [ { "name": "json", "value": "json", "description": "[The JavaScript Object Notation Data Interchange\nFormat](https://tools.ietf.org/html/rfc8259)" } ] } }, { "name": "x-ms-client-id", "in": "header", "description": "Indicates the account intended for use with the Microsoft Entra ID security\nmodel. This unique ID for the Azure Maps account can be obtained from the\n[Azure Maps management plane Account API](/rest/api/maps-management/accounts).\nFor more information on using Microsoft Entra ID security in Azure Maps, see\n[Manage authentication in Azure\nMaps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "year", "in": "query", "description": "Year of the cyclone(s)", "required": true, "type": "integer", "format": "int32" }, { "name": "basinId", "in": "query", "description": "The `basinId` enum categorizes the different ocean basins where tropical storms\ncan originate. Each basin is assigned a unique identifier to help specify the\nlocation of the storm's origin.", "required": true, "type": "string", "enum": [ "AL", "CP", "EP", "NI", "NP", "SI", "SP" ], "x-ms-enum": { "name": "BasinId", "modelAsString": true, "values": [ { "name": "AL", "value": "AL", "description": "**The Atlantic Ocean**. Crucial for tracking hurricanes that affect the\nAmericas and the Caribbean. It is one of the most active regions for\ntropical storms." }, { "name": "CP", "value": "CP", "description": "**The Central Pacific Ocean**. This basin is used for storms affecting Hawaii\nand surrounding areas." }, { "name": "EP", "value": "EP", "description": "**The Eastern Pacific Ocean**. This basin tracks storms impacting the western\ncoast of the Americas, including Mexico and Central America. It is adjacent\nto the Central Pacific basin." }, { "name": "NI", "value": "NI", "description": "**The North Indian Ocean**. This basin covers storms impacting South Asia,\nincluding countries like India and Bangladesh, which are frequently\naffected by cyclones." }, { "name": "NP", "value": "NP", "description": "**The Northwest Pacific Ocean**. This basin is important for tracking typhoons\nthat affect East Asia, including countries like China, Japan, and the\nPhilippines. It is the most active tropical storm regions globally." }, { "name": "SI", "value": "SI", "description": "**The South Indian Ocean**. This basin, positioned south of the equator, covers\ncyclones impacting Madagascar, Africa, and surrounding regions." }, { "name": "SP", "value": "SP", "description": "**The South Pacific Ocean**. This basin, positioned south of the equator, is\nrelevant for cyclones affecting Australia and the South Pacific islands." } ] } }, { "name": "govId", "in": "query", "description": "Government storm Id", "required": true, "type": "integer", "format": "int32", "x-ms-client-name": "governmentStormId" }, { "name": "details", "in": "query", "description": "When true, wind radii summary data is included in the response", "required": false, "type": "boolean", "x-ms-client-name": "includeDetails" }, { "name": "radiiGeometry", "in": "query", "description": "When true, wind radii summary data and geoJSON details are included in the\nresponse", "required": false, "type": "boolean", "x-ms-client-name": "includeGeometricDetails" }, { "name": "unit", "in": "query", "description": "Specifies to return the data in either metric units or imperial units. Default\nvalue is metric.", "required": false, "type": "string", "enum": [ "imperial", "metric" ], "x-ms-enum": { "name": "WeatherDataUnit", "modelAsString": true, "values": [ { "name": "imperial", "value": "imperial", "description": "Return data using imperial units such as Fahrenheit (F) for temperature and\nmiles (mi) for distance." }, { "name": "metric", "value": "metric", "description": "Return data using metric units such as Celsius (C) for temperature and\nkilometer (km) for distance." } ] } }, { "name": "current", "in": "query", "description": "When true, return the current storm location", "required": false, "type": "boolean", "x-ms-client-name": "includeCurrentStorm" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StormLocationsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Tropical Storm Current Location": { "$ref": "./examples/GetStormCurrentLocation.json" }, "Get Tropical Storm Locations": { "$ref": "./examples/GetStormLocations.json" } } } } }, "definitions": { "ActiveStorm": { "type": "object", "description": "A single tropical storm currently active worldwide, returned as one entry\nin `ActiveStormResult.results`. Each entry summarizes the storm with the\nidentifiers needed to reference it elsewhere in the Get Tropical Storm\nAPIs - the originating ocean basin (`basinId`), the government-issued\nidentifier (`govId`), and the year of origin (`year`) - together with\nthe storm's official name (for example, *Hilda* or *LUPIT*) and flags\nindicating whether it is still active and whether it is classified as\nsubtropical.", "properties": { "year": { "type": "string", "description": "The four-digit calendar year in which the tropical storm originated -\nfor example, *2021*. Combined with `basinId` and `govId`, this\nuniquely identifies the storm across years." }, "basinId": { "$ref": "#/definitions/BasinId", "description": "The ocean basin where the tropical storm originated. One of the\n`BasinId` values - **AL** (Atlantic), **CP** (Central Pacific),\n**EP** (Eastern Pacific), **NI** (North Indian), **NP** (Northwest\nPacific), **SI** (South Indian), or **SP** (South Pacific). For\nexample, *EP* for a storm originating in the Eastern Pacific." }, "name": { "type": "string", "description": "The official name of the storm as designated by the relevant national\nweather forecasting agency - for example, *Hilda* or *LUPIT*. Storms\nthat have not yet been formally named are typically identified by a\nplaceholder such as *TD 9E* or a number-word like *TWELVE*." }, "isActive": { "type": "boolean", "description": "`true` if the tropical storm is currently active and still being\ntracked by the issuing agency; `false` if it is no longer active." }, "isSubtropical": { "type": "boolean", "description": "`true` if the storm is classified as a subtropical cyclone - a hybrid\nsystem with characteristics of both tropical and extratropical\ncyclones; `false` otherwise." }, "govId": { "type": "integer", "format": "int32", "description": "The government-issued identifier assigned to the storm by its\nnational weather forecasting agency, unique within\n(`basinId`, `year`). Use this together with `basinId` and `year` to\nreference the storm in the other Get Tropical Storm operations." } } }, "ActiveStormResult": { "type": "object", "description": "The response returned by the Get Tropical Storm Active operation, listing\nevery tropical storm currently active worldwide as reported by national\nweather forecasting agencies. Each entry in the `results` array is an\n`ActiveStorm` carrying the storm's name, originating ocean basin,\ngovernment-issued identifier, year of origin, and active and subtropical\nstatus. When the result set is too large to fit in a single response,\n`nextLink` carries the URL for the next page.", "properties": { "results": { "type": "array", "description": "The currently active tropical storms, with one entry per storm. Each\n`ActiveStorm` reports the storm's name (for example, *Hilda*), the\noriginating ocean basin (for example, *EP* for the Eastern Pacific),\nthe government-issued identifier and year of origin, and whether the\nstorm is still active and whether it is classified as subtropical.", "items": { "$ref": "#/definitions/ActiveStorm" } }, "nextLink": { "type": "string", "description": "The URL to retrieve the next page of results when the response is\npaginated, suitable for navigating through result sets too large to\nreturn in a single call. Empty when there are no further pages." } } }, "AirAndPollen": { "type": "object", "description": "One entry in `DailyForecast.airAndPollen` describing a single pollen,\nair-quality, or UV-index indicator for the day. The `name` property\ndetermines which kind of indicator the entry represents:\n\n- **Pollen**: `name` is *Tree*, *Grass*, *Ragweed*, or *Mold*. `value`\ngives the forecast amount and `category` / `categoryValue` rate it\nfrom *Low* to *High*.\n- **Air quality**: `name` is *AirQuality* and `type` identifies the\npollutant being measured (one of *PM2.5*, *PM10*, *O3*, *NO2*,\n*SO2*, or *CO*). `category` / `categoryValue` rate the air quality\nfrom *Good* to *Hazardous*.\n- **UV index**: `name` is *UVIndex*. `value` is the UV index (0 to\n11+), and `category` / `categoryValue` rate the exposure risk from\n*Low* to *Extreme*.\n\n`category` is the qualitative label for the indicator and\n`categoryValue` is the matching 1-6 rating, where **1** indicates\nthe safest conditions and **6** the most hazardous.", "properties": { "name": { "type": "string", "description": "Identifies which indicator this entry represents. Either the name\nof a pollen source (*Tree*, *Grass*, *Ragweed*, or *Mold*),\n*AirQuality* (in which case `type` identifies the pollutant), or\n*UVIndex*." }, "value": { "type": "integer", "format": "int32", "description": "The numeric measurement for this indicator. The unit depends on\n`name`:\n\n- For pollen, the forecast pollen count.\n- For air quality, the pollutant concentration in units appropriate\nto the pollutant - typically micrograms per cubic meter (µg/m³)\nfor particulate matter and parts per billion (ppb) for gases such\nas ozone.\n- For UV index, an index value from 0 to 11+.\n\nBoth air quality and UV index are themselves indices, so they are\nreported as unitless numbers." }, "category": { "type": "string", "description": "A short qualitative label for the indicator, returned in the\nlanguage specified in the request. Possible values depend on\n`name`:\n\n- Pollen: *Low*, *Moderate*, *High*, or *Very High*.\n- Air quality: *Good*, *Moderate*, *Unhealthy for Sensitive\nGroups*, *Unhealthy*, *Very Unhealthy*, or *Hazardous*.\n- UV index: *Low*, *Moderate*, *High*, *Very High*, or *Extreme*." }, "categoryValue": { "type": "integer", "format": "int32", "description": "A 1-6 numeric rating that pairs with `category`, where **1**\nindicates the safest conditions and **6** the most hazardous. Use\nthis when a stable, language-independent numeric value is needed\ninstead of the localized `category` label." }, "type": { "type": "string", "description": "When `name` is *AirQuality*, the specific pollutant being measured\n- one of *PM2.5*, *PM10*, *O3* (ozone), *NO2* (nitrogen dioxide),\n*SO2* (sulfur dioxide), or *CO* (carbon monoxide). Not returned for\npollen or UV-index entries." } } }, "AirQuality": { "type": "object", "description": "The current air-quality reading at one location, returned as the entry in\n`AirQualityResult.results`. Combines the air-quality index reported by the\nlocal regulating body (`index`) with an internationally normalized index\n(`globalIndex`), identifies the `dominantPollutant` driving the result,\nand pairs them with a localized qualitative `category` and a matching\n`categoryColor` suitable for color-coded UI. A short `description`\nexplains what the reading means for everyday activities and any health\nprecautions, and - when the request asks for pollutant detail - the\n`pollutants` array carries a per-pollutant breakdown.", "properties": { "dateTime": { "type": "string", "format": "date-time", "description": "The date and time the air-quality reading applies to, in [ISO\n8601](https://www.iso.org/iso-8601-date-and-time-format.html) format\n(yyyy-mm-ddThh:mm:ss+hh:mm). For example, *2021-07-19T02:00:00+00:00*." }, "index": { "type": "number", "format": "float", "description": "The air-quality index (AQI) on the scale set by the local regulating\nbody for the queried location. AQI scales vary widely between countries\nand regions, so the same numeric value can mean different things at\ndifferent locations - use `category` for a label that is consistent\nacross locations. For example, *21.6* on the scale used for the queried\nlocation. For background, see [Air quality\nindex](https://en.wikipedia.org/wiki/Air_quality_index) on Wikipedia." }, "globalIndex": { "type": "number", "format": "float", "description": "A normalized air-quality index designed to be comparable across\nlocations, independent of any local AQI scale. The value is the\nhighest individual sub-index across the six measured pollutants\n(**PM2.5**, **PM10**, **NO2**, **SO2**, **CO**, **O3**); the\npollutant producing that maximum is returned in `dominantPollutant`.\n\nRange and categories:\n\n| Value | Category |\n| ------- | -------------- |\n| 0-20 | Excellent |\n| 21-50 | Fair |\n| 51-100 | Poor |\n| 101-150 | Unhealthy |\n| 151-250 | Very unhealthy |\n| 251+ | Dangerous |\n\nFor example, given sub-indices CO *0.6*, SO2 *1.1*, PM2.5 *6.5*,\nNO2 *6.7*, PM10 *12.2*, O3 *22.1*, `globalIndex` is *22.1* and\n`dominantPollutant` is *Ozone*." }, "dominantPollutant": { "$ref": "#/definitions/DominantPollutant", "description": "The pollutant driving the current `index` and `globalIndex` - one of\nthe `DominantPollutant` values, such as *Ozone* or *NO2*. Useful for\nsurfacing which substance is most responsible for the current air\nquality." }, "category": { "type": "string", "description": "A short qualitative summary of the current air quality, returned in\nthe language specified in the request. Typical values include *Good*,\n*Fair*, *Moderate*, *Poor*, and *Hazardous*; the exact set depends on\nthe regulating body for the queried location." }, "categoryColor": { "type": "string", "description": "A hexadecimal color code matching `category`, suitable for color-coding\nthe air-quality reading in a UI - for example, *#FFC300* for *Fair*.\nEach `category` value has a distinct color so that the reading can be\nrecognized at a glance." }, "description": { "type": "string", "description": "A free-form sentence or two explaining the current air quality and\nany precautions sensitive groups should consider, returned in the\nlanguage specified in the request. For example, *The air quality is\ngenerally acceptable for most individuals. However, sensitive groups\nmay experience minor to moderate symptoms from long-term exposure.*" }, "pollutants": { "type": "array", "description": "Per-pollutant detail behind the overall reading, with one `Pollutant`\nentry per measured species (typically *Nitrogen Dioxide*, *Ozone*,\n*Particulate Matter 10*, *Particulate Matter 2.5*, *Carbon Monoxide*,\nand *Sulfur Dioxide*). Each entry reports the pollutant's\nconcentration and its individual `index` and `globalIndex`\ncontributions. Returned only when the request asks for pollutant\ndetail.", "items": { "$ref": "#/definitions/Pollutant" } } } }, "AirQualityResult": { "type": "object", "description": "The response returned by the Get Current Air Quality operation, providing\nthe current air-quality conditions at a specified location. The `results`\narray contains a single `AirQuality` entry summarizing the local and\nglobally-normalized air-quality indices, the dominant pollutant, a\nqualitative category and matching color, a short description of the health\nimplications, and (when requested) per-pollutant detail.", "properties": { "results": { "type": "array", "description": "The current air-quality reading at the location, returned as a\nsingle-element array. The entry reports the local air-quality index\n(`index`), the internationally normalized index (`globalIndex`), the\n`dominantPollutant` (for example, *Ozone*), a qualitative `category`\n(such as *Fair*) with matching `categoryColor` (for example,\n*#FFC300*), a short `description` of the health implications, and -\nwhen the request asks for pollutant detail - a `pollutants` array\nwith one entry per measured pollutant.", "items": { "$ref": "#/definitions/AirQuality" } }, "nextLink": { "type": "string", "description": "The URL to retrieve the next page of results when the response is\npaginated, suitable for navigating through result sets too large to\nreturn in a single call. Empty when there are no further pages." } } }, "AlertArea": { "type": "object", "description": "One geographic area covered by a severe weather alert, returned as an\nentry in `SevereWeatherAlert.alertAreas`. Each `AlertArea` identifies the\naffected area by `name`, gives the start and end times during which the\nalert is in effect there (`startTime`, `endTime`), reports the most\nrecent status of the alert in that area (`latestStatus`), and carries a\nshort displayable `summary` of the alert. When the request asks for full\ndetails, the complete alert text is also returned in `alertDetails`,\nwith `alertDetailsLanguageCode` identifying the language it is supplied\nin.", "properties": { "name": { "type": "string", "description": "The name of the geographic area affected by the alert in this entry -\nfor example, *Kirkland Lake - Englehart*. Identifies the specific\nregion or locality the times, status, and detail text on this\n`AlertArea` apply to." }, "summary": { "type": "string", "description": "A short, displayable summary of the alert for this area, including the\ntimeframe during which it is in effect and the issuing source. For\nexample, *Heat Warning in effect until Thursday, 3:16 AM EDT. Source:\nEnvironment Canada*." }, "startTime": { "type": "string", "format": "date-time", "description": "The date and time at which the alert begins for this area, in [RFC\n3339](https://datatracker.ietf.org/doc/html/rfc3339) format\n(yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*.\nIf the alert spans multiple time zones, the value reflects the local\ntime at the coordinates supplied on the request." }, "endTime": { "type": "string", "format": "date-time", "description": "The date and time at which the alert ends or will end for this area,\nin [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format\n(yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*.\nIf the alert spans multiple time zones, the value reflects the local\ntime at the coordinates supplied on the request." }, "latestStatus": { "$ref": "#/definitions/LatestStatus", "description": "The most recent status of the alert in this area (for example,\nwhether it is newly issued, continuing, or has been canceled).\nReturned as both a localized phrase and a language-independent\n`LatestStatusKeyword` value." }, "alertDetails": { "type": "string", "description": "The complete free-form alert text issued by the source for this area,\nsuitable for displaying the full advisory. Returned only when the\nrequest asks for full details. The text is returned in whatever\nlanguage the issuing provider supplied it in, which may differ from\nthe language requested for the rest of the response; the companion\n`alertDetailsLanguageCode` identifies that language. Some countries\nor regions may offer both their native language and English." }, "alertDetailsLanguageCode": { "type": "string", "description": "The language of `alertDetails`, as an [ISO 639-1 Alpha-2 language\ncode](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) -\nfor example, `en-CA` for Canadian English. May differ from the\nlanguage requested for the rest of the response. Returned only when\nthe request asks for full details." } } }, "BasinId": { "type": "string", "description": "The `basinId` enum categorizes the different ocean basins where tropical\nstorms can originate. Each basin is assigned a unique identifier to help\nspecify the location of the storm's origin.", "enum": [ "AL", "CP", "EP", "NI", "NP", "SI", "SP" ], "x-ms-enum": { "name": "BasinId", "modelAsString": true, "values": [ { "name": "AL", "value": "AL", "description": "**The Atlantic Ocean**. Crucial for tracking hurricanes that affect the\nAmericas and the Caribbean. It is one of the most active regions for\ntropical storms." }, { "name": "CP", "value": "CP", "description": "**The Central Pacific Ocean**. This basin is used for storms affecting Hawaii\nand surrounding areas." }, { "name": "EP", "value": "EP", "description": "**The Eastern Pacific Ocean**. This basin tracks storms impacting the western\ncoast of the Americas, including Mexico and Central America. It is adjacent\nto the Central Pacific basin." }, { "name": "NI", "value": "NI", "description": "**The North Indian Ocean**. This basin covers storms impacting South Asia,\nincluding countries like India and Bangladesh, which are frequently\naffected by cyclones." }, { "name": "NP", "value": "NP", "description": "**The Northwest Pacific Ocean**. This basin is important for tracking typhoons\nthat affect East Asia, including countries like China, Japan, and the\nPhilippines. It is the most active tropical storm regions globally." }, { "name": "SI", "value": "SI", "description": "**The South Indian Ocean**. This basin, positioned south of the equator, covers\ncyclones impacting Madagascar, Africa, and surrounding regions." }, { "name": "SP", "value": "SP", "description": "**The South Pacific Ocean**. This basin, positioned south of the equator, is\nrelevant for cyclones affecting Australia and the South Pacific islands." } ] } }, "ColorValue": { "type": "object", "description": "An RGB color, returned in both component (`red`, `green`, `blue`) and\nhexadecimal (`hex`) form. Used by the minute-by-minute forecast to render\neach interval on a radar-style display - see `ForecastInterval.color` for\nthe full-spectrum color mapped to `dbz`, and\n`ForecastInterval.simplifiedColor` for the coarser color derived from\n`precipitationType` and `threshold`. For the underlying color mappings, see\n[Weather services in Azure\nMaps](/azure/azure-maps/weather-services-concepts#radar-images).", "properties": { "red": { "type": "integer", "format": "int32", "description": "Red component of the RGB value. Valid values range from 0-255." }, "green": { "type": "integer", "format": "int32", "description": "Green component of the RGB value. Valid values range from 0-255." }, "blue": { "type": "integer", "format": "int32", "description": "Blue component of the RGB value. Valid values range from 0-255." }, "hex": { "type": "string", "description": "The same color as a hexadecimal RGB string prefixed with `#` - for\nexample, *#FF0000* for red." } } }, "CurrentConditions": { "type": "object", "description": "A single weather observation for the specified location, returned by the\nGet Current Conditions operation. Depending on the request's `duration`,\nthis observation may be the latest (most recent) reading or one of the\npreceding hourly observations. By default a simplified subset is\nreturned: observation date and time, weather phrase, icon code,\nprecipitation indicator, and temperature. When the request asks for full\ndetails, every property is included, adding measurements such as\nRealFeel, dew point, wind, visibility, cloud cover, pressure, and\nrolling precipitation and temperature summaries for the past several\nhours.", "properties": { "dateTime": { "type": "string", "format": "date-time", "description": "The date and time of this observation, in [RFC\n3339](https://datatracker.ietf.org/doc/html/rfc3339) format\n(yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*." }, "phrase": { "type": "string", "description": "A short descriptive term for the weather conditions at the observation\ntime - for example, *Sunny* or *Partly Cloudy*. Pairs with `iconCode`,\nwhich identifies the matching weather icon. For more information, see\n[Weather services in Azure\nMaps](/azure/azure-maps/weather-services-concepts#weather-icons)." }, "iconCode": { "$ref": "#/definitions/IconCode", "description": "The representative weather icon code for this observation, paired with\nthe `phrase` property. The numeric value corresponds to an Azure Maps\nweather icon - for the complete list, see [Weather services in Azure\nMaps](/azure/azure-maps/weather-services-concepts#weather-icons). May be\nNULL." }, "hasPrecipitation": { "type": "boolean", "description": "`true` if precipitation (rain, snow, sleet, or hail) is occurring at the\nobservation time; otherwise `false`." }, "isDayTime": { "type": "boolean", "description": "`true` if it is daytime at the specified location at the observation\ntime; `false` if it is nighttime." }, "temperature": { "$ref": "#/definitions/WeatherValue", "description": "The air temperature at the observation time, in degrees Celsius (°C) or\nFahrenheit (°F), depending on the unit specified in the request." }, "realFeelTemperature": { "$ref": "#/definitions/WeatherValue", "description": "The RealFeel™ Temperature at the observation time, in degrees Celsius\n(°C) or Fahrenheit (°F), depending on the unit specified in the request.\nDeveloped by AccuWeather, RealFeel combines air temperature with\nhumidity, wind, cloud cover, sun intensity, and other factors to\nindicate how the weather actually feels. For more information, see\n[What is the AccuWeather RealFeel\nTemperature?](https://www.accuweather.com/en/weather-news/what-is-the-accuweather-realfeel-temperature/156655)" }, "realFeelTemperatureShade": { "$ref": "#/definitions/WeatherValue", "description": "The RealFeel™ Temperature at the observation time in shaded areas, in\ndegrees Celsius (°C) or Fahrenheit (°F), depending on the unit specified\nin the request. Like `realFeelTemperature`, but excludes the warming\neffect of direct sunlight, giving a more accurate sense of how the\nweather feels in the shade." }, "relativeHumidity": { "type": "integer", "format": "int32", "description": "The relative humidity at the observation time, expressed as a percentage\nfrom 0 to 100 of the maximum amount of water vapor the air can hold at\nthe same temperature." }, "dewPoint": { "$ref": "#/definitions/WeatherValue", "description": "The dew point at the observation time - the temperature to which air\nmust cool to become saturated (100% relative humidity). Measured in\ndegrees Celsius (°C) or Fahrenheit (°F), depending on the unit specified\nin the request. A higher dew point indicates more moisture in the air." }, "wind": { "$ref": "#/definitions/WindDetails", "description": "The wind speed and direction at the observation time. Speed is in\nkilometers per hour (km/h) or miles per hour (mph) depending on the unit\nspecified in the request; direction is in azimuth degrees, measured\nclockwise from true North (0° = N, 90° = E, 180° = S, 270° = W)." }, "windGust": { "$ref": "#/definitions/WindDetails", "description": "The maximum short-burst wind-gust speed and direction at the observation\ntime, using the same units and azimuth convention as `wind`. Wind gusts\nare brief spikes in wind speed that can affect activities such as\naviation, sailing, kite flying, and other outdoor events." }, "uvIndex": { "type": "integer", "format": "int32", "description": "The ultraviolet (UV) index at the observation time, indicating the risk\nof harm from unprotected sun exposure. Supported values are:\n\n- 0-2: Low danger from the sun's UV rays for the average person.\n- 3-5: Moderate risk of harm from unprotected sun exposure.\n- 6-7: High risk of harm from unprotected sun exposure.\n- 8-10: Very high risk of harm from unprotected sun exposure.\n- 11+: Extreme risk of harm from unprotected sun exposure." }, "uvIndexPhrase": { "type": "string", "description": "A short descriptive label for `uvIndex` - for example, *Low*, *Moderate*,\n*High*, *Very High*, or *Extreme*." }, "visibility": { "$ref": "#/definitions/WeatherValue", "description": "The horizontal visibility at the observation time - the distance at\nwhich an object or light can be clearly discerned - in kilometers (km)\nor miles (mi) depending on the unit specified in the request." }, "obstructionsToVisibility": { "type": "string", "description": "A code identifying the dominant factor reducing visibility at the\nobservation time, such as fog, smoke, haze, or precipitation. Useful for\nactivities that depend on clear visibility, like driving and aviation.\n\nPossible values:\n\n- **A** = heavy thunderstorm/hail\n- **BD** = blowing dust\n- **BN** = blowing sand\n- **BS** = blowing snow\n- **D** = dust\n- **F** = fog\n- **GF** = ground fog\n- **HZ** = haze\n- **I** = ice\n- **IC** = ice crystals\n- **IF** = ice fog\n- **IP** = ice pellets\n- **IPW** = ice pellets shower\n- **K** = smoke\n- **L** = drizzle\n- **R** = rain\n- **RS** = rain/snow\n- **RW** = rain shower\n- **S** = snow\n- **SG** = snow granules\n- **SP** = snow pellets\n- **SW** = snow shower\n- **T** = thunderstorm\n- **UP** = undefined precipitation\n- **ZL** = freezing drizzle\n- **ZR** = freezing rain\n- **+** = heavy\n- **-** = light" }, "cloudCover": { "type": "integer", "format": "int32", "description": "The percentage of the sky covered by clouds at the observation time,\nfrom 0 (clear) to 100 (overcast). May be NULL." }, "ceiling": { "$ref": "#/definitions/WeatherValue", "description": "The cloud ceiling at the observation time - the height above the ground\nof the lowest cloud layer - in feet (ft) or meters (m) depending on the\nunit specified in the request. Important for aviation, since it affects\nflight visibility and operations." }, "pressure": { "$ref": "#/definitions/WeatherValue", "description": "The atmospheric (air) pressure at ground level at the observation time,\nin millibars (mb) or inches of mercury (inHg), depending on the unit\nspecified in the request." }, "pressureTendency": { "$ref": "#/definitions/PressureTendency", "description": "The recent trend in atmospheric pressure - rising, falling, or steady.\nUseful for anticipating short-term weather changes; falling pressure\noften signals deteriorating weather, while rising pressure typically\nindicates improving conditions." }, "pastTwentyFourHourTemperatureDeparture": { "$ref": "#/definitions/WeatherValue", "description": "The change in air temperature compared to 24 hours ago, in degrees\nCelsius (°C) or Fahrenheit (°F), depending on the unit specified in the\nrequest. Positive values indicate the air is warmer than yesterday at\nthe same time; negative values indicate it is cooler." }, "apparentTemperature": { "$ref": "#/definitions/WeatherValue", "description": "The apparent temperature at the observation time - how the air actually\nfeels to humans, taking into account air temperature, relative humidity,\nand wind speed. Measured in degrees Celsius (°C) or Fahrenheit (°F),\ndepending on the unit specified in the request." }, "windChillTemperature": { "$ref": "#/definitions/WeatherValue", "description": "The wind chill temperature at the observation time - how cold the air\nfeels on exposed skin due to the combined effect of wind and low\ntemperature. Typically lower than the actual air temperature. Measured\nin degrees Celsius (°C) or Fahrenheit (°F), depending on the unit\nspecified in the request." }, "wetBulbTemperature": { "$ref": "#/definitions/WeatherValue", "description": "The wet-bulb temperature at the observation time - the temperature the\nair would reach if cooled to saturation (100% relative humidity) by\nevaporating water into it at constant pressure. Measured in degrees\nCelsius (°C) or Fahrenheit (°F), depending on the unit specified in the\nrequest. Useful for assessing heat stress and evaporative cooling." }, "precipitationSummary": { "$ref": "#/definitions/PrecipitationSummary", "description": "A summary of liquid-equivalent precipitation amounts at the observation\nlocation over rolling windows of the past 1, 3, 6, 9, 12, 18, and 24\nhours, in millimeters (mm) or inches (in) depending on the unit\nspecified in the request." }, "temperatureSummary": { "$ref": "#/definitions/TemperatureSummary", "description": "A summary of the highest and lowest air temperatures observed at this\nlocation over rolling windows of the past 6, 12, and 24 hours, in\ndegrees Celsius (°C) or Fahrenheit (°F) depending on the unit specified\nin the request." } } }, "CurrentConditionsResult": { "type": "object", "description": "The response returned by the Get Current Conditions operation, containing\none or more current-conditions observations for a specified location. By\ndefault a single observation for the present time is returned; when the\n`duration` parameter is set to 6 or 24, the response also includes one\nobservation per past hour over that window.", "properties": { "results": { "type": "array", "description": "The current-conditions observations, in chronological order with the\nmost recent first. By default a single entry - the latest observation\n- is returned; the response may also contain one entry per hour over a\nrecent rolling window (typically the past 6 or 24 hours), depending on\nthe request.", "items": { "$ref": "#/definitions/CurrentConditions" }, "readOnly": true } } }, "DailyAirQuality": { "type": "object", "description": "The forecasted air-quality reading for a single day at the queried\nlocation, returned as one entry in `DailyAirQualityForecastResult.results`.\nEach entry summarizes the day's expected air quality on the same scales\nused by `AirQuality` for the current reading - the local AQI (`index`),\nthe internationally normalized index (`globalIndex`), the\n`dominantPollutant`, a short `category` label (for example, *Fair*) and\nmatching `categoryColor` swatch (for example, *#FFC300*), and a textual\n`description` of what the reading means for people. Across the entries\nin a single forecast response the values typically evolve from day to\nday - in the example response *globalIndex* runs *42.2* -> *37* -> *40*\nacross three consecutive days while the dominant pollutant stays\n*Ozone*.", "properties": { "dateTime": { "type": "string", "format": "date-time", "description": "The day this forecast covers, in [ISO\n8601](https://www.iso.org/iso-8601-date-and-time-format.html) format\n(yyyy-mm-ddThh:mm:ss+hh:mm) - for example,\n*2021-07-18T07:00:00+00:00*. Forecast entries within a single\nresponse use sequential `dateTime` values, one per day." }, "index": { "type": "number", "format": "float", "description": "The forecasted overall air-quality index (AQI) for the day, on the\nscale set by the local regulating body for the queried location. Like\n`AirQuality.index`, this is comparable across days at the same\nlocation - for example, *35.1*, *31.6*, and *33.6* on three\nconsecutive days - but not directly comparable across locations\nbecause each region uses its own scale. Use `category` for a\nlocation-independent label. For background, see [Air quality\nindex](https://en.wikipedia.org/wiki/Air_quality_index) on Wikipedia." }, "globalIndex": { "type": "number", "format": "float", "description": "The forecasted air-quality index on the internationally normalized\n0-to-300+ scale, where higher values denote poorer air quality. The\nscale is the same as `AirQuality.globalIndex`, so values are\ncomparable across locations and across days - for example, *42.2*,\n*37*, and *40* on three consecutive forecast days. The index reflects\nconcentrations of **PM2.5**, **PM10**, **NO2**, **SO2**, **CO**, and\n**O3**." }, "dominantPollutant": { "$ref": "#/definitions/DominantPollutant", "description": "The pollutant expected to have the highest concentration during the\nday - one of the `DominantPollutant` values, for example *Ozone*.\nThis is the pollutant that typically drives the day's `index` and\n`globalIndex` values." }, "category": { "type": "string", "description": "A one-word summary of the day's forecasted air quality (for example,\n*Excellent*, *Fair*, or *Poor*), returned in the requested language.\nPairs with `categoryColor` for a quick visual cue and with\n`description` for a longer explanation. Because the label is\nderived from the local AQI bands, it is comparable across locations\neven when raw `index` values are not." }, "categoryColor": { "type": "string", "description": "The hexadecimal color associated with `category`, suitable for\nstyling a UI swatch or badge - for example, *#FFC300* for *Fair*.\nCategories and colors are consistent across daily forecast entries\nso the same label always renders with the same color." }, "description": { "type": "string", "description": "A short, human-readable explanation of the day's forecasted air\nquality and any precautions it suggests, returned in the requested\nlanguage - for example, *\"The air quality is generally acceptable\nfor most individuals. However, sensitive groups may experience minor\nto moderate symptoms from long-term exposure.\"* Intended for direct\ndisplay alongside `category` and `categoryColor`." } } }, "DailyAirQualityForecastResult": { "type": "object", "description": "The response returned by the Get Daily Air Quality Forecasts operation,\ncontaining one forecasted air-quality reading per day for the queried\nlocation across the requested forecast horizon. The horizon is set by the\ncaller's requested forecast duration (a `DailyDuration` value of 1, 2, 3,\n4, 5, 6, or 7 days), so `results` carries that many entries in\nchronological order - for example, a 3-day request returns daily readings\nfor *2021-07-18*, *2021-07-19*, and *2021-07-20*. Each entry summarizes\nthe day's expected air quality on the same scales used by the current\nair-quality reading, so it pairs naturally with `AirQualityResult` for\nshowing \"today plus the next several days\" views.", "properties": { "results": { "type": "array", "description": "The list of forecasted daily air-quality readings for the queried\nlocation, one entry per day, in chronological order starting with the\nearliest forecasted day. The number of entries matches the requested\nforecast duration - for example, a 3-day request returns three entries\nwith `dateTime` values *2021-07-18T07:00:00+00:00*,\n*2021-07-19T07:00:00+00:00*, and *2021-07-20T07:00:00+00:00*. Each\nentry reports the day's `index`, `globalIndex`, `dominantPollutant`,\n`category`, `categoryColor`, and a textual `description`.", "items": { "$ref": "#/definitions/DailyAirQuality" } }, "nextLink": { "type": "string", "description": "The URL to retrieve the next page of results when the response is\npaginated, suitable for navigating through result sets too large to\nreturn in a single call. Empty when there are no further pages." } } }, "DailyDuration": { "type": "number", "description": "Defines the duration for the air quality forecast, with options ranging from\n1 to 7 days. The default duration is 1 day.", "enum": [ 1, 2, 3, 4, 5, 6, 7 ], "x-ms-enum": { "name": "DailyDuration", "modelAsString": true, "values": [ { "name": "OneDay", "value": 1, "description": "1 day" }, { "name": "TwoDays", "value": 2, "description": "2 days" }, { "name": "ThreeDays", "value": 3, "description": "3 days" }, { "name": "FourDays", "value": 4, "description": "4 days" }, { "name": "FiveDays", "value": 5, "description": "5 days" }, { "name": "SixDays", "value": 6, "description": "6 days" }, { "name": "SevenDays", "value": 7, "description": "7 days" } ] } }, "DailyForecast": { "type": "object", "description": "The forecast for one calendar day at the specified location, returned as\none entry per day in the `forecasts` array on `DailyForecastResult`.\nIncludes the day's high/low temperature range, RealFeel ranges (regular\nand shaded), expected hours of sunshine, heating/cooling degree-day\ntotals, an array of air-quality, pollen, and UV-index indicators, and\nseparate detail blocks for the daytime and nighttime portions of the day\n(precipitation, wind, cloud cover, and more). The `sources` array lists\nthe data providers contributing to the forecast.", "properties": { "date": { "type": "string", "format": "date-time", "description": "The calendar date this forecast covers, in [ISO\n8601](https://www.iso.org/iso-8601-date-and-time-format.html) format\n(`yyyy-mm-ddThh:mm:ss-hh:mm`). For example, *2025-04-29T07:00:00-07:00*." }, "temperature": { "$ref": "#/definitions/WeatherValueRange", "description": "The forecasted high and low air temperatures for the day, in degrees\nCelsius (°C) or Fahrenheit (°F), depending on the unit specified in\nthe request." }, "realFeelTemperature": { "$ref": "#/definitions/WeatherValueRange", "description": "The high and low RealFeel™ Temperature values for the day, in degrees\nCelsius (°C) or Fahrenheit (°F), depending on the unit specified in the\nrequest. Developed by AccuWeather, RealFeel combines air temperature\nwith humidity, wind, cloud cover, sun intensity, and other factors to\nindicate how the weather actually feels. For more information, see\n[What is the AccuWeather RealFeel\nTemperature?](https://www.accuweather.com/en/weather-news/what-is-the-accuweather-realfeel-temperature/156655)" }, "realFeelTemperatureShade": { "$ref": "#/definitions/WeatherValueRange", "description": "The high and low RealFeel™ Temperature values for the day in shaded\nareas, in degrees Celsius (°C) or Fahrenheit (°F), depending on the\nunit specified in the request. Like `realFeelTemperature`, but excludes\nthe warming effect of direct sunlight, giving a more accurate sense of\nhow the weather feels in the shade." }, "hoursOfSun": { "type": "number", "format": "float", "description": "The expected number of hours of sunshine during the day, useful for\nplanning outdoor activities and gauging overall daytime conditions." }, "degreeDaySummary": { "$ref": "#/definitions/DegreeDaySummary", "description": "Heating and cooling degree-day totals for the day, used to estimate\nenergy demand for building climate control." }, "airAndPollen": { "type": "array", "description": "Forecasted air-quality, pollen, and UV-index indicators for the day.\nEach entry reports a name (such as *Tree*, *Grass*, *Ragweed*, *Mold*,\n*AirQuality*, or *UVIndex*), a numeric value, and a qualitative\n`category` (such as *Low*, *Moderate*, *High*, *Good*, *Unhealthy*, or\n*Hazardous*) so applications can flag potential health risks.", "items": { "$ref": "#/definitions/AirAndPollen" } }, "day": { "$ref": "#/definitions/DailyForecastDetail", "description": "The detailed forecast for the daytime portion of the day - including\ntemperature, precipitation, wind, cloud cover, and other key\nattributes." }, "night": { "$ref": "#/definitions/DailyForecastDetail", "description": "The detailed forecast for the nighttime portion of the day - including\ntemperature, precipitation, wind, cloud cover, and other key\nattributes." }, "sources": { "type": "array", "description": "The data providers that contributed to this day's forecast.", "items": { "type": "string" } } } }, "DailyForecastDetail": { "type": "object", "description": "Forecast details for one half of a day. The same shape is used for\nboth `DailyForecast.day` (sunrise to sunset) and `DailyForecast.night`\n(sunset to next sunrise), so all references to \"this period\" below\nmean that specific daytime or nighttime portion - never the full\n24-hour day. Includes a forecast icon and phrases, precipitation\ntype / intensity / probabilities, accumulation totals, hours of\nprecipitation, wind, and cloud cover.", "properties": { "iconCode": { "$ref": "#/definitions/IconCode", "description": "Numeric value representing an image that corresponds to the\nforecasted weather condition for this period, described by the\n`iconPhrase` property. The numeric value corresponds to an Azure\nMaps weather icon - for the complete list, see [Weather services in\nAzure Maps](/azure/azure-maps/weather-services-concepts#weather-icons).\nMay be NULL." }, "iconPhrase": { "type": "string", "description": "A short phrase that describes the icon, returned in the language\nspecified in the request. For example, *Sunny*." }, "localSource": { "$ref": "#/definitions/LocalSource", "description": "Information about the local weather data provider whose icon code\nand weather code were used for this period, when one was selected." }, "hasPrecipitation": { "type": "boolean", "description": "`true` if any precipitation (rain, snow, sleet, or hail) is expected\nduring this period; `false` otherwise." }, "precipitationType": { "$ref": "#/definitions/PrecipitationType", "description": "The dominant type of precipitation expected during this period -\none of *Rain*, *Snow*, *Ice*, or *Mix*. Returned only when\n`hasPrecipitation` is `true`." }, "precipitationIntensity": { "type": "string", "description": "A short qualitative description of the precipitation intensity for\nthis period - for example, *Light*, *Moderate*, or *Heavy*.\nReturned in the language specified in the request, and only when\n`hasPrecipitation` is `true`." }, "shortPhrase": { "type": "string", "description": "A short phrase that describes the forecast for this period,\nreturned in the language specified in the request. Azure Maps tries\nto keep this phrase under 30 characters, but some languages or\nweather events may produce a longer string." }, "longPhrase": { "type": "string", "description": "A longer, more descriptive phrase for this period, returned in the\nlanguage specified in the request. Azure Maps tries to keep this\nphrase under 100 characters, but some languages or weather events\nmay produce a longer string." }, "precipitationProbability": { "type": "integer", "format": "int32", "description": "The probability of any precipitation during this period, expressed\nas a percentage from 0 to 100, where **0** means no chance of\nprecipitation and **100** means precipitation is certain." }, "thunderstormProbability": { "type": "integer", "format": "int32", "description": "The probability of a thunderstorm during this period, expressed as\na percentage from 0 to 100, where **0** means no chance of a\nthunderstorm and **100** means a thunderstorm is certain." }, "rainProbability": { "type": "integer", "format": "int32", "description": "The probability of rain during this period, expressed as a\npercentage from 0 to 100, where **0** means no chance of rain and\n**100** means rain is certain." }, "snowProbability": { "type": "integer", "format": "int32", "description": "The probability of snow during this period, expressed as a\npercentage from 0 to 100, where **0** means no chance of snow and\n**100** means snow is certain." }, "iceProbability": { "type": "integer", "format": "int32", "description": "The probability of ice formation during this period, expressed as\na percentage from 0 to 100, where **0** means no chance of ice and\n**100** means icy conditions are certain." }, "wind": { "$ref": "#/definitions/WindDetails", "description": "The forecasted wind speed and direction for this period. Wind speed\nis in kilometers per hour (km/h) or miles per hour (mph) depending\non the unit specified in the request. Wind direction is measured in\nazimuth degrees, from 0° (true North) to 359°, moving clockwise -\neast is 90°, south is 180°, west is 270°." }, "windGust": { "$ref": "#/definitions/WindDetails", "description": "The expected maximum short-burst wind speed and direction during\nthis period. Wind gusts are sudden, brief increases in wind speed\nthat matter for activities such as aviation, sailing, and kite\nflying. Speed is in kilometers per hour (km/h) or miles per hour\n(mph) depending on the unit specified in the request, and direction\nuses the same azimuth convention as `wind`." }, "totalLiquid": { "$ref": "#/definitions/WeatherValue", "description": "The total amount of liquid precipitation (such as rain, plus the\nliquid equivalent of any snow or ice) expected during this period,\nin millimeters (mm) or inches (in) depending on the unit specified\nin the request." }, "rain": { "$ref": "#/definitions/WeatherValue", "description": "The amount of rainfall expected during this period, in millimeters\n(mm) or inches (in) depending on the unit specified in the request." }, "snow": { "$ref": "#/definitions/WeatherValue", "description": "The amount of snow accumulation expected during this period, in\ncentimeters (cm) or inches (in) depending on the unit specified in\nthe request." }, "ice": { "$ref": "#/definitions/WeatherValue", "description": "The amount of ice accumulation expected during this period, in\nmillimeters (mm) or inches (in) depending on the unit specified in\nthe request." }, "hoursOfPrecipitation": { "type": "number", "format": "float", "description": "The total number of hours during this period when any precipitation\n(rain, snow, sleet, or hail) is expected." }, "hoursOfRain": { "type": "number", "format": "float", "description": "The total number of hours during this period when rain is expected." }, "hoursOfSnow": { "type": "number", "format": "float", "description": "The total number of hours during this period when snow is expected." }, "hoursOfIce": { "type": "number", "format": "float", "description": "The total number of hours during this period when ice formation is\nexpected." }, "cloudCover": { "type": "integer", "format": "int32", "description": "The percentage of the sky covered by clouds during this period,\nfrom **0** (clear skies) to **100** (completely overcast). May be\nNULL." } } }, "DailyForecastResult": { "type": "object", "description": "The response returned by the Get Daily Forecast operation, providing a\nday-by-day weather forecast for a specified location. Includes a top-level\n`summary` describing the dominant conditions and severity for the requested\nwindow, plus a `forecasts` array with one `DailyForecast` entry per day.\nThe number of entries matches the requested `duration`\n(1, 5, 10, 15, 25, or 45 days; 25 and 45 require an S1 SKU).", "properties": { "summary": { "$ref": "#/definitions/DailyForecastSummary", "description": "A high-level summary of the dominant weather conditions across the\nrequested forecast window. The summary may cover only part of the window\n- for example, when significant weather (such as a storm system) is\nexpected during a portion of it - rather than the entire period.", "readOnly": true }, "forecasts": { "type": "array", "description": "The per-day forecasts, in chronological order with one entry per day\nin the requested `duration`. Each entry is a `DailyForecast`\nreporting the day's high/low temperature, RealFeel range, hours of\nsunshine, heating/cooling degree-day totals, air-and-pollen indices,\nseparate day and night detail blocks (precipitation, wind, cloud\ncover, and more), and the data sources contributing to the forecast.", "items": { "$ref": "#/definitions/DailyForecast" }, "readOnly": true } } }, "DailyForecastSummary": { "type": "object", "description": "A high-level summary of the dominant weather conditions across part or\nall of the requested daily-forecast window. The summarized window can be\nnarrower than the full request - for example, when significant weather\n(such as a storm system) is expected during only a portion of the\nperiod - and is delimited by `startDate` and `endDate`. The conditions\nthemselves are described both as a free-form `phrase`, a one or\ntwo-word `category` label, and a numeric `severity` rating.", "properties": { "startDate": { "type": "string", "format": "date-time", "description": "The start of the window covered by this summary, in [RFC\n3339](https://datatracker.ietf.org/doc/html/rfc3339) format - for example,\n*2019-10-27T19:39:57-08:00*. May be later than the start of the\nrequested forecast window if the summarized event begins partway\nthrough it." }, "endDate": { "type": "string", "format": "date-time", "description": "The end of the window covered by this summary, in [RFC\n3339](https://datatracker.ietf.org/doc/html/rfc3339) format - for example,\n*2019-10-29T07:00:00-08:00*. May be earlier than the end of the\nrequested forecast window if the summarized event ends before it." }, "severity": { "type": "integer", "format": "int32", "description": "A numeric severity rating for the summarized weather event. Lower\nnumbers (excluding **0**) indicate higher severity:\n\n- **0**: Unknown\n- **1**: Significant\n- **2**: Major\n- **3**: Moderate\n- **4**: Minor\n- **5**: Minimal\n- **6**: Insignificant\n- **7**: Informational" }, "phrase": { "type": "string", "description": "A brief, free-form textual summary of the dominant weather conditions\nfor the summarized window, returned in the language specified in the\nrequest. For example, *Expect showers Tuesday through Thursday*." }, "category": { "type": "string", "description": "A one or two-word label categorizing the dominant weather conditions\nfor the summarized window - for example, *Sunny*, *Partly Cloudy*,\n*Rain*, or *Snow*." } } }, "DailyHistoricalActuals": { "type": "object", "description": "The observed weather summary for a single past day at the queried\nlocation, returned as one entry in `DailyHistoricalActualsResult.results`.\nEach entry reports what was actually measured that day - minimum,\nmaximum, and average `temperature`; accumulated `precipitation`,\n`snowfall`, and `snowDepth`; and a `degreeDaySummary` of heating and\ncooling demand. Across the entries in a single response the values\nchange from day to day - in the example response the average daily\ntemperature warms from *-8.6 °C* on *2012-01-20* to *-5.3 °C* on\n*2012-01-21* to *-3.6 °C* on *2012-01-22*, while accumulated snow\ndepth on the ground falls from *15.2 cm* to *12.7 cm* to *10.2 cm*\nover the same three days.", "properties": { "date": { "type": "string", "format": "date-time", "description": "The day this observation covers, in [ISO\n8601](https://www.iso.org/iso-8601-date-and-time-format.html) format\n(yyyy-mm-ddThh:mm:ss+hh:mm) - for example,\n*2012-01-20T00:00:00-04:00*. Observation entries within a single\nresponse use sequential `date` values, one per day." }, "temperature": { "$ref": "#/definitions/WeatherValueMaxMinAvg", "description": "The observed minimum, maximum, and average air temperature for the\nday at the queried location, in degrees Celsius (°C) or Fahrenheit\n(°F) depending on the unit specified in the request - for example,\nminimum *-11.1 °C*, maximum *-6.1 °C*, and average *-8.6 °C* on\n*2012-01-20*. The `WeatherValueMaxMinAvg` shape pairs naturally with\nthe same three-value pattern used by the records and normals\nresponses for the same calendar day." }, "degreeDaySummary": { "$ref": "#/definitions/DegreeDaySummary", "description": "Observed heating and cooling degree-day totals for the day at the\nqueried location, used to estimate energy demand for building\nclimate control. Heating degree-days accumulate when the average\ntemperature is below the reference balance point and cooling\ndegree-days accumulate when it is above - for example, the cold\nwinter day *2012-01-20* records `degreeDaySummary.heating` of\n*27 °C* and `degreeDaySummary.cooling` of *0 °C*." }, "precipitation": { "$ref": "#/definitions/WeatherValue", "description": "The amount of liquid-equivalent precipitation (rain plus melted\nsnow) that fell during the day at the queried location, in\nmillimeters (mm) or inches (in) depending on the unit specified in\nthe request - for example, *10.9 mm* on *2012-01-20* (a wet day)\ncompared with *0 mm* on the following two dry days." }, "snowfall": { "$ref": "#/definitions/WeatherValue", "description": "The amount of new snow that fell during the day at the queried\nlocation, in centimeters (cm) or inches (in) depending on the unit\nspecified in the request - for example, *12.19 cm* on\n*2012-01-20*, *0.51 cm* on *2012-01-21*, and *0 cm* on\n*2012-01-22*. Snowfall is the day's fresh accumulation;\n`snowDepth` is the total depth left on the ground." }, "snowDepth": { "$ref": "#/definitions/WeatherValue", "description": "The total depth of snow on the ground at the queried location at\nthe end of the day, in centimeters (cm) or inches (in) depending\non the unit specified in the request - for example, *15.2 cm*,\n*12.7 cm*, and *10.2 cm* on three consecutive days as the\nsnowpack settles and melts. Snow depth reflects the combined\neffect of all prior `snowfall` minus melting and compaction." } } }, "DailyHistoricalActualsResult": { "type": "object", "description": "The response returned by the Get Daily Historical Actuals operation,\ncontaining one observed historical weather record per day for the queried\nlocation across the requested date range. The range is set by the\ncaller's requested start and end dates (up to 31 days), so `results`\ncarries one entry per day in chronological order - for example, a\n3-day request spanning *2012-01-20* through *2012-01-22* returns three\nentries with `date` values *2012-01-20T00:00:00-04:00*,\n*2012-01-21T00:00:00-04:00*, and *2012-01-22T00:00:00-04:00*. Each\nentry reports what actually happened that day - observed minimum,\nmaximum, and average temperature plus precipitation, snowfall, snow\ndepth, and heating/cooling degree-day totals - which makes the\nresponse useful for backfilling weather history into reports or\nclimatology studies.", "properties": { "results": { "type": "array", "description": "The list of observed historical weather records for the queried\nlocation, one entry per day, in chronological order starting with\nthe earliest day in the requested range. The number of entries\nmatches the number of days from the requested start date through\nthe requested end date (up to 31 days). Each entry reports the\nday's `temperature` (`minimum`, `maximum`, and `average`),\n`precipitation`, `snowfall`, `snowDepth`, and `degreeDaySummary`\n(`heating` and `cooling`).", "items": { "$ref": "#/definitions/DailyHistoricalActuals" } }, "nextLink": { "type": "string", "description": "The URL to retrieve the next page of results when the response is\npaginated, suitable for navigating through result sets too large to\nreturn in a single call. Empty when there are no further pages." } } }, "DailyHistoricalNormals": { "type": "object", "description": "A single calendar day of climate-normal data for the queried\nlocation, computed as a 30-year average over the *1991-2020*\nclimate baseline. Bundles the normal `temperature` (high, low, and\naverage), the normal `precipitation` accumulation, and a\n`degreeDaySummary` (cooling and heating degree days) for that day.\nReturned as one element of `DailyHistoricalNormalsResult.results`,\nin chronological order.", "properties": { "date": { "type": "string", "format": "date-time", "description": "The calendar day these normals describe, in [RFC\n3339](https://datatracker.ietf.org/doc/html/rfc3339) extended format with\na time-zone offset (yyyy-mm-ddThh:mm:ss+hh:mm). For example,\n*2012-01-20T00:00:00-04:00* - the time component is always\n*00:00:00* and the offset reflects the queried location's standard\ntime." }, "temperature": { "$ref": "#/definitions/WeatherValueMaxMinAvg", "description": "The 30-year normal high, low, and average temperatures for this\ncalendar day at the queried location, computed over the\n*1991-2020* baseline. Values are in degrees Celsius (°C) or\nFahrenheit (°F) according to the unit specified in the request -\nfor example, on *2012-01-20* the normal high is *4.4 °C*, the\nnormal low is *-3.7 °C*, and the normal average is *0.4 °C*." }, "degreeDaySummary": { "$ref": "#/definitions/DegreeDaySummary", "description": "The 30-year normal cooling and heating degree days for this\ncalendar day at the queried location, computed over the\n*1991-2020* baseline. For *2012-01-20* this entry reports *0*\ncooling degree days and *18* heating degree days, with `unit` *C*\nindicating the temperature scale used to compute them." }, "precipitation": { "$ref": "#/definitions/WeatherValue", "description": "The 30-year normal precipitation accumulation for this calendar\nday at the queried location, computed over the *1991-2020*\nbaseline. Values are in millimeters (mm) or inches (in) according\nto the unit specified in the request - for example, *2.5 mm* of\nprecipitation on *2012-01-20*." } } }, "DailyHistoricalNormalsResult": { "type": "object", "description": "The response returned by the Get Daily Historical Normals operation,\ncontaining the daily climate-normal series for the requested location\nand calendar-day range. Each day's normals are 30-year averages\ncomputed over the *1991-2020* climate baseline. Up to 31 contiguous\ncalendar days can be returned in a single response.", "properties": { "results": { "type": "array", "description": "The per-day climate-normal entries, one per calendar day in the\nrequested range, in chronological order. Each entry carries the\nnormal `temperature` (high, low, and average), the normal\n`precipitation` accumulation, and a `degreeDaySummary` (cooling\nand heating degree days) for that calendar day - all 30-year\naverages over the *1991-2020* baseline. For example, the entry\nfor *2012-01-20* reports a normal high of *4.4 °C*, a normal low\nof *-3.7 °C*, a normal average of *0.4 °C*, *2.5 mm* of\nprecipitation, and *0* cooling / *18* heating degree days.", "items": { "$ref": "#/definitions/DailyHistoricalNormals" } }, "nextLink": { "type": "string", "description": "The URL of the next page of results, if any. Present when the\nresponse is paginated and additional pages are available; absent\non the final page." } } }, "DailyHistoricalRecords": { "type": "object", "description": "The all-time record summary for a single calendar day at the queried\nlocation, returned as one entry in `DailyHistoricalRecordsResult.results`.\nEach entry reports the most extreme values ever recorded at the location\nfor that calendar day across the full historical archive: the record\nhigh and low `temperature` (each tagged with the `year` it was set, plus\nthe long-term average for the date), the record `precipitation` total,\nand the record `snowfall` total. Across the entries in a single response\nthe records vary by date - in the example response the record high\ntemperature climbs *18.3 °C* (set in *1951*) on *2012-01-20*, then\n*16.7 °C* (*1959*) on *2012-01-21*, then *21.1 °C* (*1906*) on\n*2012-01-22*, while the record lows fall *-19.4 °C* (*1984*),\n*-21.1 °C* (*1985*), and *-21.7 °C* (*1984*) on the same three days.", "properties": { "date": { "type": "string", "format": "date-time", "description": "The calendar day this record summary covers, in [ISO\n8601](https://www.iso.org/iso-8601-date-and-time-format.html) format\n(yyyy-mm-ddThh:mm:ss+hh:mm) - for example,\n*2012-01-20T00:00:00-04:00*. Only the month and day are meaningful\nfor record lookups; the year on `date` is the year of the request,\nwhile the year of each individual record is carried on the\n`WeatherValueYear.year` field." }, "temperature": { "$ref": "#/definitions/WeatherValueYearMaxMinAvg", "description": "The record-setting `maximum` and `minimum` temperatures ever\nobserved at the queried location for this calendar day - each\ntagged with the year the record was set - together with the\nlong-term `average` temperature for the date, in degrees Celsius\n(°C) or Fahrenheit (°F) depending on the unit specified in the\nrequest. For example, on *2012-01-20* the record high is\n*18.3 °C* (set in *1951*), the record low is *-19.4 °C*\n(*1984*), and the long-term average is *-0.6 °C*." }, "precipitation": { "$ref": "#/definitions/WeatherValueYearMax", "description": "The largest single-day precipitation total ever observed at the\nqueried location for this calendar day, tagged with the year it\nwas set, in millimeters (mm) or inches (in) depending on the unit\nspecified in the request - for example, *48 mm* set in *1978* on\n*2012-01-20*. Only the record `maximum` is reported because\nminimum precipitation for any calendar day is trivially zero." }, "snowfall": { "$ref": "#/definitions/WeatherValueYearMax", "description": "The largest single-day snowfall total ever observed at the queried\nlocation for this calendar day, tagged with the year it was set,\nin centimeters (cm) or inches (in) depending on the unit specified\nin the request - for example, *12.19 cm* set in *1978* on\n*2012-01-20*, or *34.29 cm* set in *2014* on *2012-01-21*. Only\nthe record `maximum` is reported because minimum snowfall for any\ncalendar day is trivially zero." } } }, "DailyHistoricalRecordsResult": { "type": "object", "description": "The response returned by the Get Daily Historical Records operation,\ncontaining one all-time record summary per calendar day for the queried\nlocation across the requested date range. The range is set by the\ncaller's requested start and end dates (up to 31 days), so `results`\ncarries one entry per calendar day in chronological order - for\nexample, a 3-day request spanning *2012-01-20* through *2012-01-22*\nreturns three entries with `date` values *2012-01-20T00:00:00-04:00*,\n*2012-01-21T00:00:00-04:00*, and *2012-01-22T00:00:00-04:00*. Each\nentry reports the most extreme values ever recorded at the location\nfor that calendar day across the full historical archive (record\nhigh and low temperature, plus record-setting precipitation and\nsnowfall), each tagged with the year the record was set - useful for\ncomparing today's conditions against the all-time benchmarks for the\nsame date.", "properties": { "results": { "type": "array", "description": "The list of all-time record summaries for the queried location, one\nentry per calendar day, in chronological order starting with the\nearliest day in the requested range. The number of entries matches\nthe number of days from the requested start date through the\nrequested end date (up to 31 days). Each entry reports the day's\nrecord `temperature` (`maximum`, `minimum`, and the long-term\n`average`), record `precipitation`, and record `snowfall`, each\npaired with the `year` the extreme was observed - for example, the\nrecord low on *2012-01-22* is *-21.7 °C* set in *1984*.", "items": { "$ref": "#/definitions/DailyHistoricalRecords" } }, "nextLink": { "type": "string", "description": "The URL to retrieve the next page of results when the response is\npaginated, suitable for navigating through result sets too large to\nreturn in a single call. Empty when there are no further pages." } } }, "DailyIndex": { "type": "object", "description": "A single index rating in the `DailyIndicesResult.results` array, scoring\nhow well one day's weather conditions are suited to a particular outdoor\nactivity such as running, golfing, kite flying, or barbecuing. Each\nentry includes the activity name (for example, *Ski Weather Forecast*),\nthe date it applies to, a numeric `value` from **0.0** to **10.0**, a\nmatching qualitative `category` label (for example, *Poor*), and a\nshort `description` of the conditions (for example, *Expect poor\nconditions for skiing.*). A response may contain many entries - one\nper day per index - covering each day in the requested `duration` and\neach requested index.", "properties": { "indexName": { "type": "string", "description": "The display name of the index, identifying the activity or condition\nit rates - for example, *Running Forecast*, *Golf Weather Forecast*,\n*Kite Flying Forecast*, or *Beach & Pool Forecast*. Returned in the\nlanguage specified in the request. For the full list of supported\nindices, see [Index\nIDs](/azure/azure-maps/weather-services-concepts#index-ids-and-index-groups-ids)\nin the *Weather services in Azure Maps* concepts article." }, "indexId": { "type": "integer", "format": "int32", "description": "The numeric identifier of the index, suitable for stable,\nlanguage-independent lookup of the activity that pairs with\n`indexName`. For example, **1** identifies *Running Forecast*, **5**\nidentifies *Golf Weather Forecast*, and **9** identifies *Kite\nFlying Forecast*. For the complete mapping, see [Index\nIDs](/azure/azure-maps/weather-services-concepts#index-ids-and-index-groups-ids)\nin the *Weather service in Azure Maps* concepts article." }, "dateTime": { "type": "string", "format": "date-time", "description": "The date the index applies to, expressed as midnight local time at\nthe forecast location in [ISO\n8601](https://www.iso.org/iso-8601-date-and-time-format.html) format\n(yyyy-mm-ddThh:mm:ss±hh:mm) - for example,\n*2020-07-14T07:00:00-04:00*. The time component is always 00:00:00 in\nthe location's local offset; treat this as the calendar day the\n`value` and `category` cover, not as an observation timestamp." }, "value": { "type": "number", "format": "float", "description": "The numeric suitability score for the activity on this day, from\n**0.0** to **10.0**. By default **10.0** indicates the most favorable\nconditions and **0.0** the least favorable, but a few indices invert\nthe scale - check `ascending` before interpreting the value. For\nexample, a `value` of **9.2** for the *Running Forecast* with\n`ascending` = `true` means very good running weather. For the\nper-index value-to-category ranges, see [Daily index range\nsets](/azure/azure-maps/daily-index-range-sets) in the *Weather\nservices in Azure Maps* concepts article." }, "category": { "type": "string", "description": "A short qualitative label describing `value` and `categoryValue` -\nfor example, *Excellent*, *Very Good*, *Good*, *Fair*, *Poor*, or\n*Very Poor*. The exact set of labels depends on the index (for\nexample, *Mosquito Activity* uses *Low*, *Moderate*, *High*, *Very\nHigh*, *Extreme*). Returned in the language specified in the\nrequest." }, "categoryValue": { "type": "integer", "format": "int32", "description": "A 1-5 numeric rating that pairs with `category`, suitable for\nstable, language-independent comparisons. The mapping between the\nnumber and the qualitative label depends on `ascending`:\n\n- When `ascending` is `true`, **5** is the best rating and **1**\nthe worst (for example, **5** = *Excellent*).\n- When `ascending` is `false`, **1** is the best rating and **5**\nthe worst (for example, for *Mosquito Activity*: **1** = *Low*,\n**2** = *Moderate*, **3** = *High*, **4** = *Very High*,\n**5** = *Extreme*)." }, "ascending": { "type": "boolean", "description": "Indicates which end of the **0.0**-**10.0** `value` scale (and the\n1-5 `categoryValue` scale) is the most favorable, since the\ndirection varies by index:\n\n- `true`: higher is better - **10.0** is the best `value`, **0.0**\nthe worst (for example, *Running Forecast*, *Golf Weather\nForecast*).\n- `false`: lower is better - **0.0** is the best `value`, **10.0**\nthe worst (for example, *Mosquito Activity*, where the rating\nmeasures a hazard rather than a benefit).\n\nUse this flag whenever comparing `value` or `categoryValue` across\nindices." }, "description": { "type": "string", "description": "A short, human-readable explanation of the rating for this day,\nsuitable for display in a UI - for example, *This is an excellent\nday for outdoor running!*, *This is a great day for golf.*, or\n*Conditions are very good today for kite-flying.* Returned in the\nlanguage specified in the request." } } }, "DailyIndicesResult": { "type": "object", "description": "The response returned by the Get Daily Indices operation, providing\nactivity-suitability ratings for the specified location. The `results`\narray contains one `DailyIndex` entry per day per index, each scoring\nthe day's weather conditions for an outdoor activity such as running,\ngolfing, kite flying, or barbecuing.", "properties": { "results": { "type": "array", "description": "The daily index ratings for the queried location, in chronological\norder starting with the current day. The array contains one\n`DailyIndex` entry per day per index, with the number of days\ncontrolled by the requested `duration` (1, 5, 10, or 15 days).", "items": { "$ref": "#/definitions/DailyIndex" }, "readOnly": true } } }, "DayQuarter": { "type": "number", "description": "Divides the day into four 6-hour quarters. Valid values are 0-3:\n\n- 0: Morning (7am - 1pm)\n- 1: Afternoon (1pm - 7pm)\n- 2: Evening (7pm - 1am)\n- 3: Overnight (1am - 7am)", "enum": [ 0, 1, 2, 3 ], "x-ms-enum": { "name": "DayQuarter", "modelAsString": true, "values": [ { "name": "FirstQuarter", "value": 0, "description": "7:00 am - 1:00 pm / 07:00 - 13:00" }, { "name": "SecondQuarter", "value": 1, "description": "1:00 pm - 7:00 pm / 13:00 - 19:00" }, { "name": "ThirdQuarter", "value": 2, "description": "7:00 pm - 1:00 am / 19:00 - 01:00" }, { "name": "ForthQuarter", "value": 3, "description": "1:00 am - 7:00 am / 01:00 - 07:00" } ] } }, "DegreeDaySummary": { "type": "object", "description": "Heating and cooling degree-day totals for a single day, used to estimate\nthe energy demand for heating or cooling a building. Each value is the\nnumber of degrees by which the day's mean temperature differs from the\n**65°F (18°C)** baseline, in the temperature unit specified in the\nrequest - degrees below the baseline contribute to `heating`, degrees\nabove it contribute to `cooling`.", "properties": { "heating": { "$ref": "#/definitions/WeatherValue", "description": "Heating Degree Days (HDD) - the number of degrees the day's mean\ntemperature falls **below** the 65°F (18°C) baseline. Higher values\nindicate greater heating demand. Reported in degrees Celsius (°C) or\nFahrenheit (°F) depending on the unit specified in the request." }, "cooling": { "$ref": "#/definitions/WeatherValue", "description": "Cooling Degree Days (CDD) - the number of degrees the day's mean\ntemperature rises **above** the 65°F (18°C) baseline. Higher values\nindicate greater cooling demand. Reported in degrees Celsius (°C) or\nFahrenheit (°F) depending on the unit specified in the request." } } }, "DominantPollutant": { "type": "string", "description": "Identifies the pollutant with the highest concentration.", "enum": [ "Carbon Monoxide", "Nitrogen Dioxide", "Ozone", "Particulate Matter 2.5", "Particulate Matter 10", "Sulfur Dioxide" ], "x-ms-enum": { "name": "DominantPollutant", "modelAsString": true, "values": [ { "name": "Carbon Monoxide", "value": "Carbon Monoxide", "description": "Carbon monoxide (**CO**) is a colorless, odorless, and tasteless but highly\ntoxic gas produced by the incomplete combustion of carbon-containing fuels.\nCommon sources include vehicle exhaust, gas stoves, furnaces, and wood\nfires." }, { "name": "Nitrogen Dioxide", "value": "Nitrogen Dioxide", "description": "Nitrogen dioxide (**NO2**) is a significant atmospheric pollutant. It is\nregulated and subject to recommended limit guidelines set by the World\nHealth Organization (WHO)." }, { "name": "Ozone", "value": "Ozone", "description": "Ozone (**O3**) is a key component of photochemical smog, the brown, harmful\nhaze that envelops many large cities, resulting from a photochemical\nreaction between sunlight and certain specific pollutants." }, { "name": "Particulate Matter 2.5", "value": "Particulate Matter 2.5", "description": "Particulate matter 2.5 (**PM2.5**) refers to fine particles with diameters that\nare generally 2.5 micrometers and smaller. These particles are more than 100 times\nthinner than a human hair and can remain suspended in the air for extended periods." }, { "name": "Particulate Matter 10", "value": "Particulate Matter 10", "description": "Particulate matter 10 (**PM10**) refers to particles with diameters that are generally 10\nmicrometers and smaller. These particles can include dust, pollen, soot, smoke, and liquid droplets." }, { "name": "Sulfur Dioxide", "value": "Sulfur Dioxide", "description": "Sulfur dioxide (**SO2**) is a heavy, colorless inorganic gas with a pungent,\nirritating odor. It is mainly produced by burning fossil fuels at power\nplants and industrial facilities, but it can also be emitted from natural\nsources such as volcanoes." } ] } }, "ErrorAdditionalInfo": { "type": "object", "description": "The resource management error additional info.", "properties": { "type": { "type": "string", "description": "The additional info type.", "readOnly": true }, "info": { "type": "object", "description": "The additional info.", "additionalProperties": {}, "readOnly": true } } }, "ErrorDetail": { "type": "object", "description": "The error detail.", "properties": { "code": { "type": "string", "description": "The error code.", "readOnly": true }, "message": { "type": "string", "description": "The error message.", "readOnly": true }, "target": { "type": "string", "description": "The error target.", "readOnly": true }, "details": { "type": "array", "description": "The error details.", "items": { "$ref": "#/definitions/ErrorDetail" }, "readOnly": true }, "additionalInfo": { "type": "array", "description": "The error additional info.", "items": { "$ref": "#/definitions/ErrorAdditionalInfo" }, "readOnly": true } } }, "ErrorResponse": { "type": "object", "description": "Common error response for all Azure Resource Manager APIs to return error\ndetails for failed operations. (This also follows the OData error response\nformat.).", "properties": { "error": { "$ref": "#/definitions/ErrorDetail", "description": "The error object." } } }, "ForecastInterval": { "type": "object", "description": "Represents a single time slice within a minute-by-minute forecast,\ndescribing the expected weather conditions during that interval. Each\ninterval covers 1, 5, or 15 minutes - depending on the resolution\nrequested - and includes the start time, precipitation intensity (`dbz`),\nprecipitation type and threshold, a short descriptive phrase, an icon\ncode, cloud cover, and the full-spectrum and simplified colors used to\nvisually represent the conditions on a radar-style display.", "properties": { "startTime": { "type": "string", "format": "date-time", "description": "The start of this forecast interval, in [RFC\n3339](https://datatracker.ietf.org/doc/html/rfc3339) format\n(`yyyy-mm-ddThh:mm:ss±hh:mm`). For example, *2019-11-14T15:18:00-08:00*." }, "minute": { "type": "integer", "format": "int32", "description": "The start of this forecast interval expressed as a number of minutes from\nthe start of the forecast (minute 0). Pairs with `startTime` and matches\nthe `startMinute` field on the corresponding `IntervalSummary`." }, "dbz": { "type": "number", "format": "double", "description": "Forecasted radar reflectivity in decibels relative to Z (dBZ), used as a\nmeasure of precipitation intensity. Higher values indicate heavier\nprecipitation; a value of 0 indicates no precipitation." }, "shortPhrase": { "type": "string", "description": "A short phrase describing the precipitation conditions during this\ninterval (for example, *Light rain*). Up to approximately 25 characters." }, "threshold": { "type": "string", "description": "The intensity bucket the precipitation falls into for the current\n`precipitationType` - for example, *light*, *moderate*, or *heavy*. Used\nwith `precipitationType` to determine `simplifiedColor`. Returned only\nwhen `dbz` is greater than zero." }, "color": { "$ref": "#/definitions/ColorValue", "description": "The full-spectrum color that maps to `dbz`, used to render this interval\non a radar-style display. Returned only when `dbz` is greater than zero." }, "simplifiedColor": { "$ref": "#/definitions/ColorValue", "description": "A simplified color derived from `precipitationType` and `threshold`,\nsuitable for UIs that need quick, easy-to-read radar visualizations\nrather than the full dBZ color spectrum. Returned only when `dbz` is\ngreater than zero." }, "precipitationType": { "$ref": "#/definitions/PrecipitationType", "description": "The type of precipitation expected during this interval - one of *Rain*,\n*Snow*, *Ice*, or *Mix*. Returned only when `dbz` is greater than zero." }, "iconCode": { "$ref": "#/definitions/IconCode", "description": "The representative weather icon code for this interval. The numeric value\ncorresponds to an Azure Maps weather icon - for the complete list, see\n[Weather services in Azure\nMaps](/azure/azure-maps/weather-services-concepts#weather-icons)." }, "cloudCover": { "type": "integer", "format": "int32", "description": "The percentage of the sky covered by clouds during this interval, from 0\n(clear) to 100 (overcast). May be NULL." } } }, "GeoJsonGeometry": { "type": "object", "description": "A valid `GeoJSON` geometry object. The type must be one of the seven valid\nGeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString,\nPolygon, MultiPolygon and GeometryCollection. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details.", "properties": { "type": { "$ref": "#/definitions/GeoJsonObjectType", "description": "Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object\ntypes - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon,\nGeometryCollection, Feature and FeatureCollection." } }, "discriminator": "type", "required": [ "type" ] }, "GeoJsonGeometryCollection": { "type": "object", "description": "A valid `GeoJSON GeometryCollection` object type. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.8) for details.", "properties": { "geometries": { "type": "array", "description": "Contains a list of valid `GeoJSON` geometry objects. **Note** that coordinates\nin GeoJSON are in x, y order (longitude, latitude).", "items": { "$ref": "#/definitions/GeoJsonGeometry" } } }, "required": [ "geometries" ], "allOf": [ { "$ref": "#/definitions/GeoJsonGeometry" } ], "x-ms-discriminator-value": "GeometryCollection" }, "GeoJsonLineString": { "type": "object", "description": "A valid `GeoJSON LineString` geometry type. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.4) for details.", "properties": { "coordinates": { "type": "array", "description": "Coordinates for the `GeoJson LineString` geometry.", "items": { "type": "array", "items": { "type": "number", "format": "double" } } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/GeoJsonGeometry" } ], "x-ms-discriminator-value": "LineString" }, "GeoJsonMultiLineString": { "type": "object", "description": "A valid `GeoJSON MultiLineString` geometry type. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.5) for details.", "properties": { "coordinates": { "type": "array", "description": "Coordinates for the `GeoJson MultiLineString` geometry.", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } } } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/GeoJsonGeometry" } ], "x-ms-discriminator-value": "MultiLineString" }, "GeoJsonMultiPoint": { "type": "object", "description": "A valid `GeoJSON MultiPoint` geometry type. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.3) for details.", "properties": { "coordinates": { "type": "array", "description": "Coordinates for the `GeoJson MultiPoint` geometry.", "items": { "type": "array", "items": { "type": "number", "format": "double" } } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/GeoJsonGeometry" } ], "x-ms-discriminator-value": "MultiPoint" }, "GeoJsonMultiPolygon": { "type": "object", "description": "A valid `GeoJSON MultiPolygon` object type. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.7) for details.", "properties": { "coordinates": { "type": "array", "description": "Contains a list of valid `GeoJSON Polygon` objects. **Note** that coordinates\nin GeoJSON are in x, y order (longitude, latitude).", "items": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } } } } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/GeoJsonGeometry" } ], "x-ms-discriminator-value": "MultiPolygon" }, "GeoJsonObjectType": { "type": "string", "description": "Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object\ntypes - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon,\nGeometryCollection, Feature and FeatureCollection.", "enum": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection", "Feature", "FeatureCollection" ], "x-ms-enum": { "name": "GeoJsonObjectType", "modelAsString": false, "values": [ { "name": "GeoJsonPoint", "value": "Point", "description": "`GeoJSON Point` geometry." }, { "name": "GeoJsonMultiPoint", "value": "MultiPoint", "description": "`GeoJSON MultiPoint` geometry." }, { "name": "GeoJsonLineString", "value": "LineString", "description": "`GeoJSON LineString` geometry." }, { "name": "GeoJsonMultiLineString", "value": "MultiLineString", "description": "`GeoJSON MultiLineString` geometry." }, { "name": "GeoJsonPolygon", "value": "Polygon", "description": "`GeoJSON Polygon` geometry." }, { "name": "GeoJsonMultiPolygon", "value": "MultiPolygon", "description": "`GeoJSON MultiPolygon` geometry." }, { "name": "GeoJsonGeometryCollection", "value": "GeometryCollection", "description": "`GeoJSON GeometryCollection` geometry." }, { "name": "GeoJsonFeature", "value": "Feature", "description": "`GeoJSON Feature` object." }, { "name": "GeoJsonFeatureCollection", "value": "FeatureCollection", "description": "`GeoJSON FeatureCollection` object." } ] } }, "GeoJsonPoint": { "type": "object", "description": "A valid `GeoJSON Point` geometry type. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details.", "properties": { "coordinates": { "type": "array", "description": "A `Position` is an array of numbers with two or more elements. The first two\nelements are _longitude_ and _latitude_, precisely in that order.\n_Altitude/Elevation_ is an optional third element. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.1) for details.", "items": { "type": "number", "format": "double" } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/GeoJsonGeometry" } ], "x-ms-discriminator-value": "Point" }, "GeoJsonPolygon": { "type": "object", "description": "A valid `GeoJSON Polygon` geometry type. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.6) for details.", "properties": { "coordinates": { "type": "array", "description": "Coordinates for the `GeoJson Polygon` geometry type.", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } } } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/GeoJsonGeometry" } ], "x-ms-discriminator-value": "Polygon" }, "HazardDetail": { "type": "object", "description": "One entry in `WeatherHazards.hazardDetails` describing a single\nweather hazard at the location (route-level when carried on\n`WeatherAlongRouteSummary.hazards`, or per-waypoint when carried on\n`WaypointForecast.hazards`). Combines a `hazardCode` identifying the\nspecific hazard type, a `hazardIndex` rating its individual severity\non the 0-4 scale, and a `shortPhrase` suitable for display in a UI.", "properties": { "hazardIndex": { "$ref": "#/definitions/HazardIndex", "description": "The severity rating for this specific hazard, on the same 0-4\nscale as `WeatherHazards.maxHazardIndex`:\n\n- **0**: No hazard\n- **1**: Be informed, be aware\n- **2**: Pay attention, be prepared\n- **3**: Take action\n- **4**: Life-threatening, emergency" }, "hazardCode": { "type": "string", "description": "A language-independent code identifying the type of hazard.\nSupported values:\n\n- `LightRain`, `ModerateRain`, `HeavyRain`\n- `LightMix`, `ModerateMix`, `HeavyMix`\n- `LightSnow`, `ModerateSnow`, `HeavySnow`\n- `LightIce`, `ModerateIce`, `HeavyIce`\n- `Hail`, `LargeHail`\n- `SunGlare`, `SunGlareHigh`\n- `Lightning`, `SevereLightning`\n- `WindModerate`, `WindHigh`, `WindExtreme`\n- `FloodWarning`, `FlashFloodWarning`\n- `TornadoWarning`, `TsunamiWarning`\n- `SevereThunderstormWarning`" }, "shortPhrase": { "type": "string", "description": "A short, displayable phrase describing the hazard, returned in\nthe language specified in the request. Up to 25 characters." } } }, "HazardIndex": { "type": "number", "description": "The aggregated severity/hazard index for each waypoint can be utilized to\ncolor-code segments of a route, indicating the safety level for drivers.\n\n- **0**: No hazard\n- **1**: Be informed, be aware\n- **2**: Pay attention, be prepared\n- **3**: Take action\n- **4**: Life-threatening, emergency", "enum": [ 0, 1, 2, 3, 4 ], "x-ms-enum": { "name": "HazardIndex", "modelAsString": true, "values": [ { "name": "NoHazard", "value": 0, "description": "No hazard" }, { "name": "Informed", "value": 1, "description": "Be informed" }, { "name": "PayAttention", "value": 2, "description": "Pay attention" }, { "name": "TakeAction", "value": 3, "description": "Take action" }, { "name": "Emergency", "value": 4, "description": "Emergency" } ] } }, "HourlyDuration": { "type": "number", "description": "Duration in hours for which the forecast is requested.", "enum": [ 1, 12, 24, 48, 72, 96 ], "x-ms-enum": { "name": "HourlyDuration", "modelAsString": true, "values": [ { "name": "OneHour", "value": 1, "description": "1 Hour" }, { "name": "TwelveHours", "value": 12, "description": "12 Hours" }, { "name": "TwentyFourHours", "value": 24, "description": "24 Hours" }, { "name": "FortyEightHours", "value": 48, "description": "48 Hours" }, { "name": "SeventyTwoHours", "value": 72, "description": "72 Hours" }, { "name": "NinetySixHours", "value": 96, "description": "96 Hours" } ] } }, "HourlyForecast": { "type": "object", "description": "The `HourlyForecast` object provides hourly weather details, including date and\ntime, expected and perceived temperatures, and dew point. It covers wind\nspeed and direction, wind gusts, relative humidity, visibility, and\nprecipitation probability. It indicates if precipitation is expected and\nspecifies its type. Additional properties include UV index, cloud cover\npercentage, and cloud ceiling height. It also features an icon code and\nphrase describing the weather condition.", "properties": { "date": { "type": "string", "format": "date-time", "description": "Date and time of the forecast in [RFC\n3339](https://datatracker.ietf.org/doc/html/rfc3339) format\n(yyyy-mm-ddThh:mm:ss±hh:mm). For example, *2019-11-14T16:00:00-08:00*." }, "iconCode": { "$ref": "#/definitions/IconCode", "description": "A numeric value that corresponds to an image displaying the `iconPhrase`.\nFor more information, see [Weather services in Azure\nMaps](/azure/azure-maps/weather-services-concepts#weather-icons)." }, "iconPhrase": { "type": "string", "description": "A descriptive term that corresponds to a specific weather condition, such\nas *Sunny*. It is paired with an `iconCode`, which is a numeric value\nrepresenting an image that visually depicts the weather condition described\nby the `iconPhrase`. For more information, see [Weather services in Azure\nMaps](/azure/azure-maps/weather-services-concepts#weather-icons)." }, "hasPrecipitation": { "type": "boolean", "description": "A boolean value that indicates whether precipitation (rain, snow, sleet, or\nhail) is expected during the specified timeframe. Returns true if\nprecipitation is expected, otherwise false." }, "isDaylight": { "type": "boolean", "description": "A boolean value that indicates whether it is daylight during the specified\nhour. Returns true if it is daylight, otherwise false." }, "temperature": { "$ref": "#/definitions/WeatherValue", "description": "The expected temperature for the specified hour, measured in degrees\nCelsius (°C) or Fahrenheit (°F), depending on the unit specified in the\nrequest." }, "realFeelTemperature": { "$ref": "#/definitions/WeatherValue", "description": "Provides RealFeel™ Temperature values for the specified hour, measured in\ndegrees Celsius (°C) or Fahrenheit (°F), depending on the unit specified in\nthe request. This metric, developed by AccuWeather, incorporates over a\ndozen factors, including humidity, wind speed, cloud cover, and sun\nintensity, to offer a comprehensive measure of how the weather actually\nfeels.\n\nFor more information, see [What is the AccuWeather RealFeel\nTemperature?](https://www.accuweather.com/en/weather-news/what-is-the-accuweather-realfeel-temperature/156655)" }, "wetBulbTemperature": { "$ref": "#/definitions/WeatherValue", "description": "Returns the temperature a parcel of air would have if it were cooled to\nsaturation (100% relative humidity) by the evaporation of water into it.\nThis property is important for understanding heat stress and the cooling\neffect of evaporation." }, "dewPoint": { "$ref": "#/definitions/WeatherValue", "description": "The temperature at which air becomes saturated with moisture and dew begins\nto form. It is measured in degrees Fahrenheit (°F) or Celsius (°C), depending\non the unit specified. This value is crucial for understanding humidity\nlevels, as a higher dew point indicates more moisture in the air, making it\nfeel more humid." }, "wind": { "$ref": "#/definitions/WindDetails", "description": "Provides the expected wind speed and direction. Wind speed is measured in\nkilometers per hour (km/h) or miles per hour (mph), based on the specified\nunit. Wind direction is measured in azimuth degrees, ranging from 0° (true\nNorth) to 359°, moving clockwise (east is 90°, south is 180°, west is\n270°)." }, "windGust": { "$ref": "#/definitions/WindDetails", "description": "Returns the expected maximum wind gust speed during each hour of the\nforecast period, measured in kilometers per hour (km/h) or miles per hour\n(mph), based on the specified unit. Wind direction is given in azimuth\ndegrees, ranging from 0° (true North) to 359°, moving clockwise. Wind gusts\nare brief increases in wind speed, important for understanding short-term\nvariations that can impact activities like aviation, sailing, and outdoor\nevents." }, "relativeHumidity": { "type": "integer", "format": "int32", "description": "The amount of water vapor present in the air, expressed as a percentage of\nthe maximum amount the air can hold at the same temperature. This value\nindicates how close the air is to being saturated with moisture, affecting\nhow comfortable or humid the environment feels." }, "visibility": { "$ref": "#/definitions/WeatherValue", "description": "Returns the distance at which an object or light can be clearly discerned\nfor each hour of the forecast period, measured in kilometers (km) or miles\n(mi), depending on the unit specified in the request. This indicates how\nfar one can clearly see, which is crucial for activities like driving and\naviation." }, "ceiling": { "$ref": "#/definitions/WeatherValue", "description": "The height of the lowest layer of clouds above the ground, measured in feet\nor meters based on the unit specified in the request. This measurement is\ncrucial for aviation and weather forecasting." }, "uvIndex": { "type": "integer", "format": "int32", "description": "Provides the ultraviolet (UV) index for each hour of the forecast period.\nThis index indicates the level of ultraviolet radiation expected, helping\nusers understand the potential risk of sun exposure during different times\nof the day. Supported values are:\n\n- 0-2: Low danger from the sun's UV rays or the average person.\n- 3-5: Moderate risk of harm from unprotected sun exposure.\n- 6-7: High risk of harm from unprotected sun exposure.\n- 8-10: Very high risk of harm from unprotected sun exposure.\n- 11+: Extreme risk of harm from unprotected sun exposure." }, "uvIndexPhrase": { "type": "string", "description": "Provides a descriptive phrase that indicates the level of UV radiation,\nsuch as Low, Moderate, High, or Very High." }, "precipitationProbability": { "type": "integer", "format": "int32", "description": "Shows the probability of precipitation during the specified hour, expressed\nas a percentage from 0 to 100. A value of 0 means no chance of\nprecipitation, while 100 means precipitation is certain. This helps users\nassess the likelihood of rain, snow, or other forms of precipitation." }, "rainProbability": { "type": "integer", "format": "int32", "description": "Shows the probability of rain during the specified timeframe, expressed as\na percentage from 0 to 100. A value of 0 means no chance of rain, while 100\nmeans rain is certain." }, "snowProbability": { "type": "integer", "format": "int32", "description": "Shows the probability of snow during the specified hour, expressed as a\npercentage from 0 to 100. A value of 0 means no chance of snow, while 100\nmeans snow is certain." }, "iceProbability": { "type": "integer", "format": "int32", "description": "Shows the probability of ice formation during the specified hour, expressed\nas a percentage from 0 to 100. A value of 0 means no chance of ice\nformation, while 100 means ice formation is certain. This information helps\nusers evaluate the potential for icy conditions." }, "totalLiquid": { "$ref": "#/definitions/WeatherValue", "description": "Returns the total amount of liquid precipitation (such as rain) expected\nduring each hour of the forecast period, measured in millimeters (mm) or\ninches (in), depending on the unit specified in the request." }, "rain": { "$ref": "#/definitions/WeatherValue", "description": "Returns the amount of rainfall expected during each hour in the forecast,\nmeasured in millimeters (mm) or inches (in), depending on the unit\nspecified in the request." }, "snow": { "$ref": "#/definitions/WeatherValue", "description": "Returns the amount of snow accumulation expected during the specified hour,\nmeasured in millimeters (mm) or inches (in), depending on the unit\nspecified in the request." }, "ice": { "$ref": "#/definitions/WeatherValue", "description": "Returns estimated ice accumulation for each hour in the forecast, measured\nin millimeters (mm) or inches (in), depending on the unit specified in the\nrequest." }, "cloudCover": { "type": "integer", "format": "int32", "description": "The percentage of the sky covered by clouds at the specified hour. This\nvalue ranges from 0% (clear skies) to 100% (completely overcast). May be\nNULL." } } }, "HourlyForecastResult": { "type": "object", "description": "The response returned by the Get Hourly Forecast operation, containing\nhour-by-hour weather forecasts for a specified location. The number of\n`HourlyForecast` entries returned matches the requested forecast\nduration - one of *1*, *12*, *24*, *48*, *72*, or *96* hours (see the\n`HourlyDuration` union).", "properties": { "forecasts": { "type": "array", "description": "The hour-by-hour forecast entries, one per hour in the requested\nwindow, in chronological order. Each entry carries the expected\ntemperature, RealFeel, dew point, wind, precipitation outlook\n(probability and amounts for rain, snow, and ice), cloud cover,\nvisibility, UV index, ceiling, and other observations for that hour.\nFor example, a duration of *12* returns 12 entries beginning\n*2019-11-14T16:00:00-08:00* and stepping forward one hour at a time.", "items": { "$ref": "#/definitions/HourlyForecast" }, "readOnly": true } } }, "IconCode": { "type": "number", "description": "The numeric weather-condition code that identifies which icon to display.\nEach value in this enumeration corresponds to an Azure Maps weather icon\n(such as Sunny, Cloudy, or Thunderstorms) and pairs with a human-readable\n`iconPhrase` returned alongside it. The same code can appear in current,\nhourly, daily, quarter-day, and minute-by-minute responses, allowing\napplications to render a consistent icon set across all weather services.\n\nFor the complete list of codes, the icons they map to, and example\nimagery, see [Weather services in Azure\nMaps](/azure/azure-maps/weather-services-concepts#weather-icons).", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44 ], "x-ms-enum": { "name": "IconCode", "modelAsString": true, "values": [ { "name": "Sunny", "value": 1, "description": "Sunny" }, { "name": "MostlySunny", "value": 2, "description": "Mostly Sunny" }, { "name": "PartlySunny", "value": 3, "description": "Partly Sunny" }, { "name": "IntermittentClouds", "value": 4, "description": "Intermittent Clouds" }, { "name": "HazySunshine", "value": 5, "description": "Hazy Sunshine" }, { "name": "MostlyCloudy", "value": 6, "description": "Mostly Cloudy" }, { "name": "Cloudy", "value": 7, "description": "Cloudy" }, { "name": "Dreary", "value": 8, "description": "Dreary (Overcast)" }, { "name": "Fog", "value": 11, "description": "Fog" }, { "name": "Showers", "value": 12, "description": "Showers" }, { "name": "MostlyCloudyWithShowers", "value": 13, "description": "Mostly Cloudy with Showers" }, { "name": "PartlySunnyWithShowers", "value": 14, "description": "Partly Sunny with Showers" }, { "name": "Thunderstorms", "value": 15, "description": "Thunderstorms" }, { "name": "MostlyCloudyWithThunderstorms", "value": 16, "description": "Mostly Cloudy with Thunderstorms" }, { "name": "PartlySunnyWithThunderstorms", "value": 17, "description": "Partly Sunny with Thunderstorms" }, { "name": "Rain", "value": 18, "description": "Rain" }, { "name": "Flurries", "value": 19, "description": "Flurries" }, { "name": "MostlyCloudyWithFlurries", "value": 20, "description": "Mostly Cloudy with Flurries" }, { "name": "PartlySunnyWithFlurries", "value": 21, "description": "Partly Sunny with Flurries" }, { "name": "Snow", "value": 22, "description": "Snow" }, { "name": "MostlyCloudyWithSnow", "value": 23, "description": "Mostly Cloudy with Snow" }, { "name": "Ice", "value": 24, "description": "Ice" }, { "name": "Sleet", "value": 25, "description": "Sleet" }, { "name": "FreezingRain", "value": 26, "description": "Freezing Rain" }, { "name": "RainAndSnow", "value": 29, "description": "Rain and Snow" }, { "name": "Hot", "value": 30, "description": "Hot" }, { "name": "Cold", "value": 31, "description": "Cold" }, { "name": "Windy", "value": 32, "description": "Windy" }, { "name": "Clear", "value": 33, "description": "Clear" }, { "name": "Mostly Clear", "value": 34, "description": "Mostly Clear" }, { "name": "Partly Cloudy", "value": 35, "description": "Partly Cloudy" }, { "name": "IntermittentCloudsNight", "value": 36, "description": "Intermittent Clouds" }, { "name": "HazyMoonlight", "value": 37, "description": "Hazy Moonlight" }, { "name": "MostlyCloudyNight", "value": 38, "description": "Mostly Cloudy" }, { "name": "PartlyCloudyWithShowers", "value": 39, "description": "Partly Cloudy with Showers" }, { "name": "MostlyCloudyWithShowersNight", "value": 40, "description": "Mostly Cloudy with Showers" }, { "name": "Partly Cloudy with Thunderstorms", "value": 41, "description": "Partly Cloudy with Thunderstorms" }, { "name": "MostlyCloudyWithThunderstormsNight", "value": 42, "description": "Mostly Cloudy with Thunderstorms" }, { "name": "MostlyCloudyWithFlurriesNight", "value": 43, "description": "Mostly Cloudy with Flurries" }, { "name": "MostlyCloudyWithSnowNight", "value": 44, "description": "Mostly Cloudy with Snow" } ] } }, "IntervalSummary": { "type": "object", "description": "Describes the weather outlook for a contiguous window inside the\nminute-by-minute forecast - typically a stretch of similar conditions such\nas *Rain ending in 25 min* or *Light snow starting in 10 min*. Each summary\nspecifies the window in minutes from the forecast start (`startMinute`,\n`endMinute`, `totalMinutes`), provides phrase descriptions at three lengths\n(short, brief, and long) so the appropriate level of detail can be shown\nfor the available UI space, and includes an `iconCode` for the\nrepresentative weather icon. A `MinuteForecastResult` returns one or more\n`IntervalSummary` entries that together cover the forecast period.", "properties": { "startMinute": { "type": "integer", "format": "int32", "description": "The first minute of this interval, expressed as a number of minutes from\nthe start of the forecast (minute 0)." }, "endMinute": { "type": "integer", "format": "int32", "description": "The last minute of this interval, expressed as a number of minutes from\nthe start of the forecast (minute 0)." }, "totalMinutes": { "type": "integer", "format": "int32", "description": "The length of this interval, in minutes (`endMinute` - `startMinute` + 1)." }, "shortPhrase": { "type": "string", "description": "A short phrase describing the precipitation conditions during this interval. Up to 25 characters." }, "briefPhrase": { "type": "string", "description": "A brief phrase describing the precipitation conditions during this interval. Up to 60 characters." }, "longPhrase": { "type": "string", "description": "A long phrase describing the precipitation conditions during this interval. Supports\nmore than 60 characters." }, "iconCode": { "$ref": "#/definitions/IconCode", "description": "The representative weather icon code for this interval. The numeric value\ncorresponds to an Azure Maps weather icon - for the complete list, see\n[Weather services in Azure\nMaps](/azure/azure-maps/weather-services-concepts#weather-icons)." } } }, "LatLongPair": { "type": "object", "description": "A location represented as a latitude and longitude.", "properties": { "latitude": { "type": "number", "format": "double", "description": "Latitude property" }, "longitude": { "type": "number", "format": "double", "description": "Longitude property" } } }, "LatestStatus": { "type": "object", "description": "The most recent status of a severe weather alert in a specific area,\nreturned on `AlertArea.latestStatus`. The same status keyword (one of\n`New`, `Continue`, `Update`, `Correct`, `Extend`, `Upgrade`, `Cancel`,\nor `Expire` - see `LatestStatusKeyword` for the complete list) is\nreturned twice: once translated into the language specified on the\nrequest (`localized`), and once in English (`english`), so callers can\ndisplay a localized label to end users while still keeping a stable,\nlanguage-independent value for switching on status.", "properties": { "localized": { "type": "string", "description": "The status keyword translated into the language specified on the\nrequest - for example, *Continu* for French. If no language was\nspecified on the request, this matches `english`." }, "english": { "$ref": "#/definitions/LatestStatusKeyword", "description": "The status keyword in English (en-US) - one of the values defined by\n`LatestStatusKeyword` (`New`, `Continue`, `Update`, `Correct`,\n`Extend`, `Upgrade`, `Cancel`, or `Expire`). Always returned in\nEnglish regardless of the requested language, which makes it suitable\nfor stable, language-independent status checks." } } }, "LatestStatusKeyword": { "type": "string", "description": "A predefined list of eight keywords used to describe the current status of a\nsevere weather alert.", "enum": [ "Cancel", "Continue", "Correct", "Expire", "Extend", "New", "Update", "Upgrade" ], "x-ms-enum": { "name": "LatestStatusKeyword", "modelAsString": true, "values": [ { "name": "Cancel", "value": "Cancel", "description": "Indicates that the alert has been canceled before its scheduled expiration time." }, { "name": "Continue", "value": "Continue", "description": "Indicates that the alert has been updated since its initial issuance, but\nno changes were made to `alertDetails`, `startTime`, `endTime`, or `class`." }, { "name": "Correct", "value": "Correct", "description": "Indicates that the alert has been modified to correct a previous error." }, { "name": "Expire", "value": "Expire", "description": "Indicates that the alert has expired and is no longer active." }, { "name": "Extend", "value": "Extend", "description": "Indicates that the alert has been extended in duration, area, or both since\nits initial issuance." }, { "name": "New", "value": "New", "description": "The status of an alert when first issued." }, { "name": "Update", "value": "Update", "description": "Indicates that the alert has been modified since its initial issuance." }, { "name": "Upgrade", "value": "Upgrade", "description": "Indicates that the alert has been elevated to a higher class or category\nsince first issued." } ] } }, "LocalSource": { "type": "object", "description": "Information about a local weather data provider used to source the\nforecast on `DailyForecastDetail.localSource`. Identifies the provider\n(`id`, `name`) and exposes the provider's native `weatherCode` so that\napplications can render the provider's own icon set instead of the\ndefault Azure Maps icons.", "properties": { "id": { "type": "integer", "format": "int32", "description": "A numeric identifier that uniquely identifies the local data provider." }, "name": { "type": "string", "description": "The name of the local data provider, returned in the language\nspecified in the request when available; otherwise returned in\nEnglish or the language in which the provider supplied it." }, "weatherCode": { "type": "string", "description": "The provider-native weather code for this forecast, suitable for\nmapping to the provider's own icon set instead of the default Azure\nMaps `iconCode`." } } }, "MinuteForecastResult": { "type": "object", "description": "The response returned by the Get Minute Forecast operation, providing a\nminute-by-minute precipitation outlook for a specified location over the\nnext 120 minutes at the requested resolution (1, 5, or 15 minutes). The\nresponse is organized into three layers: an overall `summary` with phrase\ndescriptions and a representative icon for the whole period; an\n`intervalSummaries` array that groups consecutive minutes into longer\nstretches of similar conditions (such as *Rain ending in 25 min*); and an\n`intervals` array containing the detailed per-minute forecast points,\nincluding precipitation intensity (`dbz`), precipitation type, cloud\ncover, and the colors used to render radar-style visualizations.", "properties": { "summary": { "$ref": "#/definitions/MinuteForecastSummary", "description": "Top-level phrase summaries that describe the precipitation outlook for\nthe entire ~120-minute forecast window. Includes short, brief, and long\nvariants so the appropriate level of detail can be displayed for the\navailable UI space, plus a representative `iconCode` for the period.", "readOnly": true }, "intervalSummaries": { "type": "array", "description": "Phrase summaries that divide the forecast window into one or more\ncontiguous stretches of similar conditions - for example, *Rain ending\nin 25 min* followed by *Partly cloudy*. Each entry specifies the\nminutes it covers (`startMinute`, `endMinute`, `totalMinutes`),\nprovides short, brief, and long phrase variants, and includes an\n`iconCode` for the stretch. Together, these summaries cover the full\nforecast period.", "items": { "$ref": "#/definitions/IntervalSummary" }, "readOnly": true }, "intervals": { "type": "array", "description": "The detailed per-step forecast points that make up the minute-by-minute\nforecast. Each `ForecastInterval` covers 1, 5, or 15 minutes - depending\non the resolution requested - and reports the start time, precipitation\nintensity (`dbz`), precipitation type and threshold, a short\ndescriptive phrase, an icon code, cloud cover, and the colors used to\nrender a radar-style display.", "items": { "$ref": "#/definitions/ForecastInterval" }, "readOnly": true } } }, "MinuteForecastSummary": { "type": "object", "description": "Provides phrase summaries describing the precipitation outlook for the\nupcoming minute-by-minute forecast period. Multiple phrase lengths are\nincluded - short (~25 characters), brief (~60 characters), and long\n(60+ characters) - so applications can display the level of detail that\nbest fits the available UI space. An `iconCode` indicates the\nrepresentative weather icon for the period.", "properties": { "briefPhrase60": { "type": "string", "description": "A brief phrase describing the precipitation outlook for the next 60\nminutes only (a shorter window than the other phrases on this object).\nUp to approximately 60 characters." }, "shortPhrase": { "type": "string", "description": "A short phrase describing the precipitation outlook for the full ~120\nminute forecast window. Up to approximately 25 characters." }, "briefPhrase": { "type": "string", "description": "A brief phrase describing the precipitation outlook for the full ~120\nminute forecast window. Up to approximately 60 characters." }, "longPhrase": { "type": "string", "description": "A long phrase describing the precipitation outlook for the full ~120\nminute forecast window. Supports more than 60 characters." }, "iconCode": { "$ref": "#/definitions/IconCode", "description": "A representative weather icon code for the full ~120 minute forecast\nwindow. The numeric value corresponds to an Azure Maps weather icon -\nfor the complete list, see [Weather services in Azure\nMaps](/azure/azure-maps/weather-services-concepts#weather-icons)." } } }, "PastHoursTemperature": { "type": "object", "description": "The highest and lowest air temperatures observed during one of the rolling\nwindows on `TemperatureSummary` (past 6, 12, or 24 hours), in degrees\nCelsius (°C) or Fahrenheit (°F) depending on the unit specified in the\nrequest.", "properties": { "minimum": { "$ref": "#/definitions/WeatherValue", "description": "The lowest temperature observed during the window." }, "maximum": { "$ref": "#/definitions/WeatherValue", "description": "The highest temperature observed during the window." } } }, "Pollutant": { "type": "object", "description": "A single pollutant measured at the queried location, returned as one entry\nin `AirQuality.pollutants`. Each entry identifies the pollutant (by code\nand English name), reports its measured `concentration` in the air, and\ngives the pollutant's individual contribution to the local AQI (`index`)\nand the internationally normalized index (`globalIndex`) - the same two\nscales reported at the overall reading on `AirQuality`, but restricted\nto this pollutant. A typical air-quality reading carries one entry per\npollutant - *Nitrogen Dioxide*, *Ozone*, *Particulate Matter 10*,\n*Particulate Matter 2.5*, *Carbon Monoxide*, and *Sulfur Dioxide* - so\ncallers can see which substances are present and how much each\ncontributes.", "properties": { "type": { "$ref": "#/definitions/PollutantType", "description": "The pollutant code, used as a stable, language-independent identifier -\none of the `PollutantType` values (**PM2.5**, **PM10**, **O3**, **NO2**,\n**SO2**, or **CO**). Additional pollutant types may be added in the\nfuture." }, "name": { "type": "string", "description": "The pollutant's English name that pairs with `type` - for example,\n*Nitrogen Dioxide* for **NO2**, *Ozone* for **O3**, *Particulate Matter\n10* for **PM10**, *Particulate Matter 2.5* for **PM2.5**, *Carbon\nMonoxide* for **CO**, or *Sulfur Dioxide* for **SO2**. Always returned\nin English regardless of the requested language, which makes it\nsuitable as a stable display label when localized text is not\nrequired." }, "index": { "type": "number", "format": "float", "description": "This pollutant's contribution to the overall air-quality index (AQI)\non the scale set by the local regulating body for the queried\nlocation. Uses the same local scale as `AirQuality.index`, so the\nraw number is comparable to the overall reading at the same location\nbut not directly comparable across locations - for example, *21.6*\nfor *Ozone* on a reading with overall `index` *21.6* (Ozone is the\ndominant pollutant). For background, see [Air quality\nindex](https://en.wikipedia.org/wiki/Air_quality_index) on Wikipedia." }, "globalIndex": { "type": "number", "format": "float", "description": "This pollutant's contribution to the internationally normalized\nair-quality index, on the same 0-to-300+ scale as\n`AirQuality.globalIndex` so that per-pollutant values can be\ncompared across locations. Higher values denote a larger\ncontribution to poor air quality. For example, *22.1* for *Ozone*\nor *6.7* for *Nitrogen Dioxide*." }, "concentration": { "$ref": "#/definitions/WeatherValue", "description": "The pollutant's measured concentration in the air, in micrograms per\ncubic meter (µg/m³) for *NO2*, *O3*, *PM10*, *PM2.5*, *CO*, and\n*SO2* - for example, *53.5 µg/m³* for *Ozone* or *13.4 µg/m³* for\n*Nitrogen Dioxide* - or in parts per million (ppm) when reported in\nthat unit. Concentration is the raw measurement that feeds into\n`index` and `globalIndex`." } } }, "PollutantType": { "type": "string", "description": "A description for the six types of pollutants tracked by the Azure Maps Weather service.", "enum": [ "CO", "NO2", "O3", "PM2.5", "PM10", "SO2" ], "x-ms-enum": { "name": "PollutantType", "modelAsString": true, "values": [ { "name": "CO", "value": "CO", "description": "The average concentration of carbon monoxide (CO) in micrograms per cubic\nmeter (µg/m³) over the past hour.\n\nCO is a colorless, odorless, and tasteless but highly toxic gas produced by\nthe incomplete combustion of carbon-containing fuels. Common sources\ninclude vehicle exhaust, gas stoves, furnaces, and wood fires." }, { "name": "NO2", "value": "NO2", "description": "The average concentration of nitrogen dioxide (NO2) in micrograms per cubic\nmeter (µg/m³) over the past hour.\n\nNO2 is a significant atmospheric pollutant. It is regulated and subject to\nrecommended limit guidelines set by the World Health Organization (WHO)." }, { "name": "O3", "value": "O3", "description": "The average concentration of Ozone (O3) in micrograms per cubic meter\n(µg/m³) over the past hour.\n\nO3 is a key component of photochemical smog, the brown, harmful haze that\nenvelops many large cities, resulting from a photochemical reaction between\nsunlight and specific pollutants." }, { "name": "PM2_5", "value": "PM2.5", "description": "The average concentration of particles smaller than 2.5 microns in\ndiameter, measured in micrograms per cubic meter (µg/m³), over the past\nhour.\n\nPM2.5, also known as aerosols, consists of fine dust and tiny liquid\ndroplets suspended in the air." }, { "name": "PM10", "value": "PM10", "description": "The average concentration of particles with diameters between 2.5 and 10\nmicrons, measured in micrograms per cubic meter (µg/m³) over the past hour.\n\nParticulate matter 10 (PM10), also known as aerosols, consists of fine dust\nand tiny liquid droplets suspended in the air." }, { "name": "SO2", "value": "SO2", "description": "The average concentration of Sulfur dioxide (SO2) in micrograms per cubic\nmeter (µg/m³) over the past hour.\n\nSO2 is a dense, colorless inorganic gas with a pungent, irritating odor. It\nis primarily produced by the combustion of fossil fuels at power plants and\nindustrial facilities, but it can also be emitted from natural sources such\nas volcanoes." } ] } }, "PrecipitationSummary": { "type": "object", "description": "The total liquid-equivalent precipitation that has fallen at the\nobservation location over rolling windows ending at the observation time.\nEach value covers the full window measured back from \"now\" - for example,\n`past3Hours` is the running total for the most recent three hours, not\njust the third hour - so the windows overlap and longer windows include\nthe precipitation reported for the shorter ones. Snow and ice contribute\ntheir melted (liquid) equivalent. Reported in millimeters (mm) or inches\n(in) depending on the unit specified in the request.", "properties": { "pastHour": { "$ref": "#/definitions/WeatherValue", "description": "Liquid-equivalent precipitation that has fallen in the past hour." }, "past3Hours": { "$ref": "#/definitions/WeatherValue", "description": "Liquid-equivalent precipitation that has fallen in the past 3 hours." }, "past6Hours": { "$ref": "#/definitions/WeatherValue", "description": "Liquid-equivalent precipitation that has fallen in the past 6 hours." }, "past9Hours": { "$ref": "#/definitions/WeatherValue", "description": "Liquid-equivalent precipitation that has fallen in the past 9 hours." }, "past12Hours": { "$ref": "#/definitions/WeatherValue", "description": "Liquid-equivalent precipitation that has fallen in the past 12 hours." }, "past18Hours": { "$ref": "#/definitions/WeatherValue", "description": "Liquid-equivalent precipitation that has fallen in the past 18 hours." }, "past24Hours": { "$ref": "#/definitions/WeatherValue", "description": "Liquid-equivalent precipitation that has fallen in the past 24 hours." } } }, "PrecipitationType": { "type": "string", "description": "Specifies the type of precipitation. Valid values are *Rain*, *Snow*, *Ice*, or\n*Mix*. This property is included in the response when dBZ is greater than zero.", "enum": [ "Ice", "Mix", "Rain", "Snow" ], "x-ms-enum": { "name": "PrecipitationType", "modelAsString": true, "values": [ { "name": "Ice", "value": "Ice", "description": "Ice" }, { "name": "Mix", "value": "Mix", "description": "Mix" }, { "name": "Rain", "value": "Rain", "description": "Rain" }, { "name": "Snow", "value": "Snow", "description": "Snow" } ] } }, "PressureTendency": { "type": "object", "description": "The recent trend in atmospheric pressure - whether the pressure is\nrising, falling, or steady - returned as both a localized phrase and a\none-letter code. Useful for anticipating short-term weather changes;\nfalling pressure often signals deteriorating weather, while rising\npressure typically indicates improving conditions.", "properties": { "localizedDescription": { "type": "string", "description": "A short phrase describing the pressure tendency - for example, *Falling*,\n*Steady*, or *Rising* - returned in the language specified in the\nrequest." }, "code": { "type": "string", "description": "A language-independent one-letter code for the pressure tendency:\n**F** = Falling, **S** = Steady, **R** = Rising." } } }, "QuarterDayForecast": { "type": "object", "description": "The forecast for one 6-hour quarter-day period - morning (7am-1pm),\nafternoon (1pm-7pm), evening (7pm-1am), or overnight (1am-7am) - at the\nspecified location. Includes the quarter's date and identifier, an icon\nand descriptive phrase, the high/low temperature range and RealFeel,\nhumidity and dew point, wind and gust details, visibility, cloud cover,\nand precipitation and thunderstorm outlook (probability, type, intensity,\nand accumulation totals).", "properties": { "date": { "type": "string", "format": "date-time", "description": "The calendar date this quarter-day belongs to, in [RFC\n3339](https://datatracker.ietf.org/doc/html/rfc3339) format\n(`yyyy-mm-ddThh:mm:ss±hh:mm`) at the start of the day. For example,\n*2019-11-14T00:00:00-08:00*. Use `effectiveDate` for the actual start\ntime of this quarter." }, "effectiveDate": { "type": "string", "format": "date-time", "description": "The start of this quarter-day period, in [RFC\n3339](https://datatracker.ietf.org/doc/html/rfc3339) format\n(`yyyy-mm-ddThh:mm:ss±hh:mm`). For example, *2019-11-14T07:00:00-08:00*\nfor the morning quarter on November 14, 2019." }, "quarter": { "$ref": "#/definitions/DayQuarter", "description": "Identifies which 6-hour quarter of the day this forecast covers:\n\n- 0: Morning (7am - 1pm)\n- 1: Afternoon (1pm - 7pm)\n- 2: Evening (7pm - 1am)\n- 3: Overnight (1am - 7am)" }, "iconCode": { "$ref": "#/definitions/IconCode", "description": "The representative weather icon code for this quarter-day period. The\nnumeric value corresponds to an Azure Maps weather icon - for the\ncomplete list, see [Weather services in Azure\nMaps](/azure/azure-maps/weather-services-concepts#weather-icons)." }, "iconPhrase": { "type": "string", "description": "A short descriptive term that pairs with `iconCode` to label this\nquarter-day's weather - for example, *Sunny* or *Partly Cloudy*. For\nmore information, see [Weather services in Azure\nMaps](/azure/azure-maps/weather-services-concepts#weather-icons)." }, "phrase": { "type": "string", "description": "A brief textual description of the weather conditions for this\nquarter-day. More descriptive than `iconPhrase` - where `iconPhrase`\nmight return *Thunderstorms*, `phrase` may return *Cloudy with a couple\nof showers and a thunderstorm*." }, "temperature": { "$ref": "#/definitions/WeatherValueRange", "description": "The expected high and low temperatures during this quarter-day period,\nin degrees Celsius (°C) or Fahrenheit (°F), depending on the unit\nspecified in the request." }, "realFeelTemperature": { "$ref": "#/definitions/WeatherValueRange", "description": "The high and low RealFeel™ Temperature values for this quarter-day, in\ndegrees Celsius (°C) or Fahrenheit (°F), depending on the unit specified\nin the request. Developed by AccuWeather, RealFeel combines air\ntemperature with humidity, wind, cloud cover, sun intensity, and other\nfactors to indicate how the weather actually feels. For more\ninformation, see [What is the AccuWeather RealFeel\nTemperature?](https://www.accuweather.com/en/weather-news/what-is-the-accuweather-realfeel-temperature/156655)" }, "dewPoint": { "$ref": "#/definitions/WeatherValue", "description": "The dew point during this quarter-day - the temperature to which air\nmust cool to become saturated (100% relative humidity). Measured in\ndegrees Celsius (°C) or Fahrenheit (°F), depending on the unit specified\nin the request. A higher dew point indicates more moisture in the air." }, "relativeHumidity": { "type": "integer", "format": "int32", "description": "The relative humidity during this quarter-day, expressed as a\npercentage from 0 to 100 of the maximum amount of water vapor the air\ncan hold at the same temperature." }, "wind": { "$ref": "#/definitions/WindDetails", "description": "The expected wind speed and direction during this quarter-day. Speed\nis in kilometers per hour (km/h) or miles per hour (mph) depending on\nthe unit specified in the request; direction is in azimuth degrees,\nmeasured clockwise from true North (0° = N, 90° = E, 180° = S, 270° =\nW)." }, "windGust": { "$ref": "#/definitions/WindDetails", "description": "The expected maximum wind-gust speed and direction during this\nquarter-day, using the same units and azimuth convention as `wind`.\nWind gusts are brief spikes in wind speed that can affect activities\nsuch as aviation, sailing, and outdoor events." }, "visibility": { "$ref": "#/definitions/WeatherValue", "description": "The distance at which an object or light can be clearly discerned\nduring this quarter-day, in kilometers (km) or miles (mi) depending on\nthe unit specified in the request." }, "cloudCover": { "type": "integer", "format": "int32", "description": "The percentage of the sky covered by clouds during this quarter-day,\nfrom 0 (clear) to 100 (overcast). May be NULL." }, "hasPrecipitation": { "type": "boolean", "description": "`true` if precipitation (rain, snow, sleet, or hail) is expected during\nthis quarter-day; otherwise `false`." }, "precipitationType": { "$ref": "#/definitions/PrecipitationType", "description": "The type of precipitation expected during this quarter-day - one of\n*Rain*, *Snow*, *Ice*, or *Mix*. Returned only when `hasPrecipitation`\nis `true`." }, "precipitationIntensity": { "type": "string", "description": "The intensity of the expected precipitation - typically *Light*,\n*Moderate*, or *Heavy*. Returned only when `hasPrecipitation` is\n`true`." }, "precipitationProbability": { "type": "integer", "format": "int32", "description": "The probability of precipitation during this quarter-day, from 0 (no\nchance) to 100 (certain)." }, "thunderstormProbability": { "type": "integer", "format": "int32", "description": "The probability of a thunderstorm during this quarter-day, from 0 (no\nchance) to 100 (certain)." }, "totalLiquid": { "$ref": "#/definitions/WeatherValue", "description": "The total amount of liquid precipitation (such as rain, plus the liquid\nequivalent of snow or ice) expected during this quarter-day, in\nmillimeters (mm) or inches (in) depending on the unit specified in the\nrequest." }, "rain": { "$ref": "#/definitions/WeatherValue", "description": "The amount of rainfall expected during this quarter-day, in millimeters\n(mm) or inches (in) depending on the unit specified in the request." }, "snow": { "$ref": "#/definitions/WeatherValue", "description": "The amount of snow accumulation expected during this quarter-day, in\nmillimeters (mm) or inches (in) depending on the unit specified in the\nrequest." }, "ice": { "$ref": "#/definitions/WeatherValue", "description": "The estimated ice accumulation expected during this quarter-day, in\nmillimeters (mm) or inches (in) depending on the unit specified in the\nrequest." } } }, "QuarterDayForecastResult": { "type": "object", "description": "The response returned by the Get Quarter-Day Forecast operation, providing\nweather forecasts in 6-hour quarter-day blocks (morning, afternoon,\nevening, and overnight) for a specified location. The number of\n`QuarterDayForecast` entries returned matches the requested `duration` -\nfor example, a 1-day forecast returns 4 quarters and a 5-day forecast\nreturns 20.", "properties": { "forecasts": { "type": "array", "description": "The forecasted quarter-day periods, in chronological order. Each entry is\na `QuarterDayForecast` covering one of the four 6-hour blocks (morning,\nafternoon, evening, or overnight) and reports the temperature range,\nwind, precipitation outlook, cloud cover, and other conditions for that\nblock.", "items": { "$ref": "#/definitions/QuarterDayForecast" }, "readOnly": true } } }, "RadiusSector": { "type": "object", "description": "One quadrant of a tropical storm's wind radii, returned as one entry in\n`StormWindRadiiSummary.radiusSectorData`. Each sector is bracketed in\ndirection by `beginBearing` and `endBearing` (azimuth degrees clockwise\nfrom true North) and in distance by `range` (nautical miles), recording\nhow far winds at or above the parent summary's `windSpeed` threshold\nextend in that quadrant. The four sectors on a `StormWindRadiiSummary`\ntypically span **0°-90°** (NE), **90°-180°** (SE), **180°-270°** (SW),\nand **270°-360°** (NW).", "properties": { "beginBearing": { "type": "number", "format": "double", "description": "The starting angle of the sector, in azimuth degrees clockwise from\ntrue North (0° = N, 90° = E, 180° = S, 270° = W). For example, **0**\nfor the NE quadrant." }, "endBearing": { "type": "number", "format": "double", "description": "The ending angle of the sector, using the same azimuth convention as\n`beginBearing`. For example, **90** for the NE quadrant. Together with\n`beginBearing`, this defines the sector's angular span." }, "range": { "type": "number", "format": "double", "description": "The maximum distance from the storm's center, in nautical miles (NM),\nat which winds at or above the parent\n`StormWindRadiiSummary.windSpeed` threshold are expected within this\nsector." } } }, "SevereWeatherAlert": { "type": "object", "description": "One severe weather alert active at the specified location, returned as\nan entry in `SevereWeatherAlertsResult.results`. Combines metadata about\nthe alert itself (country, identifier, category, severity classification,\npriority, issuing source, and any disclaimer) with a `description`\ncarrying short localized and English summary phrases and an `alertAreas`\narray describing the specific geographic areas the alert covers, the\ntimes during which it is in effect, and the full alert detail. The\nunderlying alerts are issued by official government meteorological\nagencies and leading global weather alert providers, and cover phenomena\nsuch as hurricanes, thunderstorms, flooding, lightning, heat waves, and\nforest fires.", "properties": { "countryCode": { "type": "string", "description": "The 2-character [ISO 3166-1 Alpha-2 country\ncode](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)\nfor the country or region the alert was issued in - for example,\n`US` or `CA`." }, "alertId": { "type": "integer", "format": "int32", "description": "A numeric identifier for the alert, unique within the issuing\nprovider." }, "description": { "$ref": "#/definitions/SevereWeatherAlertDescription", "description": "Short summary phrases for the alert (for example, *Heat Warning* or\n*Tornado Watch*), returned both in the language specified in the\nrequest (`localized`) and in English (`english`)." }, "category": { "type": "string", "description": "A short, language-independent label classifying the alert by the\nweather phenomenon it concerns - for example, `NON-PRECIPITATION`,\n`PRECIPITATION`, `THUNDERSTORM`, `TROPICAL`, or `FIRE`. The exact\nset of values depends on the issuing provider." }, "priority": { "type": "integer", "format": "int32", "description": "The importance of the alert within its originating country or\nregion, where **1** is the highest priority and larger numbers are\nlower priority. The exact scale is provider-specific and may change\nover time as alert systems evolve." }, "class": { "type": "string", "description": "A provider-specific classification of the alert (for example, a\nwarning class or alert kind), when one is supplied by the issuing\nagency. Not available in all countries and may be omitted." }, "level": { "type": "string", "description": "The severity level of the alert, when one is supplied by the\nissuing agency. The exact set of values is provider-specific. Not\navailable in all countries and may be omitted." }, "source": { "type": "string", "description": "The name of the agency that issued the alert - for example,\n*Environment Canada* or *U.S. National Weather Service*. Alerts are\ntypically issued by official government meteorological agencies or\nleading global weather alert providers." }, "sourceId": { "type": "integer", "format": "int32", "description": "A numeric identifier for the source provider that pairs with\n`source`. Suitable for stable, language-independent lookup of the\nprovider." }, "disclaimer": { "type": "string", "description": "A disclaimer about the alert information from the source - for\nexample, a note about possible delays or data limitations. If\npresent, it must be displayed alongside the alert. Not always\nreturned." }, "alertAreas": { "type": "array", "description": "The geographic areas covered by the alert. Each `AlertArea`\nidentifies one affected area by name, gives the alert's start and\nend times for that area, the most recent alert status, and (when\nthe request asks for full details) the complete alert detail text.\nAn alert may cover one or several areas - for example, a heat\nwarning may apply to multiple adjacent regions on the same advisory.", "items": { "$ref": "#/definitions/AlertArea" } } } }, "SevereWeatherAlertDescription": { "type": "object", "description": "Short summary phrases for a severe weather alert, returned on\n`SevereWeatherAlert.description`. The same phrase is provided twice: once\ntranslated into the language specified on the request (`localized`) and\nonce in English (`english`), so callers can display a localized label to\nend users while still keeping a stable, language-independent string for\nlogging, matching, or fallback display.", "properties": { "localized": { "type": "string", "description": "The summary phrase translated into the language specified on the request\n(for example, *Avis de chaleur* for French). If no language was specified\non the request, this matches `english`." }, "english": { "type": "string", "description": "The summary phrase in English (en-US) - for example, *Heat Warning* or\n*Tornado Watch*. Always returned in English regardless of the requested\nlanguage, which makes it suitable as a stable, language-independent\nlabel." } } }, "SevereWeatherAlertsResult": { "type": "object", "description": "The response returned by the Get Severe Weather Alerts operation,\ncontaining every severe weather alert active at the specified location.\nAlerts cover phenomena such as hurricanes, thunderstorms, flooding,\nlightning, heat waves, and forest fires - whatever local meteorological\nauthorities have issued. The `results` array is empty when no alerts are\nin effect.", "properties": { "results": { "type": "array", "description": "The severe weather alerts active at the specified location, ordered by\n`priority` (highest priority first). Empty when no alerts are in\neffect.", "items": { "$ref": "#/definitions/SevereWeatherAlert" }, "readOnly": true } } }, "StormForecast": { "type": "object", "description": "A single forecast point along a tropical storm's predicted track,\nreturned as one entry in `StormForecastResult.results`. Each entry\nreports the storm's forecasted position, sustained wind and wind-gust\nspeeds, the storm's classification at the forecast time (for example,\n*Tropical Storm*), and the forecast window for that valid time. When\nthe request asks for wind-radii detail, the entry also carries a\n`windRadiiSummary` array describing the wind distribution around the\nstorm's center.", "properties": { "dateTime": { "type": "string", "description": "The valid time of this forecast point - the future moment the\nforecasted position and conditions apply to - in [ISO\n8601](https://www.iso.org/iso-8601-date-and-time-format.html) format\n(yyyy-mm-ddThh:mm:ss-hh:mm). For example,\n*2021-04-25T06:00:00+00:00*." }, "initializedDateTime": { "type": "string", "description": "The time at which the forecast was issued, in [ISO\n8601](https://www.iso.org/iso-8601-date-and-time-format.html) format\n(yyyy-mm-ddThh:mm:ss-hh:mm). For example,\n*2021-04-24T18:00:00+00:00*. Typically earlier than `dateTime`,\nsince a single forecast run predicts conditions at several future\nvalid times." }, "location": { "$ref": "#/definitions/LatLongPair", "description": "The storm's forecasted position at this point on the track, given as\nlatitude and longitude - for example, latitude *22*, longitude\n*137.8*." }, "maxWindGust": { "$ref": "#/definitions/WeatherValue", "description": "The expected maximum short-burst wind-gust speed and direction at this\nforecast point, measured in kilometers per hour (km/h) or miles per\nhour (mph) depending on the unit specified in the request - for\nexample, *92.6 km/h*. Wind direction is in azimuth degrees, measured\nclockwise from true North (0° = N, 90° = E, 180° = S, 270° = W). May\nbe NULL." }, "sustainedWind": { "$ref": "#/definitions/WeatherValue", "description": "The maximum sustained wind speed expected at this forecast point,\nmeasured in kilometers per hour (km/h) or miles per hour (mph)\ndepending on the unit specified in the request - for example,\n*74.1 km/h*." }, "status": { "type": "string", "description": "The storm's classification at this forecast point, in English - for\nexample, *Tropical Storm*. Possible values:\n\n- Cyclonic storm\n- Deep depression\n- Depression\n- Extremely severe cyclonic storm\n- Hurricane category (1-5)\n- Intense tropical cyclone\n- Moderate tropical storm\n- Post-tropical cyclone\n- Potential tropical cyclone\n- Severe cyclonic storm\n- Severe tropical storm\n- Subtropical\n- Super cyclonic storm\n- Tropical cyclone\n- Tropical cyclone category (1-5)\n- Tropical depression\n- Tropical disturbance\n- Tropical storm\n- Typhoon\n- Very intense tropical cyclone\n- Very severe cyclonic storm\n- Very strong typhoon\n- Violent typhoon" }, "window": { "$ref": "#/definitions/WeatherWindow", "description": "The forecast window covering this point on the track - the time range\nthe forecast applies to, the storm's classification at the start and\nend of that range, and the left and right edges of the storm's\nprojected path. When the request asks for the window geometry,\n`WeatherWindow.geometry` carries a GeoJSON representation of the\naffected area." }, "windRadiiSummary": { "type": "array", "description": "Wind radii summaries describing the wind distribution around the\nstorm's center at this forecast point - one entry per wind-speed\nthreshold (such as the 34-, 50-, and 64-knot radii), each enumerating\nhow far winds at or above that speed extend in the NE, SE, SW, and NW\nquadrants. Returned only when the request asks for wind-radii detail.", "items": { "$ref": "#/definitions/StormWindRadiiSummary" } } } }, "StormForecastResult": { "type": "object", "description": "The response returned by the Get Tropical Storm Forecast operation,\ngiving the official government-issued forecast track for a single\ntropical storm identified by `basinId`, `govId`, and `year`. Each entry\nin the `results` array is a `StormForecast` reporting the storm's\nforecasted position, status, sustained wind and wind-gust speeds, and\nforecast window for one point in time along the predicted track. When\nthe result set is too large to fit in a single response, `nextLink`\ncarries the URL for the next page.", "properties": { "results": { "type": "array", "description": "The forecast points along the storm's predicted track, in chronological\norder. Each `StormForecast` reports the storm's position, classification\n(for example, *Tropical Storm*), sustained wind and wind-gust speeds,\nand the forecast window for one valid time - for example, a Northwest\nPacific (*NP*) storm forecast at *2021-04-25T06:00:00+00:00* at\n(latitude *22*, longitude *137.8*) with a sustained wind of\n*74.1 km/h* and a wind gust of *92.6 km/h*.", "items": { "$ref": "#/definitions/StormForecast" } }, "nextLink": { "type": "string", "description": "The URL to retrieve the next page of results when the response is\npaginated, suitable for navigating through result sets too large to\nreturn in a single call. Empty when there are no further pages." } } }, "StormLocation": { "type": "object", "description": "A single observed location fix along a tropical storm's track, returned as\none entry in `StormLocationsResult.results`. Each entry captures where the\nstorm's center was at a specific point in time and the conditions observed\nthere - position (latitude/longitude), sustained wind and peak wind gust,\nminimum central pressure, the storm's direction and forward speed of motion,\nand its lifecycle classification (for example, *Tropical Depression* or\n*Tropical Storm*). Together, the sequence of entries forms the storm's\nobserved track and is used to follow how its position, intensity, and\nstructure evolved.", "properties": { "dateTime": { "type": "string", "description": "The date and time of the observation, in [ISO\n8601](https://www.iso.org/iso-8601-date-and-time-format.html) format\n(yyyy-mm-ddThh:mm:ss+hh:mm). For example, *2021-02-22T00:00:00+00:00*.\nSuccessive entries in `StormLocationsResult.results` typically step\nbackward in time at a fixed cadence (for example, every 6 hours)." }, "location": { "$ref": "#/definitions/LatLongPair", "description": "Latitude and longitude coordinates of the storm's center at this\nobservation time. For example, latitude *10.4* and longitude *125.7*." }, "maxWindGust": { "$ref": "#/definitions/WeatherValue", "description": "The peak wind gust observed near the storm's center at this time, in\nkilometers per hour (km/h) or miles per hour (mph) depending on the unit\nspecified in the request - for example, *64.8 km/h*. Wind gusts are short,\nsudden bursts of wind that exceed the sustained wind reported in\n`sustainedWind`. May be NULL when no gust observation is available." }, "sustainedWind": { "$ref": "#/definitions/WeatherValue", "description": "The maximum 1-minute sustained wind associated with the storm at this\nobservation time, in kilometers per hour (km/h) or miles per hour (mph)\ndepending on the unit specified in the request - for example, *46.3 km/h*\nfor a tropical depression up to *83.3 km/h* once the system has reached\ntropical-storm strength. Sustained wind, together with `status`, is the\nprimary measure of the storm's current intensity." }, "minimumPressure": { "$ref": "#/definitions/WeatherValue", "description": "The lowest atmospheric pressure measured at the storm's center at this\ntime, in millibars (mb) or inches of mercury (inHg) depending on the unit\nspecified in the request. Lower central pressure generally indicates a\nstronger storm. May be NULL when no pressure observation is available." }, "movement": { "$ref": "#/definitions/WindDetails", "description": "The direction the storm is moving and how fast it is moving in that\ndirection at this observation time. The direction is given in azimuth\ndegrees, measured clockwise from true North (0° = N, 90° = E, 180° = S,\n270° = W) - for example, **305°** with a localized description of *NW*, or\n**270°** with a localized description of *W*. The forward speed is in\nkilometers per hour (km/h) or miles per hour (mph) depending on the unit\nspecified in the request - for example, *9.3 km/h*." }, "status": { "type": "string", "description": "The storm's lifecycle classification at this observation time, in English.\nTypical values include *Tropical Depression* (sustained winds below tropical-storm strength), *Tropical Storm*, and *Hurricane* / *Typhoon*\n(depending on basin), and may also reflect subtropical or post-tropical\nstages indicated by `isSubtropical` and `isPostTropical`." }, "isSubtropical": { "type": "boolean", "description": "`true` if at this observation time the storm is classified as a\nsubtropical cyclone - a hybrid system with characteristics of both\ntropical and extratropical cyclones. `false` otherwise." }, "hasTropicalPotential": { "type": "boolean", "description": "`true` if at this observation time the system has the potential to develop\ninto a tropical cyclone, used to flag pre-genesis disturbances. `false`\notherwise." }, "isPostTropical": { "type": "boolean", "description": "`true` if at this observation time the storm has transitioned from a\ntropical cyclone to a post-tropical cyclone (for example, an\nextratropical or remnant low). `false` otherwise." }, "windRadiiSummary": { "type": "array", "description": "The wind-radii summary observed around the storm's center at this time,\nwith one entry per wind-speed threshold (typically **34**, **50**, and\n**64** knots). Each entry describes how far winds at or above that\nthreshold extended from the center in each compass quadrant (NE, SE, SW,\nNW). Returned only when the request asks for wind radii detail.", "items": { "$ref": "#/definitions/StormWindRadiiSummary" } } } }, "StormLocationsResult": { "type": "object", "description": "The response returned by the Get Tropical Storm Locations operation,\ngiving the observed track of a single tropical storm identified by\n`basinId`, `govId`, and `year`. Each entry in the `results` array is a\n`StormLocation` reporting the storm's position, classification, sustained\nwind and wind-gust speeds, minimum pressure, movement, and lifecycle\nflags at one observed point in time. When the result set is too large\nto fit in a single response, `nextLink` carries the URL for the next\npage.", "properties": { "results": { "type": "array", "description": "The observed points along the storm's track, in reverse chronological\norder (most recent observation first). Each `StormLocation` reports the\nstorm's position, classification (for example, *Tropical Depression*\nor *Tropical Storm*), sustained wind and wind-gust speeds, minimum\npressure, and movement at one observation time - for example, a\nNorthwest Pacific (*NP*) storm observed at *2021-02-22T00:00:00+00:00*\nat (latitude *10.4*, longitude *125.7*) with a sustained wind of\n*46.3 km/h* and a wind gust of *64.8 km/h*.", "items": { "$ref": "#/definitions/StormLocation" } }, "nextLink": { "type": "string", "description": "The URL to retrieve the next page of results when the response is\npaginated, suitable for navigating through result sets too large to\nreturn in a single call. Empty when there are no further pages." } } }, "StormSearchResult": { "type": "object", "description": "The response returned by the Get Tropical Storm Search operation, listing\nthe tropical storms that match the supplied search criteria (typically a\nbasin and year). Each entry in the `results` array is a\n`StormSearchResultItem` carrying the storm's name, originating ocean\nbasin, government-issued identifier, year of origin, and active,\nretired, and subtropical status. When the result set is too large to\nfit in a single response, `nextLink` carries the URL for the next page.", "properties": { "results": { "type": "array", "description": "The tropical storms matching the search criteria, with one entry per\nstorm. Each `StormSearchResultItem` reports the storm's name (for\nexample, *Ana*, *Ida*, or *Henri* in the *AL* basin for *2021*), the\noriginating ocean basin, the government-issued identifier and year of\norigin, and whether the storm is still active, has been retired, and\nwhether it is classified as subtropical.", "items": { "$ref": "#/definitions/StormSearchResultItem" } }, "nextLink": { "type": "string", "description": "The URL to retrieve the next page of results when the response is\npaginated, suitable for navigating through result sets too large to\nreturn in a single call. Empty when there are no further pages." } } }, "StormSearchResultItem": { "type": "object", "description": "A single tropical storm matching a Get Tropical Storm Search request,\nreturned as one entry in `StormSearchResult.results`. Each entry\nsummarizes the storm with the identifiers needed to reference it\nelsewhere in the Get Tropical Storm APIs - the originating ocean basin\n(`basinId`), the government-issued identifier (`govId`), and the year of\norigin (`year`) - together with the storm's official name (for example,\n*Ana* or *Henri*) and flags indicating whether it is currently active,\nhas been retired, and whether it is classified as subtropical.", "properties": { "year": { "type": "string", "description": "The four-digit calendar year in which the tropical storm originated -\nfor example, *2021*. Combined with `basinId` and `govId`, this\nuniquely identifies the storm across years." }, "basinId": { "$ref": "#/definitions/BasinId", "description": "The ocean basin where the tropical storm originated. One of the\n`BasinId` values - **AL** (Atlantic), **CP** (Central Pacific),\n**EP** (Eastern Pacific), **NI** (North Indian), **NP** (Northwest\nPacific), **SI** (South Indian), or **SP** (South Pacific). For\nexample, *AL* for a storm originating in the Atlantic basin." }, "name": { "type": "string", "description": "The official name of the storm as designated by the relevant national\nweather forecasting agency - for example, *Ana*, *Henri*, or *Ida*.\nStorms that have not yet been formally named are typically identified\nby a placeholder such as *TD 9E* or a number-word like *TWELVE*." }, "isActive": { "type": "boolean", "description": "`true` if the tropical storm is currently active and still being\ntracked by the issuing agency; `false` if it is no longer active." }, "isRetired": { "type": "boolean", "description": "`true` if the storm's name has been permanently retired in its source\nbasin and will not be reused for future storms; `false` otherwise.\nNames are typically retired only when a storm is so deadly or costly\nthat future use of the name would be inappropriate." }, "isSubtropical": { "type": "boolean", "description": "`true` if the storm is classified as a subtropical cyclone - a hybrid\nsystem with characteristics of both tropical and extratropical\ncyclones; `false` otherwise." }, "govId": { "type": "integer", "format": "int32", "description": "The government-issued identifier assigned to the storm by its national\nweather forecasting agency, unique within (`basinId`, `year`). Use\nthis together with `basinId` and `year` to reference the storm in the\nother Get Tropical Storm operations." } } }, "StormWindRadiiSummary": { "type": "object", "description": "A wind radii summary describing the wind distribution around a tropical\nstorm's center for a single wind-speed threshold (typically the 34-,\n50-, or 64-knot radii). Returned as one entry per threshold in\n`StormForecast.windRadiiSummary` (forecast track) or\n`StormLocation.windRadiiSummary` (observed track) when the request asks\nfor wind-radii detail. Combines the threshold itself (`windSpeed`) with\na `radiusSectorData` array carrying one sector per quadrant (NE, SE,\nSW, NW) that records how far winds at or above that speed extend from\nthe storm's center. When the request also asks for the radii geometry,\n`radiiGeometry` carries a GeoJSON representation of the affected area.", "properties": { "dateTime": { "type": "string", "description": "The valid time the wind-radii data applies to, in [ISO\n8601](https://www.iso.org/iso-8601-date-and-time-format.html) format\n(yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*." }, "windSpeed": { "$ref": "#/definitions/WeatherValue", "description": "The wind-speed threshold this entry describes (typically **34**, **50**,\nor **64** knots). All four sectors in `radiusSectorData` describe the\nextent of winds at or above this speed in their respective quadrants.\nReported in kilometers per hour (km/h) or miles per hour (mph)\ndepending on the unit specified in the request." }, "radiusSectorData": { "type": "array", "description": "One `RadiusSector` per compass quadrant - NE (0°-90°), SE (90°-180°),\nSW (180°-270°), and NW (270°-360°) - giving the maximum distance from\nthe storm's center at which winds at or above `windSpeed` are expected\nin that quadrant.", "items": { "$ref": "#/definitions/RadiusSector" } }, "radiiGeometry": { "$ref": "#/definitions/GeoJsonGeometry", "description": "A GeoJSON representation of the area around the storm's center where\nwinds at or above `windSpeed` are expected, suitable for rendering the\nwind radii on a map. Returned only when the request asks for the radii\ngeometry." } } }, "SunGlare": { "type": "object", "description": "The sun-glare driving hazard at a single waypoint, returned as\n`WaypointForecast.sunGlare`. Reports a `glareIndex` from **0** to\n**100** measuring the intensity of glare a driver would experience\nat the waypoint, together with the `calculatedVehicleHeading` used\nto compute it - the heading is either the value supplied for the\nwaypoint in the request or, if none was supplied, one inferred from\nthe neighboring waypoints.", "properties": { "calculatedVehicleHeading": { "type": "integer", "format": "int32", "description": "The vehicle heading used to compute `glareIndex`, in azimuth\ndegrees from **0°** (true North) to **359°**, measured clockwise -\neast is 90°, south is 180°, west is 270°. If a heading was\nsupplied for the waypoint in the request, that value is echoed\nback; otherwise the service calculates one from the headings of\nthe neighboring waypoints when available." }, "glareIndex": { "type": "integer", "format": "int32", "description": "An index from **0** to **100** indicating the intensity of sun\nglare for a driver at the waypoint, given\n`calculatedVehicleHeading` and the position of the sun. Values of\n**50** and above can be hazardous for some drivers; **100**\nindicates driving directly into the sun under clear conditions." } } }, "TemperatureSummary": { "type": "object", "description": "The highest and lowest air temperatures observed at the location over\nrolling windows ending at the observation time. Each value covers the\nfull window measured back from \"now\" - for example, `past12Hours` reports\nthe high and low across the most recent 12 hours, not just the twelfth\nhour - so the windows overlap and longer windows include the\ntemperatures reported for the shorter ones. Reported in degrees Celsius\n(°C) or Fahrenheit (°F) depending on the unit specified in the request.", "properties": { "past6Hours": { "$ref": "#/definitions/PastHoursTemperature", "description": "Highest and lowest temperatures observed in the past 6 hours." }, "past12Hours": { "$ref": "#/definitions/PastHoursTemperature", "description": "Highest and lowest temperatures observed in the past 12 hours." }, "past24Hours": { "$ref": "#/definitions/PastHoursTemperature", "description": "Highest and lowest temperatures observed in the past 24 hours." } } }, "UnitType": { "type": "number", "description": "An integer value associated with the type of unit being displayed.\nFor example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit\ntranslation. For more information, see [Weather services in\nAzure Maps](/azure/azure-maps/weather-services-concepts#unit-types).", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 31 ], "x-ms-enum": { "name": "UnitType", "modelAsString": true, "values": [ { "name": "Feet", "value": 0, "description": "feet" }, { "name": "Inches", "value": 1, "description": "inches" }, { "name": "Miles", "value": 2, "description": "miles" }, { "name": "Millimeter", "value": 3, "description": "millimeter" }, { "name": "Centimeter", "value": 4, "description": "centimeter" }, { "name": "Meter", "value": 5, "description": "meter" }, { "name": "Kilometer", "value": 6, "description": "kilometer" }, { "name": "KilometersPerHour", "value": 7, "description": "kilometersPerHour" }, { "name": "Knots", "value": 8, "description": "knots" }, { "name": "MilesPerHour", "value": 9, "description": "milesPerHour" }, { "name": "MetersPerSecond", "value": 10, "description": "metersPerSecond" }, { "name": "HectoPascals", "value": 11, "description": "hectoPascals" }, { "name": "InchesOfMercury", "value": 12, "description": "inchesOfMercury" }, { "name": "KiloPascals", "value": 13, "description": "kiloPascals" }, { "name": "Millibars", "value": 14, "description": "millibars" }, { "name": "MillimetersOfMercury", "value": 15, "description": "millimetersOfMercury" }, { "name": "PoundsPerSquareInch", "value": 16, "description": "poundsPerSquareInch" }, { "name": "Celsius", "value": 17, "description": "Celsius" }, { "name": "Fahrenheit", "value": 18, "description": "Fahrenheit" }, { "name": "Kelvin", "value": 19, "description": "kelvin" }, { "name": "Percent", "value": 20, "description": "percent" }, { "name": "Float", "value": 21, "description": "float" }, { "name": "Integer", "value": 22, "description": "integer" }, { "name": "MicrogramsPerCubicMeterOfAir", "value": 31, "description": "MicrogramsPerCubicMeterOfAir" } ] } }, "WaypointForecast": { "type": "object", "description": "The detailed forecast for one waypoint along a road route, returned as\none entry per requested waypoint in\n`WeatherAlongRouteResult.waypoints` (same order as the waypoints\nsupplied in the request). Reports the conditions at that location: a\nrepresentative `iconCode` and `shortPhrase`, whether it is day or\nnight, cloud cover, temperature, wind and wind-gust details,\nprecipitation type and intensity, a lightning-strike count, the sun\nglare hazard for the driver, the `WeatherHazards` aggregated at the\nwaypoint, and any free-form hazard `notifications`.", "properties": { "iconCode": { "$ref": "#/definitions/IconCode", "description": "The representative weather icon code for this waypoint. The numeric\nvalue corresponds to an Azure Maps weather icon - for the complete\nlist, see [Weather services in Azure\nMaps](/azure/azure-maps/weather-services-concepts#weather-icons)." }, "shortPhrase": { "type": "string", "description": "A brief, displayable phrase describing the forecasted weather\nconditions at this waypoint - for example, *Mostly cloudy* or\n*Light rain*. Returned in the language specified in the request." }, "isDayTime": { "type": "boolean", "description": "`true` if it is daytime at this waypoint at the forecast time;\n`false` if it is nighttime." }, "cloudCover": { "type": "integer", "format": "int32", "description": "The percentage of the sky covered by clouds at this waypoint, from\n**0** (clear skies) to **100** (completely overcast). May be NULL." }, "temperature": { "$ref": "#/definitions/WeatherValue", "description": "The forecasted air temperature at this waypoint, in degrees Celsius\n(°C) or Fahrenheit (°F), depending on the unit specified in the\nrequest." }, "wind": { "$ref": "#/definitions/WindDetails", "description": "The forecasted wind speed and direction at this waypoint. Speed is\nin kilometers per hour (km/h) or miles per hour (mph) depending on\nthe unit specified in the request; direction is in azimuth degrees,\nmeasured clockwise from true North (0° = N, 90° = E, 180° = S,\n270° = W)." }, "windGust": { "$ref": "#/definitions/WindDetails", "description": "The forecasted maximum short-burst wind-gust speed and direction at\nthis waypoint, using the same units and azimuth convention as\n`wind`. Wind gusts are brief spikes in wind speed that can affect\nactivities such as driving high-profile vehicles, aviation, and\nsailing." }, "precipitation": { "$ref": "#/definitions/WeatherAlongRoutePrecipitation", "description": "The expected precipitation at this waypoint - radar reflectivity\n(`dbz`) measuring intensity, plus the precipitation `type` (rain,\nsnow, ice, hail, or mix)." }, "lightningCount": { "type": "integer", "format": "int32", "description": "The number of lightning strikes expected near this waypoint during\nthe forecast period. **0** indicates no lightning activity; higher\nvalues indicate more strikes, which can be used as a proxy for\nthunderstorm intensity." }, "sunGlare": { "$ref": "#/definitions/SunGlare", "description": "The sun-glare driving hazard at this waypoint. Reports a glare\nindex from **0** to **100** along with the vehicle heading used to\ncompute it, where **50** and above can be hazardous and **100**\nindicates driving directly into the sun under clear conditions." }, "hazards": { "$ref": "#/definitions/WeatherHazards", "description": "The aggregated weather hazards at this waypoint - `maxHazardIndex`\ngives the worst hazard's severity on the 0-4 scale, and\n`hazardDetails` enumerates the specific hazards (heavy rain, snow,\nice, lightning, sun glare, severe weather warnings, and so on)\ndetected at the waypoint. Uses the same shape as\n`WeatherAlongRouteSummary.hazards`, but scoped to this single\nwaypoint instead of the entire route." }, "notifications": { "type": "array", "description": "Free-form hazard notifications relevant to this waypoint - each\n`WeatherNotification` carries a hazard code, severity, and short\ndescriptive phrase. Empty when no notifications apply.", "items": { "$ref": "#/definitions/WeatherNotification" } } } }, "WeatherAlongRoutePrecipitation": { "type": "object", "description": "The expected precipitation at a single waypoint along the route,\nreturned as `WaypointForecast.precipitation`. Reports the forecast\nintensity as radar reflectivity (`dbz`) together with the\nprecipitation `type` (rain, snow, ice, hail, or mix). A `dbz` of\n**0** indicates no precipitation, in which case `type` may still be\nreturned to indicate the precipitation type that *would* occur if\nany fell at the waypoint (for example, snow during cold weather).", "properties": { "dbz": { "type": "number", "format": "double", "description": "Forecasted radar reflectivity in decibels relative to Z (dBZ),\nused as a measure of precipitation intensity. Values range from\n**0.0** to **100.0**; higher values indicate heavier\nprecipitation, and **0.0** indicates no precipitation." }, "type": { "type": "string", "description": "The type of precipitation expected at the waypoint - one of\n`RAIN`, `HAIL`, `SNOW`, `ICE`, or `MIX`." } } }, "WeatherAlongRouteResult": { "type": "object", "description": "The response returned by the Get Weather Along Route operation,\nproviding the forecast for a sequence of waypoints along a road\nroute. Includes a top-level `summary` with the highest hazard index\nacross the route and a representative weather icon, plus a\n`waypoints` array containing one detailed forecast per requested\nwaypoint - cloud cover, temperature, wind, precipitation, lightning\ncount, sun glare, hazards, and notifications.", "properties": { "summary": { "$ref": "#/definitions/WeatherAlongRouteSummary", "description": "A high-level overview of conditions across the entire route - a\nrepresentative weather `iconCode` and the maximum hazard index\nencountered at any waypoint - useful for surfacing a single\nroute-level status.", "readOnly": true }, "waypoints": { "type": "array", "description": "The per-waypoint forecasts, returned in the same order as the\nwaypoints supplied in the request (one entry per waypoint). Each\n`WaypointForecast` reports cloud cover, weather hazards, lightning\ncount, hazard notifications, precipitation type and intensity, sun\nglare, temperature, and wind details for its location.", "items": { "$ref": "#/definitions/WaypointForecast" }, "readOnly": true } } }, "WeatherAlongRouteSummary": { "type": "object", "description": "The route-level summary on `WeatherAlongRouteResult.summary`,\ngiving a single high-level snapshot of conditions across the entire\nroute. Includes a representative weather `iconCode` for the route\nand an aggregated `hazards` block reporting the maximum hazard\nindex and the specific hazard types encountered at any waypoint.\nUse this when a single route-level indicator is needed; for\nper-waypoint detail, use `WeatherAlongRouteResult.waypoints`.", "properties": { "iconCode": { "$ref": "#/definitions/IconCode", "description": "The representative weather icon code for the route as a whole.\nThe numeric value corresponds to an Azure Maps weather icon - for\nthe complete list, see [Weather services in Azure\nMaps](/azure/azure-maps/weather-services-concepts#weather-icons)." }, "hazards": { "$ref": "#/definitions/WeatherHazards", "description": "The aggregated weather hazards across all waypoints on the route -\n`maxHazardIndex` reports the highest severity encountered at any\nwaypoint and `hazardDetails` enumerates the specific hazard types\n(heavy rain, snow, ice, lightning, severe weather warnings, and so\non) detected anywhere along the route." } } }, "WeatherDataUnit": { "type": "string", "description": "Specifies whether to return data in metric or imperial units, with metric as\nthe default. For example:\n\n- Metric: millimeter (mm), meter (m), kilometer (km), Celsius (C)\n- Imperial: inch (in), foot (ft), mile (mi), Fahrenheit (F)", "enum": [ "imperial", "metric" ], "x-ms-enum": { "name": "WeatherDataUnit", "modelAsString": true, "values": [ { "name": "imperial", "value": "imperial", "description": "Return data using imperial units such as Fahrenheit (F) for temperature and\nmiles (mi) for distance." }, { "name": "metric", "value": "metric", "description": "Return data using metric units such as Celsius (C) for temperature and\nkilometer (km) for distance." } ] } }, "WeatherHazards": { "type": "object", "description": "A summary of the significant weather hazards at a single location.\nThe same shape is used in two places by the Get Weather Along Route\nresponse: on `WeatherAlongRouteSummary.hazards`, where it aggregates\nacross the entire route (max severity at any waypoint), and on\n`WaypointForecast.hazards`, where it describes the hazards at one\nspecific waypoint. Conveys both a top-level `maxHazardIndex` rating\nthe worst hazard in scope (from **0** - no hazard - to **4** -\nlife-threatening) and a `hazardDetails` array enumerating each\nspecific hazard type encountered (rain, snow, ice, hail, sun glare,\nlightning, wind, and severe weather warnings such as floods,\ntornadoes, tsunamis, and severe thunderstorms).", "properties": { "maxHazardIndex": { "$ref": "#/definitions/HazardIndex", "description": "The highest hazard-severity rating in scope - the maximum across\nthe entire route when used on `WeatherAlongRouteSummary.hazards`,\nor the worst hazard at this specific waypoint when used on\n`WaypointForecast.hazards`. Useful for color-coding route segments\nor waypoint markers to indicate safety levels:\n\n- **0**: No hazard\n- **1**: Be informed, be aware\n- **2**: Pay attention, be prepared\n- **3**: Take action\n- **4**: Life-threatening, emergency" }, "hazardDetails": { "type": "array", "description": "The individual hazards contributing to `maxHazardIndex`. Each\n`HazardDetail` identifies a specific hazard type (rain, snow, ice,\nhail, sun glare, lightning, wind, or a severe weather warning such\nas a flood, tornado, tsunami, or severe thunderstorm) along with\nits severity and a short descriptive phrase. See the\n`HazardDetail.hazardCode` documentation for the complete list of\nsupported hazard codes.", "items": { "$ref": "#/definitions/HazardDetail" } } } }, "WeatherNotification": { "type": "object", "description": "One free-form hazard notification raised at a single waypoint along the\nroute, returned as an entry in `WaypointForecast.notifications`. Each\nnotification combines a `type` classifying the notification, a\n`hazardCode` identifying the specific hazard, a `hazardIndex` rating its\nseverity on the 0-4 scale, and a `shortPhrase` suitable for display.\nNotifications complement `WaypointForecast.hazards` - the latter\nenumerates every active hazard at the waypoint, while `notifications`\ncarries only the ones the service has flagged as worth surfacing to the\ndriver.", "properties": { "type": { "type": "string", "description": "A short label classifying the notification. Returned in the language\nspecified in the request." }, "hazardIndex": { "$ref": "#/definitions/HazardIndex", "description": "The severity rating for this notification, on the same 0-4 scale used\nacross the Get Weather Along Route response:\n\n- **0**: No hazard\n- **1**: Be informed, be aware\n- **2**: Pay attention, be prepared\n- **3**: Take action\n- **4**: Life-threatening, emergency" }, "hazardCode": { "type": "string", "description": "A language-independent code identifying the specific hazard the\nnotification refers to. Uses the same set of values as\n`HazardDetail.hazardCode`:\n\n- `LightRain`, `ModerateRain`, `HeavyRain`\n- `LightMix`, `ModerateMix`, `HeavyMix`\n- `LightSnow`, `ModerateSnow`, `HeavySnow`\n- `LightIce`, `ModerateIce`, `HeavyIce`\n- `Hail`, `LargeHail`\n- `SunGlare`, `SunGlareHigh`\n- `Lightning`, `SevereLightning`\n- `WindModerate`, `WindHigh`, `WindExtreme`\n- `FloodWarning`, `FlashFloodWarning`\n- `TornadoWarning`, `TsunamiWarning`\n- `SevereThunderstormWarning`" }, "shortPhrase": { "type": "string", "description": "A short, displayable phrase describing the notification, returned in\nthe language specified in the request." } } }, "WeatherValue": { "type": "object", "description": "Values for weather-related metrics such as temperature, dew point, and wind\nspeed, presented in either metric or imperial units, as specified in the unit\nURI parameter. For more information, see [Unit\ntypes](/azure/azure-maps/weather-services-concepts#unit-types) in the article\nWeather services in Azure Maps.", "properties": { "value": { "type": "number", "format": "float", "description": "The measured value expressed in the specified unit." }, "unit": { "type": "string", "description": "The unit of measurement used in the return value, such as \"C\" for Celsius,\n\"F\" for Fahrenheit." }, "unitType": { "$ref": "#/definitions/UnitType", "description": "An integer representing the type of unit. For example, 0 for feet, 1 for\ninches, 2 for miles. For a complete list, see [Unit\ntypes](/azure/azure-maps/weather-services-concepts#unit-types) in the\narticle Weather services in Azure Maps." } } }, "WeatherValueMaxMinAvg": { "type": "object", "description": "A three-value temperature summary - `minimum`, `maximum`, and `average` -\nfor a single day at the queried location, in degrees Celsius (°C) or\nFahrenheit (°F) depending on the unit specified in the request. Used for\nthe `temperature` field on `DailyHistoricalActuals` (what was actually\nobserved on the day) and on `DailyHistoricalNormals` (the 30-year average\nfor that calendar day) so the two responses can be compared\nfield-for-field. For example, on *2012-01-20* the observed reading was\nminimum *-11.1 °C*, maximum *-6.1 °C*, and average *-8.6 °C*, while the\n30-year normal for the same calendar day was minimum *-3.7 °C*, maximum\n*4.4 °C*, and average *0.4 °C* - the difference reveals an unusually\ncold day relative to climate normals.", "properties": { "maximum": { "$ref": "#/definitions/WeatherValue", "description": "The highest temperature for the day at the queried location, in\ndegrees Celsius (°C) or Fahrenheit (°F) depending on the unit\nspecified in the request - for example, *-6.1 °C* observed on\n*2012-01-20* or *4.4 °C* as the 30-year normal for that calendar\nday." }, "minimum": { "$ref": "#/definitions/WeatherValue", "description": "The lowest temperature for the day at the queried location, in\ndegrees Celsius (°C) or Fahrenheit (°F) depending on the unit\nspecified in the request - for example, *-11.1 °C* observed on\n*2012-01-20* or *-3.7 °C* as the 30-year normal for that calendar\nday. Always less than or equal to `maximum`." }, "average": { "$ref": "#/definitions/WeatherValue", "description": "The mean temperature for the day at the queried location, in\ndegrees Celsius (°C) or Fahrenheit (°F) depending on the unit\nspecified in the request - for example, *-8.6 °C* observed on\n*2012-01-20* or *0.4 °C* as the 30-year normal for that calendar\nday. Falls between `minimum` and `maximum`." } } }, "WeatherValueRange": { "type": "object", "description": "Provides the highest and lowest forecasted temperatures for the specified\ntimeframe, measured in degrees Celsius (°C) or Fahrenheit (°F), based on the\nunit specified in the request.", "properties": { "minimum": { "$ref": "#/definitions/WeatherValue", "description": "Provides the minimum temperature for the specified timeframe, measured in\ndegrees Celsius (°C) or Fahrenheit (°F), based on the unit specified in the\nrequest." }, "maximum": { "$ref": "#/definitions/WeatherValue", "description": "Provides the maximum temperature for the specified timeframe, measured in\ndegrees Celsius (°C) or Fahrenheit (°F), based on the unit specified in the\nrequest." } } }, "WeatherValueYear": { "type": "object", "description": "A single record-setting measurement tagged with the year the record was\nset, used as a building block for the all-time daily extremes returned\non `DailyHistoricalRecords` - specifically the record `maximum` and\nrecord `minimum` of `WeatherValueYearMaxMinAvg` (record-high and\nrecord-low temperature) and the record `maximum` of\n`WeatherValueYearMax` (greatest precipitation, snowfall, and similar\naccumulated metrics). Each entry pairs the `value` and its `unit`/\n`unitType` with the `year` in which that value was observed at the\nqueried location for the calendar day in question - for example,\n*21.1 °C* set in *1906* (record high on *2012-01-22*), *-21.7 °C* set\nin *1984* (record low on *2012-01-22*), or *48 mm* of precipitation\nset in *1978*.", "properties": { "value": { "type": "number", "format": "float", "description": "The numeric record value, in the unit specified by `unit` /\n`unitType` - for example, *21.1* for the *21.1 °C* record high on\n*2012-01-22*, *-21.7* for the *-21.7 °C* record low on the same\nday, or *48* for the *48 mm* precipitation record set in *1978*.\nThe metric this value represents (record-high temperature,\nrecord-low temperature, greatest precipitation, greatest snowfall,\nand so on) is determined by which `WeatherValueYearMaxMinAvg` or\n`WeatherValueYearMax` field this entry appears under." }, "unit": { "type": "string", "description": "Short string label for the unit of `value` - for example, *C* for\nCelsius or *F* for Fahrenheit on temperature records, *mm* or *in*\non precipitation records, and *cm* or *in* on snowfall records.\nWhich unit is used depends on the unit specified in the request." }, "unitType": { "type": "integer", "format": "int32", "description": "An integer representing the type of unit. For a complete list, see\n[Unit types](/azure/azure-maps/weather-services-concepts#unit-types)\nin the article Weather services in Azure Maps." }, "year": { "type": "integer", "format": "int32", "description": "The four-digit calendar year in which `value` was observed at the\nqueried location for this calendar day, identifying when the record\nwas set - for example, *1906* for the record high on *2012-01-22*,\n*1984* for the record low on the same day, and *1978* for the\nrecord precipitation. Note that the `year` of the surrounding\n`DailyHistoricalRecords.date` is just the year from the request\nwindow and is unrelated to the record year reported here; only the\nmonth and day of `date` identify the calendar day whose all-time\nrecord is being returned." } } }, "WeatherValueYearMax": { "type": "object", "description": "A single-value record-high summary for a calendar day at the queried\nlocation: only `maximum` (tagged with the year the record was set\nvia `WeatherValueYear`). Used by `DailyHistoricalRecords.precipitation`\nand `DailyHistoricalRecords.snowfall` to report the greatest amount\never observed on that calendar day. Carries no minimum because the\nlowest amount of precipitation or snowfall for any given calendar\nday is trivially zero and therefore uninformative; symmetric metrics\nlike temperature use `WeatherValueYearMaxMinAvg` instead.", "properties": { "maximum": { "$ref": "#/definitions/WeatherValueYear", "description": "The all-time greatest amount ever observed at the queried location\nfor this calendar day, tagged with the year the record was set.\nUnits depend on which `DailyHistoricalRecords` field this entry\nappears under - precipitation values are in millimeters (mm) or\ninches (in), and snowfall values are in centimeters (cm) or inches\n(in), each according to the unit specified in the request. For\nexample, *48 mm* of precipitation set in *1978*, or *12.19 cm* of\nsnowfall set in *1978* (with *34.29 cm* set in *2014* on a\ndifferent calendar day)." } } }, "WeatherValueYearMaxMinAvg": { "type": "object", "description": "The record-temperature triple for a single calendar day at a location -\nrecord `maximum` and `minimum` (each tagged with the year the record was\nset) plus the long-term `average` for that calendar date. Used as the\n`temperature` field on `DailyHistoricalRecords`. Values are in degrees\nCelsius (°C) or Fahrenheit (°F) depending on the unit specified in the\nrequest. For example, on *2012-01-20* the record high is *18.3 °C* set\nin *1951*, the record low is *-19.4 °C* set in *1984*, and the\nlong-term average for the date is *-0.6 °C*.", "properties": { "maximum": { "$ref": "#/definitions/WeatherValueYear", "description": "The all-time highest temperature ever observed at the queried\nlocation for this calendar day, tagged with the year the record was\nset, in degrees Celsius (°C) or Fahrenheit (°F) depending on the\nunit specified in the request - for example, *18.3 °C* set in\n*1951* on *2012-01-20*. Always greater than or equal to `minimum`." }, "minimum": { "$ref": "#/definitions/WeatherValueYear", "description": "The all-time lowest temperature ever observed at the queried\nlocation for this calendar day, tagged with the year the record was\nset, in degrees Celsius (°C) or Fahrenheit (°F) depending on the\nunit specified in the request - for example, *-19.4 °C* set in\n*1984* on *2012-01-20*. Always less than or equal to `maximum`." }, "average": { "$ref": "#/definitions/WeatherValue", "description": "The long-term average temperature for this calendar day at the\nqueried location, in degrees Celsius (°C) or Fahrenheit (°F)\ndepending on the unit specified in the request - for example,\n*-0.6 °C* on *2012-01-20*. The average is a multi-year climate\nvalue tied to the calendar date rather than to any single year, so\nunlike `maximum` and `minimum` it is a `WeatherValue` and carries\nno `year` field." } } }, "WeatherWindow": { "type": "object", "description": "The forecast window covering one segment of a tropical storm's predicted\ntrack, returned as `StormForecast.window`. Each window represents the\narea of uncertainty around the storm's projected path - bounded in time\nby `beginDateTime` and `endDateTime` and laterally by the `left` and\n`right` points marking the left and right edges of the path relative to\nthe storm's direction of travel - and reports the storm's classification\nat the start and end of the segment (`beginStatus`, `endStatus`). When\nthe request asks for the window geometry, `geometry` carries a GeoJSON\nrepresentation of the affected area.", "properties": { "left": { "$ref": "#/definitions/LatLongPair", "description": "The point at the left edge of the storm's projected path for this\nsegment - left relative to the storm's direction of travel - given as\nlatitude and longitude. For example, latitude *22.56387*, longitude\n*137.739517*." }, "right": { "$ref": "#/definitions/LatLongPair", "description": "The point at the right edge of the storm's projected path for this\nsegment - opposite `left`, right of the storm's direction of travel -\ngiven as latitude and longitude. For example, latitude *21.4361*,\nlongitude *137.860489*." }, "beginDateTime": { "type": "string", "format": "date-time", "description": "The date and time at which this segment of the forecast window begins,\nin [ISO\n8601](https://www.iso.org/iso-8601-date-and-time-format.html) format\n(yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*." }, "endDateTime": { "type": "string", "format": "date-time", "description": "The date and time at which this segment of the forecast window ends,\nin [ISO\n8601](https://www.iso.org/iso-8601-date-and-time-format.html) format\n(yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*." }, "beginStatus": { "type": "string", "description": "The storm's classification at the start of this window segment - for\nexample, *Tropical Storm*. Uses the same set of values as\n`StormForecast.status`." }, "endStatus": { "type": "string", "description": "The storm's classification at the end of this window segment - for\nexample, *Tropical Storm*. Uses the same set of values as\n`StormForecast.status`." }, "geometry": { "$ref": "#/definitions/GeoJsonGeometry", "description": "A GeoJSON representation of the area affected by the storm across this\nwindow segment, suitable for rendering the projected path on a map.\nReturned only when the request asks for the window geometry." } } }, "WindDetails": { "type": "object", "description": "Provides the forecasted wind speed, measured in units such as kilometers\nper hour (km/h) or miles per hour (mph), depending on the unit specified\nin the request. Also indicates the wind direction measured in azimuth\ndegrees, starting at true North and moving clockwise. North corresponds\nto 0°, east to 90°, south to 180°, and west to 270°. Possible values range\nfrom 0° to 359°.", "properties": { "direction": { "$ref": "#/definitions/WindDirection", "description": "Wind direction is measured in azimuth degrees, starting at true North (0°)\nand moving clockwise. East corresponds to 90°, south to 180°, and west to\n270°. Possible values range from 0° to 359°. This property returns an\ninteger representing the wind direction." }, "speed": { "$ref": "#/definitions/WeatherValue", "description": "The expected wind speed, measured in kilometers per hour (km/h) or miles\nper hour (mph), depending on the unit specified in the request." } } }, "WindDirection": { "type": "object", "description": "Provides details about wind direction, including the direction in azimuth\ndegrees and a localized abbreviation of the wind direction.", "properties": { "degrees": { "type": "integer", "format": "int32", "description": "Wind direction is measured in azimuth degrees, starting at true North and\nmoving clockwise. North corresponds to 0 degrees, east to 90 degrees, south\nto 180 degrees, and west to 270 degrees. Possible values range from 0 to\n359 degrees." }, "localizedDescription": { "type": "string", "description": "A localized abbreviation of the wind direction, returned in the language\nspecified in the request. For example, `N` for North, `E` for East, `S` for\nSouth, and `W` for West." } } } }, "parameters": { "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" } } }