@azure-rest/maps-timezone package

Interfaces

ConvertWindowsTimezoneToIana
CountryRecordOutput	A country/region record.
ErrorAdditionalInfoOutput	The resource management error additional info.
ErrorDetailOutput	The error detail.
ErrorResponseOutput	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
GetIanaTimezoneIds
GetIanaVersion
GetTimeZoneByCoordinates
GetTimeZoneByID
GetWindowsTimezoneIds
IanaIdOutput
MapsTimeZoneClientOptions	The optional parameters for the client
ReferenceTimeOutput	Details in effect at the local time.
RepresentativePointOutput	Representative point property
Routes
TimeTransitionOutput
TimeZoneConvertWindowsTimezoneToIana200Response	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.
TimeZoneConvertWindowsTimezoneToIanaDefaultResponse	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.
TimeZoneConvertWindowsTimezoneToIanaQueryParam
TimeZoneConvertWindowsTimezoneToIanaQueryParamProperties
TimeZoneGetIanaTimezoneIds200Response	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.
TimeZoneGetIanaTimezoneIdsDefaultResponse	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.
TimeZoneGetIanaVersion200Response	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.
TimeZoneGetIanaVersionDefaultResponse	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.
TimeZoneGetTimeZoneByCoordinates200Response	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, with the exception of regions that observe solar days.
TimeZoneGetTimeZoneByCoordinatesDefaultResponse	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, with the exception of regions that observe solar days.
TimeZoneGetTimeZoneByCoordinatesHeaderParam
TimeZoneGetTimeZoneByCoordinatesHeaders
TimeZoneGetTimeZoneByCoordinatesQueryParam
TimeZoneGetTimeZoneByCoordinatesQueryParamProperties
TimeZoneGetTimeZoneByID200Response	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.
TimeZoneGetTimeZoneByIDDefaultResponse	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.
TimeZoneGetTimeZoneByIDHeaderParam
TimeZoneGetTimeZoneByIDHeaders
TimeZoneGetTimeZoneByIDQueryParam
TimeZoneGetTimeZoneByIDQueryParamProperties
TimeZoneGetWindowsTimezoneIds200Response	The Get Windows Time Zones API is an HTTP GET request that returns a full list of Windows Time Zone IDs.
TimeZoneGetWindowsTimezoneIdsDefaultResponse	The Get Windows Time Zones API is an HTTP GET request that returns a full list of Windows Time Zone IDs.
TimeZoneIanaVersionResultOutput	This object is returned from a successful Timezone IANA Version call
TimeZoneIdOutput
TimeZoneNamesOutput	Timezone names object.
TimeZoneResultOutput	This object is returned from a successful Timezone By ID call or By Coordinates call
WindowsTimeZoneOutput

Type Aliases

MapsTimeZoneClient

TimeZoneConvertWindowsTimezoneToIanaParameters

TimeZoneGetIanaTimezoneIdsParameters

TimeZoneGetIanaVersionParameters

TimeZoneGetTimeZoneByCoordinatesParameters

TimeZoneGetTimeZoneByIDParameters

TimeZoneGetWindowsTimezoneIdsParameters

Functions

default(AzureKeyCredential, ClientOptions)	Creates an instance of MapsTimeZoneClient from a subscription key. Example import MapsTimeZone from "@azure-rest/maps-timezone"; const credential = new AzureKeyCredential("<subscription-key>"); const client = MapsTimeZone(credential);
default(TokenCredential, string, ClientOptions)	Creates an instance of MapsTimeZone from an Azure Identity TokenCredential. Example import MapsTimeZoneClient from "@azure-rest/maps-timezone"; import { DefaultAzureCredential } from "@azure/identity"; const credential = new DefaultAzureCredential(); const client = MapsTimeZone(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)	Creates an instance of MapsTimeZone from an Azure Identity AzureSASCredential. Example import MapsTimeZone from "@azure-rest/maps-timezone"; import { AzureSASCredential } from "@azure/core-auth"; const credential = new AzureSASCredential("<SAS Token>"); const client = MapsTimeZone(credential);
isUnexpected(TimeZoneGetTimeZoneByID200Response | TimeZoneGetTimeZoneByIDDefaultResponse)
isUnexpected(TimeZoneGetTimeZoneByCoordinates200Response | TimeZoneGetTimeZoneByCoordinatesDefaultResponse)
isUnexpected(TimeZoneGetWindowsTimezoneIds200Response | TimeZoneGetWindowsTimezoneIdsDefaultResponse)
isUnexpected(TimeZoneGetIanaTimezoneIds200Response | TimeZoneGetIanaTimezoneIdsDefaultResponse)
isUnexpected(TimeZoneGetIanaVersion200Response | TimeZoneGetIanaVersionDefaultResponse)
isUnexpected(TimeZoneConvertWindowsTimezoneToIana200Response | TimeZoneConvertWindowsTimezoneToIanaDefaultResponse)

