Weather - Get Minute Forecast

Används för att få en minut-för-minut-prognos för de kommande 120 minuterna i intervaller om 1, 5 och 15 minuter.
API:et Get Minute Forecast är en HTTP-begäran GET som returnerar prognoser minut för minut för en viss plats under de kommande 120 minuterna. Användare kan begära väderprognoser i intervaller om 1, 5 och 15 minuter. Svaret kommer att innehålla detaljer som typen av nederbörd (inklusive regn, snö eller en blandning av båda), starttid och värde för nederbördsintensitet (dBZ). Mer information finns i Begära väderprognosdata minut för minut.

GET {endpoint}/weather/forecast/minute/json?api-version=1.1&query={query}
GET {endpoint}/weather/forecast/minute/json?api-version=1.1&query={query}&interval={interval}&language={language}

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
path True

string (uri)

Azure Maps-tjänstens värdnamn. Använd https://atlas.microsoft.com för Azure publika molnet. För att rikta in dig på en specifik Azure Maps geografi eller ett suveränt moln, se Azure Maps geografisk omfattning.

format
path True

JsonFormat

Önskat format för svaret. Endast json format stöds.

api-version
query True

string

minLength: 1

Den API-version som ska användas för den här åtgärden.

query
query True

number[]

Den tillämpliga frågan som anges som en kommaavgränsad sträng som består av latitud följt av longitud, t.ex. "47.641268,-122.125679".

Väderinformation är i allmänhet tillgänglig för platser på land, vattendrag omgivna av land och områden i havet som ligger inom cirka 50 nautiska mil från en kustlinje.

interval
query

integer (int32)

Anger tidsintervall i minuter för den returnerade väderprognosen. Värden som stöds är

  • 1 - Hämta prognos för 1-minutsintervaller. Returneras som standard.
  • 5 - Hämta prognoser för 5-minutersintervaller.
  • 15 - Hämta prognoser för 15-minutersintervaller.
language
query

string

Språk där sökresultat ska returneras. Bör vara en av IETF-språktaggar som stöds, skiftlägesokänsliga. När data på angivet språk inte är tillgängliga för ett visst fält används standardspråket.

Mer information finns i språk som stöds.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-id

string

Anger vilket konto som är avsett för användning med Microsoft Entra ID-säkerhetsmodellen. Detta unika ID för Azure Maps-kontot kan erhållas från Azure Maps Management Plane Account API. För mer information om hur man använder Microsoft Entra ID säkerhet i Azure Maps, se Hantera autentisering i Azure Maps.

Svar

Name Typ Description
200 OK

MinuteForecastResult

Begäran har slutförts.

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

AadToken

Dessa är Microsoft Entra OAuth 2.0 flöden. När den kombineras med Azure rollbaserad åtkomst kontroll kan den användas för att kontrollera åtkomst till Azure Maps REST-API:er. Azure:s rollbaserade åtkomstkontroller används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller delresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Note

  • Den här säkerhetsdefinitionen kräver användningen av x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et.
  • Authorization URL är specifik för den offentliga Azure-molninstansen. Suveräna moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer.
  • Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
  • Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
  • Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

subscription-key

Det här är en delad nyckel som etableras när du Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST API:er. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de har utfärdats i.

För offentligt exponerade program rekommenderar vi att du använder konfidentiella klientprogram metod för åtkomst till Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Typ: apiKey
I: header

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll till förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på Map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Successfully retrieve minute-by-minute forecasts for a given location

Exempelbegäran

GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query=47.632346,-122.138874&interval=15

Exempelsvar

