Weather - Get Daily Indices

Serviço:
Maps
Versão da API:
1.1

Use quando quiser saber se as condições climáticas são ideais para uma atividade específica, como atividades esportivas ao ar livre, construção ou agricultura (os resultados incluem informações sobre a umidade do solo).
A Get Daily Indices API é uma solicitação HTTP GET que retorna valores de índice que fornecem orientação para ajudar no planejamento de atividades futuras. Por exemplo, uma aplicação móvel de saúde pode notificar os utilizadores de que hoje está bom tempo para correr ou para outras atividades ao ar livre, como jogar golfe ou empinar pipa. As lojas de varejo podem otimizar suas campanhas de marketing digital com base nos valores de índice previstos. O serviço retorna em valores de índices diários para os próximos 5, 10 e 15 dias a partir do dia atual.

GET {endpoint}/weather/indices/daily/json?api-version=1.1&query={query}
Com parâmetros opcionais: 
GET {endpoint}/weather/indices/daily/json?api-version=1.1&query={query}&language={language}&duration={duration}&indexId={indexId}&indexGroupId={indexGroupId}

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
 path True

string (uri)

O nome de host do serviço Azure Maps. Usa https://atlas.microsoft.com para a Azure cloud pública. Para direcionar uma geografia Azure Maps específica ou uma nuvem soberana, veja Azure Maps âmbito geográfico.
format
 path True

JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.
api-version
 query True

string

minLength: 1

A versão da API a utilizar para esta operação.
query
 query True

number[]

A consulta aplicável especificada como uma cadeia de caracteres separada por vírgulas composta por latitude seguida de longitude, por exemplo, "47.641268,-122.125679".

As informações meteorológicas estão geralmente disponíveis para locais em terra, corpos de água cercados por terra e áreas do oceano que estão a aproximadamente 50 milhas náuticas de uma costa.
duration
 query

integer (int32)

Especifica por quantos dias os índices diários são retornados. Por padrão, os dados dos índices para o dia atual serão retornados. Ao solicitar dados de índices futuros, o dia atual é incluído na resposta como dia 1. Os valores disponíveis são

  • 1 - Retornar dados de índice diário para o dia atual. Valor padrão.
  • 5 - Retornar 5 dias de dados diários do índice a partir do dia atual.
  • 10 - Retornar 10 dias de dados diários do índice a partir do dia atual.
  • 15 - Retornar 15 dias de dados diários do índice a partir do dia atual.
indexGroupId
 query

integer (int32)

Identificador de grupo de índice numérico que pode ser usado para restringir os resultados retornados ao subconjunto correspondente de índices (grupo de índices). Não pode ser emparelhado com indexId. Por favor, consulte os serviços meteorológicos em Azure Maps para mais detalhes e para consultar os grupos de índice suportados.
indexId
 query

integer (int32)

Identificador de índice numérico que pode ser usado para restringir os resultados retornados ao tipo de índice correspondente. Não pode ser emparelhado com indexGroupId. Por favor, consulte os serviços meteorológicos em Azure Maps para mais detalhes e para ver os índices suportados.
language
 query

string

Idioma em que os resultados da pesquisa devem ser retornados. Deve ser uma das tags de idioma IETF suportadas, sem distinção entre maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado.

Consulte de idiomas suportados para obter detalhes.

Cabeçalho do Pedido

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

string

Indica a conta destinada a ser utilizada com o modelo de segurança do Microsoft Entra ID. Este ID único para a conta Azure Maps pode ser obtido a partir da API da conta Azure Maps plano de gestão. Para mais informações sobre o uso da segurança Microsoft Entra ID em Azure Maps, consulte Gerir autenticação em Azure Maps.

Respostas

Name Tipo Description
200 OK

DailyIndicesResult

O pedido foi bem-sucedido.
Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

AadToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando combinado com controlo Azure baseado em funções, pode ser usado para controlar o acesso a APIs REST Azure Maps. Os controlos de acesso baseados em papéis do Azure são usados para designar o acesso a uma ou mais contas ou subrecursos de recursos 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.

Note

  • 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 clouds soberanas têm URLs de Autorização e configurações de Microsoft Entra ID únicas.
  • 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.
  • Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

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

Âmbitos

Name Description
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: header

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 daily indices values from current day

Pedido de amostra

GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query=43.84745,-79.37849&indexGroupId=11

