Freigeben über


Timezone - Get Timezone By ID

Verwenden Sie, um die aktuellen, historischen und zukünftigen Zeitzoneninformationen für die angegebene IANA-Zeitzonen-ID abzurufen.

Die Get Timezone By ID API ist eine HTTP-Anforderung GET , die aktuelle, verlaufsbezogene und zukünftige Zeitzoneninformationen für die angegebene IANA-Zeitzonen-ID zurückgibt.

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-Parameter

Name In Erforderlich Typ Beschreibung
format
path True

JsonFormat

Gewünschtes Format der Antwort. Nur das json-Format wird unterstützt.

api-version
query True

string

Versionsnummer der Azure Maps API.

query
query True

string

Die IANA-Zeitzonen-ID.

options
query

TimezoneOptions

Alternativ können Sie den Alias "o" verwenden. Verfügbare Optionen für typen von Informationen, die im Ergebnis zurückgegeben werden.

timeStamp
query

string

date-time

Alternativ können Sie den Alias "stamp" oder "s" verwenden. Referenzzeit, wenn sie nicht angegeben wird, verwendet die API die Computerzeit, die die Anforderung verarbeitet.

transitionsFrom
query

string

date-time

Alternativ können Sie den Alias "tf" verwenden. Das Startdatum, ab dem Sommerzeitübergänge (DST) angefordert werden, gilt nur, wenn "Optionen" = alle oder "Optionen" = Übergange sind.

transitionsYears
query

integer

Alternativ können Sie den Alias "ty" verwenden. Die Anzahl der Jahre ab "transitionsFrom", für die DST-Übergänge angefordert werden, gilt nur, wenn "options" = all oder "options" = Transitions ist.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-id

string

Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie in den folgenden Artikeln .

Accept-Language

string

Gibt den Sprachcode an, in dem die Zeitzonennamen zurückgegeben werden sollen. Wenn kein Sprachcode angegeben wird, erfolgt die Antwort in "EN". Weitere Informationen finden Sie unter Unterstützte Sprachen .

Antworten

Name Typ Beschreibung
200 OK

TimezoneResult

OK

Other Status Codes

ErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

Hinweise

  • Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

Der Authorization URL ist spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen. * Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht das konfigurationsbasierte Einrichten einer Anwendung für mehrere Anwendungsfälle.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Dies ist ein freigegebener Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal erstellen oder PowerShell, die CLI, Azure SDKs oder die REST-API verwenden.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, den Ansatz vertraulicher Clientanwendungen zu verwenden, um auf Azure Maps-REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Hierbei handelt es sich um ein Shared Access Signature Token, das aus dem Sas-Listenvorgang für die Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Successfully retrieve timezone by ID

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
CountryRecord

Ein Länder-/Regionsdatensatz.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

JsonFormat

Gewünschtes Format der Antwort. Nur das json-Format wird unterstützt.

ReferenceTime

Details, die zur Lokalen Zeit wirksam sind.

RepresentativePoint

Repräsentative Punkteigenschaft

TimeTransition
TimezoneId
TimezoneNames

Zeitzonennamen-Objekt.

TimezoneOptions

Alternativ können Sie den Alias "o" verwenden. Optionen, die für im Ergebnis zurückgegebene Informationstypen verfügbar sind.

TimezoneResult

Dieses Objekt wird von einem erfolgreichen Aufruf von Timezone By ID oder By Coordinates zurückgegeben.

CountryRecord

Ein Länder-/Regionsdatensatz.

Name Typ Beschreibung
Code

string

ISO-3166 2-Buchstaben-Länder-/Regionscode für das Land/die Region.

Name

string

Land-/Regionsname

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

JsonFormat

Gewünschtes Format der Antwort. Nur das json-Format wird unterstützt.

Name Typ Beschreibung
json

string

Das Datenaustauschformat der JavaScript-Objektnotation

ReferenceTime

Details, die zur Lokalen Zeit wirksam sind.

Name Typ Beschreibung
DaylightSavings

string

Zeitersparnis in Minuten beim wirksamen ReferenceUTCTimestamp.

PosixTz

