Timezone - Get Timezone By ID

Usare per ottenere le informazioni correnti, cronologiche e future sul fuso orario per l'ID fuso orario IANA specificato.

L'API Get Timezone By ID è una richiesta http GET che restituisce informazioni correnti, cronologiche e future sul fuso orario per l'ID del fuso orario IANA specificato.

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}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
format
path True

JsonFormat

Formato desiderato della risposta. È supportato solo json formato.

api-version
query True

string

Numero di versione dell'API mappe di Azure.

query
query True

string

ID fuso orario IANA.

options
query

TimezoneOptions

In alternativa, usare l'alias "o". Opzioni disponibili per i tipi di informazioni restituite nel risultato.

timeStamp
query

string

date-time

In alternativa, usare l'alias "stamp" o "s". Ora di riferimento, se omessa, l'API userà il tempo del computer che gestisce la richiesta.

transitionsFrom
query

string

date-time

In alternativa, usare l'alias "tf". La data di inizio dalla quale vengono richieste transizioni di ora legale (DST), si applica solo quando "options" = all o "options" = transizioni.

transitionsYears
query

integer

In alternativa, usare l'alias "ty". Il numero di anni da "transitionsFrom" per cui vengono richieste transizioni DST, si applica solo quando "options" = all o "options" = transizioni.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
x-ms-client-id

string

Specifica quale account è destinato all'utilizzo in combinazione con il modello di sicurezza Microsoft Entra ID. Rappresenta un ID univoco per l'account mappe di Azure e può essere recuperato dall'API dell'account del piano di gestione di Mappe di Azure. Per usare la sicurezza di Microsoft Entra ID in Mappe di Azure, vedere gli articoli di seguenti per indicazioni.

Accept-Language

string

Specifica il codice della lingua in cui devono essere restituiti i nomi del fuso orario. Se non viene fornito alcun codice linguistico, la risposta sarà in "EN". Per informazioni dettagliate, vedere lingue supportate.

Risposte

Nome Tipo Descrizione
200 OK

TimezoneResult

OK

Other Status Codes

ErrorResponse

Si è verificato un errore imprevisto.

Sicurezza

AADToken

Questi sono i flussi di Microsoft Entra OAuth 2.0. Se abbinato a l'accesso in base al ruolo di Azure controllarlo, può essere usato per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più account di risorse di Mappe di Azure o a risorse secondarie. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per le API REST di Mappe di Azure.

Per implementare scenari, è consigliabile visualizzare concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.

Note

  • Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare a quale risorsa di Mappe di Azure l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione di mappe .

Il Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni microsoft Entra ID. * Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST. * L'utilizzo del Sdk Web di Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Si tratta di una chiave condivisa di cui viene effettuato il provisioning quando si Creare un account di Mappe di Azure nel portale di Azure o usando PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o l'API REST.

Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere usata come chiave master nell'account in cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'approccio applicazioni client riservate per accedere alle API REST di Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.

Tipo: apiKey
In: query

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione List SAS nell'risorsa di Mappe di Azure tramite il piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere ai controlli di accesso in base al ruolo di Azure e al controllo granulare per la scadenza, la frequenza e le aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.

Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

Successfully retrieve timezone by ID

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
CountryRecord

Record di paese/area geografica.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore

JsonFormat

Formato desiderato della risposta. È supportato solo json formato.

ReferenceTime

Dettagli in vigore all'ora locale.

RepresentativePoint

Proprietà punto rappresentativo

TimeTransition
TimezoneId
TimezoneNames

Oggetto Nomi fuso orario.

TimezoneOptions

In alternativa, usare l'alias "o". Opzioni disponibili per i tipi di informazioni restituite nel risultato.

TimezoneResult

Questo oggetto viene restituito da una chiamata di timezone per ID riuscita o da coordinate

CountryRecord

Record di paese/area geografica.

Nome Tipo Descrizione
Code

string

Codice paese/area geografica ISO-3166 a 2 lettere per il paese/area geografica.

Name

string

