timezone

Creates, updates, deletes, gets or lists a timezone resource.

Overview

Name	timezone
Type	Resource
Id	azure.maps_timezone.timezone

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_timezone_by_id	exec	format, query, endpoint	Accept-Language, options, timeStamp, transitionsFrom, transitionsYears, x-ms-client-id	Use to get the current, historical, and future time zone information for the specified IANA time zone ID. The Get Timezone By ID API is an HTTP GET request that returns current, historical, and future time zone information for the specified IANA time zone ID.
get_timezone_by_coordinates	exec	format, query, endpoint	Accept-Language, options, timeStamp, transitionsFrom, transitionsYears, x-ms-client-id	Use to get the current, historical, and future time zone information for the specified latitude-longitude pair. The Get Timezone By Coordinates API is an HTTP GET request that returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location.
get_windows_timezone_ids	exec	format, endpoint	x-ms-client-id	Use to get the list of Windows Time Zone IDs. The Get Windows Time Zones API is an HTTP GET request that returns a full list of Windows Time Zone IDs.
get_iana_timezone_ids	exec	format, endpoint	x-ms-client-id	Use to get the list of IANA time zone IDs. The Get IANA Time Zones API is an HTTP GET request that returns a full list of Internet Assigned Numbers Authority (IANA) time zone IDs. Updates to the IANA service are reflected in the system within one day.
get_iana_version	exec	format, endpoint	x-ms-client-id	Use to get the current IANA version number. The Get Time Zone IANA Version API is an HTTP GET request that returns the current Internet Assigned Numbers Authority (IANA) version number as Metadata.
convert_windows_timezone_to_iana	exec	format, query, endpoint	territory, x-ms-client-id	Use to get the IANA ID. The Get Windows to IANA Time Zone API is an HTTP GET request that returns a corresponding Internet Assigned Numbers Authority (IANA) ID, given a valid Windows Time Zone ID. Multiple IANA IDs may be returned for a single Windows ID. It is possible to narrow these results by adding an optional territory parameter.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme). (default: )
format	string	Desired format of the response. Only json format is supported. "json" Default value is "json".
query	string	The Windows time zone ID. Required.
Accept-Language	string	Specifies the language code in which the timezone names should be returned. If no language code is provided, the response will be in "EN". Please refer to Supported Languages _ for details. Default value is None.
options	string	Alternatively, use alias "o". Options available for types of information returned in the result. Known values are: "none", "zoneInfo", "transitions", and "all". Default value is None.
territory	string	Windows Time Zone territory code. Default value is None.
timeStamp	string (date-time)	Alternatively, use alias "stamp", or "s". Reference time, if omitted, the API will use the machine time serving the request. Default value is None.
transitionsFrom	string (date-time)	Alternatively, use alias "tf". The start date from which daylight savings time (DST) transitions are requested, only applies when "options" = all or "options" = transitions. Default value is None.
transitionsYears	integer	Alternatively, use alias "ty". The number of years from "transitionsFrom" for which DST transitions are requested, only applies when "options" = all or "options" = transitions. Default value is None.
x-ms-client-id	string

Lifecycle Methods

get_timezone_by_id

Use to get the current, historical, and future time zone information for the specified IANA time zone ID. The Get Timezone By ID API is an HTTP GET request that returns current, historical, and future time zone information for the specified IANA time zone ID.

EXEC azure.maps_timezone.timezone.get_timezone_by_id 
@format='{{ format }}' --required, 
@query='{{ query }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@Accept-Language='{{ Accept-Language }}', 
@options='{{ options }}', 
@timeStamp='{{ timeStamp }}', 
@transitionsFrom='{{ transitionsFrom }}', 
@transitionsYears='{{ transitionsYears }}', 
@x-ms-client-id='{{ x-ms-client-id }}'
;

get_timezone_by_coordinates

Use to get the current, historical, and future time zone information for the specified latitude-longitude pair. The Get Timezone By Coordinates API is an HTTP GET request that returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location.

EXEC azure.maps_timezone.timezone.get_timezone_by_coordinates 
@format='{{ format }}' --required, 
@query='{{ query }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@Accept-Language='{{ Accept-Language }}', 
@options='{{ options }}', 
@timeStamp='{{ timeStamp }}', 
@transitionsFrom='{{ transitionsFrom }}', 
@transitionsYears='{{ transitionsYears }}', 
@x-ms-client-id='{{ x-ms-client-id }}'
;

get_windows_timezone_ids

Use to get the list of Windows Time Zone IDs. The Get Windows Time Zones API is an HTTP GET request that returns a full list of Windows Time Zone IDs.

EXEC azure.maps_timezone.timezone.get_windows_timezone_ids 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@x-ms-client-id='{{ x-ms-client-id }}'
;

get_iana_timezone_ids

Use to get the list of IANA time zone IDs. The Get IANA Time Zones API is an HTTP GET request that returns a full list of Internet Assigned Numbers Authority (IANA) time zone IDs. Updates to the IANA service are reflected in the system within one day.

EXEC azure.maps_timezone.timezone.get_iana_timezone_ids 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@x-ms-client-id='{{ x-ms-client-id }}'
;

get_iana_version

Use to get the current IANA version number. The Get Time Zone IANA Version API is an HTTP GET request that returns the current Internet Assigned Numbers Authority (IANA) version number as Metadata.

EXEC azure.maps_timezone.timezone.get_iana_version 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@x-ms-client-id='{{ x-ms-client-id }}'
;

convert_windows_timezone_to_iana

Use to get the IANA ID. The Get Windows to IANA Time Zone API is an HTTP GET request that returns a corresponding Internet Assigned Numbers Authority (IANA) ID, given a valid Windows Time Zone ID. Multiple IANA IDs may be returned for a single Windows ID. It is possible to narrow these results by adding an optional territory parameter.

EXEC azure.maps_timezone.timezone.convert_windows_timezone_to_iana 
@format='{{ format }}' --required, 
@query='{{ query }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@territory='{{ territory }}', 
@x-ms-client-id='{{ x-ms-client-id }}'
;