Partilhar via


Timezone - Get Timezone By ID

Use para obter as informações de fuso horário atual, histórico e futuro para o ID de fuso horário IANA especificado.

A API Get Timezone By ID é uma solicitação de GET HTTP que retorna informações de fuso horário atuais, históricas e futuras para o ID de fuso horário IANA especificado.

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}

Parâmetros do URI

Name Em Necessário Tipo Description
format
path True

JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.

api-version
query True

string

Número da versão da API do Azure Maps.

query
query True

string

O ID do fuso horário IANA.

options
query

TimezoneOptions

Como alternativa, use o alias "o". Opções disponíveis para os tipos de informação retornados no resultado.

timeStamp
query

string

date-time

Como alternativa, use o alias "carimbo" ou "s". Hora de referência, se omitida, a API usará o tempo da máquina servindo a solicitação.

transitionsFrom
query

string

date-time

Como alternativa, use o alias "tf". A data de início a partir da qual as transições do horário de verão (DST) são solicitadas, só se aplica quando "opções" = todas ou "opções" = transições.

transitionsYears
query

integer

Como alternativa, use o alias "ty". O número de anos a partir de "transitionsFrom" para os quais as transições de horário de verão são solicitadas, só se aplica quando "options" = all ou "options" = transitions.

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-id

string

Especifica qual conta deve ser usada em conjunto com o modelo de segurança do Microsoft Entra ID. Ele representa uma ID exclusiva para a conta do Azure Maps e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Maps. Para usar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientação.

Accept-Language

string

Especifica o código de idioma no qual os nomes de fuso horário devem ser retornados. Se nenhum código de idioma for fornecido, a resposta será em "EN". Consulte de idiomas suportados para obter detalhes.

Respostas

Name Tipo Description
200 OK

TimezoneResult

OK

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Maps.

Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.

Observações

  • Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento do Maps.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. * O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de de aplicativos cliente confidenciais para acessar APIs REST do Azure Maps para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(ões) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta do Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Successfully retrieve timezone by ID

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
CountryRecord

Um registo de país/região.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.

ReferenceTime

Detalhes em vigor à hora local.

RepresentativePoint

Propriedade do ponto representativo

TimeTransition
TimezoneId
TimezoneNames

Objeto de nomes de fuso horário.

TimezoneOptions

Como alternativa, use o alias "o". Opções disponíveis para os tipos de informação retornados no resultado.

TimezoneResult

Este objeto é retornado de uma chamada bem-sucedida de fuso horário por ID ou por coordenadas

CountryRecord

Um registo de país/região.

Name Tipo Description
Code

string

ISO-3166 Código de país/região de 2 letras para o país/região.

Name

string

Nome do país/região

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.

Name Tipo Description
json

string

O formato de intercâmbio de dados de notação de objeto JavaScript

ReferenceTime

Detalhes em vigor à hora local.

Name Tipo Description
DaylightSavings

string

Economia de tempo em minutos em vigor no ReferenceUTCTimestamp.

PosixTz

string

String POSIX usada para definir a variável de ambiente de fuso horário.

PosixTzValidYear

integer

O ano para o qual esta string POSIX é válida. Nota: Uma string POSIX só será válida no ano determinado.

StandardOffset

string

UTC offset em vigor no ReferenceUTCTimestamp.

Sunrise

string

Nascer do sol no fuso horário determinado, conforme mostrado na propriedade Tag, preenchido somente quando a chamada estiver byCoordinates. O nascer do sol é descrito no formato ISO 8601. Observe que a API de fuso horário não retorna os horários do nascer e pôr do sol quando o dia solar é observado na região solicitada.

Sunset

string

Pôr do sol no fuso horário determinado, conforme mostrado na propriedade Tag, preenchido somente quando a chamada estiver byCoordinates. O pôr do sol é descrito no formato ISO 8601. Observe que a API de fuso horário não retorna os horários do nascer e pôr do sol quando o dia solar é observado na região solicitada.

Tag

string

Nome do fuso horário em vigor no carimbo de data/hora de referência (ou seja, PST ou PDT, dependendo se o horário de verão está em vigor).

WallTime

string

Hora de parede atual no fuso horário determinado, conforme mostrado na propriedade Tag.

RepresentativePoint

Propriedade do ponto representativo

Name Tipo Description
Latitude

number

Propriedade Latitude

Longitude

number

Propriedade Longitude

TimeTransition

Name Tipo Description
DaylightSavings

string

Propriedade Horário de verão

StandardOffset

string

Propriedade StandardOffset

Tag

string

Propriedade Tag

UtcEnd

string

Data de fim, hora de término para este período de transição

UtcStart

string

Data de início, hora de início deste período de transição

TimezoneId

Name Tipo Description
Aliases

string[]

Uma matriz de aliases de ID de fuso horário. Só retornado quando [options]=zoneinfo ou todos os.

Nota: pode ser nulo.

Countries

CountryRecord[]

Uma matriz de registros de país/região. Só retornado quando [options]=zoneinfo ou todos os.

Id

string

Propriedade Id

Names

TimezoneNames

Objeto de nomes de fuso horário.

ReferenceTime

ReferenceTime

Detalhes em vigor à hora local.

RepresentativePoint

RepresentativePoint

Propriedade do ponto representativo

TimeTransitions

TimeTransition[]

O horário de verão de fuso horário transita de [transitionsFrom] até o carimbo de data/hora + 1 ano.

TimezoneNames

Objeto de nomes de fuso horário.

Name Tipo Description
Daylight

string

Nome da luz do dia

Generic

string

Nome Genérico

ISO6391LanguageCode

string

O código linguístico ISO 639-1 dos nomes

Standard

string

Nome padrão

TimezoneOptions

Como alternativa, use o alias "o". Opções disponíveis para os tipos de informação retornados no resultado.

Name Tipo Description
all

string

Inclua zoneinfo e transições no resultado.

none

string

Não inclua zoneinfo ou transições no resultado.

transitions

string

Inclua informações de transição no resultado (o número de transições está atualmente limitado a 250).

zoneInfo

string

Inclua informações adicionais de fuso horário no resultado.

TimezoneResult

Este objeto é retornado de uma chamada bem-sucedida de fuso horário por ID ou por coordenadas

Name Tipo Description
ReferenceUtcTimestamp

string

Propriedade Reference Utc Timestamp

TimeZones

TimezoneId[]

Matriz TimeZoneId

Version

string

Propriedade Version