Weather - Get Tropical Storm Forecast

  • リファレンス
Service:
Maps
API Version:
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}
With optional parameters: 
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

Government storm Id
year
 query True

integer

int32

低気圧の年
details
 query

boolean

true の場合、風半径の概要データが応答に含まれます
radiiGeometry
 query

boolean

true の場合、風半径の概要データと geoJSON の詳細が応答に含まれます
unit
 query

WeatherDataUnit

メトリック単位または帝国単位のいずれかでデータを返すように指定します。 既定値はメトリックです。
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

これらは OAuth 2.0 フロー Microsoft Entraです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API をAzure Mapsするための 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 を使用すると、複数のユース ケースに対してアプリケーションを構成ベースで設定できます。

Type: 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 にアクセスすることをお勧めします。

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

例

Get Tropical Storm Forecasts

Sample Request

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

Sample Response

Status code:
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 = NW 象限。
StormForecast

政府発行の嵐の予測
StormForecastResult

政府発行の予測の一覧
StormWindRadiiSummary

要求で details=true または radiiGeometry=true の場合に表示されます。
UnitType

表示される単位の種類に関連付けられている数値 ID 値。 単位変換に使用できます。 詳細については、「Azure Mapsの天気予報サービス」を参照してください。
WeatherDataUnit

メトリック単位または帝国単位のいずれかでデータを返すように指定します。 既定値はメトリックです。
WeatherUnit

気象に関連する特定の単位の特定の値。
WeatherWindow

嵐の予測ウィンドウ

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 オブジェクト。

GeoJsonGeometry

有効な 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

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

名前 型 説明
geometries GeoJsonGeometry[]:

有効な GeoJSON geometry オブジェクトの一覧を格納します。 GeoJSON の座標は x、y の順序 (経度、緯度) であることに注意してください。
type string:

GeometryCollection

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonLineString

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

名前 型 説明
coordinates

number[]

ジオメトリの GeoJson LineString 座標。
type string:

LineString

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonMultiLineString

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

名前 型 説明
coordinates

number[]

ジオメトリの GeoJson MultiLineString 座標。
type string:

MultiLineString

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonMultiPoint

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

名前 型 説明
coordinates

number[]

ジオメトリの GeoJson MultiPoint 座標。
type string:

MultiPoint

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonMultiPolygon

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

名前 型 説明
coordinates

number[]

有効な GeoJSON Polygon オブジェクトの一覧を格納します。 GeoJSON の座標は x、y の順序 (経度、緯度) であることに注意してください。
type string:

MultiPolygon

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonPoint

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

名前 型 説明
coordinates

number[]

は Position 、2 つ以上の要素を持つ数値の配列です。 最初の 2 つの要素は 経度 と 緯度で、正確にはその順序です。 高度/標高 は、省略可能な 3 番目の要素です。 詳細については、 RFC 7946 を参照してください。
type string:

Point

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonPolygon

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

名前 型 説明
coordinates

number[]

ジオメトリタイプの GeoJson Polygon 座標。
type string:

Polygon

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

JsonFormat

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

名前 型 説明
json

string

JavaScript オブジェクト表記データ交換形式

LatLongPair

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

名前 型 説明
latitude

number

Latitude プロパティ
longitude

number

Longitude プロパティ

RadiusSector

ベアリング 0 – 90 = NE クアドラント;90 から 180 = SE 象限。180 –270 = SW 象限;270 から 360 = NW 象限。

名前 型 説明
beginBearing

number

象限の始点の方位 (度単位)。
endBearing

number

象限の終点の方位 (度単位)。
range

number

四分円の半径 (海里単位)。

StormForecast

政府発行の嵐の予測

名前 型 説明
dateTime

string

Datetime 予測が有効で、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

政府発行の予測の一覧

名前 型 説明
nextLink

string

は、返される機能の次のページへのリンクです。 最後のページの場合、このフィールドはありません。
results

StormForecast[]

政府発行の予測の一覧

StormWindRadiiSummary

要求で details=true または radiiGeometry=true の場合に表示されます。

名前 型 説明
dateTime

string

風半径の概要データが有効な DateTime は、ISO8601形式で表示されます。
radiiGeometry GeoJsonGeometry:

GeoJSON オブジェクト。 要求で radiiGeometry=true の場合に表示されます。 風半径の象限のアウトラインについて説明します。
radiusSectorData

RadiusSector[]

風半径の象限をプロットするために必要な情報が含まれます。 ベアリング 0 – 90 = NE クアドラント;90 から 180 = SE 象限。180 –270 = SW 象限;270 から 360 = NW 象限。
windSpeed

WeatherUnit

radiusSectorData に関連付けられている風速。

UnitType

表示される単位の種類に関連付けられている数値 ID 値。 単位変換に使用できます。 詳細については、「Azure Mapsの天気予報サービス」を参照してください。

名前 型 説明
0

Integer

1

Integer

10

Integer

11

Integer

12

Integer

13

Integer

14

Integer

15

Integer

16

Integer

17

Integer

18

Integer

19

Integer

2

Integer

20

Integer

21

Integer

22

Integer

3

Integer

31

Integer

4

Integer

5

Integer

6

Integer

7

Integer

8

Integer

9

Integer

WeatherDataUnit

メトリック単位または帝国単位のいずれかでデータを返すように指定します。 既定値はメトリックです。

名前 型 説明
imperial

string

帝国単位でデータを返します。 帝国システムの単位の例としては、華氏とマイルがあります。
metric

string

メトリック単位でデータを返します。 メトリック システムの単位の例としては、摂氏とキロメートルがあります。

WeatherUnit

気象に関連する特定の単位の特定の値。

名前 型 説明
unit

string

戻り値の単位の型。
unitType

UnitType

表示される単位の種類に関連付けられている数値 ID 値。 単位変換に使用できます。 詳細については、「Azure Mapsの天気予報サービス」を参照してください。
value

number

丸められた値。

WeatherWindow

嵐の予測ウィンドウ

名前 型 説明
beginDateTime

string

移動ウィンドウの先頭の DateTime 。ISO8601形式で表示されます。
beginStatus

string

ウィンドウの先頭にある Storm の状態。
endDateTime

string

移動ウィンドウの終了の DateTime。ISO8601形式で表示されます。
endStatus

string

ウィンドウの最後にある Storm の状態。
geometry GeoJsonGeometry:

要求で windowGeometry=true の場合に表示されます。 指定された時間枠内の移動ウィンドウを記述する座標を含む GeoJSON オブジェクト。
left

LatLongPair

時間枠の左側にあるポイントの位置。
right

LatLongPair

時間枠の最後にあるウィンドウの右側にあるポイントの位置。