Weather - Get Tropical Storm Search

Referenz

Service:: Maps

API Version:: 1.1

Verwenden Sie , um eine Liste der Stürme zu erhalten, die von nationalen Wettervorhersageagenturen ausgegeben werden.

Die Get Tropical Storm Search API ist eine HTTP-Anforderung GET , die eine Liste der von der Regierung ausgestellten tropischen Stürme nach Jahr, Becken-ID und Regierungs-ID zurückgibt. Informationen über die tropischen Stürme umfassen, Regierungs-ID, Becken-ID, status, Jahr, Name und ob es subtropisch ist.

GET https://atlas.microsoft.com/weather/tropical/storms/json?api-version=1.1&year={year}

With optional parameters:

GET https://atlas.microsoft.com/weather/tropical/storms/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	JsonFormat	Das gewünschte Format der Antwort. Nur das `json`-Format wird unterstützt.
api-version	query	True	string	Versionsnummer der Azure Maps API.
year	query	True	integer int32	Jahr des Zyklons(en)
basinId	query		basinId	Beckenbezeichner
govId	query		integer int32	Regierungssturm-ID

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell verwendet werden soll. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Azure Maps-Verwaltungsebenen-API abgerufen werden. Informationen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Antworten

Name	Typ	Beschreibung
200 OK	StormSearchResult	OK
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0-Flows. In Kombination mit der rollenbasierten Zugriffssteuerung in Azure 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 einem 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.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

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.

ist Authorization URL spezifisch für die öffentliche Azure-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen. * Die rollenbasierte Zugriffssteuerung von 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 verwendeter Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API Create.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Anders ausgedrückt: 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 für den Zugriff auf Azure Maps REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

SAS Token

Dies ist 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 für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

Get Tropical Storm Search

Get Tropical Storm Search With Three Properties

Get Tropical Storm Search

Sample Request

HTTP

GET https://atlas.microsoft.com/weather/tropical/storms/json?api-version=1.1&year=2021&basinId=AL

Sample Response

Status code:: 200

{
  "results": [
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 1,
      "name": "Ana",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 2,
      "name": "Bill",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 3,
      "name": "Claudette",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 4,
      "name": "Danny",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 5,
      "name": "Elsa",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 6,
      "name": "Fred",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 7,
      "name": "Grace",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 8,
      "name": "Henri",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 9,
      "name": "Ida",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 10,
      "name": "Kate",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 11,
      "name": "Julian",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 12,
      "name": "Larry",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 13,
      "name": "Mindy",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 14,
      "name": "Nicholas",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 15,
      "name": "ODETTE",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 16,
      "name": "Peter",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 17,
      "name": "Rose",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 18,
      "name": "Sam",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 19,
      "name": "Teresa",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 20,
      "name": "Victor",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    },
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 21,
      "name": "Wanda",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    }
  ]
}

Get Tropical Storm Search With Three Properties

Sample Request

HTTP

GET https://atlas.microsoft.com/weather/tropical/storms/json?api-version=1.1&year=2021&basinId=AL&govId=1

Sample Response

Status code:: 200

{
  "results": [
    {
      "year": "2021",
      "basinId": "AL",
      "govId": 1,
      "name": "Ana",
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false
    }
  ]
}

Definitionen

Name	Beschreibung
basinId	Beckenbezeichner
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
JsonFormat	Das gewünschte Format der Antwort. Nur das `json`-Format wird unterstützt.
StormSearchResult	Search von der Regierung ausgestellte Stürme
StormSearchResultItem	Von der Regierung ausgestelltes aktives Sturmereignis

basinId

Beckenbezeichner

Name	Typ	Beschreibung
AL	string	Atlantic
CP	string	Zentralpazifik
EP	string	Östlicher Pazifik
NI	string	Nordindischer Ozean
NP	string	Nordwestpazifik
SI	string	Südwestindischer Ozean
SP	string	Südpazifik

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	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

JsonFormat

Das gewünschte Format der Antwort. Nur das json-Format wird unterstützt.

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation

StormSearchResult

Search von der Regierung ausgestellte Stürme

Name	Typ	Beschreibung
nextLink	string	ist der Link zur nächsten Seite der zurückgegebenen Features. Wenn es sich um die letzte Seite handelt, ist dieses Feld nicht vorhanden.
results	StormSearchResultItem[]	Search von der Regierung ausgestellte Stürme

StormSearchResultItem

Von der Regierung ausgestelltes aktives Sturmereignis

Name	Typ	Beschreibung
basinId	basinId	Beckenbezeichner (AL, EP, SI, NI, CP, NP, SP)
govId	integer	Regierungssturm-ID. Dies entspricht der Depressionsnummer.
isActive	boolean	True, wenn die Depression kürzlich aktualisiert wurde.
isRetired	boolean	True, wenn der Name des Sturms im Quellbecken dauerhaft eingestellt wurde.
isSubtropical	boolean	Richtig, wenn die Senke als subtropischer Zyklon klassifiziert wird.
name	string	Der Name der Depression.
year	string	Entstehungsjahr

Share via

Weather - Get Tropical Storm Search

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

AADToken

Hinweise

Scopes

subscription-key

SAS Token

Beispiele

Get Tropical Storm Search

Sample Request

Sample Response

Get Tropical Storm Search With Three Properties

Sample Request

Sample Response

Definitionen

basinId

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat

StormSearchResult

StormSearchResultItem

Zusätzliche Ressourcen