Weather - Get Tropical Storm Forecast

リファレンス

サービス:: Maps

API バージョン:: 1.1

全国の天気予報機関によって予測された熱帯低気圧のリストを取得するために使用します。

Get Tropical Storm Forecasts API は、政府発行の個々の熱帯低気圧の予報を返す HTTP GET リクエストです。予測された熱帯低気圧に関する情報には、場所、ステータス、予測が作成された日付、ウィンドウ、風速、風半径が含まれます。

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

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

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

URI パラメーター

名前	/	必須	型	説明
format	path	True	JsonFormat	応答の目的の形式。 `json` 形式のみがサポートされています。
api-version	query	True	string	Azure Maps API のバージョン番号。
basinId	query	True	basinId	流域識別子
govId	query	True	integer (int32)	政府の嵐 ID
year	query	True	integer (int32)	サイクロン発生年
details	query		boolean	true の場合、風半径のサマリーデータが応答に含まれます
radiiGeometry	query		boolean	true の場合、風の半径の概要データと geoJSON の詳細が応答に含まれます
unit	query		WeatherDataUnit	メートル法の単位またはインペリアル単位でデータを返すように指定します。デフォルト値は metric です。
windowGeometry	query		boolean	true の場合、ウィンドウジオメトリデータ (geoJSON) が応答に含まれます

要求ヘッダー

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

応答

名前	型	説明
200 OK	StormForecastResult	[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 とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。

注記

このセキュリティ定義使用して、アプリケーションがアクセスを要求している 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
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

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

subscription-key

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

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

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

型: apiKey
/: query

SAS Token

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

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

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

型: apiKey
/: header

例

Get Tropical Storm Forecasts

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "results": [
    {
      "dateTime": "2021-04-25T06:00:00+00:00",
      "initializedDateTime": "2021-04-24T18:00:00+00:00",
      "location": {
        "latitude": 22,
        "longitude": 137.8
      },
      "maxWindGust": {
        "value": 92.6,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 74.1,
        "unit": "km/h",
        "unitType": 7
      },
      "status": "Tropical Storm",
      "window": {
        "left": {
          "latitude": 22.56387,
          "longitude": 137.739517
        },
        "right": {
          "latitude": 21.4361,
          "longitude": 137.860489
        }
      }
    },
    {
      "dateTime": "2021-04-25T18:00:00+00:00",
      "initializedDateTime": "2021-04-24T18:00:00+00:00",
      "location": {
        "latitude": 23.7,
        "longitude": 142.4
      },
      "maxWindGust": {
        "value": 92.6,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 74.1,
        "unit": "km/h",
        "unitType": 7
      },
      "status": "Tropical Storm",
      "window": {
        "left": {
          "latitude": 24.45283,
          "longitude": 142.055313
        },
        "right": {
          "latitude": 22.94641,
          "longitude": 142.744675
        }
      }
    }
  ]
}

定義

名前	説明
basinId	流域識別子
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GeoJsonGeometry	有効な `GeoJSON` geometry オブジェクト。この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ型のいずれかである必要があります。詳細については、RFC 7946 を参照してください。
GeoJsonGeometryCollection	有効な `GeoJSON GeometryCollection` オブジェクト型。詳細については、RFC 7946 を参照してください。
GeoJsonLineString	有効な `GeoJSON LineString` geometry 型。詳細については、RFC 7946 を参照してください。
GeoJsonMultiLineString	有効な `GeoJSON MultiLineString` geometry 型。詳細については、RFC 7946 を参照してください。
GeoJsonMultiPoint	有効な `GeoJSON MultiPoint` geometry 型。詳細については、RFC 7946 を参照してください。
GeoJsonMultiPolygon	有効な `GeoJSON MultiPolygon` オブジェクト型。詳細については、RFC 7946 を参照してください。
GeoJsonPoint	有効な `GeoJSON Point` geometry 型。詳細については、RFC 7946 を参照してください。
GeoJsonPolygon	有効な `GeoJSON Polygon` geometry 型。詳細については、RFC 7946 を参照してください。
JsonFormat	応答の目的の形式。 `json` 形式のみがサポートされています。
LatLongPair	緯度と経度として表される場所。
RadiusSector	方位 0–90 = NE 象限。90–180 = SE 象限。180–270 = SW象限;270–360 = 北西象限。
StormForecast	政府発行の暴風雨予報
StormForecastResult	政府発行の予測一覧
StormWindRadiiSummary	リクエストで details=true または radiiGeometry=true の場合に表示されます。
UnitType	表示されているユニットのタイプに関連付けられた数値 ID 値。単位の翻訳に使用できます。詳細については、「 Azure Maps の天気サービス」を参照してください。
WeatherDataUnit	メートル法の単位またはインペリアル単位でデータを返すように指定します。デフォルト値は metric です。
WeatherUnit	天候に関連する特定のユニットの特定の値。
WeatherWindow	嵐の予報ウィンドウ