Resposta da amostra

Código de estado:
200 
{
  "results": [
    {
      "description": "This is an excellent day for outdoor running!",
      "ascending": true,
      "category": "Excellent",
      "categoryValue": 5,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 1,
      "indexName": "Running Forecast",
      "value": 9.2
    },
    {
      "description": "Conditions are excellent for jogging outdoors!",
      "ascending": true,
      "category": "Excellent",
      "categoryValue": 5,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 2,
      "indexName": "Jogging Forecast",
      "value": 9.4
    },
    {
      "description": "Conditions are excellent for hiking!",
      "ascending": true,
      "category": "Excellent",
      "categoryValue": 5,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 3,
      "indexName": "Hiking Forecast",
      "value": 9.8
    },
    {
      "description": "Conditions are excellent for bicycling outdoors!",
      "ascending": true,
      "category": "Excellent",
      "categoryValue": 5,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 4,
      "indexName": "Bicycling Forecast",
      "value": 9.9
    },
    {
      "description": "This is a great day for golf.",
      "ascending": true,
      "category": "Excellent",
      "categoryValue": 5,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 5,
      "indexName": "Golf Weather Forecast",
      "value": 10
    },
    {
      "description": "This is an excellent day for playing tennis!",
      "ascending": true,
      "category": "Excellent",
      "categoryValue": 5,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 6,
      "indexName": "Tennis Forecast",
      "value": 9.2
    },
    {
      "description": "This is an excellent day for skateboarding!",
      "ascending": true,
      "category": "Excellent",
      "categoryValue": 5,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 7,
      "indexName": "Skateboarding Forecast",
      "value": 9.9
    },
    {
      "description": "Conditions are excellent for attending an outdoor concert!",
      "ascending": true,
      "category": "Excellent",
      "categoryValue": 5,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 8,
      "indexName": "Outdoor Concert Forecast",
      "value": 9.7
    },
    {
      "description": "Conditions are very good today for kite-flying.",
      "ascending": true,
      "category": "Very Good",
      "categoryValue": 4,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 9,
      "indexName": "Kite Flying Forecast",
      "value": 8.5
    },
    {
      "description": "Conditons will be very good for a visit to the beach or pool.",
      "ascending": true,
      "category": "Very Good",
      "categoryValue": 4,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 10,
      "indexName": "Beach & Pool Forecast",
      "value": 8.6
    },
    {
      "description": "Conditions will be very good for sailing.",
      "ascending": true,
      "category": "Very Good",
      "categoryValue": 4,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 11,
      "indexName": "Sailing Forecast",
      "value": 8.3
    },
    {
      "description": "This is a great night to be stargazing!",
      "ascending": true,
      "category": "Excellent",
      "categoryValue": 5,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 12,
      "indexName": "Stargazing Forecast",
      "value": 9.5
    },
    {
      "description": "Expect only fair conditions for fishing.",
      "ascending": true,
      "category": "Fair",
      "categoryValue": 2,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 13,
      "indexName": "Fishing Forecast",
      "value": 3.5
    },
    {
      "description": "Expect poor conditions for skiing.",
      "ascending": true,
      "category": "Poor",
      "categoryValue": 1,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 15,
      "indexName": "Ski Weather Forecast",
      "value": 0
    },
    {
      "description": "The weather is favorable for a very high level of mosquito activity. Plan activities and insect repellents accordingly.",
      "ascending": true,
      "category": "Very High",
      "categoryValue": 4,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 17,
      "indexName": "Mosquito Activity Forecast",
      "value": 7
    },
    {
      "description": "Expect only fair conditions for hunting.",
      "ascending": true,
      "category": "Fair",
      "categoryValue": 2,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 20,
      "indexName": "Hunting Forecast",
      "value": 4.5
    },
    {
      "description": "This is a great day for an outdoor barbecue!",
      "ascending": true,
      "category": "Excellent",
      "categoryValue": 5,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 24,
      "indexName": "Outdoor Barbecue",
      "value": 9.8
    },
    {
      "description": "This is a great day for lawn mowing!",
      "ascending": true,
      "category": "Excellent",
      "categoryValue": 5,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 28,
      "indexName": "Lawn Mowing Forecast",
      "value": 9.6
    },
    {
      "description": "Conditions will be very good for outdoor activities.",
      "ascending": true,
      "category": "Very Good",
      "categoryValue": 4,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "indexId": 29,
      "indexName": "Outdoor Activity Forecast",
      "value": 8.7
    }
  ]
}

