Timezone - Get Timezone By ID

Referenz

Dienst:: Maps

API-Version:: 1.0

Dient zum Abrufen der aktuellen, historischen und zukünftigen Zeitzoneninformationen für die angegebene IANA-Zeitzonen-ID.

Die Get Timezone By ID-API ist eine HTTP-GET Anforderung, die aktuelle, historische 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}

Mit optionalen Parametern:

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 `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 alias "o" verwenden. Optionen, die für Typen von Informationen verfügbar sind, die im Ergebnis zurückgegeben werden.
timeStamp	query		string date-time	Alternativ können Sie alias "stamp" oder "s" verwenden. Wenn dies nicht angegeben wird, verwendet die API die Computerzeit für die Anforderung.
transitionsFrom	query		string date-time	Alternativ können Sie alias "tf" verwenden. Das Startdatum, ab dem Sommerzeitübergänge (DST) angefordert werden, gilt nur, wenn "options" = all or "options" = transitions.
transitionsYears	query		integer	Alternativ können Sie alias "ty" verwenden. Die Anzahl der Jahre ab "transitionsFrom", für die DST-Übergänge angefordert werden, gilt nur, wenn "options" = all or "options" = transitions.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell für die Verwendung vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus der Azure Maps-Verwaltungsebenen-Konto-API abgerufen werden. Informationen zur Verwendung der Sicherheit von Microsoft Entra-ID in Azure Maps finden Sie in den folgenden Artikeln anleitungen.
Accept-Language		string	Gibt den Sprachcode an, in dem die Zeitzonennamen zurückgegeben werden sollen. Wenn kein Sprachcode angegeben wird, befindet sich die Antwort in "EN". Weitere Informationen finden Sie unter unterstützten Sprachen.

Antworten

Name	Typ	Beschreibung
200 OK	TimezoneResult	OKAY
Other Status Codes	ErrorResponse	Unerwarteter Fehler.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

Notizen

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 Karten-Verwaltungs-APIerworben werden.

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

Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die Microsoft Identity Platform.

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 Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.

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

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

Typ: apiKey
In: query

SAS Token

Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

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

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

Typ: apiKey
In: header

Beispiele

Successfully retrieve timezone by ID

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
        }
      ]
    }
  ]
}

Definitionen

Name	Beschreibung
CountryRecord	Ein Länder-/Regionsdatensatz.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
JsonFormat	Gewünschtes Format der Antwort. Nur `json` Format wird unterstützt.
ReferenceTime	Details, die zur Ortszeit wirksam sind.
RepresentativePoint	Repräsentative Point-Eigenschaft
TimeTransition
TimezoneId
TimezoneNames	Timezone names object.
TimezoneOptions	Alternativ können Sie alias "o" verwenden. Optionen, die für Typen von Informationen verfügbar sind, die im Ergebnis zurückgegeben werden.
TimezoneResult	Dieses Objekt wird von einem erfolgreichen Timezone By ID-Aufruf oder von Koordinatenaufruf 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	Name des Landes/der Region

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
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 json Format wird unterstützt.

Name	Typ	Beschreibung
json	string	das JavaScript Object Notation Data Interchange Format

ReferenceTime

Details, die zur Ortszeit wirksam sind.

Name	Typ	Beschreibung
DaylightSavings	string	Zeitersparnis in Minuten in der `ReferenceUTCTimestamp`.
PosixTz	string	POSIX-Zeichenfolge zum Festlegen der Umgebungsvariablen für Zeitzonen.
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	UTC-Offset im `ReferenceUTCTimestamp`.
Sunrise	string	Sunrise in der angegebenen Zeitzone, wie in der `Tag` Eigenschaft dargestellt, wird nur ausgefüllt, wenn der Anruf `byCoordinates`ist. Der Sonnenaufgang wird im ISO 8601 Format beschrieben. Beachten Sie, dass die Zeitzonen-API keine Sonnenaufgangs- und Sonnenuntergangszeiten zurückgibt, wenn der Sonnentag in der angeforderten Region beobachtet wird.
Sunset	string	Sonnenuntergang in der angegebenen Zeitzone, wie in der eigenschaft `Tag` dargestellt, wird nur ausgefüllt, wenn der Aufruf `byCoordinates`ist. Der Sonnenuntergang wird im ISO 8601 Format beschrieben. Beachten Sie, dass die Zeitzonen-API keine Sonnenaufgangs- und Sonnenuntergangszeiten zurückgibt, wenn der Sonnentag in der angeforderten Region beobachtet wird.
Tag	string	Der Name der Zeitzone in Kraft beim Referenzzeitstempel (d. h. PST oder PDT, je nachdem, ob Die Sommerzeit in Kraft ist).
WallTime	string	Aktuelle Wandzeit in der angegebenen Zeitzone, wie in der eigenschaft `Tag` dargestellt.

RepresentativePoint

Repräsentative Point-Eigenschaft

Name	Typ	Beschreibung
Latitude	number	Latitude-Eigenschaft
Longitude	number	Longitude-Eigenschaft

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 alle. Hinweis: Möglicherweise ist null.
Countries	CountryRecord[]	Ein Array von Länder-/Regionsdatensätzen. Wird nur zurückgegeben, wenn [options]=zoneinfo oder alle.
Id	string	ID-Eigenschaft
Names	TimezoneNames	Timezone names object.
ReferenceTime	ReferenceTime	Details, die zur Ortszeit wirksam sind.
RepresentativePoint	RepresentativePoint	Repräsentative Point-Eigenschaft
TimeTransitions	TimeTransition[]	Der DST der Zeitzone wechselt von [transitionsFrom] bis zum Zeitstempel + 1 Jahr.

TimezoneNames

Timezone names object.

Name	Typ	Beschreibung
Daylight	string	Sommername
Generic	string	Gattungsname
ISO6391LanguageCode	string	Der ISO 639-1-Sprachcode der Namen
Standard	string	Standardname

TimezoneOptions

Alternativ können Sie alias "o" verwenden. Optionen, die für Typen von Informationen verfügbar sind, die im Ergebnis zurückgegeben werden.

Name	Typ	Beschreibung
all	string	Schließen Sie sowohl Zoneinfo als auch Übergänge in das Ergebnis ein.
none	string	Schließen Sie keine Zoneninfo oder Übergänge in das Ergebnis ein.
transitions	string	Fügen 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 Timezone By ID-Aufruf oder von Koordinatenaufruf zurückgegeben.

Name	Typ	Beschreibung
ReferenceUtcTimestamp	string	Referenz utc Timestamp-Eigenschaft
TimeZones	TimezoneId[]	TimeZoneId-Array
Version	string	Version-Eigenschaft

Freigeben über