{
  "intervalSummaries": [
    {
      "briefPhrase": "Rain ending in %minute_value min",
      "endMinute": 24,
      "iconCode": 12,
      "longPhrase": "Rain ending in %minute_value min",
      "shortPhrase": "Rain ending in %minute_value min",
      "startMinute": 0,
      "totalMinutes": 25
    },
    {
      "briefPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "endMinute": 119,
      "iconCode": 7,
      "longPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "shortPhrase": "No precip for %MINUTE_VALUE min",
      "startMinute": 25,
      "totalMinutes": 95
    }
  ],
  "intervals": [
    {
      "cloudCover": 100,
      "color": {
        "blue": 2,
        "green": 98,
        "hex": "#086202",
        "red": 8
      },
      "dbz": 23,
      "iconCode": 12,
      "minute": 0,
      "precipitationType": "Rain",
      "shortPhrase": "Light Rain",
      "simplifiedColor": {
        "blue": 39,
        "green": 190,
        "hex": "#23BE27",
        "red": 35
      },
      "startTime": "2019-11-14T15:18:00-08:00",
      "threshold": "LIGHT"
    },
    {
      "cloudCover": 100,
      "color": {
        "blue": 9,
        "green": 133,
        "hex": "#208509",
        "red": 32
      },
      "dbz": 18,
      "iconCode": 12,
      "minute": 15,
      "precipitationType": "Rain",
      "shortPhrase": "Light Rain",
      "simplifiedColor": {
        "blue": 39,
        "green": 190,
        "hex": "#23BE27",
        "red": 35
      },
      "startTime": "2019-11-14T15:33:00-08:00",
      "threshold": "LIGHT"
    },
    {
      "cloudCover": 100,
      "dbz": 0,
      "iconCode": 7,
      "minute": 30,
      "shortPhrase": "No Precipitation",
      "startTime": "2019-11-14T15:48:00-08:00"
    },
    {
      "cloudCover": 100,
      "dbz": 0,
      "iconCode": 7,
      "minute": 45,
      "shortPhrase": "No Precipitation",
      "startTime": "2019-11-14T16:03:00-08:00"
    },
    {
      "cloudCover": 100,
      "dbz": 0,
      "iconCode": 7,
      "minute": 60,
      "shortPhrase": "No Precipitation",
      "startTime": "2019-11-14T16:18:00-08:00"
    },
    {
      "cloudCover": 100,
      "dbz": 0,
      "iconCode": 7,
      "minute": 75,
      "shortPhrase": "No Precipitation",
      "startTime": "2019-11-14T16:33:00-08:00"
    },
    {
      "cloudCover": 100,
      "dbz": 0,
      "iconCode": 7,
      "minute": 90,
      "shortPhrase": "No Precipitation",
      "startTime": "2019-11-14T16:48:00-08:00"
    },
    {
      "cloudCover": 100,
      "dbz": 0,
      "iconCode": 7,
      "minute": 105,
      "shortPhrase": "No Precipitation",
      "startTime": "2019-11-14T17:03:00-08:00"
    }
  ],
  "summary": {
    "briefPhrase": "Rain ending in 25 min",
    "briefPhrase60": "Rain ending in 25 min",
    "iconCode": 12,
    "longPhrase": "Rain ending in 25 min",
    "shortPhrase": "Rain ending in 25 min"
  }
}

Definitioner

Name Description
ColorValue

En RGB-färg, återgiven i både komponentform (red, green, ) blueoch hexadecimal (hex) form. Används av minut-för-minut-prognosen för att rendera varje intervall på en radarliknande display – se ForecastInterval.color för fullspektrumfärgen som mappas till dbz, och ForecastInterval.simplifiedColor för den grövre färgen härledd från precipitationType och threshold. För de underliggande färgmappningarna, se Vädertjänster i Azure Maps.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Detaljerna om felet.

ErrorResponse

Vanligt felsvar för alla Azure Resource Manager API:er för att returnera feldetaljer vid misslyckade operationer. (Detta följer även formatet för OData-felsvar.).

ForecastInterval

Representerar ett enda tidssnitt inom en minut-för-minut-prognos, som beskriver de förväntade väderförhållandena under det intervallet. Varje intervall täcker 1, 5 eller 15 minuter – beroende på önskad upplösning – och inkluderar starttid, nederbördsintensitet (dbz), nederbördstyp och tröskel, en kort beskrivande fras, en ikonkod, molntäcke samt fullspektrum- och förenklade färger som används för att visuellt representera förhållandena på en radarliknande display.

IconCode

Den numeriska väderkoden som identifierar vilken ikon som ska visas. Varje värde i denna uppräkning motsvarar en Azure Maps-väderikon (såsom Sunny, Cloudy eller Thunderweathers) och paras ihop med en människoläsbar symbol iconPhrase som returneras tillsammans med den. Samma kod kan förekomma i aktuella, timvisa, dagliga, kvartsdags- och minut-för-minut-svar, vilket gör att applikationer kan visa en konsekvent ikon som är inställd över alla vädertjänster.

