Azure Maps Weather Service (preview:1.0)

2025/08/14 • 8 deleted methods

Weather_GetHourlyForecast (removed)
Description :  **Get Hourly Forecast** **Applies to**: S0 and S1 pricing tiers. Request detailed weather forecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days), and 240 hours (10 days) for the given the given coordinate location. The API returns details such as temperature, humidity, wind, precipitation, and ultraviolet (UV) index. In S0 you can request hourly forecast for the next 1, 12, 24 hours (1 day), and 72 hours (3 days). In S1 you can also request hourly forecast for the next 120 (5 days) and 240 hours (10 days).
Reference :  Link ¶

⚼ Request

GET:  /weather/forecast/hourly/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: Coordinates of the location for which hourly forecast information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". ,
Required: True ,
}
string ,
unit:
{
Description: Specifies to return the data in either metric units or imperial units. Default value is metric. ,
Required: False ,
}
string ,
duration:
{
Description: Time frame of the returned weather forecast. By default, the forecast data for next hour will be returned. Available values are * `1` - Return forecast data for the next hour. Default value. * `12` - Return hourly forecast for next 12 hours. * `24` - Return hourly forecast for next 24 hours. * `72` - Return hourly forecast for next 72 hours (3 days). * `120` - Return hourly forecast for next 120 hours (5 days). Only available in S1 SKU. * `240` - Return hourly forecast for next 240 hours (10 days). Only available in S1 SKU. ,
Required: False ,
}
integer ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Default value is en-us. Please refer to [Supported languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
forecasts:
{
Description: Forecast data for each returned hour. ,
Required: False ,
}
[
{
date:
{
Description: Date and time of the forecast in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Required: False ,
}
string ,
iconCode:
{
Description: Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
iconPhrase:
{
Description: Phrase description of the weather icon. ,
Required: False ,
}
string ,
hasPrecipitation:
{
Description: Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation. ,
Required: False ,
}
boolean ,
isDaylight:
{
Description: Specifies whether or not it is daylight. True indicates day light. ,
Required: False ,
}
boolean ,
temperature:
{
Description: Temperature being returned. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
realFeelTemperature:
{
Description: RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
wetBulbTemperature:
{
Description: The temperature to which air may be cooled by evaporating water into it at constant pressure until it reaches saturation. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dewPoint:
{
Description: The dewpoint temperature in specified unit. The dewpoint temperature is the temperature that the air must be cooled to in order to reach saturation. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
wind:
{
Description: Wind details being returned including speed and direction. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: float ,
Required: False ,
}
number ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value of the speed. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the speed value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
windGust:
{
Description: Wind gust. Wind gust is a sudden, brief increase in speed of the wind. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: float ,
Required: False ,
}
number ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value of the speed. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the speed value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
relativeHumidity:
{
Description: Relative humidity is the amount of water vapor present in air expressed as a percentage of the amount needed for saturation at the same temperature. ,
Format: int32 ,
Required: False ,
}
integer ,
visibility:
{
Description: Visibility in specified unit. A measure of the distance at which an object or light can be clearly discerned. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ceiling:
{
Description: Cloud ceiling in specified unit. The ceiling is a measurement of the height of the base of the lowest clouds. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
uvIndex:
{
Description: Measure of the strength of the ultraviolet radiation from the sun. Supported values are: * `0-2` - Low danger from the sun's UV rays or the average person. * `3-5` - Moderate risk of harm from unprotected sun exposure. * `6-7` - High risk of harm from unprotected sun exposure. * `8-10` - Very high risk of harm from unprotected sun exposure. * `11+` - Extreme risk of harm from unprotected sun exposure. ,
Format: int32 ,
Required: False ,
}
integer ,
uvIndexPhrase:
{
Description: Phrase associated with the `uvIndex`. ,
Required: False ,
}
string ,
precipitationProbability:
{
Description: Percent representing the probability of precipitation. For example, '20'. ,
Format: int32 ,
Required: False ,
}
integer ,
rainProbability:
{
Description: Percent representing the probability of rain. For example, '50'. ,
Format: int32 ,
Required: False ,
}
integer ,
snowProbability:
{
Description: Percent representing the probability of snow. For example, '50'. ,
Format: int32 ,
Required: False ,
}
integer ,
iceProbability:
{
Description: Percent representing the probability of snow. For example, '5'. ,
Format: int32 ,
Required: False ,
}
integer ,
totalLiquid:
{
Description: Total liquid equivalent of precipitation during the forecast period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rain:
{
Description: Rain ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
snow:
{
Description: Snow ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ice:
{
Description: Ice ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
cloudCover:
{
Description: Percent representing cloud cover. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Weather_GetMinuteForecast (removed)
Description :  **Get Minute Forecast** **Applies to**: S1 pricing tier. Get Minute Forecast service returns minute-by-minute forecasts for a given location for the next 120 minutes. Users can request weather forecasts in the interval of 1, 5 and 15 minutes. The response will include details such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation intensity value (dBZ).
Reference :  Link ¶

⚼ Request

GET:  /weather/forecast/minute/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: Coordinates of the location for which minute forecast information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". ,
Required: True ,
}
string ,
interval:
{
Description: Specifies time interval in minutes for the returned weather forecast. Supported values are * `1` - Retrieve forecast for 1-minute intervals. Returned by default. * `5` - Retrieve forecasts for 5-minute intervals. * `15` - Retrieve forecasts for 15-minute intervals. ,
Required: False ,
}
integer ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Default value is en-us. Please refer to [Supported languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Phrase summaries for the entire forecast period. ,
Required: False ,
}
{
briefPhrase60:
{
Description: Summary phrase for the next 60 minutes. Phrase length is approximately 60 characters. ,
Required: False ,
}
string ,
shortPhrase:
{
Description: Short summary phrase for the next 120 minutes. Phrase length is approximately 25 characters. ,
Required: False ,
}
string ,
briefPhrase:
{
Description: Summary phrase for the next 120 minutes. Phrase length is approximately 60 characters. ,
Required: False ,
}
string ,
longPhrase:
{
Description: Long summary phrase for the next 120 minutes. Phrase length is 60+ characters. ,
Required: False ,
}
string ,
iconCode:
{
Description: Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
intervalSummaries:
{
Description: Summary information for each interval in the forecast. The Summaries breaks down each potential interval where precipitation starts and stops. ,
Required: False ,
}
[
{
startMinute:
{
Description: The first minute to which the summary applies. ,
Format: int32 ,
Required: False ,
}
integer ,
endMinute:
{
Description: The last minute to which the summary applies. ,
Format: int32 ,
Required: False ,
}
integer ,
totalMinutes:
{
Description: The number of minutes for which the summary applies. ,
Format: int32 ,
Required: False ,
}
integer ,
shortPhrase:
{
Description: Short summary phrase. Phrase length is approximately 25 characters. ,
Required: False ,
}
string ,
briefPhrase:
{
Description: Brief summary phrase. Phrase length is approximately 60 characters. ,
Required: False ,
}
string ,
longPhrase:
{
Description: Long summary phrase. Phrase length is 60+ characters. ,
Required: False ,
}
string ,
iconCode:
{
Description: Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
intervals:
{
Description: Forecast data for each interval in the forecast. ,
Required: False ,
}
[
{
startTime:
{
Description: The date and time for the start of the interval in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Required: False ,
}
string ,
minute:
{
Description: The first minute for the interval. ,
Format: int32 ,
Required: False ,
}
integer ,
dbz:
{
Description: A unit that represents forecasted precipitation intensity. ,
Format: double ,
Required: False ,
}
number ,
shortPhrase:
{
Description: A short phrase describing precipitation condition for the interval. ,
Required: False ,
}
string ,
threshold:
{
Description: Key that specifies the threshold value. Along with precipitationType, can be used to determine the simplifiedColor. If dbz is zero, not present in the response. ,
Required: False ,
}
string ,
color:
{
Description: The full spectrum color that maps to the dBZ (decibel relative to Z). If dbz is zero, color is not present in the response. ,
Required: False ,
}
{
red:
{
Description: Red component of the RGB value. ,
Format: int32 ,
Required: False ,
}
integer ,
green:
{
Description: Green component of the RGB value. ,
Format: int32 ,
Required: False ,
}
integer ,
blue:
{
Description: Blue component of the RGB value ,
Format: int32 ,
Required: False ,
}
integer ,
hex:
{
Description: Hexadecimal color value. ,
Required: False ,
}
string ,
}
,
simplifiedColor:
{
Description: The band color that maps to the precipitation type and threshold. If dbz is zero, not present in the response. ,
Required: False ,
}
{
red:
{
Description: Red component of the RGB value. ,
Format: int32 ,
Required: False ,
}
integer ,
green:
{
Description: Green component of the RGB value. ,
Format: int32 ,
Required: False ,
}
integer ,
blue:
{
Description: Blue component of the RGB value ,
Format: int32 ,
Required: False ,
}
integer ,
hex:
{
Description: Hexadecimal color value. ,
Required: False ,
}
string ,
}
,
precipitationType:
{
Description: Specifies the type of precipitation ("rain" "snow" "ice" or "mix"). If dbz is zero, precipitationType is not present in the response. ,
Required: False ,
}
string ,
iconCode:
{
Description: Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
cloudCover:
{
Description: Percent representing cloud cover. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Weather_GetQuarterDayForecast (removed)
Description :  **Get Quarter-Day Forecast** **Applies to**: S0 and S1 pricing tiers. Service returns detailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for a given location. Response data is presented by quarters of the day - morning, afternoon, evening, and overnight. Details such as temperature, humidity, wind, precipitation, and UV index are returned.
Reference :  Link ¶

⚼ Request

GET:  /weather/forecast/quarterDay/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: Coordinates of the location for which quarter-day forecast information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". ,
Required: True ,
}
string ,
unit:
{
Description: Specifies to return the data in either metric units or imperial units. Default value is metric. ,
Required: False ,
}
string ,
duration:
{
Description: Specifies for how many days the quester-day forecast responses are returned. Supported values are: * `1` - Return forecast data for the next day. Returned by default. * `5` - Return forecast data for the next 5 days. * `10` - Return forecast data for next 10 days. * `15` - Return forecast data for the next 15 days. ,
Required: False ,
}
integer ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Default value is en-us. Please refer to [Supported languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
forecasts:
{
Description: Forecast data for each quarter in the response. ,
Required: False ,
}
[
{
date:
{
Description: Date and time of the forecast in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Required: False ,
}
string ,
effectiveDate:
{
Description: Date and time of the beginning of the forecast quarter displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Required: False ,
}
string ,
quarter:
{
Description: Quarter of the day. ,
Format: int32 ,
Required: False ,
}
integer ,
iconCode:
{
Description: Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
iconPhrase:
{
Description: Phrase description of the icon. Displayed in specified language. For example, 'Sunny'. ,
Required: False ,
}
string ,
phrase:
{
Description: Short summary phrase summary for quarter. ,
Required: False ,
}
string ,
temperature:
{
Description: Temperature values for the quarter. ,
Required: False ,
}
{
minimum:
{
Description: Minimum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: Maximum temperature for the time period ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
realFeelTemperature:
{
Description: RealFeel™ Temperature values for the quarter. ,
Required: False ,
}
{
minimum:
{
Description: Minimum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: Maximum temperature for the time period ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
dewPoint:
{
Description: The dewpoint temperature in specified unit. The dewpoint temperature is the temperature that the air must be cooled to in order to reach saturation. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
relativeHumidity:
{
Description: Relative humidity is the amount of water vapor present in air expressed as a percentage of the amount needed for saturation at the same temperature. ,
Format: int32 ,
Required: False ,
}
integer ,
wind:
{
Description: Wind details being returned including speed and direction. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: float ,
Required: False ,
}
number ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value of the speed. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the speed value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
windGust:
{
Description: Wind gust. Wind gust is a sudden, brief increase in speed of the wind. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: float ,
Required: False ,
}
number ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value of the speed. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the speed value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
visibility:
{
Description: Visibility in specified unit. A measure of the distance at which an object or light can be clearly discerned. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
cloudCover:
{
Description: Percent representing cloud cover. ,
Format: int32 ,
Required: False ,
}
integer ,
hasPrecipitation:
{
Description: Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation. ,
Required: False ,
}
boolean ,
precipitationType:
{
Description: Specifies the type of precipitation ("rain" "snow" "ice" or "mix"). If dbz = zero, precipitationType is not present in the response. ,
Required: False ,
}
string ,
precipitationIntensity:
{
Description: Description of the intensity. ,
Required: False ,
}
string ,
precipitationProbability:
{
Description: Percent representing the probability of precipitation. For example, '20'. ,
Format: int32 ,
Required: False ,
}
integer ,
thunderstormProbability:
{
Description: Percent representing the probability of a thunderstorm. For example, '10'. ,
Format: int32 ,
Required: False ,
}
integer ,
totalLiquid:
{
Description: Total liquid equivalent of precipitation during the forecast period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rain:
{
Description: Rain ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
snow:
{
Description: Snow ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ice:
{
Description: Ice ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Weather_GetCurrentConditions (removed)
Description :  **Get Current Conditions** **Applies to**: S0 and S1 pricing tiers. Get Current Conditions service returns detailed current weather conditions such as precipitation, temperature and wind for a given coordinate location. Also, observations from the past 6 or 24 hours for a particular location can be retrieved. The basic information returned with the response include details such as observation date and time, brief description of the weather conditions, weather icon, precipitation indicator flags, and temperature. Additional details such as RealFeel™ Temperature and UV index are also returned.
Reference :  Link ¶

⚼ Request

GET:  /weather/currentConditions/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: Coordinates of the location for which current conditions information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". ,
Required: True ,
}
string ,
unit:
{
Description: Specifies to return the data in either metric units or imperial units. Default value is metric. ,
Required: False ,
}
string ,
details:
{
Description: Return full details for the current conditions. Available values are * `true` - Returns full details. By default all details are returned. * `false` - Returns a truncated version of the current condition data, which includes observation date time, weather phrase, icon code, precipitation indicator flag, and temperature. ,
Required: False ,
}
string ,
duration:
{
Description: Time frame of the returned weather conditions. By default, the most current weather conditions will be returned. Default value is 0. Supported values are: * `0` - Return the most current weather conditions. * `6` - Return weather conditions from past 6 hours. * `24` - Return weather conditions from past 24 hours. ,
Required: False ,
}
integer ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Default value is en-us. Please refer to [Supported languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
results:
{
Required: False ,
}
[
{
dateTime:
{
Description: Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Required: False ,
}
string ,
phrase:
{
Description: Phrase description of the current weather condition. Displayed in specified language. ,
Required: False ,
}
string ,
iconCode:
{
Description: Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
hasPrecipitation:
{
Description: Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation. ,
Required: False ,
}
boolean ,
isDayTime:
{
Description: Indicates the time of the day. True indicates 'day',', false indicates 'night. ,
Required: False ,
}
boolean ,
temperature:
{
Description: Temperature being returned. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
realFeelTemperature:
{
Description: RealFeel™ Temperature being returned. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
realFeelTemperatureShade:
{
Description: RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
relativeHumidity:
{
Description: Relative humidity is the amount of water vapor present in air expressed as a percentage of the amount needed for saturation at the same temperature. ,
Format: int32 ,
Required: False ,
}
integer ,
dewPoint:
{
Description: The dewpoint temperature in specified unit. The dewpoint temperature is the temperature that the air must be cooled to in order to reach saturation. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
wind:
{
Description: Wind details being returned including speed and direction. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: float ,
Required: False ,
}
number ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value of the speed. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the speed value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
windGust:
{
Description: Wind gust. Wind gust is a sudden, brief increase in speed of the wind. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: float ,
Required: False ,
}
number ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value of the speed. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the speed value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
uvIndex:
{
Description: Measure of the strength of the ultraviolet radiation from the sun. Supported values are: * `0-2` - Low danger from the sun's UV rays or the average person. * `3-5` - Moderate risk of harm from unprotected sun exposure. * `6-7` - High risk of harm from unprotected sun exposure. * `8-10` - Very high risk of harm from unprotected sun exposure. * `11+` - Extreme risk of harm from unprotected sun exposure. ,
Format: int32 ,
Required: False ,
}
integer ,
uvIndexPhrase:
{
Description: Phrase associated with the `uvIndex`. ,
Required: False ,
}
string ,
visibility:
{
Description: Visibility in specified unit. A measure of the distance at which an object or light can be clearly discerned. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
obstructionsToVisibility:
{
Description: Cause of limited visibility. ,
Required: False ,
}
string ,
cloudCover:
{
Description: Percent representing cloud cover. ,
Format: int32 ,
Required: False ,
}
integer ,
ceiling:
{
Description: Cloud ceiling in specified unit. The ceiling is a measurement of the height of the base of the lowest clouds. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
pressure:
{
Description: Atmospheric pressure in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
pressureTendency:
{
Description: Atmospheric pressure change. ,
Required: False ,
}
{
localizedDescription:
{
Description: Description of the pressure tendency in specified language ,
Required: False ,
}
string ,
code:
{
Description: Pressure tendency code regardless of language. One of F=Falling, S=Steady, R=Rising. ,
Required: False ,
}
string ,
}
,
past24HourTemperatureDeparture:
{
Description: Departure from the temperature observed 24 hours ago in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
apparentTemperature:
{
Description: Perceived outdoor temperature caused by the combination of air temperature, relative humidity, and wind speed in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
windChillTemperature:
{
Description: Perceived air temperature on exposed skin due to wind. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
wetBulbTemperature:
{
Description: The temperature to which air may be cooled by evaporating water into it at constant pressure until it reaches saturation. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
precipitationSummary:
{
Description: Summary of precipitation amounts over the past 24 hours. ,
Required: False ,
}
{
pastHour:
{
Description: The amount of precipitation (liquid equivalent) that has fallen in the past hour. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
past3Hours:
{
Description: The amount of precipitation (liquid equivalent) that has fallen in the past three hours. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
past6Hours:
{
Description: The amount of precipitation (liquid equivalent) that has fallen in the past six hours. Contains Metric and Imperial Values. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
past9Hours:
{
Description: The amount of precipitation (liquid equivalent) that has fallen in the past nine hours. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
past12Hours:
{
Description: The amount of precipitation (liquid equivalent) that has fallen in the past 12 hours. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
past18Hours:
{
Description: The amount of precipitation (liquid equivalent) that has fallen in the past 18 hours. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
past24Hours:
{
Description: The amount of precipitation (liquid equivalent) that has fallen in the past 24 hours. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
temperatureSummary:
{
Description: Summary of temperature fluctuations over the past 6, 12, and 24 hours. ,
Required: False ,
}
{
past6Hours:
{
Description: Summary of temperature fluctuations over the past 6 hours. ,
Required: False ,
}
{
minimum:
{
Description: minimum ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: maximum ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
past12Hours:
{
Description: Summary of temperature fluctuations over the past 12 hours. ,
Required: False ,
}
{
minimum:
{
Description: minimum ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: maximum ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
past24Hours:
{
Description: Summary of temperature fluctuations over the past 24 hours. ,
Required: False ,
}
{
minimum:
{
Description: minimum ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: maximum ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Weather_GetDailyForecast (removed)
Description :  **Get Daily Forecast** **Applies to**: S0 and S1 pricing tiers. The service returns detailed weather forecast such as temperature and wind by day for the next 1, 5, 10, 15, 25, or 45 days for a given coordinate location. The response include details such as temperature, wind, precipitation, air quality, and UV index. In S0 you can request daily forecast for the next 1, 5, 10, and 15 days. In S1 you can also request daily forecast for the next 25 days, and 45 days.
Reference :  Link ¶

⚼ Request

GET:  /weather/forecast/daily/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: Coordinates of the location for which current conditions information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". ,
Required: True ,
}
string ,
unit:
{
Description: Specifies to return the data in either metric units or imperial units. Default value is metric. ,
Required: False ,
}
string ,
duration:
{
Description: Specifies for how many days the daily forecast responses are returned. Available values are * `1` - Return forecast data for the next day. Returned by default. * `5` - Return forecast data for the next 5 days. * `10` - Return forecast data for the next 10 days. * `25` - Return forecast data for the next 25 days. Only available in S1 SKU. * `45` - Return forecast data for the next 45 days. Only available in S1 SKU. ,
Required: False ,
}
integer ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Default value is en-us. Please refer to [Supported languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Summary for the main conditions for the requested time period. Notice that summary can cover only part of the time period. ,
Required: False ,
}
{
startDate:
{
Description: Date and time that the summary is in effect, displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Required: False ,
}
string ,
endDate:
{
Description: Date and time that the summary period ends, displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Required: False ,
}
string ,
severity:
{
Description: severity ,
Format: int32 ,
Required: False ,
}
integer ,
phrase:
{
Description: Summary phrase of the daily forecast. Displayed in specified language. ,
Required: False ,
}
string ,
category:
{
Description: one or 2 word(s) to summarize the phrase. ,
Required: False ,
}
string ,
}
,
forecasts:
{
Description: Forecast data for each requested day. ,
Required: False ,
}
[
{
date:
{
Description: Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Required: False ,
}
string ,
temperature:
{
Description: Temperature values for the day. ,
Required: False ,
}
{
minimum:
{
Description: Minimum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: Maximum temperature for the time period ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
realFeelTemperature:
{
Description: RealFeel™ Temperature being returned. ,
Required: False ,
}
{
minimum:
{
Description: Minimum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: Maximum temperature for the time period ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
realFeelTemperatureShade:
{
Description: RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade. ,
Required: False ,
}
{
minimum:
{
Description: Minimum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: Maximum temperature for the time period ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
hoursOfSun:
{
Description: Hours of sun. ,
Format: float ,
Required: False ,
}
number ,
degreeDaySummary:
{
Description: Summary of Heating Degree Day or Cooling Degree Day information ,
Required: False ,
}
{
heating:
{
Description: Number of degrees that the mean temperature is below 65 degrees F/ 18 degree C. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
cooling:
{
Description: Number of degrees that the mean temperature is above 65 degrees F/ 18 degree C. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
airAndPollen:
{
Description: airAndPollen ,
Required: False ,
}
[
{
name:
{
Description: Name of the pollen or pollutant. For example, grass, mold, weed, air quality, tree and UV index. ,
Required: False ,
}
string ,
value:
{
Description: Value of the given type above. Values associated with mold, grass, weed and tree are in units of parts per cubic meter. Both air quality and UV are indices, so they are unitless. ,
Format: int32 ,
Required: False ,
}
integer ,
category:
{
Description: Category of the air quality or pollution type. For example, low, high, good, moderate, unhealthy, hazardous. ,
Required: False ,
}
string ,
categoryValue:
{
Description: Value associated with the air quality or pollution category. These values range from 1 to 6. 1 implying good conditions, 6 implying hazardous conditions. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Only exists for air quality. Examples include ozone and particle pollution. ,
Required: False ,
}
string ,
}
,
]
,
day:
{
Description: Day ,
Required: False ,
}
{
iconCode:
{
Description: Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
iconPhrase:
{
Description: Phrase description of the icon. Displayed in specified language. For example, 'Sunny'. ,
Required: False ,
}
string ,
localSource:
{
Required: False ,
}
{
id:
{
Description: Numeric identifier, unique to the local data provider. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Name of the local data provider. Name is displayed in the language specified by language code in URL, if available. Otherwise, Name is displayed in English or the language in which the name was provided. ,
Required: False ,
}
string ,
weatherCode:
{
Description: Weather code provided by the local data provider. This weather code allows the forecast to be matched to icons provided by the local data provider instead of Azure Maps icons. ,
Required: False ,
}
string ,
}
,
hasPrecipitation:
{
Description: Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation. ,
Required: False ,
}
boolean ,
precipitationType:
{
Description: Specifies the type of precipitation ("rain" "snow" "ice" or "mix"). If dbz = zero, precipitationType is not present in the response. ,
Required: False ,
}
string ,
precipitationIntensity:
{
Description: Description of the intensity. ,
Required: False ,
}
string ,
shortPhrase:
{
Description: Phrase description of the forecast in specified language. Azure Maps attempts to keep this phrase under 30 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 30 characters. ,
Required: False ,
}
string ,
longPhrase:
{
Description: Phrase description of the forecast in specified language. Azure Maps attempts to keep this phrase under 100 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 100 characters. ,
Required: False ,
}
string ,
precipitationProbability:
{
Description: Percent representing the probability of precipitation. For example, '20'. ,
Format: int32 ,
Required: False ,
}
integer ,
thunderstormProbability:
{
Description: Percent representing the probability of a thunderstorm. For example, '80'. ,
Format: int32 ,
Required: False ,
}
integer ,
rainProbability:
{
Description: Percent representing the probability of rain. For example, '40'. ,
Format: int32 ,
Required: False ,
}
integer ,
snowProbability:
{
Description: Percent representing the probability of snow. For example, '30'. ,
Format: int32 ,
Required: False ,
}
integer ,
iceProbability:
{
Description: Percent representing the probability of ice. For example, '30'. ,
Format: int32 ,
Required: False ,
}
integer ,
wind:
{
Description: Wind details being returned including speed and direction. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: float ,
Required: False ,
}
number ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value of the speed. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the speed value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
windGust:
{
Description: Wind gust. Wind gust is a sudden, brief increase in speed of the wind. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: float ,
Required: False ,
}
number ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value of the speed. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the speed value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
totalLiquid:
{
Description: Total liquid equivalent of precipitation during the forecast period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rain:
{
Description: Rain ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
snow:
{
Description: Snow ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ice:
{
Description: Ice ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
hoursOfPrecipitation:
{
Description: Hours of precipitation ,
Format: float ,
Required: False ,
}
number ,
hoursOfRain:
{
Description: Hours of rain. ,
Format: float ,
Required: False ,
}
number ,
hoursOfSnow:
{
Description: Hours of snow. ,
Format: float ,
Required: False ,
}
number ,
hoursOfIce:
{
Description: Hours of ice. ,
Format: float ,
Required: False ,
}
number ,
cloudCover:
{
Description: Percent representing cloud cover. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
night:
{
Description: Night ,
Required: False ,
}
{
iconCode:
{
Description: Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
iconPhrase:
{
Description: Phrase description of the icon. Displayed in specified language. For example, 'Sunny'. ,
Required: False ,
}
string ,
localSource:
{
Required: False ,
}
{
id:
{
Description: Numeric identifier, unique to the local data provider. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Name of the local data provider. Name is displayed in the language specified by language code in URL, if available. Otherwise, Name is displayed in English or the language in which the name was provided. ,
Required: False ,
}
string ,
weatherCode:
{
Description: Weather code provided by the local data provider. This weather code allows the forecast to be matched to icons provided by the local data provider instead of Azure Maps icons. ,
Required: False ,
}
string ,
}
,
hasPrecipitation:
{
Description: Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation. ,
Required: False ,
}
boolean ,
precipitationType:
{
Description: Specifies the type of precipitation ("rain" "snow" "ice" or "mix"). If dbz = zero, precipitationType is not present in the response. ,
Required: False ,
}
string ,
precipitationIntensity:
{
Description: Description of the intensity. ,
Required: False ,
}
string ,
shortPhrase:
{
Description: Phrase description of the forecast in specified language. Azure Maps attempts to keep this phrase under 30 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 30 characters. ,
Required: False ,
}
string ,
longPhrase:
{
Description: Phrase description of the forecast in specified language. Azure Maps attempts to keep this phrase under 100 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 100 characters. ,
Required: False ,
}
string ,
precipitationProbability:
{
Description: Percent representing the probability of precipitation. For example, '20'. ,
Format: int32 ,
Required: False ,
}
integer ,
thunderstormProbability:
{
Description: Percent representing the probability of a thunderstorm. For example, '80'. ,
Format: int32 ,
Required: False ,
}
integer ,
rainProbability:
{
Description: Percent representing the probability of rain. For example, '40'. ,
Format: int32 ,
Required: False ,
}
integer ,
snowProbability:
{
Description: Percent representing the probability of snow. For example, '30'. ,
Format: int32 ,
Required: False ,
}
integer ,
iceProbability:
{
Description: Percent representing the probability of ice. For example, '30'. ,
Format: int32 ,
Required: False ,
}
integer ,
wind:
{
Description: Wind details being returned including speed and direction. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: float ,
Required: False ,
}
number ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value of the speed. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the speed value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
windGust:
{
Description: Wind gust. Wind gust is a sudden, brief increase in speed of the wind. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: float ,
Required: False ,
}
number ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value of the speed. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the speed value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
totalLiquid:
{
Description: Total liquid equivalent of precipitation during the forecast period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rain:
{
Description: Rain ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
snow:
{
Description: Snow ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ice:
{
Description: Ice ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
hoursOfPrecipitation:
{
Description: Hours of precipitation ,
Format: float ,
Required: False ,
}
number ,
hoursOfRain:
{
Description: Hours of rain. ,
Format: float ,
Required: False ,
}
number ,
hoursOfSnow:
{
Description: Hours of snow. ,
Format: float ,
Required: False ,
}
number ,
hoursOfIce:
{
Description: Hours of ice. ,
Format: float ,
Required: False ,
}
number ,
cloudCover:
{
Description: Percent representing cloud cover. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sources:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Weather_GetWeatherAlongRoute (removed)
Description :  **Get Weather along route** **Applies to**: S1 pricing tier. Weather along a route API returns hyper local (one kilometer or less), up-to-the-minute weather nowcasts, weather hazard assessments, and notifications along a route described as a sequence of waypoints. This includes a list of weather hazards affecting the waypoint or route, and the aggregated hazard index for each waypoint might be used to paint each portion of a route according to how safe it is for the driver. When submitting the waypoints, it is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. Data is updated every five minutes. The service supplements Azure Maps [Route Service](https://docs.microsoft.com/rest/api/maps/route) that allows you to first request a route between an origin and a destination and use that as an input for Weather Along Route endpoint. In addition, the service supports scenarios to generate weather notifications for waypoints that experience an increase in intensity of a weather hazard. For example, if the vehicle is expected to begin experiencing heavy rain as it reaches a waypoint, a weather notification for heavy rain will be generated for that waypoint allowing the end product to display a heavy rain notification before the driver reaches that waypoint. The trigger for when to display the notification for a waypoint could be based, for example, on a [geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps), or selectable distance to the waypoint. The API covers all regions of the planet except latitudes above Greenland and Antarctica.
Reference :  Link ¶

⚼ Request

GET:  /weather/route/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: Coordinates through which the route is calculated, separated by colon (:) and entered in chronological order. A minimum of two waypoints is required. A single API call may contain up to 60 waypoints. A waypoint indicates location, ETA, and optional heading: latitude,longitude,ETA,heading, where * `Latitude` - Latitude coordinate in decimal degrees. * `Longitude` - Longitude coordinate in decimal degrees. * `ETA (estimated time of arrival)` - The number of minutes from the present time that it will take for the vehicle to reach the waypoint. Allowed range is from 0.0 to 120.0 minutes. * `Heading` - An optional value indicating the vehicle heading as it passes the waypoint. Expressed in clockwise degrees relative to true north. This is issued to calculate sun glare as a driving hazard. Allowed range is from 0.0 to 360.0 degrees. If not provided, a heading will automatically be derived based on the position of neighboring waypoints. It is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. This way a more accurate assessment can be provided for the trip and prevent isolated events not being captured between waypoints. Information can and should be updated along the route (especially for trips greater than 2 hours) to continuously pull new waypoints moving forward, but also to ensure that forecast information for content such as precipitation type and intensity is accurate as storms develop and dissipate over time. ,
Required: True ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Default value is en-us. Please refer to [Supported languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Required: False ,
}
{
iconCode:
{
Description: Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
hazards:
{
Required: False ,
}
{
maxHazardIndex:
{
Description: A severity/hazard index. * `0` - No hazard. * `1` - Be informed, be aware. * `2` - Pay attention, be prepared. * `3` - Take action. * `4` - Life threatening, emergency. ,
Format: int32 ,
Required: False ,
}
integer ,
hazardDetails:
{
Description: Details of the weather hazards affecting the trip. ,
Required: False ,
}
[
{
hazardIndex:
{
Description: A severity/hazard index. * `0` - No hazard. * `1` - Be informed, be aware. * `2` - Pay attention, be prepared. * `3` - Take action. * `4` - Life threatening, emergency. ,
Format: int32 ,
Required: False ,
}
integer ,
hazardCode:
{
Description: A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning. ,
Required: False ,
}
string ,
shortPhrase:
{
Description: A displayable short phrase describing the forecasted conditions and precipitation intensity/type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
waypoints:
{
Description: Data for each waypoint returned in the same order as specified in the request. ,
Required: False ,
}
[
{
iconCode:
{
Description: Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
shortPhrase:
{
Description: A displayable short phrase describing the forecasted conditions and precipitation intensity/type. ,
Required: False ,
}
string ,
isDayTime:
{
Description: Indicates the time of the day. True indicates 'day',', false indicates 'night. ,
Required: False ,
}
boolean ,
cloudCover:
{
Description: Percent representing cloud cover. ,
Format: int32 ,
Required: False ,
}
integer ,
temperature:
{
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
wind:
{
Description: Wind details being returned including speed and direction. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: float ,
Required: False ,
}
number ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value of the speed. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the speed value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
windGust:
{
Description: Wind details being returned including speed and direction. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: float ,
Required: False ,
}
number ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value of the speed. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the speed value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
precipitation:
{
Required: False ,
}
{
dbz:
{
Description: The forecasted precipitation intensity in dBZ (decibels relative to Z) from 0.0 to 100.0. ,
Format: double ,
Required: False ,
}
number ,
type:
{
Description: Precipitation type. If precipitation should occur, the type that it will be: "RAIN," "HAIL," "SNOW," "ICE," or "MIX." ,
Required: False ,
}
string ,
}
,
lightningCount:
{
Description: Estimation of thunderstorm intensity on an open scale. A value of 0 means there is no thunderstorm; values of 1 and higher mean there is a thunderstorm in increasing intensity. ,
Format: int32 ,
Required: False ,
}
integer ,
sunGlare:
{
Description: A rating that indicates how blinding the sun is for the driver. ,
Required: False ,
}
{
calculatedVehicleHeading:
{
Description: If the vehicle heading value is not provided for a waypoint, then the service will calculate a heading based upon the location of neighboring waypoints if provided. ,
Format: int32 ,
Required: False ,
}
integer ,
glareIndex:
{
Description: An index from 0 to 100 indicating sun glare intensity for a driver. A value of 50 and above can be considered a hazard for some drivers and a value of 100 signifies the driver is driving straight into the sun and atmospheric conditions are clear allowing for the full intensity of the sun to blind the driver. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
hazards:
{
Required: False ,
}
{
maxHazardIndex:
{
Description: A severity/hazard index. * `0` - No hazard. * `1` - Be informed, be aware. * `2` - Pay attention, be prepared. * `3` - Take action. * `4` - Life threatening, emergency. ,
Format: int32 ,
Required: False ,
}
integer ,
hazardDetails:
{
Description: Details of the weather hazards affecting the trip. ,
Required: False ,
}
[
{
hazardIndex:
{
Description: A severity/hazard index. * `0` - No hazard. * `1` - Be informed, be aware. * `2` - Pay attention, be prepared. * `3` - Take action. * `4` - Life threatening, emergency. ,
Format: int32 ,
Required: False ,
}
integer ,
hazardCode:
{
Description: A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning. ,
Required: False ,
}
string ,
shortPhrase:
{
Description: A displayable short phrase describing the forecasted conditions and precipitation intensity/type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
notifications:
{
Required: False ,
}
[
{
type:
{
Description: A type of notification generated to warn drivers of the onset of a hazard, or increase in intensity of a hazard. ,
Required: False ,
}
string ,
hazardIndex:
{
Description: A severity/hazard index. * `0` - No hazard. * `1` - Be informed, be aware. * `2` - Pay attention, be prepared. * `3` - Take action. * `4` - Life threatening, emergency. ,
Format: int32 ,
Required: False ,
}
integer ,
hazardCode:
{
Description: A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning. ,
Required: False ,
}
string ,
shortPhrase:
{
Description: A displayable short phrase describing the forecasted conditions and precipitation intensity/type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Weather_GetSevereWeatherAlerts (removed)
Description :  **Get Severe Weather Alerts** **Applies to**: S0 and S1 pricing tiers. Severe weather phenomenon can significantly impact our everyday life and business operations. For example, severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of refrigerated food products.  Azure Maps Severe Weather Alerts API returns the severe weather alerts that are available worldwide from both official Government Meteorological Agencies and leading global to regional weather alert providers. The service can return details such as alert type, category, level and detailed description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, heat waves or forest fires.
Reference :  Link ¶

⚼ Request

GET:  /weather/severe/alerts/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: Coordinates of the location for which severe weather alerts are requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". ,
Required: True ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Default value is en-us. Please refer to [Supported languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
details:
{
Description: Return full details for the severe weather alerts. Available values are * `true` - Returns full details. By default all details are returned. * `false` - Returns a truncated version of the alerts data, which excludes the area-specific full description of alert details (`alertDetails`). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
results:
{
Description: A list of all severe weather alerts for the queried location. ,
Required: False ,
}
[
{
countryCode:
{
Description: 2-character ISO 3166-1 Alpha-2 country code, for example, "US". ,
Required: False ,
}
string ,
alertId:
{
Description: A unique numerical identifier for a weather alert. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Description of the alert. ,
Required: False ,
}
{
localized:
{
Description: Description of the alert in the specified language. By default English (en-US) is returned if the language parameter is not specified in the request. ,
Required: False ,
}
string ,
english:
{
Description: Description of the alert in English (en-US). ,
Required: False ,
}
string ,
}
,
category:
{
Description: Category of the alert. ,
Required: False ,
}
string ,
priority:
{
Description: Number signifying the importance or ranking order of the given alert within the country/region it has originated. A lower number signifies a higher priority. For example, 1 is the highest priority. The number varies by country/region and can change over time as each country/region evolves their alert systems. ,
Format: int32 ,
Required: False ,
}
integer ,
class:
{
Description: Classification of the alert. This field is not available for all countries and therefore not always returned. ,
Required: False ,
}
string ,
level:
{
Description: Severity level of the alert. This field is not available for all countries and therefore not always returned. ,
Required: False ,
}
string ,
source:
{
Description: The provider of the alert information. By default the source is returned in English (en-US). The alerts are from official Government Meteorological Agencies and leading global weather alert providers. ,
Required: False ,
}
string ,
sourceId:
{
Description: A numerical identifier associated with the source provider name of the alert data. ,
Format: int32 ,
Required: False ,
}
integer ,
disclaimer:
{
Description: A disclaimer regarding the source of the alert information. This field is not always available. For example, disclaimer may include details about the delays or potential issues related to the alarm. ,
Required: False ,
}
string ,
alertAreas:
{
Description: Information about the alert specific to the affected area(s). ,
Required: False ,
}
[
{
name:
{
Description: The name of an area which is affected by the alert. The location that was requested falls under the alert area. ,
Required: False ,
}
string ,
summary:
{
Description: Text summarizing the alert in the returned area. ,
Required: False ,
}
string ,
startTime:
{
Description: The start date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. If the alert crosses multiple time zones the returned time in the response is the local time to the requested coordinate location. ,
Required: False ,
}
string ,
endTime:
{
Description: The end date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. If the alert crosses multiple time zones the returned time in the response is the local time to the requested coordinate location. ,
Required: False ,
}
string ,
latestStatus:
{
Description: The latest status of the alert in the current area. ,
Required: False ,
}
{
localized:
{
Description: The latest status keyword for the alert, in the specified language. By default, returned in English (en-US). ,
Required: False ,
}
string ,
english:
{
Description: Latest status keyword for the alert, in English (en-US). ,
Enum:
{
New: "New" - the status of an alert upon initial issuance. ,
Extend: "Extend" - the alert has been extended in time, in area, or both since its initial issuance. ,
Cancel: "Cancel" - the alert has been canceled prior to its original expiration time. ,
Correct: "Correct" - the alert has been modified to correct a previous error. ,
Expire: "Expire" - the alert has expired and is no longer active. ,
Upgrade: "Upgrade" - the alert has been upgraded to a higher class or category since its initial issuance. ,
Continue: "Continue" - the alert has been updated since its initial issuance, but no changes were made to `alertAreas`, `startTime`, `endTime`, or `class`. ,
Update: "Update" - the alert has been updated since its initial issuance. ,
}
,
Required: False ,
}
enum ,
}
,
alertDetails:
{
Description: Full details associated with the alert. Returned if `details`=True. This field is always returned in the language(s) of choice by the issuing provider and Azure Maps only returns what is created by the provider. Please note, some countries/regions may offer their native language and English. Language parameter won’t apply to this field. ,
Required: False ,
}
string ,
alertDetailsLanguageCode:
{
Description: Language of the `alertDetails`. This field helps to point out that the language of the `alertDetails` may differ from the requested language parameter. Returned if `details`=True. Language code has been derived from the ISO 639-1 Alpha-2 codes. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Weather_GetDailyIndices (removed)
Description :  **Get Daily Indices** **Applies to**: S0 and S1 pricing tiers. There may be times when you want to know if the weather conditions are optimal for a specific activity, for example, for outdoor construction, indoor activities, running or farming including soil moisture information. Azure Maps Indices API returns index values that will guide end users to plan future activities. For example, a health mobile application can notify users that today is good weather for running or for other outdoors activities like for playing golf, and retail stores can optimize their digital marketing campaigns based on predicted index values. The service returns in daily indices values for current and next 5, 10 and 15 days starting from current day.
Reference :  Link ¶

⚼ Request

GET:  /weather/indices/daily/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: Coordinates of the location for which daily indices are requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". ,
Required: True ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Default value is en-us. Please refer to [Supported languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
duration:
{
Description: Specifies for how many days the daily indices are returned. By default, the indices data for the current day will be returned. When requesting future indices data, the current day is included in the response as day 1. Available values are * `1` - Return daily index data for the current day. Default value. * `5` - Return 5 days of daily index data starting from the current day. * `10` - Return 10 days of daily index data starting from the current day. * `15` - Return 15 days of daily index data starting from the current day. ,
Required: False ,
}
integer ,
indexId:
{
Description: Numeric index identifier that can be used for restricting returned results to the corresponding index type. Cannot be paired with `indexGroupId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported indices. ,
Required: False ,
}
integer ,
indexGroupId:
{
Description: Numeric index group identifier that can be used for restricting returned results to the corresponding subset of indices (index group). Cannot be paired with `indexId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index groups. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
results:
{
Description: A list of all daily indices for the queried location. ,
Required: False ,
}
[
{
indexName:
{
Description: Name of the index, for example, "Construction", "Outdoor Activity", "Flight Delays". ,
Required: False ,
}
string ,
indexId:
{
Description: Numeric ID used to identify the specific index. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index IDs. For example, the index ID can support UI visualization scenarios. ,
Format: int32 ,
Required: False ,
}
integer ,
dateTime:
{
Description: Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Required: False ,
}
string ,
value:
{
Description: Index value. Ranges from 0.0 to 10.0. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported ranges. ,
Format: float ,
Required: False ,
}
number ,
category:
{
Description: Textual description for `categoryValue` corresponding to the level that the index value falls under, for example "Very Good". ,
Required: False ,
}
string ,
categoryValue:
{
Description: Level that the index value falls under, represented by an integer. This value can be 1 through 5 and should be used in combination with the `ascending` flag because it can differ among indices. For example, the following values apply for Mosquito Activity: Low=1, Moderate=2, High=3, Very High=4, and Extreme=5. ,
Format: int32 ,
Required: False ,
}
integer ,
ascending:
{
Description: Describes the direction of the `value` and `categoryValue`. For example, when `ascending`=True, the poorest index value is 0 and the best index value is 10. When `ascending`=True, the poorest index value is 10 and the best index value is 0. ,
Required: False ,
}
boolean ,
description:
{
Description: A textual explanation that can be used for display purposes to summarize the index value and category. For example, when the index value for Flight Delays is very good, the description will be "Conditions are excellent for flying!". ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}