Timezone - Get Timezone By ID

リファレンス

サービス:: Maps

API バージョン:: 1.0

指定した IANA タイムゾーン ID の現在、履歴、および将来のタイムゾーン情報を取得するために使用します。

Get Timezone By ID API は、指定された IANA タイムゾーン ID の現在、履歴、および将来のタイムゾーン情報を返す HTTP GET 要求です。

GET https://atlas.microsoft.com/timezone/byId/json?api-version=1.0&query={query}

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

GET https://atlas.microsoft.com/timezone/byId/json?api-version=1.0&options={options}&timeStamp={timeStamp}&transitionsFrom={transitionsFrom}&transitionsYears={transitionsYears}&query={query}

URI パラメーター

名前	/	必須	型	説明
format	path	True	JsonFormat	応答の目的の形式。 `json` 形式のみがサポートされています。
api-version	query	True	string	Azure Maps API のバージョン番号。
query	query	True	string	IANA タイムゾーン ID。
options	query		TimezoneOptions	または、エイリアス "o" を使用します。結果で返される情報の種類に使用できるオプション。
timeStamp	query		string date-time	または、エイリアス "stamp" または "s" を使用します。参照時刻を省略すると、API は要求を提供するマシン時間を使用します。
transitionsFrom	query		string date-time	または、エイリアス "tf" を使用します。夏時間 (DST) の切り替えが要求される開始日は、"options" = all または "options" = transitions の場合にのみ適用されます。
transitionsYears	query		integer	または、エイリアス "ty" を使用します。 DST 切り替えが要求される "transitionsFrom" からの年数は、"options" = all または "options" = transitions の場合にのみ適用されます。

要求ヘッダー

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティモデルと組み合わせて使用するアカウントを指定します。これは Azure Maps アカウントの一意の ID を表し、Azure Maps 管理プレーンアカウント API から取得できます。 Azure Maps で Microsoft Entra ID セキュリティを使用するには、ガイダンス次の記事を参照してください。
Accept-Language		string	タイムゾーン名を返す言語コードを指定します。言語コードが指定されていない場合、応答は "EN" になります。詳細については、サポートされている言語のを参照してください。

応答

名前	型	説明
200 OK	TimezoneResult	わかりました
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
フロー: 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

例

Successfully retrieve timezone by ID

要求のサンプル

HTTP

GET https://atlas.microsoft.com/timezone/byId/json?api-version=1.0&options=all&query=Asia/Bahrain

応答のサンプル

状態コード:: 200

{
  "Version": "2018c",
  "ReferenceUtcTimestamp": "2018-01-31T00:03:15.1349348Z",
  "TimeZones": [
    {
      "Id": "Asia/Qatar",
      "Aliases": [
        "Asia/Bahrain"
      ],
      "Countries": [
        {
          "Name": "Qatar",
          "Code": "QA"
        },
        {
          "Name": "Bahrain",
          "Code": "BH"
        }
      ],
      "Names": {
        "ISO6391LanguageCode": "en",
        "Generic": "Arabian Time",
        "Standard": "Arabian Standard Time",
        "Daylight": "Arabian Daylight Time"
      },
      "ReferenceTime": {
        "Tag": "+03",
        "StandardOffset": "03:00:00",
        "DaylightSavings": "00:00:00",
        "WallTime": "2018-01-31T03:03:15.1349348+03:00",
        "PosixTzValidYear": 2018,
        "PosixTz": "<+03>-3"
      },
      "RepresentativePoint": {
        "Latitude": 25.283333333333335,
        "Longitude": 51.53333333333333
      },
      "TimeTransitions": [
        {
          "Tag": "+03",
          "StandardOffset": "03:00:00",
          "DaylightSavings": "00:00:00",
          "UtcStart": "1972-05-31T20:00:00Z",
          "UtcEnd": "9999-12-31T23:59:59.9999999Z"
        }
      ]
    }
  ]
}

定義