Definições

Name Description
DailyIndex

O objeto DailyIndex ajuda os utilizadores a planear atividades ao ar livre com base nas condições meteorológicas, fornecendo o nome da atividade, como 'Previsão do Tempo de Esqui'; uma classificação numérica de 0,0 a 10,0 indicando adequação; uma classificação por texto, como 'Pobre'; e uma breve descrição das condições, como 'Espere más condições para esquiar.'
DailyIndicesResult

Este objeto é retornado de uma chamada Get Daily Indices bem-sucedida.
ErrorAdditionalInfo

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

O detalhe do erro.
ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)
JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.

DailyIndex

Object

O objeto DailyIndex ajuda os utilizadores a planear atividades ao ar livre com base nas condições meteorológicas, fornecendo o nome da atividade, como 'Previsão do Tempo de Esqui'; uma classificação numérica de 0,0 a 10,0 indicando adequação; uma classificação por texto, como 'Pobre'; e uma breve descrição das condições, como 'Espere más condições para esquiar.'

Name Tipo Description
ascending

boolean

Indica a direção das value propriedades e categoryValue . Quando verdadeiro, o valor do índice mais baixo é 0 e o melhor valor do índice é 10. Quando falso, o valor de índice mais baixo é 10 e o melhor valor de índice é 0.
category

string

Fornece uma avaliação qualitativa do índice, descrevendo a categoryValue propriedade. As categorias variam entre índices e podem incluir valores como Excelente, Muito Bom, Bom, Razoável e Mau.
categoryValue

integer (int32)

Fornece uma representação numérica da propriedade da categoria, indicando a avaliação qualitativa do índice. Os valores variam de 1 a 5 e devem ser usados com a bandeira ascendente, pois podem diferir entre índices. Por exemplo, para Atividade de Mosquitos: Baixo=1, Moderado=2, Alto=3, Muito Alto=4, Extremo=5.
dateTime

string (date-time)

Data e hora da observação no formato ISO 8601 (yyy-mm-ddThh:mm:ss-hh:mm). Por exemplo, 2025-04-29T07:00:00-07:00.
description

string

Fornece uma explicação breve e fácil de usar do valor do índice, ajudando os utilizadores a compreender a sua importância em relação a condições meteorológicas ou atividades específicas. Por exemplo, se o valor do índice para churrasco ao ar livre for 'Excelente', a descrição será 'Este é um ótimo dia para um churrasco ao ar livre!'
indexId

integer (int32)

Um identificador numérico que representa de forma única um tipo específico de índice, distinguindo entre diferentes índices para várias atividades ao ar livre. Por exemplo, um 'indexId' de 1 corresponde ao índice 'Running', e um 'indexId' de 5 corresponde ao índice 'Golfing'. Para mais informações, consulte IDs de Índice no artigo de conceitos Serviço meteorológico em Azure Maps.
indexName

string

O nome do índice indica o tipo de atividade ou condição a que se relaciona, como corrida, golfe ou outras atividades ao ar livre. Para mais informações, consulte IDs de Índice no artigo de conceitos Serviço meteorológico em Azure Maps.
value

number (float)

Um valor numérico de índice que varia de 0,0 a 10,0 que quantifica a adequação das condições meteorológicas para uma atividade ou condição específica, como corrida ou golfe. Valores mais elevados normalmente indicam condições mais favoráveis, dependendo do valor da ascending propriedade. Por exemplo, um valor de 8 para o índice 'Running' sugere um tempo muito bom para correr, enquanto um valor de 6 para o índice 'Golfe' indica boas condições mas ligeiramente menos ideais. Para mais informações, consulte Conjuntos de intervalos diários de índice no artigo de conceitos Serviço meteorológico em Azure Maps.

DailyIndicesResult

Object

Este objeto é retornado de uma chamada Get Daily Indices bem-sucedida.

Name Tipo Description
results

DailyIndex[]

Uma lista de todos os índices diários para o local consultado.

ErrorAdditionalInfo

Object

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

Name Tipo Description
info

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

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

Object

Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)

Name Tipo Description
error

ErrorDetail

O objeto de erro.

JsonFormat

Enumeração

Formato desejado da resposta. Apenas json formato é suportado.

Valor Description
json

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