Weather - Get Tropical Storm Search

Referência

Serviço:: Maps

Versão da API:: 1.1

Usado para obter uma lista de tempestades emitidas pelas agências nacionais de previsão meteorológica.

A Get Tropical Storm Search API é um pedido HTTP GET que devolve uma lista de tempestades tropicais emitidas pelo governo por ano, ID da bacia e ID do governo. As informações sobre as tempestades tropicais incluem, ID do governo, ID da bacia, estado, ano, nome e se é subtropical.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
format	path	True	JsonFormat	Formato pretendido da resposta. Apenas `json` o formato é suportado.
api-version	query	True	string	Número da versão da API do Azure Maps.
year	query	True	integer int32	Ano do(s) ciclone(s)
basinId	query		basinId	Identificador da bacia
govId	query		integer int32	ID da tempestade do governo

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 do Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão do Azure Maps. Para utilizar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	StormSearchResult	OK
Other Status Codes	ErrorResponse	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 do Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais contas de recursos ou sub-recursos do Azure Maps. 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 as APIs REST do Azure Maps.

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 recurso do Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps .

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 do 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 do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * A utilização do SDK Web do 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 a plataforma de identidades da Microsoft, consulte Descrição geral da plataforma de identidades da Microsoft.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave partilhada que é aprovisionada quando Cria uma conta do 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 às APIs REST do Azure Maps para que a sua chave possa ser armazenada em segurança.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das 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.

Tipo: apiKey
Em: header

Exemplos

Get Tropical Storm Search

Get Tropical Storm Search With Three Properties

Get Tropical Storm Search

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
basinId	Identificador da bacia
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
JsonFormat	Formato pretendido da resposta. Apenas `json` o formato é suportado.
StormSearchResult	Procurar tempestades emitidas pelo governo
StormSearchResultItem	Evento de tempestade ativo emitido 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	Pacífico Noroeste
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ções adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.

Name	Tipo	Description
json	string	Formato JavaScript Object Notation Data Interchange

StormSearchResult

Procurar tempestades 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	StormSearchResultItem[]	Procurar tempestades emitidas pelo governo

StormSearchResultItem

Evento de tempestade ativo emitido pelo governo

Name	Tipo	Description
basinId	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	É verdade se a depressão foi actualizada recentemente.
isRetired	boolean	Verdadeiro se o nome da tempestade tiver sido permanentemente descontinuado na bacia de origem.
isSubtropical	boolean	Verdadeiro quando a depressão é classificada como um ciclone subtropical.
name	string	O nome da depressão.
year	string	Ano de origem

Partilhar via

Weather - Get Tropical Storm Search

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

AADToken

Notas

Âmbitos

subscription-key

SAS Token

Exemplos

Get Tropical Storm Search

Pedido de amostra

Resposta da amostra

Get Tropical Storm Search With Three Properties

Pedido de amostra

Resposta da amostra

Definições

basinId

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat

StormSearchResult

StormSearchResultItem

Recursos adicionais