För den kompletta listan över koder, ikonerna de mappar till och exempelbilder, se Weather services i Azure Maps.

IntervalSummary

Beskriver väderprognosen för ett sammanhängande fönster i minut-för-minut-prognosen – vanligtvis en period med liknande förhållanden, som regn som slutar om 25 minuter eller lätt snö som börjar om 10 minuter. Varje sammanfattning specificerar fönstret i minuter från prognosens start (startMinute, , ), totalMinutestillhandahåller frasbeskrivningar i tre längder (kort, kort och lång) så att lämplig detaljnivå kan visas för det tillgängliga UI-utrymmet, och inkluderar en iconCode för den representativa endMinuteväderikonen. A returnerar MinuteForecastResult en eller flera IntervalSummary poster som tillsammans täcker prognosperioden.

JsonFormat

Önskat format för svaret. Endast json format stöds.

MinuteForecastResult

Svaret returnerades av Get Minute Forecast-operationen, som gav en minut-för-minut nederbördsprognos för en specificerad plats under de kommande 120 minuterna med önskad upplösning (1, 5 eller 15 minuter). Svaret är organiserat i tre lager: ett övergripande summary lager med frasbeskrivningar och en representativ ikon för hela perioden; en intervalSummaries array som grupperar sammanhängande minuter i längre perioder med liknande förhållanden (såsom regn som slutar om 25 minuter); och en intervals array som innehåller detaljerade prognospunkter per minut, inklusive nederbördsintensitet (dbz), nederbördstyp, molntäcke och färger som används för att återge radarliknande visualiseringar.

MinuteForecastSummary

Tillhandahåller sammanfattningar som beskriver nederbördsprognosen för den kommande minut-för-minut-prognosperioden. Flera fraslängder ingår – kort (~25 tecken), kort (~60 tecken) och lång (60+ tecken) – så att applikationer kan visa den detaljnivå som bäst passar det tillgängliga UI-utrymmet. An iconCode anger den representativa väderikonen för perioden.

PrecipitationType

Anger typen av nederbörd. Giltiga värden är Regn,Snö, Is eller Blandning. Den här egenskapen ingår i svaret när dBZ är större än noll.

ColorValue

En RGB-färg, återgiven i både komponentform (red, green, ) blueoch hexadecimal (hex) form. Används av minut-för-minut-prognosen för att rendera varje intervall på en radarliknande display – se ForecastInterval.color för fullspektrumfärgen som mappas till dbz, och ForecastInterval.simplifiedColor för den grövre färgen härledd från precipitationType och threshold. För de underliggande färgmappningarna, se Vädertjänster i Azure Maps.

Name Typ Description
blue

integer (int32)

Blå komponent av RGB-värdet. Giltiga värden varierar från 0 till 255.

green

integer (int32)

Grön komponent i RGB-värdet. Giltiga värden varierar från 0 till 255.

hex

string

Samma färg som en hexadecimal RGB-sträng med prefix – # till exempel #FF0000 för rött.

red

integer (int32)

Röd komponent i RGB-värdet. Giltiga värden varierar från 0 till 255.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

Ytterligare information.

type

string

Ytterligare informationstyp.

ErrorDetail

Detaljerna om felet.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Vanligt felsvar för alla Azure Resource Manager API:er för att returnera feldetaljer vid misslyckade operationer. (Detta följer även formatet för OData-felsvar.).

Name Typ Description
error

ErrorDetail

Felobjektet.

ForecastInterval

Representerar ett enda tidssnitt inom en minut-för-minut-prognos, som beskriver de förväntade väderförhållandena under det intervallet. Varje intervall täcker 1, 5 eller 15 minuter – beroende på önskad upplösning – och inkluderar starttid, nederbördsintensitet (dbz), nederbördstyp och tröskel, en kort beskrivande fras, en ikonkod, molntäcke samt fullspektrum- och förenklade färger som används för att visuellt representera förhållandena på en radarliknande display.

Name Typ Description
cloudCover

integer (int32)

Andelen av himlen täckt av moln under detta intervall, från 0 (klart) till 100 (moln). Kan vara NULL.

color

ColorValue

Den fullspektrumfärg som motsvarar dbz, används för att rendera detta intervall på en radarliknande display. Returneras endast när dbz är större än noll.

dbz

number (double)

