Timezone - Get Timezone By ID
Permet d’obtenir les informations actuelles, historiques et futures du fuseau horaire pour l’ID de fuseau horaire IANA spécifié.
L’API Get Timezone By ID
est une requête HTTP GET
qui retourne des informations de fuseau horaire actuelles, historiques et futures pour l’ID de fuseau horaire IANA spécifié.
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}
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
format
|
path | True |
Format souhaité de la réponse. Seul |
|
api-version
|
query | True |
string |
Numéro de version de l’API Azure Maps. |
query
|
query | True |
string |
ID de fuseau horaire IANA. |
options
|
query |
Vous pouvez également utiliser l’alias « o ». Options disponibles pour les types d’informations retournées dans le résultat. |
||
time
|
query |
string date-time |
Vous pouvez également utiliser l’alias « stamp » ou « s ». L’heure de référence, si elle est omise, l’API utilise l’heure de l’ordinateur qui sert la requête. |
|
transitions
|
query |
string date-time |
Vous pouvez également utiliser l’alias « tf ». La date de début à partir de laquelle les transitions d’heure d’été (DST) sont demandées, s’applique uniquement lorsque « options » = toutes ou « options » = transitions. |
|
transitions
|
query |
integer |
Vous pouvez également utiliser l’alias « ty ». Le nombre d’années de « transitionsFrom » pour lesquelles les transitions DST sont demandées s’applique uniquement lorsque « options » = all ou « options » = transitions. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
x-ms-client-id |
string |
Spécifie le compte destiné à l’utilisation conjointement avec le modèle de sécurité Microsoft Entra ID. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte de plan de gestion Azure Maps. Pour utiliser la sécurité microsoft Entra ID dans Azure Maps, consultez les articles suivants pour obtenir des conseils. |
|
Accept-Language |
string |
Spécifie le code de langue dans lequel les noms de fuseau horaire doivent être retournés. Si aucun code de langue n’est fourni, la réponse est en « EN ». Pour plus d’informations, consultez langues prises en charge. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
D’ACCORD |
|
Other Status Codes |
Une erreur inattendue s’est produite. |
Sécurité
AADToken
Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé à 'accès en fonction du rôle Azure contrôle, il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.
Pour implémenter des scénarios, nous vous recommandons d’afficher concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.
Notes
- Cette définition de sécurité nécessite l’utilisation de l’en-tête
x-ms-client-id
pour indiquer la ressource Azure Maps à laquelle l’application demande l’accès. Cela peut être acquis à partir de l’API de gestion Maps.
La Authorization URL
est spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra.
* Le contrôle d’accès en fonction du rôle Azure est configuré à partir de l'plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.
* L’utilisation du kit de développement logiciel (SDK) web Azure Maps permet la configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
- Pour plus d’informations sur la plateforme d’identités Microsoft, consultez vue d’ensemble de la plateforme d’identités Microsoft.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Il s’agit d’une clé partagée provisionnée lorsque vous créer un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, CLI, sdk Azure ou API REST.
Avec cette clé, toute application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé principale dans le compte dans lequel elles sont émises.
Pour les applications exposées publiquement, nous vous recommandons d’utiliser les applications clientes confidentielles approche permettant d’accéder aux API REST Azure Maps afin que votre clé puisse être stockée en toute sécurité.
Type:
apiKey
Dans:
query
SAS Token
Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, azure SDK ou LES API REST.
Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.
Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.
Type:
apiKey
Dans:
header
Exemples
Successfully retrieve timezone by ID
Exemple de requête
GET https://atlas.microsoft.com/timezone/byId/json?api-version=1.0&options=all&query=Asia/Bahrain
Exemple de réponse
{
"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"
}
]
}
]
}
Définitions
Nom | Description |
---|---|
Country |
Enregistrement pays/région. |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Json |
Format souhaité de la réponse. Seul |
Reference |
Détails en vigueur à l’heure locale. |
Representative |
Propriété de point représentatif |
Time |
|
Timezone |
|
Timezone |
Objet de noms de fuseau horaire. |
Timezone |
Vous pouvez également utiliser l’alias « o ». Options disponibles pour les types d’informations retournées dans le résultat. |
Timezone |
Cet objet est retourné à partir d’un appel de fuseau horaire réussi par ID ou par appel de coordonnées |
CountryRecord
Enregistrement pays/région.
Nom | Type | Description |
---|---|---|
Code |
string |
Code pays/région ISO-3166 2 lettres pour le pays/la région. |
Name |
string |
nom du pays/de la région |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
Nom | Type | Description |
---|---|---|
info |
object |
Informations supplémentaires. |
type |
string |
Type d’informations supplémentaire. |
ErrorDetail
Détail de l’erreur.
Nom | Type | Description |
---|---|---|
additionalInfo |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d’erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
Nom | Type | Description |
---|---|---|
error |
Objet d’erreur. |
JsonFormat
Format souhaité de la réponse. Seul json
format est pris en charge.
Nom | Type | Description |
---|---|---|
json |
string |
ReferenceTime
Détails en vigueur à l’heure locale.
Nom | Type | Description |
---|---|---|
DaylightSavings |
string |
L’enregistrement du temps en minutes en vigueur au |
PosixTz |
string |
Chaîne POSIX utilisée pour définir la variable d’environnement de fuseau horaire. |
PosixTzValidYear |
integer |
L’année pour laquelle cette chaîne POSIX est valide. Remarque : une chaîne POSIX ne sera valide que dans l’année donnée. |
StandardOffset |
string |
Décalage UTC en vigueur au |
Sunrise |
string |
Lever du soleil au fuseau horaire donné, comme indiqué dans la propriété |
Sunset |
string |
Coucher du soleil au fuseau horaire donné, comme indiqué dans la propriété |
Tag |
string |
Nom du fuseau horaire en vigueur au timestamp de référence (par exemple, PST ou PDT selon que l’heure d’été est en vigueur). |
WallTime |
string |
Heure du mur actuel au fuseau horaire donné, comme indiqué dans la propriété |
RepresentativePoint
Propriété de point représentatif
Nom | Type | Description |
---|---|---|
Latitude |
number |
Latitude, propriété |
Longitude |
number |
Longitude, propriété |
TimeTransition
Nom | Type | Description |
---|---|---|
DaylightSavings |
string |
Propriété DaylightSavings |
StandardOffset |
string |
StandardOffset, propriété |
Tag |
string |
Propriété Tag |
UtcEnd |
string |
Date de fin, heure de fin de cette période de transition |
UtcStart |
string |
Date de début, heure de début de cette période de transition |
TimezoneId
Nom | Type | Description |
---|---|---|
Aliases |
string[] |
Tableau d’alias d’ID de fuseau horaire. Retourné uniquement lorsque [options]=zoneinfo ou tous les. Remarque : peut être null. |
Countries |
Tableau d’enregistrements pays/région. Retourné uniquement lorsque [options]=zoneinfo ou tous les. |
|
Id |
string |
Id, propriété |
Names |
Objet de noms de fuseau horaire. |
|
ReferenceTime |
Détails en vigueur à l’heure locale. |
|
RepresentativePoint |
Propriété de point représentatif |
|
TimeTransitions |
La DST du fuseau horaire passe de [transitionsFrom] jusqu’à l’horodatage + 1 an. |
TimezoneNames
Objet de noms de fuseau horaire.
Nom | Type | Description |
---|---|---|
Daylight |
string |
Nom de l’été |
Generic |
string |
Machin |
ISO6391LanguageCode |
string |
Code de langue ISO 639-1 des noms |
Standard |
string |
Nom standard |
TimezoneOptions
Vous pouvez également utiliser l’alias « o ». Options disponibles pour les types d’informations retournées dans le résultat.
Nom | Type | Description |
---|---|---|
all |
string |
Incluez à la fois les zonesinfo et les transitions dans le résultat. |
none |
string |
N’incluez pas les zonesinfo ou les transitions dans le résultat. |
transitions |
string |
Incluez les informations de transition dans le résultat (le nombre de transitions est actuellement limité à 250). |
zoneInfo |
string |
Incluez des informations de fuseau horaire supplémentaires dans le résultat. |
TimezoneResult
Cet objet est retourné à partir d’un appel de fuseau horaire réussi par ID ou par appel de coordonnées
Nom | Type | Description |
---|---|---|
ReferenceUtcTimestamp |
string |
Référence utc Timestamp, propriété |
TimeZones |
Tableau TimeZoneId |
|
Version |
string |
Version, propriété |