Timezone - Get Timezone By ID

Ссылка

Service:: Maps

API Version:: 1.0

Используйте для получения текущих, исторических и будущих сведений о часовом поясе для указанного идентификатора часового пояса IANA.

Get Timezone By ID API — это HTTP-запросGET, который возвращает текущие, исторические и будущие сведения о часовом поясе для указанного идентификатора часового пояса IANA.

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

With optional parameters:

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	Номер версии API Azure Maps
query	query	True	string	Идентификатор часового пояса IANA.
options	query		TimezoneOptions	Кроме того, используйте псевдоним "o". Параметры, доступные для типов сведений, возвращаемых в результате.
timeStamp	query		string date-time	Кроме того, используйте псевдоним "stamp" или "s". Время ссылки, если оно опущено, API будет использовать машинное время, обслуживая запрос.
transitionsFrom	query		string date-time	Кроме того, используйте псевдоним "tf". Дата начала, с которой запрашиваются переходы на летнее время (DST), применяется только в том случае, если "options" = all или "options" = переходы.
transitionsYears	query		integer	Кроме того, используйте псевдоним "ty". Количество лет с момента перехода, для которого запрашиваются переходы на летнее время, применяется только в том случае, если "options" = all или "options" = переходы.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает учетную запись, предназначенную для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.
Accept-Language		string	Указывает код языка, в котором должны возвращаться имена часовых поясов. Если код языка не указан, ответ будет указан в формате "EN". Дополнительные сведения см. в разделе Поддерживаемые языки .

Ответы

Имя	Тип	Описание
200 OK	TimezoneResult	ОК
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

Безопасность

AADToken

Это Microsoft Entra потоков OAuth 2.0. В сочетании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе может быть предоставлен доступ через встроенную или пользовательскую роль, состоящую из одного или нескольких разрешений для Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, которые могут управлять доступом к определенным API и областям.

Примечания

Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами.

объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.

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

Это общий ключ, который подготавливается при Create учетной записи Azure Maps в портал Azure или с помощью PowerShell, CLI, пакетов AZURE SDK или REST API.

С помощью этого ключа любое приложение может получить доступ ко всем REST API. Иными словами, этот ключ можно использовать в качестве ключа master в учетной записи, в которую они выдаются.

Для общедоступных приложений мы рекомендуем использовать подход конфиденциальных клиентских приложений для доступа к Azure Maps REST API, чтобы ключ можно было безопасно хранить.

Type: apiKey
In: query

SAS Token

Этот маркер подписанного URL-адреса создается из операции List SAS в ресурсе Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов использования конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи сопоставления , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Type: apiKey
In: header

Примеры

Successfully retrieve timezone by ID

Sample Request

HTTP

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

Sample Response

Status code:: 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	Этот объект возвращается из успешного вызова Timezone By ID или By Coordinates

CountryRecord

Запись страны или региона.

Имя	Тип	Описание
Code	string	Iso-3166 2-буквенный код страны или региона для страны или региона.
Name	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

ReferenceTime

Сведения, которые действуют по местному времени.

Имя	Тип	Описание
DaylightSavings	string	Экономия времени в минутах в действии `ReferenceUTCTimestamp`на .
PosixTz	string	Строка POSIX, используемая для задания переменной среды часового пояса.
PosixTzValidYear	integer	Год, на который действительна эта строка POSIX. Примечание. Строка POSIX будет действительна только в заданном году.
StandardOffset	string	Смещение в формате UTC, действовающее в `ReferenceUTCTimestamp`.
Sunrise	string	Восход солнца в заданном часовом поясе, как показано в свойстве `Tag` . Восход солнца описан в формате ISO8601. (Заполняется только в том случае, если вызов выполняется byCoordinates)
Sunset	string	Закат в заданном часовом поясе, как показано в свойстве `Tag` . Закат описан в формате ISO8601. (Заполняется только в том случае, если вызов выполняется byCoordinates)
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[]	Массив псевдонимов идентификаторов часовых поясов. Возвращается только в том случае, если [options]=zoneinfo или все. Примечание. Может иметь значение NULL.
Countries	CountryRecord[]	Массив записей страны или региона. Возвращается только в том случае, если [options]=zoneinfo или все.
Id	string	Свойство Id
Names	TimezoneNames	Объект имен часового пояса.
ReferenceTime	ReferenceTime	Сведения, которые действуют по местному времени.
RepresentativePoint	RepresentativePoint	Свойство репрезентативной точки
TimeTransitions	TimeTransition[]	Переходы летнего пояса с [transitionsFrom] до метки времени + 1 год.

TimezoneNames

Объект имен часового пояса.

Имя	Тип	Описание
Daylight	string	Название дневного света
Generic	string	Generic Name
ISO6391LanguageCode	string	Код языка ISO 639-1 имен
Standard	string	Стандартное имя

TimezoneOptions

Кроме того, используйте псевдоним "o". Параметры, доступные для типов сведений, возвращаемых в результате.

Имя	Тип	Описание
all	string	Включите в результат как zoneinfo, так и переходы.
none	string	Не включайте zoneinfo или переходы в результат.
transitions	string	Включите сведения о переходе в результат (количество переходов в настоящее время ограничено 250).
zoneInfo	string	Включите дополнительные сведения о часовом поясе в результат.

TimezoneResult

Этот объект возвращается из успешного вызова Timezone By ID или By Coordinates

Имя	Тип	Описание
ReferenceUtcTimestamp	string	Свойство Reference UTC Timestamp
TimeZones	TimezoneId[]	Массив TimeZoneId
Version	string	Version, свойство