Prognostiserad radarreflektivitet i decibel relativt Z (dBZ), använd som mått på nederbördsintensitet. Högre värden indikerar tyngre nederbörd; ett värde på 0 indikerar ingen nederbörd.

iconCode

IconCode

Den representativa väderikonkoden för detta intervall. Det numeriska värdet motsvarar en Azure Maps-väderikon – för den kompletta listan, se Vädertjänster i Azure Maps.

minute

integer (int32)

Början av detta prognosintervall uttrycks som ett antal minuter från prognosens början (minut 0). Parar med startTime och matchar startMinute fältet på motsvarande IntervalSummary.

precipitationType

PrecipitationType

Den typ av nederbörd som förväntas under denna period – regn,snö,is eller blandning. Returneras endast när dbz är större än noll.

shortPhrase

string

En kort fras som beskriver nederbördsförhållandena under detta intervall (till exempel lätt regn). Upp till ungefär 25 tecken.

simplifiedColor

ColorValue

En förenklad färg härledd från precipitationType och threshold, lämplig för användargränssnitt som kräver snabba, lättlästa radarvisualiseringar istället för hela dBZ-färgspektrumet. Returneras endast när dbz är större än noll.

startTime

string (date-time)

Början av detta prognosintervall, i RFC 3339-format (yyyy-mm-ddThh:mm:ss±hh:mm). Till exempel, 2019-11-14T15:18:00-08:00.

threshold

string

Den intensitetshink som nederbörden faller i för strömmen precipitationType – till exempel lätt, måttlig eller tung. Används med precipitationType för att bestämma simplifiedColor. Returneras endast när dbz är större än noll.

IconCode

Den numeriska väderkoden som identifierar vilken ikon som ska visas. Varje värde i denna uppräkning motsvarar en Azure Maps-väderikon (såsom Sunny, Cloudy eller Thunderweathers) och paras ihop med en människoläsbar symbol iconPhrase som returneras tillsammans med den. Samma kod kan förekomma i aktuella, timvisa, dagliga, kvartsdags- och minut-för-minut-svar, vilket gör att applikationer kan visa en konsekvent ikon som är inställd över alla vädertjänster.

För den kompletta listan över koder, ikonerna de mappar till och exempelbilder, se Weather services i Azure Maps.

Värde Description
1

Sunny

2

Mestadels soligt

3

Delvis soligt

4

Tillfälliga moln

5

Disigt solsken

6

Mestadels molnigt

7

Cloudy

8

Trist (mulet)

11

Dimma

12

Showers

13

Mestadels molnigt med duschar

14

Delvis soligt med skurar

15

Thunderstorms

16

Mestadels molnigt med åskväder

17

Delvis soligt med åskväder

18

Regn

19

Flurries

20

Mestadels molnigt med flurries

21

Delvis soligt med flurries

22

Snow

23

Mestadels molnigt med snö

24

Is

25

Slask

26

Underkylt regn

29

Regn och snö

30

Hot

31

Kall

32

Windy

33

Klar

34

Mestadels klart

35

Delvis molnigt

36

Tillfälliga moln

37

Disigt månsken

38

Mestadels molnigt

39

Delvis molnigt med duschar

40

Mestadels molnigt med duschar

41

Delvis molnigt med åskväder

42

Mestadels molnigt med åskväder

43

Mestadels molnigt med flurries

44

Mestadels molnigt med snö

IntervalSummary

Beskriver väderprognosen för ett sammanhängande fönster i minut-för-minut-prognosen – vanligtvis en period med liknande förhållanden, som regn som slutar om 25 minuter eller lätt snö som börjar om 10 minuter. Varje sammanfattning specificerar fönstret i minuter från prognosens start (startMinute, , ), totalMinutestillhandahåller frasbeskrivningar i tre längder (kort, kort och lång) så att lämplig detaljnivå kan visas för det tillgängliga UI-utrymmet, och inkluderar en iconCode för den representativa endMinuteväderikonen. A returnerar MinuteForecastResult en eller flera IntervalSummary poster som tillsammans täcker prognosperioden.

Name Typ Description
briefPhrase

string

En kort fras som beskriver nederbördsförhållandena under denna period. Upp till 60 tecken.

endMinute

integer (int32)

Den sista minuten av detta intervall, uttryckt som ett antal minuter från prognosens början (minut 0).

iconCode

IconCode

