Weather - Get Tropical Storm Active

Referens

Service:: Maps

API Version:: 1.1

Använd för att få en lista över de aktiva tropiska stormarna som utfärdats av nationella väderprognosbyråer.

API:et Get Tropical Storm Active är en HTTP-begäran GET som returnerar en lista över alla myndighetsutfärdade aktiva tropiska stormar. Information om de tropiska stormarna omfattar regerings-ID, bassäng-ID, ursprungsår, namn och om det är subtropiskt.

GET https://atlas.microsoft.com/weather/tropical/storms/active/json?api-version=1.1

URI-parametrar

Name	I	Obligatorisk	Typ	Description
format	path	True	JsonFormat	Önskat format för svaret. Endast `json` format stöds.
api-version	query	True	string	Versionsnummer för Azure Maps API.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från konto-API:et för Azure Maps hanteringsplan. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Svar

Name	Typ	Description
200 OK	ActiveStormResult	OK
Other Status Codes	ErrorResponse	Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden. När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps resurskonto eller underresurser. 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 för att 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 ha åtkomstkontroll för specifika API:er och omfång.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API :et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, 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 Microsofts identitetsplattform översikt.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://atlas.microsoft.com/.default	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 Portal 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:et. Med andra ord kan den här nyckeln användas som huvudnyckel i det konto som de har utfärdats i.

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

Type: apiKey
In: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, 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 av 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 säkrare 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.

Type: apiKey
In: header

Exempel

Get Tropical Storm Active

Sample Request

HTTP

GET https://atlas.microsoft.com/weather/tropical/storms/active/json?api-version=1.1

Sample Response

Status code:: 200

{
  "results": [
    {
      "year": "2021",
      "basinId": "EP",
      "name": "Hilda",
      "isActive": true,
      "isSubtropical": false,
      "govId": 8
    },
    {
      "year": "2021",
      "basinId": "EP",
      "name": "TD 9E",
      "isActive": true,
      "isSubtropical": false,
      "govId": 9
    },
    {
      "year": "2021",
      "basinId": "NP",
      "name": "TWELVE",
      "isActive": true,
      "isSubtropical": false,
      "govId": 12
    },
    {
      "year": "2021",
      "basinId": "NP",
      "name": "LUPIT",
      "isActive": true,
      "isSubtropical": false,
      "govId": 13
    },
    {
      "year": "2021",
      "basinId": "NP",
      "name": "FOURTEEN",
      "isActive": true,
      "isSubtropical": false,
      "govId": 14
    },
    {
      "year": "2021",
      "basinId": "NP",
      "name": "FIFTEEN",
      "isActive": true,
      "isSubtropical": false,
      "govId": 15
    }
  ]
}

Definitioner

Name	Description
ActiveStorm	Statligt utfärdad aktiv storm
ActiveStormResult	Alla myndighetsspecifika aktiva stormar
basinId	Bassängidentifierare
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
JsonFormat	Önskat format för svaret. Endast `json` format stöds.

ActiveStorm

Statligt utfärdad aktiv storm

Name	Typ	Description
basinId	basinId	Bassängidentifierare (AL, EP, SI, NI, CP, NP, SP)
govId	integer	Regeringens storm-ID. Detta kommer att matcha depressionsnumret.
isActive	boolean	Sant om depressionen har uppdaterats nyligen.
isSubtropical	boolean	Sant när depressionen klassificeras som en subtropisk cyklon.
name	string	Namnet på depressionen.
year	string	Ursprungsåret

ActiveStormResult

Alla myndighetsspecifika aktiva stormar

Name	Typ	Description
nextLink	string	är länken till nästa sida i de funktioner som returneras. Om det är den sista sidan, nej det här fältet.
results	ActiveStorm[]	Alla myndighetsspecifika aktiva stormar

basinId

Bassängidentifierare

Name	Typ	Description
AL	string	Atlanten
CP	string	Centrala Stilla havet
EP	string	Östra Stilla havet
NI	string	Norra Indiska oceanen
NP	string	Nordvästra Stilla havet
SI	string	Sydvästra Indiska oceanen
SP	string	Södra Stillahavsområdet

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

JsonFormat

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

Name	Typ	Description
json	string	Datautbytesformat för JavaScript-objektnotation