Weather - Get Tropical Storm Search

リファレンス

サービス:: Maps

API バージョン:: 1.1

を使用して、国内の天気予報機関によって発行された嵐の一覧を取得します。

Get Tropical Storm Search API は、政府が発行した熱帯暴風雨の一覧を年、流域 ID、および政府 ID で返す HTTP GET 要求です。熱帯暴風雨に関する情報には、政府 ID、流域 ID、状態、年、名前、亜熱帯の場合が含まれます。

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

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
format	path	True	JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
api-version	query	True	string	Azure Maps API のバージョン番号。
year	query	True	integer int32	低気圧の年
basinId	query		basinId	ベイスン識別子
govId	query		integer int32	Government storm Id

要求ヘッダー

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティモデルと組み合わせて使用するアカウントを指定します。これは Azure Maps アカウントの一意の ID を表し、Azure Maps 管理プレーンアカウント API から取得できます。 Azure Maps で Microsoft Entra ID セキュリティを使用するには、ガイダンスについては、次の記事を参照してください。

応答

名前	型	説明
200 OK	StormSearchResult	OK
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

これらは Microsoft Entra OAuth 2.0 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上の Azure Maps リソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。ユーザー、グループ、またはサービスプリンシパルには、組み込みのロールまたは Azure Maps REST API への 1 つ以上のアクセス許可で構成されたカスタムロールを使用してアクセス権を付与できます。

シナリオを実装するには、認証の概念を表示することをお勧めします。要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。

メモ

このセキュリティ定義では、ヘッダーを使用して、 x-ms-client-id アプリケーションがアクセスを要求している Azure Maps リソースを示す必要があります。これは、 Maps 管理 API から取得できます。

は Authorization URL 、Azure パブリッククラウドインスタンスに固有です。ソブリンクラウドには、一意の承認 URL と Microsoft Entra ID 構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユースケースでアプリケーションを構成ベースで設定できます。

Microsoft ID プラットフォームの詳細については、「 Microsoft ID プラットフォームの概要」を参照してください。

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

Scopes

名前	説明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

これは、Azure portal で Azure Maps アカウントを作成するとき、または PowerShell、CLI、Azure SDK、または REST API を使用するときにプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションですべての REST API にアクセスできます。つまり、このキーは、発行先のアカウントのマスターキーとして使用できます。

公開されているアプリケーションの場合は、機密クライアントアプリケーションアプローチを使用して Azure Maps REST API にアクセスし、キーを安全に格納できるようにすることをお勧めします。

型: apiKey
/: query

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンに対するきめ細かい制御が許可されます。言い換えると、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できます。

公開されているアプリケーションの場合、 Map アカウントリソースで許可される配信元の特定のリストを構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

型: apiKey
/: header

例

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
    }
  ]
}

定義

名前	説明
basinId	ベイスン識別子
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
StormSearchResult	政府が発行した嵐を検索する
StormSearchResultItem	政府が発行したアクティブな嵐イベント

basinId

ベイスン識別子

名前	型	説明
AL	string	大西洋
CP	string	中部太平洋
EP	string	東太平洋
NI	string	北インド洋
NP	string	北西太平洋
SI	string	南西インド洋
SP	string	南太平洋

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

JsonFormat

応答の目的の形式。サポートされているのは json 形式のみです。

名前	型	説明
json	string	JavaScript オブジェクト表記データ交換形式

StormSearchResult

政府が発行した嵐を検索する

名前	型	説明
nextLink	string	は、返される機能の次のページへのリンクです。最後のページの場合、このフィールドはありません。
results	StormSearchResultItem[]	政府が発行した嵐を検索する

StormSearchResultItem

政府が発行したアクティブな嵐イベント

名前	型	説明
basinId	basinId	ベイシン識別子 (AL、EP、SI、NI、CP、NP、SP)
govId	integer	Government Storm ID。これはうつ病の数と一致します。
isActive	boolean	True の場合は、うつ病が最近更新されています。
isRetired	boolean	True を指定すると、ソースベイスンでストーム名が完全に廃止されます。
isSubtropical	boolean	True の場合、うつ病は亜熱帯低気圧として分類されます。
name	string	うつ病の名前。
year	string	元の年

次の方法で共有

Weather - Get Tropical Storm Search

URI パラメーター

要求ヘッダー

応答

セキュリティ

AADToken

メモ

Scopes

subscription-key

SAS Token

例

Get Tropical Storm Search

Sample request

Sample response

Get Tropical Storm Search With Three Properties

Sample request

Sample response

定義

basinId

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat

StormSearchResult

StormSearchResultItem

その他のリソース