basinId

列挙

流域識別子

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

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

GeoJsonGeometry

Object

有効な GeoJSON geometry オブジェクト。この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ型のいずれかである必要があります。詳細については、RFC 7946 を参照してください。

名前	型	説明
type	GeoJsonObjectType	`GeoJSON` 型を指定します。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonGeometryCollection

Object

有効な GeoJSON GeometryCollection オブジェクト型。詳細については、RFC 7946 を参照してください。

名前	型	説明
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	有効な `GeoJSON` ジオメトリオブジェクトの一覧が含まれています。 GeoJSON の座標が x、y の順序 (経度、緯度) であるに注意してください。
type	string: GeometryCollection	`GeoJSON` 型を指定します。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonLineString

Object

有効な GeoJSON LineString geometry 型。詳細については、RFC 7946 を参照してください。

名前	型	説明
coordinates	number[] (double)	`GeoJson LineString` ジオメトリの座標。
type	string: LineString	`GeoJSON` 型を指定します。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonMultiLineString

Object

有効な GeoJSON MultiLineString geometry 型。詳細については、RFC 7946 を参照してください。

名前	型	説明
coordinates	number[] (double)	`GeoJson MultiLineString` ジオメトリの座標。
type	string: MultiLineString	`GeoJSON` 型を指定します。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonMultiPoint

Object

有効な GeoJSON MultiPoint geometry 型。詳細については、RFC 7946 を参照してください。

名前	型	説明
coordinates	number[] (double)	`GeoJson MultiPoint` ジオメトリの座標。
type	string: MultiPoint	`GeoJSON` 型を指定します。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonMultiPolygon

Object

有効な GeoJSON MultiPolygon オブジェクト型。詳細については、RFC 7946 を参照してください。

名前	型	説明
coordinates	number[] (double)	有効な `GeoJSON Polygon` オブジェクトの一覧を格納します。 GeoJSON の座標が x、y の順序 (経度、緯度) であるに注意してください。
type	string: MultiPolygon	`GeoJSON` 型を指定します。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonPoint

Object

有効な GeoJSON Point geometry 型。詳細については、RFC 7946 を参照してください。

名前	型	説明
coordinates	number[] (double)	`Position` は、2 つ以上の要素を持つ数値の配列です。最初の 2 つの要素は、経度、緯度正確にその順序で示されます。高度/標高は、オプションの 3 番目の要素です。詳細については、RFC 7946 を参照してください。
type	string: Point	`GeoJSON` 型を指定します。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonPolygon

Object

有効な GeoJSON Polygon geometry 型。詳細については、RFC 7946 を参照してください。

名前	型	説明
coordinates	number[] (double)	`GeoJson Polygon` geometry タイプの座標。
type	string: Polygon	`GeoJSON` 型を指定します。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

JsonFormat

列挙

応答の目的の形式。 json 形式のみがサポートされています。

値	説明
json	JavaScript オブジェクト表記データ交換形式をする

LatLongPair

Object

緯度と経度として表される場所。

名前	型	説明
latitude	number (double)	Latitude プロパティ
longitude	number (double)	Longitude プロパティ

RadiusSector

Object

方位 0–90 = NE 象限。90–180 = SE 象限。180–270 = SW象限;270–360 = 北西象限。

名前	型	説明
beginBearing	number (double)	象限の始まりの方位(度単位)。
endBearing	number (double)	象限の終点の方位角 (度単位)。
range	number (double)	象限の半径 (海里単位)。

StormForecast

Object

政府発行の暴風雨予報