string

POSIX-Zeichenfolge, die zum Festlegen der Umgebungsvariablen der Zeitzone verwendet wird.

PosixTzValidYear

integer

Das Jahr, für das diese POSIX-Zeichenfolge gültig ist. Hinweis: Eine POSIX-Zeichenfolge ist nur im angegebenen Jahr gültig.

StandardOffset

string

Der UTC-Offset ist am ReferenceUTCTimestampwirksam.

Sunrise

string

Sonnenaufgang in der angegebenen Zeitzone, wie in der Tag Eigenschaft gezeigt. Der Sonnenaufgang wird im ISO8601-Format beschrieben. (Nur aufgefüllt werden, wenn der Aufruf byCoordinates ist)

Sunset

string

Sonnenuntergang in der angegebenen Zeitzone, wie in der Tag Eigenschaft gezeigt. Der Sonnenuntergang wird im ISO8601-Format beschrieben. (Nur aufgefüllt werden, wenn der Aufruf byCoordinates ist)

Tag

string

Zeitzonenname, der beim Referenzzeitstempel wirksam ist (d. h. PST oder PDT, je nachdem, ob die Sommerzeit aktiv ist).

WallTime

string

Aktuelle Wandzeit in der angegebenen Zeitzone, wie in der Tag -Eigenschaft gezeigt.

RepresentativePoint

Repräsentative Punkteigenschaft

Name Typ Beschreibung
Latitude

number

Latitude-Eigenschaft

Longitude

number

Längengradeigenschaft

TimeTransition

Name Typ Beschreibung
DaylightSavings

string

DaylightSavings-Eigenschaft

StandardOffset

string

StandardOffset-Eigenschaft

Tag

string

Tag-Eigenschaft

UtcEnd

string

Enddatum, Endzeit für diesen Übergangszeitraum

UtcStart

string

Startdatum, Startzeit für diesen Übergangszeitraum

TimezoneId

Name Typ Beschreibung
Aliases

string[]

Ein Array von Zeitzonen-ID-Aliasen. Wird nur zurückgegeben, wenn [options]=zoneinfo oder all.

Hinweis: Kann NULL sein.

Countries

CountryRecord[]

Ein Array von Länder-/Regionsdatensätzen. Wird nur zurückgegeben, wenn [options]=zoneinfo oder all.

Id

string

ID-Eigenschaft

Names

TimezoneNames

Zeitzonennamen-Objekt.

ReferenceTime

ReferenceTime

Details, die zur Lokalen Zeit wirksam sind.

RepresentativePoint

RepresentativePoint

Repräsentative Punkteigenschaft

TimeTransitions

TimeTransition[]

Die Zeitzonenzeit wechselt von [transitionsFrom] auf Zeitstempel + 1 Jahr.

TimezoneNames

Zeitzonennamen-Objekt.

Name Typ Beschreibung
Daylight

string

Name des Tageslichts

Generic

string

Generic Name

ISO6391LanguageCode

string

Der ISO 639-1-Sprachcode der Namen

Standard

string

Name (Standard)

TimezoneOptions

Alternativ können Sie den Alias "o" verwenden. Optionen, die für im Ergebnis zurückgegebene Informationstypen verfügbar sind.

Name Typ Beschreibung
all

string

Schließen Sie sowohl zoneninfo als auch Übergänge in das Ergebnis ein.

none

string

Schließen Sie keine Zoneninfos oder Übergänge in das Ergebnis ein.

transitions

string

Schließen Sie Übergangsinformationen in das Ergebnis ein (Die Anzahl der Übergänge ist derzeit auf 250 begrenzt).

zoneInfo

string

Fügen Sie zusätzliche Zeitzoneninformationen in das Ergebnis ein.

TimezoneResult

Dieses Objekt wird von einem erfolgreichen Aufruf von Timezone By ID oder By Coordinates zurückgegeben.

Name Typ Beschreibung
ReferenceUtcTimestamp

string

Referenz utc Timestamp-Eigenschaft

TimeZones

TimezoneId[]

TimeZoneId-Array

Version

string

Version-Eigenschaft