Weather - Get Tropical Storm Active
Usado para obter uma lista das tempestades tropicais activas emitidas pelas agências nacionais de previsão meteorológica.
A Get Tropical Storm Active
API é um pedido HTTP GET
que devolve uma lista de todas as tempestades tropicais ativas emitidas pelo governo. As informações sobre as tempestades tropicais incluem, ID do governo, ID da bacia, ano de origem, nome e se é subtropical.
GET https://atlas.microsoft.com/weather/tropical/storms/active/json?api-version=1.1
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
format
|
path | True |
Formato pretendido da resposta. Apenas |
|
api-version
|
query | True |
string |
Número da versão da API Azure Maps. |
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
x-ms-client-id |
string |
Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps veja os seguintes artigos para obter orientações. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Ocorreu um erro inesperado. |
Segurança
AADToken
Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.
Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.
Notas
- Esta definição de segurança requer a utilização do
x-ms-client-id
cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas .
O Authorization URL
é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID.
* O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
* A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.
- Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.
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
Esta é uma chave partilhada que é aprovisionada quando Create uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.
Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.
Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.
Type:
apiKey
In:
query
SAS Token
Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.
Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.
Type:
apiKey
In:
header
Exemplos
Get Tropical Storm Active
Sample Request
GET https://atlas.microsoft.com/weather/tropical/storms/active/json?api-version=1.1
Sample Response
{
"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
}
]
}
Definições
Name | Description |
---|---|
Active |
Tempestade ativa emitida pelo governo |
Active |
Todas as tempestades ativas emitidas pelo governo |
basin |
Identificador da bacia |
Error |
Informações adicionais sobre o erro de gestão de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta a erros |
Json |
Formato pretendido da resposta. Apenas |
ActiveStorm
Tempestade ativa emitida pelo governo
Name | Tipo | Description |
---|---|---|
basinId |
Identificador da bacia (AL, EP, SI, NI, CP, NP, SP) |
|
govId |
integer |
ID da tempestade do governo. Isto vai corresponder ao número da depressão. |
isActive |
boolean |
Verdadeiro se a depressão foi atualizada recentemente. |
isSubtropical |
boolean |
Verdadeiro quando a depressão é classificada como um ciclone subtropical. |
name |
string |
O nome da depressão. |
year |
string |
Ano de origem |
ActiveStormResult
Todas as tempestades ativas emitidas pelo governo
Name | Tipo | Description |
---|---|---|
nextLink |
string |
É a ligação para a página seguinte das funcionalidades devolvidas. Se for a última página, não este campo. |
results |
Todas as tempestades ativas emitidas pelo governo |
basinId
Identificador da bacia
Name | Tipo | Description |
---|---|---|
AL |
string |
Atlântico |
CP |
string |
Pacífico Central |
EP |
string |
Pacífico Oriental |
NI |
string |
Oceano Índico Do Norte |
NP |
string |
Noroeste do Pacífico |
SI |
string |
Sudoeste do Oceano Índico |
SP |
string |
Pacífico Sul |
ErrorAdditionalInfo
Informações adicionais sobre o erro de gestão de recursos.
Name | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
Name | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta a erros
Name | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
JsonFormat
Formato pretendido da resposta. Apenas json
o formato é suportado.
Name | Tipo | Description |
---|---|---|
json |
string |
O Formato de Intercâmbio de Dados de Notação de Objetos JavaScript |