Weather - Get Daily Indices
Verwenden Sie, wenn Sie wissen möchten, ob die Wetterbedingungen für eine bestimmte Aktivität wie Sport im Freien, Bau oder Landwirtschaft optimal sind (die Ergebnisse enthalten Informationen zur Bodenfeuchtigkeit).
Die Get Daily Indices
API ist eine HTTP-Anforderung GET
, die Indexwerte zurückgibt, die Bei der Planung zukünftiger Aktivitäten helfen. Beispielsweise kann eine mobile Gesundheitsanwendung Benutzer darüber informieren, dass heute gutes Wetter zum Laufen oder für andere Aktivitäten im Freien wie Golfspielen oder Drachenfliegen ist. Einzelhandelsgeschäfte können ihre digitalen Marketingkampagnen basierend auf vorhergesagten Indexwerten optimieren. Der Dienst gibt in täglichen Indizes Werte für den aktuellen und die nächsten 5, 10 und 15 Tage ab dem aktuellen Tag zurück.
GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query={query}
GET https://atlas.microsoft.com/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 |
---|---|---|---|---|
format
|
path | True |
Gewünschtes Format der Antwort. Nur das |
|
api-version
|
query | True |
string |
Versionsnummer der Azure Maps API. |
query
|
query | True |
number[] |
Die anwendbare Abfrage, die als kommagetrennte Zeichenfolge angegeben ist, die nach Breitengrad gefolgt von Längengrad besteht, z. B. "47.641268,-122.125679". |
duration
|
query |
integer |
Gibt an, wie viele Tage die täglichen Indizes zurückgegeben werden. Standardmäßig werden die Indizesdaten für den aktuellen Tag zurückgegeben. Beim Anfordern zukünftiger Indizesdaten wird der aktuelle Tag als Tag 1 in die Antwort einbezogen. Verfügbare Werte sind
|
|
index
|
query |
integer |
Numerischer Indexgruppenbezeichner, der zum Einschränken zurückgegebener Ergebnisse auf die entsprechende Teilmenge von Indizes (Indexgruppe) verwendet werden kann. Kann nicht mit |
|
index
|
query |
integer |
Numerischer Indexbezeichner, der zum Einschränken zurückgegebener Ergebnisse auf den entsprechenden Indextyp verwendet werden kann. Kann nicht mit |
|
language
|
query |
string |
Sprache, in der Suchergebnisse zurückgegeben werden sollen. Sollte eines der unterstützten IETF-Sprachtags sein, wobei die Groß-/Kleinschreibung nicht beachtet wird. 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ützte Sprachen . |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
x-ms-client-id |
string |
Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID Sicherheitsmodell vorgesehen ist. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der konto-API auf Azure Maps Verwaltungsebene abgerufen werden. Anleitungen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Ein unerwarteter Fehler ist aufgetreten. |
Sicherheit
AADToken
Dies sind die Microsoft Entra OAuth 2.0 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.
Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.
Hinweise
- 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 Kartenverwaltungs-API abgerufen werden.
Der Authorization URL
ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen.
* Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
* Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
- Weitere Informationen zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Dies ist ein gemeinsam genutzter Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal oder mithilfe von PowerShell, der CLI, Azure SDKs oder der REST-API Create.
Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.
Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen zu verwenden, um auf Azure Maps REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.
Type:
apiKey
In:
query
SAS Token
Hierbei handelt es sich um ein Shared Access Signature Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.
Mit diesem Token ist jede Anwendung autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.
Type:
apiKey
In:
header
Beispiele
Successfully retrieve daily indices values from current day
Sample Request
GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query=43.84745,-79.37849&indexGroupId=11
Sample Response
{
"results": [
{
"indexName": "Running Forecast",
"indexId": 1,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.2,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "This is an excellent day for outdoor running!"
},
{
"indexName": "Jogging Forecast",
"indexId": 2,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.4,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "Conditions are excellent for jogging outdoors!"
},
{
"indexName": "Hiking Forecast",
"indexId": 3,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.8,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "Conditions are excellent for hiking!"
},
{
"indexName": "Bicycling Forecast",
"indexId": 4,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.9,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "Conditions are excellent for bicycling outdoors!"
},
{
"indexName": "Golf Weather Forecast",
"indexId": 5,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 10,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "This is a great day for golf."
},
{
"indexName": "Tennis Forecast",
"indexId": 6,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.2,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "This is an excellent day for playing tennis!"
},
{
"indexName": "Skateboarding Forecast",
"indexId": 7,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.9,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "This is an excellent day for skateboarding!"
},
{
"indexName": "Outdoor Concert Forecast",
"indexId": 8,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.7,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "Conditions are excellent for attending an outdoor concert!"
},
{
"indexName": "Kite Flying Forecast",
"indexId": 9,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 8.5,
"category": "Very Good",
"categoryValue": 4,
"ascending": true,
"description": "Conditions are very good today for kite-flying."
},
{
"indexName": "Beach & Pool Forecast",
"indexId": 10,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 8.6,
"category": "Very Good",
"categoryValue": 4,
"ascending": true,
"description": "Conditons will be very good for a visit to the beach or pool."
},
{
"indexName": "Sailing Forecast",
"indexId": 11,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 8.3,
"category": "Very Good",
"categoryValue": 4,
"ascending": true,
"description": "Conditions will be very good for sailing."
},
{
"indexName": "Stargazing Forecast",
"indexId": 12,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.5,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "This is a great night to be stargazing!"
},
{
"indexName": "Fishing Forecast",
"indexId": 13,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 3.5,
"category": "Fair",
"categoryValue": 2,
"ascending": true,
"description": "Expect only fair conditions for fishing."
},
{
"indexName": "Ski Weather Forecast",
"indexId": 15,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 0,
"category": "Poor",
"categoryValue": 1,
"ascending": true,
"description": "Expect poor conditions for skiing."
},
{
"indexName": "Mosquito Activity Forecast",
"indexId": 17,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 7,
"category": "Very High",
"categoryValue": 4,
"ascending": true,
"description": "The weather is favorable for a very high level of mosquito activity. Plan activities and insect repellents accordingly."
},
{
"indexName": "Hunting Forecast",
"indexId": 20,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 4.5,
"category": "Fair",
"categoryValue": 2,
"ascending": true,
"description": "Expect only fair conditions for hunting."
},
{
"indexName": "Outdoor Barbecue",
"indexId": 24,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.8,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "This is a great day for an outdoor barbecue!"
},
{
"indexName": "Lawn Mowing Forecast",
"indexId": 28,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.6,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "This is a great day for lawn mowing!"
},
{
"indexName": "Outdoor Activity Forecast",
"indexId": 29,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 8.7,
"category": "Very Good",
"categoryValue": 4,
"ascending": true,
"description": "Conditions will be very good for outdoor activities."
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Daily |
Informationen zu einem tagesaktuellen Index. |
Daily |
Dieses Objekt wird von einem erfolgreichen Aufruf "Tägliche Indizes abrufen" zurückgegeben. |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Die Fehlerdetails. |
Error |
Fehlerantwort |
Json |
Gewünschtes Format der Antwort. Nur das |
DailyIndex
Informationen zu einem tagesaktuellen Index.
Name | Typ | Beschreibung |
---|---|---|
ascending |
boolean |
Beschreibt die Richtung von |
category |
string |
Textbeschreibung für |
categoryValue |
integer |
Ebene, unter die der Indexwert fällt, dargestellt durch eine ganze Zahl. Dieser Wert kann 1 bis 5 sein und sollte in Kombination mit dem |
dateTime |
string |
Datum und Uhrzeit der aktuellen Beobachtung im ISO 8601-Format, z. B. 2019-10-27T19:39:57-08:00. |
description |
string |
Eine Texterklärung, die zu Anzeigezwecken verwendet werden kann, um den Indexwert und die Kategorie zusammenzufassen. Wenn beispielsweise der Indexwert für Flugverspätungen sehr gut ist, lautet die Beschreibung "Die Bedingungen sind hervorragend für das Fliegen!". |
indexId |
integer |
Numerische ID, die zum Identifizieren des spezifischen Index verwendet wird. Weitere Informationen und die unterstützten Index-IDs finden Sie unter Wetterdienste in Azure Maps. Die Index-ID kann beispielsweise Benutzeroberflächenvisualisierungsszenarien unterstützen. |
indexName |
string |
Name des Indexes, z. B. "Konstruktion", "Outdoor-Aktivität", "Flugverspätungen". |
value |
number |
Indexwert. Reicht von 0,0 bis 10,0. Weitere Informationen und die unterstützten Bereiche finden Sie unter Wetterdienste in Azure Maps. |
DailyIndicesResult
Dieses Objekt wird von einem erfolgreichen Aufruf "Tägliche Indizes abrufen" zurückgegeben.
Name | Typ | Beschreibung |
---|---|---|
results |
Eine Liste aller täglichen Indizes für den abgefragten Speicherort. |
ErrorAdditionalInfo
Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Zusätzliche Informationen. |
type |
string |
Typ der zusätzlichen Informationen. |
ErrorDetail
Die Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
JsonFormat
Gewünschtes Format der Antwort. Nur das json
-Format wird unterstützt.
Name | Typ | Beschreibung |
---|---|---|
json |
string |