Den representativa väderikonkoden för detta intervall. Det numeriska värdet motsvarar en Azure Maps-väderikon – för den kompletta listan, se Vädertjänster i Azure Maps.

longPhrase

string

En lång fras som beskriver nederbördsförhållandena under denna period. Stöder mer än 60 tecken.

shortPhrase

string

En kort fras som beskriver nederbördsförhållandena under denna period. Upp till 25 tecken.

startMinute

integer (int32)

Den första minuten av detta intervall, uttryckt som ett antal minuter från prognosens början (minut 0).

totalMinutes

integer (int32)

Längden på detta intervall, i minuter (endMinute - startMinute + 1).

JsonFormat

Önskat format för svaret. Endast json format stöds.

Värde Description
json

JavaScript-objekt notationens datautbytesformat

MinuteForecastResult

Svaret returnerades av Get Minute Forecast-operationen, som gav en minut-för-minut nederbördsprognos för en specificerad plats under de kommande 120 minuterna med önskad upplösning (1, 5 eller 15 minuter). Svaret är organiserat i tre lager: ett övergripande summary lager med frasbeskrivningar och en representativ ikon för hela perioden; en intervalSummaries array som grupperar sammanhängande minuter i längre perioder med liknande förhållanden (såsom regn som slutar om 25 minuter); och en intervals array som innehåller detaljerade prognospunkter per minut, inklusive nederbördsintensitet (dbz), nederbördstyp, molntäcke och färger som används för att återge radarliknande visualiseringar.

Name Typ Description
intervalSummaries

IntervalSummary[]

Sammanfattningar som delar in prognosfönstret i en eller flera sammanhängande sträckor med liknande förhållanden – till exempel regn som slutar om 25 minuter följt av delvis molnigt. Varje post anger vilka minuter den täcker (startMinute, , endMinute, totalMinutes), innehåller korta, korta och långa frasvarianter samt inkluderar en iconCode för uppsatsen. Tillsammans täcker dessa sammanfattningar hela prognosperioden.

intervals

ForecastInterval[]

De detaljerade prognospunkterna per steg som utgör minut-för-minut-prognosen. Varje ForecastInterval täcker 1, 5 eller 15 minuter – beroende på önskad upplösning – och rapporterar starttid, nederbördsintensitet (dbz), nederbördstyp och tröskel, en kort beskrivande fras, en ikonkod, molntäcke och färgerna som används för att återge en radarliknande display.

summary

MinuteForecastSummary

Sammanfattningar på toppnivå som beskriver nederbördsprognosen för hela det ~120-minuters prognosfönstret. Inkluderar korta, korta och långa varianter så att lämplig detaljnivå kan visas för det tillgängliga UI-utrymmet, plus en representant iconCode för perioden.

MinuteForecastSummary

Tillhandahåller sammanfattningar som beskriver nederbördsprognosen för den kommande minut-för-minut-prognosperioden. Flera fraslängder ingår – kort (~25 tecken), kort (~60 tecken) och lång (60+ tecken) – så att applikationer kan visa den detaljnivå som bäst passar det tillgängliga UI-utrymmet. An iconCode anger den representativa väderikonen för perioden.

Name Typ Description
briefPhrase

string

En kort fras som beskriver nederbördsprognosen för hela ~120-minutersprognosen. Upp till ungefär 60 tecken.

briefPhrase60

string

En kort fras som beskriver nederbördsprognosen för de kommande 60 minuterna endast (ett kortare fönster än de andra fraserna på detta objekt). Upp till ungefär 60 tecken.

iconCode

IconCode

En representativ väderikonkod för hela ~120-minutersprognosfönstret. Det numeriska värdet motsvarar en Azure Maps-väderikon – för den kompletta listan, se Vädertjänster i Azure Maps.

longPhrase

string

En lång fras som beskriver nederbördsprognosen för hela ~120-minutersprognosen. Stöder mer än 60 tecken.

shortPhrase

string

En kort fras som beskriver nederbördsprognosen för hela ~120-minutersprognosen. Upp till ungefär 25 tecken.

PrecipitationType

Anger typen av nederbörd. Giltiga värden är Regn,Snö, Is eller Blandning. Den här egenskapen ingår i svaret när dBZ är större än noll.

Värde Description
Ice

Is

Mix

Mix

Rain

Regn

Snow

Snow