名前	説明
CountryRecord	国/地域レコード。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
JsonFormat	応答の目的の形式。 `json` 形式のみがサポートされています。
ReferenceTime	現地時刻に有効な詳細。
RepresentativePoint	代表的なポイントプロパティ
TimeTransition
TimezoneId
TimezoneNames	タイムゾーン名オブジェクト。
TimezoneOptions	または、エイリアス "o" を使用します。結果で返される情報の種類に使用できるオプション。
TimezoneResult	このオブジェクトは、成功したタイムゾーンの ID 呼び出しまたは座標による呼び出しから返されます

CountryRecord

国/地域レコード。

名前	型	説明
Code	string	ISO-3166 国/地域の 2 文字の国/地域コード。
Name	string	country/region Name

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

JsonFormat

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

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

ReferenceTime

現地時刻に有効な詳細。

名前	型	説明
DaylightSavings	string	`ReferenceUTCTimestamp`で有効な時間を分単位で節約できます。
PosixTz	string	タイムゾーン環境変数の設定に使用される POSIX 文字列。
PosixTzValidYear	integer	この POSIX 文字列が有効な年。注: POSIX 文字列は、指定された年にのみ有効です。
StandardOffset	string	`ReferenceUTCTimestamp`で有効な UTC オフセット。
Sunrise	string	`Tag` プロパティに示すように、指定されたタイムゾーンの日の出は、呼び出しが `byCoordinates`されたときにのみ設定されます。日の出は ISO 8601 形式で記述されています。 Timezone API では、要求されたリージョンで日の出と日の入りの時刻が返されないことに注意してください。
Sunset	string	`Tag` プロパティに示すように、指定されたタイムゾーンでのサンセット。呼び出しが `byCoordinates`場合にのみ設定されます。サンセットは、ISO 8601 形式で記述されています。 Timezone API では、要求されたリージョンで日の出と日の入りの時刻が返されないことに注意してください。
Tag	string	参照タイムスタンプで有効なタイムゾーン名 (つまり、夏時間が有効かどうかに応じて PST または PDT)。
WallTime	string	`Tag` プロパティに示すように、特定のタイムゾーンでの現在の壁の時刻。

RepresentativePoint

代表的なポイントプロパティ

名前	型	説明
Latitude	number	Latitude プロパティ
Longitude	number	Longitude プロパティ

TimeTransition

名前	型	説明
DaylightSavings	string	DaylightSavings プロパティ
StandardOffset	string	StandardOffset プロパティ
Tag	string	Tag プロパティ
UtcEnd	string	この移行期間の終了日、終了時刻
UtcStart	string	この移行期間の開始日、開始時刻

TimezoneId

名前	型	説明
Aliases	string[]	タイムゾーン ID エイリアスの配列。 [options]=zoneinfo またはすべての場合にのみ返されます。注: null である可能性があります。
Countries	CountryRecord[]	国/地域レコードの配列。 [options]=zoneinfo またはすべての場合にのみ返されます。
Id	string	Id プロパティ
Names	TimezoneNames	タイムゾーン名オブジェクト。
ReferenceTime	ReferenceTime	現地時刻に有効な詳細。
RepresentativePoint	RepresentativePoint	代表的なポイントプロパティ
TimeTransitions	TimeTransition[]	タイムゾーン DST は、[transitionsFrom] からタイムスタンプ + 1 年に遷移します。

TimezoneNames

タイムゾーン名オブジェクト。

名前	型	説明
Daylight	string	夏時間の名前
Generic	string	属名
ISO6391LanguageCode	string	名前の ISO 639-1 言語コード
Standard	string	標準名

TimezoneOptions

または、エイリアス "o" を使用します。結果で返される情報の種類に使用できるオプション。

名前	型	説明
all	string	結果に zoneinfo と遷移の両方を含めます。
none	string	結果に zoneinfo や遷移を含めないでください。
transitions	string	結果に遷移情報を含めます (現在、遷移の数は 250 に制限されています)。
zoneInfo	string	結果に追加のタイムゾーン情報を含めます。

TimezoneResult

このオブジェクトは、成功したタイムゾーンの ID 呼び出しまたは座標による呼び出しから返されます

名前	型	説明
ReferenceUtcTimestamp	string	Reference Utc Timestamp プロパティ
TimeZones	TimezoneId[]	TimeZoneId 配列
Version	string	Version プロパティ

次の方法で共有