Weather - Get Tropical Storm Search

Service:: Maps

API-versie:: 1.1

Gebruik dit om een lijst met stormen te krijgen die is uitgegeven door nationale weersvoorspellingsbureaus.
De Get Tropical Storm Search API is een HTTP-verzoek GET dat een lijst met door de overheid uitgegeven tropische stormen per jaar, bekken-ID en overheids-ID retourneert. Informatie over de tropische stormen omvat: overheids-ID, bekken-ID, status, jaar, naam en of het subtropisch is.

GET {endpoint}/weather/tropical/storms/json?api-version=1.1&year={year}

Met optionele parameters:

GET {endpoint}/weather/tropical/storms/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	De hostnaam van de Azure Maps-service. Gebruik `https://atlas.microsoft.com` voor de Azure publieke cloud. Om een specifieke Azure Maps geografie of een soevereine cloud te targeten, zie Azure Maps geografische reikwijdte.
format	path	True	JsonFormat	Gewenste indeling van het antwoord. Alleen `json` indeling wordt ondersteund.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
year	query	True	integer (int32)	Jaar van de cycloon(en)
basinId	query		BasinId	De `basinId` enum categoriseert de verschillende oceaanbekkens waar tropische stormen kunnen ontstaan. Elk bekken krijgt een unieke identificatiecode toegewezen om de locatie van de oorsprong van de storm te helpen specificeren.
govId	query		integer (int32)	Regering storm Id

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Geeft het account aan dat bedoeld is voor gebruik met het Microsoft Entra ID-beveiligingsmodel. Deze unieke ID voor het Azure Maps-account kan worden verkregen via de Azure Maps beheerplane Account API. Voor meer informatie over het gebruik van Microsoft Entra ID beveiliging in Azure Maps, zie Beheer authenticatie in Azure Maps.

Antwoorden

Name	Type	Description
200 OK	StormSearchResult	De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

AadToken

Dit zijn de Microsoft Entra OAuth 2.0 stromen. In combinatie met Azure rolgebaseerde toegang control kan het worden gebruikt om de toegang tot Azure Maps REST-API's te controleren. Azure rolgebaseerde toegangscontroles worden gebruikt om toegang aan een of meer Azure Maps-resourceaccounts of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.

Note

Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen uit de Maps Management API-.
De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Sovereign clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties.
Het op rollen gebaseerde toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Gebruik van de Azure Maps Web SDK maakt configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.
Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u Een Azure Maps-account maken in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze worden uitgegeven.

Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: header

SAS Token

Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Get Tropical Storm Search

Get Tropical Storm Search With Three Properties

Get Tropical Storm Search

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

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

Get Tropical Storm Search With Three Properties

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
BasinId	Bekkenidentificatie voor tropische stormen.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
JsonFormat	Gewenste indeling van het antwoord. Alleen `json` indeling wordt ondersteund.
StormSearchResult	Bevat een lijst van door de overheid uitgegeven stormen die voldoen aan de gespecificeerde zoekcriteria, inclusief details zoals het ID van het stroomgebied van de storm, door de overheid uitgegeven ID en status.
StormSearchResultItem	Een door de overheid veroorzaakte stormgebeurtenis, inclusief de bekkenidentificatie (basinId), door de overheid uitgegeven identificatie (govId) en status. Dit object wordt teruggegeven als onderdeel van een array binnen het StormSearchResult-object .

BasinId

Opsomming

Bekkenidentificatie voor tropische stormen.

Waarde	Description
AL	De Atlantische Oceaan. Cruciaal voor het volgen van orkanen die Amerika en het Caribisch gebied treffen. Het is een van de meest actieve regio's voor tropische stormen.
CP	De centrale Stille Oceaan. Dit bekken wordt gebruikt voor stormen die Hawaï en de omliggende gebieden treffen.
EP	De oostelijke Stille Oceaan. Dit bekken volgt stormen die de westkust van Amerika treffen, inclusief Mexico en Midden-Amerika. Het grenst aan het centrale stroomgebied van de Stille Oceaan.
NI	De Noord-Indische Oceaan. Dit bekken omvat stormen die Zuid-Azië treffen, waaronder landen als India en Bangladesh, die vaak worden getroffen door cyclonen.
NP	Het noordwesten van de Stille Oceaan. Dit bekken is belangrijk voor het volgen van tyfoons die Oost-Azië treffen, waaronder landen als China, Japan en de Filippijnen. Het zijn de meest actieve tropische stormgebieden ter wereld.
SI	De Zuid-Indische Oceaan. Dit bekken, gelegen ten zuiden van de evenaar, omvat cyclonen die Madagaskar, Afrika en de omliggende regio's treffen.
SP	De Stille Zuidzee. Dit bekken, gelegen ten zuiden van de evenaar, is relevant voor cyclonen die Australië en de eilanden in de Stille Zuidzee treffen.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info		De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name	Type	Description
error	ErrorDetail	Het foutobject.

JsonFormat

Opsomming

Gewenste indeling van het antwoord. Alleen json indeling wordt ondersteund.

Waarde	Description
json	De Notatie Data Interchange-indeling voor JavaScript-objecten

StormSearchResult

Object

Bevat een lijst van door de overheid uitgegeven stormen die voldoen aan de gespecificeerde zoekcriteria, inclusief details zoals het ID van het stroomgebied van de storm, door de overheid uitgegeven ID en status.

Name	Type	Description
nextLink	string	Bevat de URL om de volgende pagina met resultaten op te halen als het antwoord gepagineerd is. Dit is handig wanneer het antwoord te groot is om in één oproep te worden beantwoord, waardoor gebruikers door meerdere pagina's met resultaten kunnen navigeren.
results	StormSearchResultItem[]	Array van StormSearchResultItem-objecten , elk vertegenwoordigend voor een tropische storm die overeenkomt met de zoekcriteria die in het verzoek zijn gegeven.

StormSearchResultItem

Object

Een door de overheid veroorzaakte stormgebeurtenis, inclusief de bekkenidentificatie (basinId), door de overheid uitgegeven identificatie (govId) en status. Dit object wordt teruggegeven als onderdeel van een array binnen het StormSearchResult-object .

Name	Type	Description
basinId	BasinId	Categoriseert de verschillende oceaanbekkens waar tropische stormen kunnen ontstaan. Elk bekken krijgt een unieke identificatiecode toegewezen om de locatie van de oorsprong van de storm te helpen specificeren. Geldige bekkenidentificaties zijn onder andere AL, CP, EP, NI, NP, SI en SP.
govId	integer (int32)	Een unieke identificatie die door nationale weersvoorspellingsinstanties aan tropische stormen wordt toegekend. Deze identificatie helpt specifieke stormen nauwkeurig te volgen en te refereren, inclusief status, locatie en intensiteit. Dit komt overeen met het depressiegetal.
isActive	boolean	Geeft aan of de tropische storm momenteel actief is. Als dat waar is, is de storm actief; als het niet klopt, is de storm niet actief
isRetired	boolean	Komt terug als de storm permanent is teruggetrokken in het bronbekken.
isSubtropical	boolean	Komt terug als de storm wordt geclassificeerd als een subtropische cycloon, wat betekent dat hij zowel tropische als extratropische kenmerken heeft.
name	string	Identificeert de tropische storm met zijn officiële naam, zoals bepaald door het relevante nationale weerdienstagentschap.
year	string	Geeft het jaar aan waarin de tropische storm is ontstaan.