Weather - Get Daily Indices
Verwenden Sie diese Option, wenn Sie wissen möchten, ob die Wetterbedingungen für eine bestimmte Aktivität optimal sind, z. B. für sportliche Aktivitäten im Freien, auf dem Bau oder in der Landwirtschaft (die Ergebnisse enthalten Informationen zur Bodenfeuchtigkeit).
Bei der Get Daily Indices API handelt es sich um eine HTTP-Anforderung GET , die Indexwerte zurückgibt, die bei der Planung zukünftiger Aktivitäten hilfreich sind. Beispielsweise kann eine mobile Gesundheitsanwendung Benutzer darüber informieren, dass heute gutes Wetter zum Laufen oder für andere Outdoor-Aktivitäten wie Golfspielen oder Drachensteigen ist. Einzelhandelsgeschäfte können ihre digitalen Marketingkampagnen auf der Grundlage von prognostizierten Indexwerten optimieren.
Der Dienst gibt tägliche Indizes für den aktuellen und die nächsten 5, 10 und 15 Tage ab dem aktuellen Tag zurück.
GET {endpoint}/weather/indices/daily/json?api-version=1.1&query={query}
GET {endpoint}/weather/indices/daily/json?api-version=1.1&query={query}&language={language}&duration={duration}&indexId={indexId}&indexGroupId={indexGroupId}
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Der Hostname des Azure Maps-Dienstes. Verwenden Sie |
|
format
|
path | True |
Gewünschtes Format der Antwort. Nur |
|
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
|
query
|
query | True |
number[] |
Die entsprechende Abfrage, die als kommagetrennte Zeichenfolge angegeben wird, die durch Breitengrad und Längengrad besteht, z. B. "47.641268,-122.125679". Wetterinformationen sind in der Regel für Orte an Land, von Land umgebene Gewässer und Bereiche des Ozeans verfügbar, die sich innerhalb von etwa 50 Seemeilen um eine Küste befinden. |
|
duration
|
query |
integer (int32) |
Gibt an, für wie viele Tage die täglichen Indizes zurückgegeben werden. Standardmäßig werden die Indexdaten für den aktuellen Tag zurückgegeben. Bei der Abfrage von Daten zu Future-Indizes wird der aktuelle Tag als Tag 1 in die Antwort einbezogen. Verfügbare Werte sind
|
|
|
index
|
query |
integer (int32) |
Numerischer Indexgruppenbezeichner, der verwendet werden kann, um zurückgegebene Ergebnisse auf die entsprechende Teilmenge von Indizes (Indexgruppe) einzuschränken. Kann nicht mit gekoppelt werden |
|
|
index
|
query |
integer (int32) |
Numerischer Indexbezeichner, der zum Einschränken zurückgegebener Ergebnisse auf den entsprechenden Indextyp verwendet werden kann. Kann nicht mit gekoppelt werden |
|
|
language
|
query |
string |
Sprache, in der Suchergebnisse zurückgegeben werden sollen. Sollte eine der unterstützten IETF-Sprachtags sein, Groß-/Kleinschreibung wird nicht beachtet. Wenn Daten in der angegebenen Sprache für ein bestimmtes Feld nicht verfügbar sind, wird die Standardsprache verwendet. Weitere Informationen finden Sie unter unterstützten Sprachen. |
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| x-ms-client-id |
string |
Gibt das Konto an, das für die Nutzung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Diese eindeutige ID für das Azure Maps-Konto kann aus der Azure Maps Management-Plane-Konto-API abgerufen werden. Weitere Informationen zur Nutzung Microsoft Entra ID Sicherheit in Azure Maps finden Sie unter Authentifizierung verwalten in Azure Maps. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Die Anforderung ist erfolgreich. |
|
| Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
AadToken
Dies sind die Microsoft Entra OAuth 2.0 Flows. In Kombination mit Azure rollenbasierten Zugriffs Steuerung kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Azure-rollenbasierte Zugriffskontrollen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.
Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.
Note
- Diese Sicherheitsdefinition erfordert die Verwendung des
x-ms-client-id-Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Karten-Verwaltungs-APIerworben werden. - Die
Authorization URList spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über einzigartige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen. - Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
- Die Verwendung des Azure Maps Web SDK ermöglicht das konfigurationsbasierte Einrichten einer Anwendung für mehrere Anwendungsfälle.
- Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die Microsoft Identity Platform.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Dies ist ein freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.
Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.
Typ:
apiKey
In:
header
SAS Token
Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.
Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und feinkörniger Kontrolle auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token autorisiert. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen das Steuern des Zugriffs auf eine sicherere Weise zu ermöglichen als der freigegebene Schlüssel.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge auf der Zuordnungskontoressource zu konfigurieren,, um das Rendern von Missbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.
Typ:
apiKey
In:
header
Beispiele
Successfully retrieve daily indices values from current day
Beispielanforderung
GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query=43.84745,-79.37849&indexGroupId=11
Beispiel für eine Antwort
{
"results": [
{
"description": "This is an excellent day for outdoor running!",
"ascending": true,
"category": "Excellent",
"categoryValue": 5,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 1,
"indexName": "Running Forecast",
"value": 9.2
},
{
"description": "Conditions are excellent for jogging outdoors!",
"ascending": true,
"category": "Excellent",
"categoryValue": 5,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 2,
"indexName": "Jogging Forecast",
"value": 9.4
},
{
"description": "Conditions are excellent for hiking!",
"ascending": true,
"category": "Excellent",
"categoryValue": 5,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 3,
"indexName": "Hiking Forecast",
"value": 9.8
},
{
"description": "Conditions are excellent for bicycling outdoors!",
"ascending": true,
"category": "Excellent",
"categoryValue": 5,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 4,
"indexName": "Bicycling Forecast",
"value": 9.9
},
{
"description": "This is a great day for golf.",
"ascending": true,
"category": "Excellent",
"categoryValue": 5,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 5,
"indexName": "Golf Weather Forecast",
"value": 10
},
{
"description": "This is an excellent day for playing tennis!",
"ascending": true,
"category": "Excellent",
"categoryValue": 5,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 6,
"indexName": "Tennis Forecast",
"value": 9.2
},
{
"description": "This is an excellent day for skateboarding!",
"ascending": true,
"category": "Excellent",
"categoryValue": 5,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 7,
"indexName": "Skateboarding Forecast",
"value": 9.9
},
{
"description": "Conditions are excellent for attending an outdoor concert!",
"ascending": true,
"category": "Excellent",
"categoryValue": 5,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 8,
"indexName": "Outdoor Concert Forecast",
"value": 9.7
},
{
"description": "Conditions are very good today for kite-flying.",
"ascending": true,
"category": "Very Good",
"categoryValue": 4,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 9,
"indexName": "Kite Flying Forecast",
"value": 8.5
},
{
"description": "Conditons will be very good for a visit to the beach or pool.",
"ascending": true,
"category": "Very Good",
"categoryValue": 4,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 10,
"indexName": "Beach & Pool Forecast",
"value": 8.6
},
{
"description": "Conditions will be very good for sailing.",
"ascending": true,
"category": "Very Good",
"categoryValue": 4,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 11,
"indexName": "Sailing Forecast",
"value": 8.3
},
{
"description": "This is a great night to be stargazing!",
"ascending": true,
"category": "Excellent",
"categoryValue": 5,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 12,
"indexName": "Stargazing Forecast",
"value": 9.5
},
{
"description": "Expect only fair conditions for fishing.",
"ascending": true,
"category": "Fair",
"categoryValue": 2,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 13,
"indexName": "Fishing Forecast",
"value": 3.5
},
{
"description": "Expect poor conditions for skiing.",
"ascending": true,
"category": "Poor",
"categoryValue": 1,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 15,
"indexName": "Ski Weather Forecast",
"value": 0
},
{
"description": "The weather is favorable for a very high level of mosquito activity. Plan activities and insect repellents accordingly.",
"ascending": true,
"category": "Very High",
"categoryValue": 4,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 17,
"indexName": "Mosquito Activity Forecast",
"value": 7
},
{
"description": "Expect only fair conditions for hunting.",
"ascending": true,
"category": "Fair",
"categoryValue": 2,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 20,
"indexName": "Hunting Forecast",
"value": 4.5
},
{
"description": "This is a great day for an outdoor barbecue!",
"ascending": true,
"category": "Excellent",
"categoryValue": 5,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 24,
"indexName": "Outdoor Barbecue",
"value": 9.8
},
{
"description": "This is a great day for lawn mowing!",
"ascending": true,
"category": "Excellent",
"categoryValue": 5,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 28,
"indexName": "Lawn Mowing Forecast",
"value": 9.6
},
{
"description": "Conditions will be very good for outdoor activities.",
"ascending": true,
"category": "Very Good",
"categoryValue": 4,
"dateTime": "2020-07-14T07:00:00-04:00",
"indexId": 29,
"indexName": "Outdoor Activity Forecast",
"value": 8.7
}
]
}
Definitionen
| Name | Beschreibung |
|---|---|
|
Daily |
Eine einzelne Indexbewertung im |
|
Daily |
Die Antwort wurde von der Get Daily Indices-Operation zurückgegeben, die Aktivitäten-Eignungsbewertungen für den angegebenen Standort lieferte. Das |
|
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
|
Error |
Das Fehlerdetails. |
|
Error |
Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.) |
|
Json |
Gewünschtes Format der Antwort. Nur |
DailyIndex
Eine einzelne Indexbewertung im DailyIndicesResult.results Array, der bewertet, wie gut die Wetterbedingungen eines Tages für eine bestimmte Outdoor-Aktivität wie Laufen, Golfen, Drachensteigen oder Grillen geeignet sind. Jeder Eintrag enthält den Namen der Aktivität (zum Beispiel Skiwettervorhersage), das Datum, auf das er zutrifft, eine Zahl value von 0,0 bis 10,0, ein passendes qualitatives category Label (zum Beispiel Schlecht) und eine Übersicht description der Bedingungen (zum Beispiel Erwarten Sie schlechte Bedingungen beim Skifahren). Eine Antwort kann viele Einträge enthalten – einen pro Tag pro Index –, die jeden Tag im angeforderten duration und jedem gewünschten Index abdecken.
| Name | Typ | Beschreibung |
|---|---|---|
| ascending |
boolean |
Gibt an, welches Ende der0,0-10,0-Skala
Verwenden Sie diese Flagge beim Vergleich |
| category |
string |
Ein kurzes qualitatives Etikett, das |
| categoryValue |
integer (int32) |
Eine numerische Bewertung von 1 bis 5, die mit
|
| dateTime |
string (date-time) |
Das Datum, auf das der Index gilt, wird als Mitternachtszeit Ortszeit am Vorhersageort im ISO-8601-Format angegeben (yyyy-mm-ddThh:mm:ss±hh:mm) – zum Beispiel 2020-07-14T07:00:00-04:00. Die Zeitkomponente ist immer 00:00:00 im lokalen Versatz des Ortes; behandeln Sie dies als den Kalendertag, den die |
| description |
string |
Eine kurze, für Menschen lesbare Erklärung der Bewertung für diesen Tag, geeignet für die Anzeige in einer Benutzeroberfläche – zum Beispiel: Dies ist ein ausgezeichneter Tag zum Outdoor-Laufen!, Dies ist ein großartiger Tag für Golf, oder Die Bedingungen sind heute sehr gut fürs Drachensteigen. Zurückgegeben in der in der Anfrage angegebenen Sprache. |
| indexId |
integer (int32) |
Die numerische Identifikatorin des Indexes, geeignet für stabile, sprachunabhängige Abfrage der Aktivität, die mit |
| indexName |
string |
Der Anzeigename des Indexes, der die Aktivität oder den Zustand kennzeichnet, den er bewertet – zum Beispiel Laufvorhersage, Golfwettervorhersage, Drachenflugvorhersage oder Strand- und Schwimmbadvorhersage. In der in der Anfrage angegebenen Sprache zurückgegeben. Für die vollständige Liste der unterstützten Indizes siehe Index-IDs im Artikel Weather Services in Azure Maps Konzepte. |
| value |
number (float) |
Der numerische Eignungswert für die Aktivität an diesem Tag liegt zwischen 0,0 und 10,0. Standardmäßig zeigt 10,0 die günstigsten Bedingungen an und 0,0 die am wenigsten günstigen, aber einige Indizes kehren die Skala um – prüfen |
DailyIndicesResult
Die Antwort wurde von der Get Daily Indices-Operation zurückgegeben, die Aktivitäten-Eignungsbewertungen für den angegebenen Standort lieferte. Das results Array enthält pro Tag einen DailyIndex Eintrag pro Index, der jeweils die Tageswetterbedingungen für eine Outdoor-Aktivität wie Laufen, Golfen, Drachensteigen oder Grillen bewertet.
| Name | Typ | Beschreibung |
|---|---|---|
| results |
Die täglichen Indexbewertungen für den angefragten Ort, in chronologischer Reihenfolge beginnend mit dem aktuellen Tag. Das Array enthält pro Tag einen |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
| Name | Typ | Beschreibung |
|---|---|---|
| info |
Die zusätzlichen Informationen. |
|
| type |
string |
Der zusätzliche Informationstyp. |
ErrorDetail
Das Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Das Fehlerziel. |
ErrorResponse
Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerobjekt. |
JsonFormat
Gewünschtes Format der Antwort. Nur json Format wird unterstützt.
| Wert | Beschreibung |
|---|---|
| json |