Timezone - Get Timezone By ID
Usare per ottenere le informazioni correnti, cronologiche e future sul fuso orario per l'ID del 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 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 |
Formato desiderato della risposta. È supportato solo il formato |
|
api-version
|
query | True |
string |
Numero di versione dell'API Mappe di Azure. |
query
|
query | True |
string |
ID fuso orario IANA. |
options
|
query |
In alternativa, usare l'alias "o". Opzioni disponibili per i tipi di informazioni restituite nel risultato. |
||
time
|
query |
string date-time |
In alternativa, usare l'alias "stamp" o "s". Tempo di riferimento, se omesso, l'API userà il tempo di computer che gestisce la richiesta. |
|
transitions
|
query |
string date-time |
In alternativa, usare l'alias "tf". La data di inizio da cui vengono richieste transizioni di ora legale (DST), si applica solo quando le "opzioni" = tutte o "opzioni" = transizioni. |
|
transitions
|
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" = tutte o "options" = transizioni. |
Intestazione della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
x-ms-client-id |
string |
Specifica l'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 account del piano di gestione di Mappe di Azure. Per usare la sicurezza di Microsoft Entra ID in Mappe di Azure, vedere gli articoli 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 |
OK |
|
Other Status Codes |
Si è verificato un errore imprevisto. |
Sicurezza
AADToken
Si tratta dei flussi Microsoft Entra OAuth 2.0 . Se abbinato al controllo degli accessi in base al ruolo di Azure , 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 i 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 mappe.
è Authorization URL
specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni ID Microsoft Entra.
* 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 di Azure Maps Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.
- Per altre informazioni su Microsoft Identity Platform, vedere Panoramica di Microsoft Identity Platform.
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 crea un account 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 alle 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 Elenca firma di accesso condiviso nella risorsa 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 con i controlli di accesso in base al ruolo di Azure e il controllo granulare alla scadenza, alla frequenza e alle 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 dell'account map 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 |
---|---|
Country |
Record paese/area geografica. |
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
Error |
Dettagli dell'errore. |
Error |
Risposta di errore |
Json |
Formato desiderato della risposta. È supportato solo il formato |
Reference |
Dettagli effettivi all'ora locale. |
Representative |
Proprietà del punto rappresentativo |
Time |
|
Timezone |
|
Timezone |
Oggetto nomi fuso orario. |
Timezone |
In alternativa, usare l'alias "o". Opzioni disponibili per i tipi di informazioni restituite nel risultato. |
Timezone |
Questo oggetto viene restituito da una chiamata timezone per ID riuscita o per coordinata |
CountryRecord
Record 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 |
Informazioni aggiuntive sull'errore. |
|
code |
string |
Codice di errore. |
details |
Dettagli dell'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore. |
ErrorResponse
Risposta di errore
Nome | Tipo | Descrizione |
---|---|---|
error |
Oggetto error. |
JsonFormat
Formato desiderato della risposta. È supportato solo il formato json
.
Nome | Tipo | Descrizione |
---|---|---|
json |
string |
ReferenceTime
Dettagli effettivi all'ora locale.
Nome | Tipo | Descrizione |
---|---|---|
DaylightSavings |
string |
Tempo di risparmio in minuti effettivo in corrispondenza di |
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 attivo in corrispondenza di |
Sunrise |
string |
Alba al fuso orario specificato, come illustrato nella |
Sunset |
string |
Tramonto nel fuso orario specificato, come illustrato nella |
Tag |
string |
Nome del fuso orario attivo al timestamp di riferimento ,ad esempio PST o PDT a seconda che l'ora legale sia attiva. |
WallTime |
string |
Ora del muro corrente nel fuso orario specificato, come illustrato nella |
RepresentativePoint
Proprietà del 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 |
Tag (proprietà) |
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. Nota: può essere Null. |
Countries |
Matrice di record di paese/area geografica. Restituito solo quando [opzioni]=zoneinfo o tutti. |
|
Id |
string |
Id - proprietà |
Names |
Oggetto nomi fuso orario. |
|
ReferenceTime |
Dettagli effettivi all'ora locale. |
|
RepresentativePoint |
Proprietà del punto rappresentativo |
|
TimeTransitions |
Il fuso orario DST passa da [transitionsFrom] fino al timestamp + 1 anno. |
TimezoneNames
Oggetto nomi fuso orario.
Nome | Tipo | Descrizione |
---|---|---|
Daylight |
string |
Nome giorno |
Generic |
string |
Generic Name |
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 |
Includi informazioni aggiuntive sul fuso orario nel risultato. |
TimezoneResult
Questo oggetto viene restituito da una chiamata timezone per ID riuscita o per coordinata
Nome | Tipo | Descrizione |
---|---|---|
ReferenceUtcTimestamp |
string |
Proprietà Timestamp utc di riferimento |
TimeZones |
Matrice TimeZoneId |
|
Version |
string |
Version - proprietà |