名前	型	説明
dateTime	string	予測が有効な日時は、ISO8601形式で表示されます。
initializedDateTime	string	予測が作成された日時 (ISO8601形式で表示)。
location	LatLongPair	嵐の座標
maxWindGust	WeatherUnit	嵐に関連する最大突風速度。 NULL を指定できます。
status	string	使用可能なステータス値は次のとおりです。サイクロン性嵐深いうつ病鬱病非常に激しいサイクロン性暴風雨ハリケーンカテゴリー(1-5) 強烈な熱帯低気圧中程度の熱帯性暴風雨ポストトロピカルサイクロン潜在的な熱帯低気圧激しいサイクロン性暴風雨激しい熱帯低気圧亜熱帯のスーパーサイクロン性嵐熱帯低気圧熱帯低気圧のカテゴリー (1-5) 熱帯低気圧熱帯擾乱熱帯低気圧台風非常に激しい熱帯低気圧非常に激しいサイクロン性嵐非常に強い台風猛烈な台風
sustainedWind	WeatherUnit	嵐に関連する最大持続風速。 NULL を指定できます。
windRadiiSummary	StormWindRadiiSummary[]	リクエストで details=true または radiiGeometry=true の場合に表示されます。
window	WeatherWindow	指定した期間中の嵐の予報ウィンドウに関する情報が含まれます (円錐全体ではありません)。リクエストで windowGeometry=true の場合、このオブジェクトにはウィンドウジオメトリの geoJSON の詳細が含まれます。

StormForecastResult

Object

政府発行の予測一覧

名前	型	説明
nextLink	string	返される機能の次のページへのリンクです。最後のページの場合、このフィールドはありません。
results	StormForecast[]	政府発行の予測一覧

StormWindRadiiSummary

Object

リクエストで details=true または radiiGeometry=true の場合に表示されます。

名前	型	説明
dateTime	string	風半径の集計データが有効である DateTime を ISO8601形式で表示します。
radiiGeometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	GeoJSON オブジェクト。リクエストでradiiGeometry = trueの場合に表示されます。風半径の象限のアウトラインを記述します。
radiusSectorData	RadiusSector[]	風半径の象限をプロットするために必要な情報が含まれています。方位 0–90 = NE 象限。90–180 = SE 象限。180–270 = SW象限;270–360 = 北西象限。
windSpeed	WeatherUnit	radiusSectorData に関連付けられた風速。

UnitType

列挙

表示されているユニットのタイプに関連付けられた数値 ID 値。単位の翻訳に使用できます。詳細については、「 Azure Maps の天気サービス」を参照してください。

値	説明
0	フィート
1	インチ
10	メートル毎秒
11	ヘクトパスカル
12	水銀柱インチ
13	キロパスカル
14	ミリバール
15	水銀柱ミリメートル
16	ポンド/平方インチ
17	摂氏
18	ファラハイト
19	ケルビン
2	マイル
20	パーセント
21	フロート
22	整数 (integer)
3	ミリメートル
31	空気1立方メートルあたりのマイクログラム
4	センチメートル
5	メートル
6	キロメートル
7	キロメートル毎時
8	ノット
9	時速マイル

WeatherDataUnit

列挙

メートル法の単位またはインペリアル単位でデータを返すように指定します。デフォルト値は metric です。

値	説明
imperial	インペリアル単位でデータを返します。インペリアルシステムのいくつかの例は、華氏とマイルです。
metric	メートル単位でデータを返します。メートル法の単位の例としては、摂氏とキロメートルがあります。

WeatherUnit

Object

天候に関連する特定のユニットの特定の値。

名前	型	説明
unit	string	戻り値の単位のタイプ。
unitType	UnitType (int32)	表示されているユニットのタイプに関連付けられた数値 ID 値。単位の翻訳に使用できます。詳細については、「 Azure Maps の天気サービス」を参照してください。
value	number (float)	丸められた値。

WeatherWindow

Object

嵐の予報ウィンドウ

名前	型	説明
beginDateTime	string (date-time)	移動ウィンドウの開始日時を ISO8601 形式で表示します。
beginStatus	string	ウィンドウの開始時のストームステータス。
endDateTime	string (date-time)	移動ウィンドウの終了日時を ISO8601 形式で表示します。
endStatus	string	ウィンドウの終了時のストームステータス。
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	リクエストでwindowGeometry = trueの場合に表示されます。指定された時間枠内の移動ウィンドウを記述する座標を含む GeoJSON オブジェクト。
left	LatLongPair	時間枠の時点でのウィンドウの左側にあるポイントの位置。
right	LatLongPair	時間枠の終了時にウィンドウの右側にあるポイントの位置。

次の方法で共有

Weather - Get Tropical Storm Forecast

URI パラメーター

要求ヘッダー

応答

セキュリティ

AADToken

注記

スコープ

subscription-key

SAS Token

例

Get Tropical Storm Forecasts

要求のサンプル

応答のサンプル

定義

basinId

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonPoint

GeoJsonPolygon

JsonFormat

LatLongPair

RadiusSector

StormForecast

StormForecastResult

StormWindRadiiSummary

UnitType

WeatherDataUnit

WeatherUnit

WeatherWindow