nome paese/area geografica

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorDetail[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

JsonFormat

Formato desiderato della risposta. È supportato solo json formato.

ReferenceTime

Dettagli in vigore all'ora locale.

Nome Tipo Descrizione
DaylightSavings

string

Risparmio di tempo in minuti in vigore al ReferenceUTCTimestamp.

PosixTz

string

Stringa POSIX usata per impostare la variabile di ambiente del fuso orario.

PosixTzValidYear

integer

L'anno per cui questa stringa POSIX è valida. Nota: una stringa POSIX sarà valida solo nell'anno specificato.

StandardOffset

string

Offset UTC in vigore al ReferenceUTCTimestamp.

Sunrise

string

Alba al fuso orario specificato, come illustrato nella proprietà Tag, popolata solo quando la chiamata è byCoordinates. L'alba è descritta nel formato ISO 8601 . Si noti che l'API Fuso orario non restituisce l'alba e l'ora del tramonto quando il giorno solare viene osservato nell'area richiesta.

Sunset

string

Tramonto nel fuso orario specificato, come illustrato nella proprietà Tag, popolato solo quando la chiamata viene byCoordinates. Il tramonto è descritto nel formato ISO 8601. Si noti che l'API Fuso orario non restituisce l'alba e l'ora del tramonto quando il giorno solare viene osservato nell'area richiesta.

Tag

string

Nome del fuso orario in vigore al timestamp di riferimento (ad esempio PST o PDT a seconda che l'ora legale sia attiva).

WallTime

string

Ora corrente in corrispondenza del fuso orario specificato, come illustrato nella proprietà Tag.

RepresentativePoint

Proprietà punto rappresentativo

Nome Tipo Descrizione
Latitude

number

Proprietà Latitude

Longitude

number

Longitudine - proprietà

TimeTransition

Nome Tipo Descrizione
DaylightSavings

string

DaylightSavings - proprietà

StandardOffset

string

Proprietà StandardOffset

Tag

string

Proprietà tag

UtcEnd

string

Data di fine, ora di fine per questo periodo di transizione

UtcStart

string

Data di inizio, ora di inizio per questo periodo di transizione

TimezoneId

Nome Tipo Descrizione
Aliases

string[]

Matrice di alias ID fuso orario. Restituito solo quando [opzioni]= zoneinfo o tutti i.

Nota: può essere null.

Countries

CountryRecord[]

Matrice di record di paese/area geografica. Restituito solo quando [opzioni]= zoneinfo o tutti i.

Id

string

Id - proprietà

Names

TimezoneNames

Oggetto Nomi fuso orario.

ReferenceTime

ReferenceTime

Dettagli in vigore all'ora locale.

RepresentativePoint

RepresentativePoint

Proprietà punto rappresentativo

TimeTransitions

TimeTransition[]

Il fuso orario DST passa da [transitionsFrom] fino al timestamp + 1 anno.

TimezoneNames

Oggetto Nomi fuso orario.

Nome Tipo Descrizione
Daylight

string

Nome luce legale

Generic

string

Nome generico

ISO6391LanguageCode

string

Codice linguistico ISO 639-1 dei nomi

Standard

string

Nome standard

TimezoneOptions

In alternativa, usare l'alias "o". Opzioni disponibili per i tipi di informazioni restituite nel risultato.

Nome Tipo Descrizione
all

string

Includere sia zoneinfo che transizioni nel risultato.

none

string

Non includere zoneinfo o transizioni nel risultato.

transitions

string

Includere le informazioni sulla transizione nel risultato (il numero di transizioni è attualmente limitato a 250).

zoneInfo

string

Includere informazioni aggiuntive sul fuso orario nel risultato.

TimezoneResult

Questo oggetto viene restituito da una chiamata di timezone per ID riuscita o da coordinate

Nome Tipo Descrizione
ReferenceUtcTimestamp

string

Proprietà Timestamp utc di riferimento

TimeZones

TimezoneId[]

Matrice TimeZoneId

Version

string

Proprietà Version