Function Details

default(AzureKeyCredential, ClientOptions)

Creates an instance of MapsTimeZoneClient from a subscription key.

Example

import MapsTimeZone from "@azure-rest/maps-timezone";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsTimeZone(credential);

function default(credential: AzureKeyCredential, options?: ClientOptions): MapsTimeZoneClient

Parameters

credential

AzureKeyCredential

An AzureKeyCredential instance used to authenticate requests to the service

options

ClientOptions

Options used to configure the TimeZone Client

Returns

MapsTimeZoneClient

default(TokenCredential, string, ClientOptions)

Creates an instance of MapsTimeZone from an Azure Identity TokenCredential.

Example

import MapsTimeZoneClient from "@azure-rest/maps-timezone";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsTimeZone(credential, "<maps-account-client-id>");

function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsTimeZoneClient

Parameters

credential

TokenCredential

An TokenCredential instance used to authenticate requests to the service

mapsAccountClientId

string

The Azure Maps client id of a specific map resource

options

ClientOptions

Options used to configure the TimeZone Client

Returns

MapsTimeZoneClient

default(AzureSASCredential, ClientOptions)

Creates an instance of MapsTimeZone from an Azure Identity AzureSASCredential.

Example

import MapsTimeZone from "@azure-rest/maps-timezone";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsTimeZone(credential);

function default(credential: AzureSASCredential, options?: ClientOptions): MapsTimeZoneClient

Parameters

credential

AzureSASCredential

An AzureSASCredential instance used to authenticate requests to the service

options

ClientOptions

Options used to configure the TimeZone Client

Returns

MapsTimeZoneClient

isUnexpected(TimeZoneGetTimeZoneByID200Response | TimeZoneGetTimeZoneByIDDefaultResponse)

function isUnexpected(response: TimeZoneGetTimeZoneByID200Response | TimeZoneGetTimeZoneByIDDefaultResponse): response

Parameters

response

TimeZoneGetTimeZoneByID200Response | TimeZoneGetTimeZoneByIDDefaultResponse

Returns

response

isUnexpected(TimeZoneGetTimeZoneByCoordinates200Response | TimeZoneGetTimeZoneByCoordinatesDefaultResponse)

function isUnexpected(response: TimeZoneGetTimeZoneByCoordinates200Response | TimeZoneGetTimeZoneByCoordinatesDefaultResponse): response

Parameters

response

TimeZoneGetTimeZoneByCoordinates200Response | TimeZoneGetTimeZoneByCoordinatesDefaultResponse

Returns

response

isUnexpected(TimeZoneGetWindowsTimezoneIds200Response | TimeZoneGetWindowsTimezoneIdsDefaultResponse)

function isUnexpected(response: TimeZoneGetWindowsTimezoneIds200Response | TimeZoneGetWindowsTimezoneIdsDefaultResponse): response

Parameters

response

TimeZoneGetWindowsTimezoneIds200Response | TimeZoneGetWindowsTimezoneIdsDefaultResponse

Returns

response

isUnexpected(TimeZoneGetIanaTimezoneIds200Response | TimeZoneGetIanaTimezoneIdsDefaultResponse)

function isUnexpected(response: TimeZoneGetIanaTimezoneIds200Response | TimeZoneGetIanaTimezoneIdsDefaultResponse): response

Parameters

response

TimeZoneGetIanaTimezoneIds200Response | TimeZoneGetIanaTimezoneIdsDefaultResponse

Returns

response

isUnexpected(TimeZoneGetIanaVersion200Response | TimeZoneGetIanaVersionDefaultResponse)

function isUnexpected(response: TimeZoneGetIanaVersion200Response | TimeZoneGetIanaVersionDefaultResponse): response

Parameters

response

TimeZoneGetIanaVersion200Response | TimeZoneGetIanaVersionDefaultResponse

Returns

response

isUnexpected(TimeZoneConvertWindowsTimezoneToIana200Response | TimeZoneConvertWindowsTimezoneToIanaDefaultResponse)

function isUnexpected(response: TimeZoneConvertWindowsTimezoneToIana200Response | TimeZoneConvertWindowsTimezoneToIanaDefaultResponse): response

Parameters

response

TimeZoneConvertWindowsTimezoneToIana200Response | TimeZoneConvertWindowsTimezoneToIanaDefaultResponse

Returns

response