Search - Get Geocode Autocomplete

Use para obter uma lista classificada de entidades sugeridas com base na localização de um usuário e em uma consulta parcial.
Dado um pedido com a localização do utilizador e uma consulta parcial que serve como prefixo de uma cadeia de consulta completa (referida como prefixo de consulta), a API de Autopreenchimento do Azure Maps devolve uma lista de entidades sugeridas que o utilizador provavelmente está a procurar. Estas entidades são classificadas do mais ao menos provável.

GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query={query}
GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query={query}&coordinates={coordinates}&bbox={bbox}&top={top}&resultTypeGroups={resultTypeGroups}&resultTypes={resultTypes}&view={view}&countryRegion={countryRegion}

Parâmetros do URI

Name Em Obrigatório Tipo Descrição
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.

api-version
query True

string

minLength: 1

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

query
query True

string

Required. O prefixo da consulta do usuário.

Exemplo: "1 Micro" ou "Muir Woods".

bbox
query

number[]

Necessário quando coordinates não é fornecido. Uma área retangular na Terra definida como um objeto de caixa delimitadora. Os lados do retângulo são definidos por valores de longitude e latitude. Quando você especifica esse parâmetro, a área geográfica é levada em conta ao calcular os resultados de uma consulta de local.

Exemplo: lon1,lat1,lon2,lat2.

Tamanho mínimo: aproximadamente 0,00001 graus (~0,01 metros).

Tamanho máximo: até a extensão global total (-180,-90 a 180,90)

coordinates
query

number[]

Necessário quando bbox não é fornecido. Um ponto na Terra especificado como longitude e latitude. Quando especifica este parâmetro, a localização do utilizador é tida em conta e os resultados devolvidos podem ser mais relevantes para o utilizador. Exemplo: &coordinates=lon,lat

Observação:coordinates torna-se um sinal secundário se bbox for fornecido.

countryRegion
query

string

Sinal para o resultado de preenchimento automático para um código de região/país ISO 3166-1 Alpha-2 especificado, por exemplo, FR. Somente os resultados no país/região especificado serão retornados.

resultTypeGroups
query

AutocompleteResultTypeGroupsEnum[]

Uma lista separada por vírgulas de grupos de tipos de entidade retornados. Os valores possíveis são

  • Morada
  • Localidade
resultTypes
query

AutocompleteResultTypeEnum[]

Uma lista separada por vírgulas dos tipos de entidade retornados. Quando o grupo de tipos é definido como Endereço, os tipos suportados são:

  • Morada
  • Bloqueio de estrada

Todos os outros tipos pertencem ao grupo Tipo de lugar. Isso pode incluir entidades como AdminDivision1, Neighborhood, PopulatedPlace e muito mais. O valor padrão é todos os tipos de entidade possíveis.

top
query

integer (int32)

minimum: 1
maximum: 20

Número máximo de respostas que serão devolvidas. Padrão: 5, mínimo: 1 e máximo: 20.

view
query

string

Uma cadeia de caracteres que representa um código de região/país ISO 3166-1 Alpha-2 . Isso alterará fronteiras e rótulos disputados geopoliticamente para se alinhar com a região de usuário especificada. Por defeito, o parâmetro View está definido como "Auto" mesmo que não o tenhas definido no pedido.

Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.

Cabeçalho do Pedido

Name Obrigatório Tipo Descrição
x-ms-client-id

string

Especifica qual a conta destinada a ser usada em conjunto com o modelo de segurança do Azure AD. Representa um ID único para a conta Azure Maps e pode ser recuperado na API de Contas do plano de gestão do Azure Maps. Para mais informações sobre o uso da segurança Microsoft Entra ID em Azure Maps, consulte Gerir autenticação em Azure Maps.

Accept-Language

string

Idioma em que os resultados da pesquisa devem ser retornados.

Consulte de idiomas suportados para obter detalhes.

Respostas

Name Tipo Descrição
200 OK

AutocompleteResponse

O pedido foi bem-sucedido.

Media Types: "application/geo+json", "application/json"

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Media Types: "application/geo+json", "application/json"

Cabeçalhos

x-ms-error-code: string

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 Descrição
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

Autocomplete API call to search for '1 Microsoft'
Autocomplete API call to search for '1 Microsoft Way, Redmond', filtered by roadblock resultTypes, place resultTypeGroups, and return empty result
Autocomplete API call to search for 'Muir Woods', filtered by address resultTypeGroups
Autocomplete API call to search for 'Muir Woods', filtered by park and populated place resultTypes, place resultTypeGroups
Autocomplete API call to search for 'Muir Woods', filtered by park resultTypes
Autocomplete API call to search for 'Muir Woods', filtered by place resultTypeGroups
Autocomplete API call to search for 'Muir Woods', filtered by roadblock resultTypes, address resultTypeGroups

Autocomplete API call to search for '1 Microsoft'

Pedido de amostra

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=1 Microsoft&coordinates=-113.301894,49.201888

Resposta da amostra

Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Address",
        "type": "Address",
        "address": {
          "streetNumber": "1",
          "streetName": "Microsoft Way",
          "addressLine": "1 Microsoft Way",
          "locality": "Redmond",
          "adminDistricts": [
            {
              "name": "Washington"
            },
            {
              "name": "King County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "98052",
          "formattedAddress": "1 Microsoft Way, Redmond, Washington 98052, United States"
        }
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Place",
        "type": "LandmarkBuilding",
        "address": {
          "locality": "Bellevue",
          "adminDistricts": [
            {
              "name": "Washington"
            },
            {
              "name": "King County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "formattedAddress": "Bellevue, Washington, United States"
        },
        "name": "Microsoft-Advanta C"
      }
    }
  ]
}

Autocomplete API call to search for '1 Microsoft Way, Redmond', filtered by roadblock resultTypes, place resultTypeGroups, and return empty result

Pedido de amostra

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=1 Microsoft Way, Redmond&coordinates=-113.301894,49.201888&resultTypeGroups=Place&resultTypes=RoadBlock

Resposta da amostra

Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": []
}

Autocomplete API call to search for 'Muir Woods', filtered by address resultTypeGroups

Pedido de amostra

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address

Resposta da amostra

Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Address",
        "type": "RoadBlock",
        "address": {
          "locality": "Mill Valley",
          "adminDistricts": [
            {
              "name": "California",
              "shortName": "CA"
            },
            {
              "name": "Marin County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "94941",
          "streetName": "Muir Woods Trail",
          "addressLine": "",
          "formattedAddress": "Muir Woods Trail, Mill Valley, CA 94941, United States"
        }
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Address",
        "type": "RoadBlock",
        "address": {
          "locality": "Sausalito",
          "adminDistricts": [
            {
              "name": "California",
              "shortName": "CA"
            },
            {
              "name": "Marin County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "94965",
          "streetName": "Muir Woods Rd",
          "addressLine": "",
          "formattedAddress": "Muir Woods Rd, Sausalito, CA 94965, United States"
        }
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Address",
        "type": "RoadBlock",
        "address": {
          "locality": "Las Vegas",
          "adminDistricts": [
            {
              "name": "Nevada",
              "shortName": "NV"
            },
            {
              "name": "Clark County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "89122",
          "streetName": "Muir Woods Pkwy",
          "addressLine": "",
          "formattedAddress": "Muir Woods Pkwy, Las Vegas, NV 89122, United States"
        }
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Address",
        "type": "RoadBlock",
        "address": {
          "locality": "Stockton",
          "adminDistricts": [
            {
              "name": "California",
              "shortName": "CA"
            },
            {
              "name": "San Joaquin County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "95209",
          "streetName": "Muir Woods Ave",
          "addressLine": "",
          "formattedAddress": "Muir Woods Ave, Stockton, CA 95209, United States"
        }
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Address",
        "type": "RoadBlock",
        "address": {
          "locality": "Stonington",
          "adminDistricts": [
            {
              "name": "Maine",
              "shortName": "ME"
            },
            {
              "name": "Hancock County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "04681",
          "streetName": "Muir Woods Rd",
          "addressLine": "",
          "formattedAddress": "Muir Woods Rd, Stonington, ME 04681, United States"
        }
      }
    }
  ]
}

Autocomplete API call to search for 'Muir Woods', filtered by park and populated place resultTypes, place resultTypeGroups

Pedido de amostra

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place&resultTypes=Park,PopulatedPlace

Resposta da amostra

Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Place",
        "type": "PopulatedPlace",
        "address": {
          "locality": "Muir Woods",
          "adminDistricts": [
            {
              "name": "Georgia"
            },
            {
              "name": "Fulton County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "30349",
          "formattedAddress": "Muir Woods, Georgia 30349, United States"
        }
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Place",
        "type": "Park",
        "address": {
          "adminDistricts": [
            {
              "name": "California"
            },
            {
              "name": "Marin County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "formattedAddress": "California"
        },
        "name": "Muir Woods National Park"
      }
    }
  ]
}

Autocomplete API call to search for 'Muir Woods', filtered by park resultTypes

Pedido de amostra

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypes=Park

Resposta da amostra

Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Place",
        "type": "Park",
        "address": {
          "adminDistricts": [
            {
              "name": "California"
            },
            {
              "name": "Marin County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "formattedAddress": "California"
        },
        "name": "Muir Woods National Monument"
      }
    }
  ]
}

Autocomplete API call to search for 'Muir Woods', filtered by place resultTypeGroups

Pedido de amostra

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place

Resposta da amostra

Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Place",
        "type": "Forest",
        "address": {
          "adminDistricts": [
            {
              "name": "Wisconsin"
            },
            {
              "name": "Dane County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "formattedAddress": "Wisconsin"
        },
        "name": "Muir Woods"
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Place",
        "type": "PopulatedPlace",
        "address": {
          "locality": "Muir Woods",
          "adminDistricts": [
            {
              "name": "Georgia"
            },
            {
              "name": "Fulton County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "30349",
          "formattedAddress": "Muir Woods, Georgia 30349, United States"
        }
      }
    },
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Place",
        "type": "Park",
        "address": {
          "adminDistricts": [
            {
              "name": "California"
            },
            {
              "name": "Marin County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "formattedAddress": "California"
        },
        "name": "Muir Woods National Monument"
      }
    }
  ]
}

Autocomplete API call to search for 'Muir Woods', filtered by roadblock resultTypes, address resultTypeGroups

Pedido de amostra

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address&resultTypes=RoadBlock

Resposta da amostra

Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Address",
        "type": "RoadBlock",
        "address": {
          "streetName": "Muir St",
          "addressLine": " Muir St",
          "locality": "Grosse Pointe Farms",
          "adminDistricts": [
            {
              "name": "Michigan"
            },
            {
              "name": "Wayne County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "48236",
          "formattedAddress": "Muir St, Grosse Pointe Farms, Michigan 48236, United States"
        }
      }
    }
  ]
}

Definições

Name Descrição
Address

O endereço de uma localização geocodificada ou sugerida por autocompletamento, analisada em campos estruturados. A escassez é normal: apenas os campos que a entidade resolvida fornece são povoados. Por exemplo, streetName e streetNumber aparece apenas para endereços ao nível da rua, e intersection aparece apenas para resultados de interseções rodoviárias.

AddressAdminDistrictsItem

Uma subdivisão administrativa que contém um endereço. Por exemplo, um estado, província ou condado. Devolvido como uma entrada no array principal Address.adminDistricts , onde as entradas são ordenadas do mais grosseiro para o mais fino.

AddressCountryRegion

O país ou região que contém o endereço, identificado pelo seu nome de exibição e pelo código de país ISO 3166-1 Alpha-2. Qualquer um dos campos pode ser omitido numa dada resposta.

AutocompleteFeature

Uma única entrada no features array de um AutocompleteResponse, conforme a forma do GeoJSON Feature objeto. Representa uma sugestão de autocompletamento: classificação (type, typeGroup), endereço analisado e nome opcional do local são expostos via properties, com uma coordenada representativa em geometry quando um está disponível.

AutocompleteProperties

A properties carga útil de um AutocompleteFeature. Transporta a classificação do resultado (typeGroup, type), o seu endereço analisado e (para muitos Placeresultados -tipados) um nome de exibição separado.

AutocompleteResponse

O corpo de resposta bem-sucedida retornou por Get Autocomplete. Codificado como um GeoJSON FeatureCollection conjunto cujo features array contém um Feature por sugestão de autocompletamento, classificado do mais ao menos provável.

AutocompleteResultTypeEnum

Uma classificação das sugestões de autopreenchimento usadas tanto Get Autocomplete como filtro de entrada (através do parâmetro de resultTypes consulta) como como etiqueta de saída (através do type campo em cada AutocompleteProperties). Os membros definem uma taxonomia ao estilo do gazeteiro que abrange endereços, segmentos de estrada, regiões administrativas, locais povoados, características naturais e pontos de interesse. Esta taxonomia é dividida em dois grupos mais amplos por AutocompleteResultTypeGroupsEnum: Address, que cobre endereços e segmentos de estrada; e Place, que abrange todos os outros tipos de resultados.

AutocompleteResultTypeGroupsEnum

Uma classificação grosseira de uma sugestão autocompleta em dois grupos. Usado tanto Get Autocomplete como filtro de entrada através do resultTypeGroups parâmetro de consulta (restringindo que tipos de sugestões são devolvidas) como como classificador de saída através do typeGroup campo em cada AutocompleteProperties um (identificando a que grupo pertence uma sugestão devolvida). O Address grupo abrange endereços individuais e segmentos de rua; o Place grupo abrange todos os outros tipos de entidades (regiões administrativas, locais povoados, características naturais e pontos de interesse).

Azure.Core.Foundations.Error

O objeto de erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta contendo detalhes do erro.

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com Azure diretrizes da API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

FeatureCollectionEnum

O GeoJSON tipo de objeto utilizado na raiz das respostas bem-sucedidas das operações de geocodificação direta, geocodificação reversa e autocompletar (incluindo as suas variantes em lote). O único valor é FeatureCollection, conforme definido no RFC 7946. Get Polygon é a única exceção: a sua raiz de resposta é um GeoJSON Feature, veja FeatureTypeEnum.

FeatureTypeEnum

O GeoJSON tipo de objeto para Feature os objetos. Etiqueta cada entrada dentro do features array de uma FeatureCollection resposta (geocodificação, geocodificação reversa, autocompletamento) e aparece na raiz da Get Polygon resposta. O único valor é Feature, conforme definido no RFC 7946.

GeoJsonObjectType

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPoint

Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.

Intersection

Detalhes de interseção para um endereço resolvidos como um cruzamento rodoviário — a esquina onde duas ou mais ruas nomeadas se encontram. Preenchido apenas quando a entidade resolvida é um RoadIntersection; o pai Address.intersection é de outra forma omitido.

Address

O endereço de uma localização geocodificada ou sugerida por autocompletamento, analisada em campos estruturados. A escassez é normal: apenas os campos que a entidade resolvida fornece são povoados. Por exemplo, streetName e streetNumber aparece apenas para endereços ao nível da rua, e intersection aparece apenas para resultados de interseções rodoviárias.

Name Tipo Descrição
addressLine

string

A primeira linha do endereço, normalmente o nome e número da rua. Por exemplo, "15127 NE 24th St".

adminDistricts

AddressAdminDistrictsItem[]

As subdivisões administrativas que contêm o endereço, ordenadas do mais grosseiro para o mais refinado. A primeira entrada é tipicamente a subdivisão de primeira ordem (como um estado dos EUA ou uma província canadiana); Entradas subsequentes cobrem divisões mais finas onde o país, dependência ou região as define (como um condado no índice 1).

countryRegion

AddressCountryRegion

O país ou região que contém o endereço, com o seu nome de exibição e o código de país ISO 3166-1 Alpha-2.

formattedAddress

string

O endereço completo é apresentado como uma única cadeia legível por humanos, com os componentes unidos de acordo com as convenções do país ou região do endereço. Exemplo: "15127 NE 24th St, Redmond, WA 98052".

intersection

Intersection

Os detalhes das ruas que se cruzam para o endereço, preenchidos quando a entidade resolvida é um RoadIntersection (como a esquina de duas ruas nomeadas).

locality

string

A localidade onde o endereço se encontra: normalmente uma cidade, vila ou aldeia. Por exemplo: "Redmond".

neighborhood

string

O bairro nomeado dentro da localidade, quando um é identificado.

postalCode

string

O código postal do endereço, quando definido um. Exemplo: "98052".

streetName

string

O componente do nome da rua do endereço, quando a entidade resolvida é um endereço ao nível da rua. Exemplo: "NE 24th St".

streetNumber

string

O número da casa ou edifício na rua, quando a entidade resolvida é um endereço ao nível da rua. Exemplo: "15127".

AddressAdminDistrictsItem

Uma subdivisão administrativa que contém um endereço. Por exemplo, um estado, província ou condado. Devolvido como uma entrada no array principal Address.adminDistricts , onde as entradas são ordenadas do mais grosseiro para o mais fino.

Name Tipo Descrição
name

string

O nome completo do loteamento. Por exemplo, "Washington" para um estado dos EUA, ou "King County" para um condado.

shortName

string

A forma abreviada ou abreviada do nome da subdivisão, quando é definido. Por exemplo, "WA" para um estado dos EUA. Subdivisões mais finas muitas vezes não têm uma forma curta distinta, caso em shortName que se repete name (como "King County").

AddressCountryRegion

O país ou região que contém o endereço, identificado pelo seu nome de exibição e pelo código de país ISO 3166-1 Alpha-2. Qualquer um dos campos pode ser omitido numa dada resposta.

Name Tipo Descrição
ISO

string

O código de país ISO 3166-1 Alpha-2 para o país ou região. Por exemplo, "US" para os Estados Unidos, ou "GB" para o Reino Unido.

name

string

O nome de exibição do país ou região. Por exemplo, "Estados Unidos".

AutocompleteFeature

Uma única entrada no features array de um AutocompleteResponse, conforme a forma do GeoJSON Feature objeto. Representa uma sugestão de autocompletamento: classificação (type, typeGroup), endereço analisado e nome opcional do local são expostos via properties, com uma coordenada representativa em geometry quando um está disponível.

Name Tipo Descrição
geometry

GeoJsonPoint

A coordenada da sugestão de autopreenchimento como um GeoJSON Point, com valores em ordem de longitude/latitude WGS 84. Pode ser omitida quando a sugestão não se resolve para uma única coordenada representativa, por exemplo, sugestões regionais amplas ou de topónimos.

properties

AutocompleteProperties

Dados estruturados sobre a sugestão de autocompletamento, incluindo a sua classificação, endereço analisado e (para Placesugestões com -tip) o nome do lugar. Veja AutocompleteProperties a forma por propriedade.

type

FeatureTypeEnum

O tipo de GeoJSON objeto. Sempre Feature, conforme definido no RFC 7946.

AutocompleteProperties

A properties carga útil de um AutocompleteFeature. Transporta a classificação do resultado (typeGroup, type), o seu endereço analisado e (para muitos Placeresultados -tipados) um nome de exibição separado.

Name Tipo Descrição
address

Address

O endereço do resultado do autocompletamento, analisado em campos estruturados. Address-os resultados tipados normalmente incluem detalhes ao nível da rua; Place- os resultados tipados incluem localidade, distritos administrativos e país/região (os campos ao nível da rua são geralmente omitidos).

name

string

O nome de exibição do local sugerido. Preenchido para Placeresultados com -tipados quando o nome ainda não está representado na estrutura address (por exemplo, parques, marcos ou outras características nomeadas). Omitido para Addressresultados com -tipados e para Placeresultados -tipados cujo nome já está incluído em address (como um local povoado cujo nome aparece em address.locality).

type

AutocompleteResultTypeEnum

O tipo específico de entidade para o qual o resultado se resolve. Por exemplo, um endereço, um local povoado, um parque ou um marco. Veja AutocompleteResultTypeEnum para a lista completa de valores, particionada em Address e Place grupos por AutocompleteResultTypeGroupsEnum.

typeGroup

AutocompleteResultTypeGroupsEnum

A classificação ampla do resultado como um endereço ou um local nomeado. Veja AutocompleteResultTypeGroupsEnum a lista de valores.

AutocompleteResponse

O corpo de resposta bem-sucedida retornou por Get Autocomplete. Codificado como um GeoJSON FeatureCollection conjunto cujo features array contém um Feature por sugestão de autocompletamento, classificado do mais ao menos provável.

Name Tipo Descrição
features

AutocompleteFeature[]

O array de GeoJSON Feature objetos devolvidos pela consulta. Cada Feature um representa uma única sugestão de autocompletamento: a sua classificação (type, typeGroup), endereço analisado e o nome opcional do local são expostos via properties, e a sua coordenada principal via geometry.

nextLink

string

Contém o URL para obter a página seguinte de resultados se a resposta for paginada. Isto é útil quando a resposta é demasiado grande para ser devolvida numa única chamada, permitindo aos utilizadores navegar por várias páginas de resultados.

type

FeatureCollectionEnum

O GeoJSON tipo de objeto de um corpo de resposta bem-sucedido Get Autocomplete . Sempre FeatureCollection, conforme definido no RFC 7946.

AutocompleteResultTypeEnum

Uma classificação das sugestões de autopreenchimento usadas tanto Get Autocomplete como filtro de entrada (através do parâmetro de resultTypes consulta) como como etiqueta de saída (através do type campo em cada AutocompleteProperties). Os membros definem uma taxonomia ao estilo do gazeteiro que abrange endereços, segmentos de estrada, regiões administrativas, locais povoados, características naturais e pontos de interesse. Esta taxonomia é dividida em dois grupos mais amplos por AutocompleteResultTypeGroupsEnum: Address, que cobre endereços e segmentos de estrada; e Place, que abrange todos os outros tipos de resultados.

Valor Descrição
Address

Uma morada específica.

AdminDivision1

Primeiro nível administrativo dentro do país/região, como um estado ou província.

AdminDivision2

Segundo nível administrativo dentro do país/região, como um condado.

AdminDivision3

Terceiro nível administrativo dentro do país/região, como um distrito, freguesia ou município.

AdministrativeBuilding

Um edifício que alberga escritórios governamentais ou funções administrativas públicas.

Airport

Uma instalação onde as aeronaves descolam e aterram regularmente, com instalações para passageiros e carga.

AirportTerminal

Um edifício de terminal de passageiros dentro de um aeroporto.

AmusementPark

Uma instalação de entretenimento com diversões, jogos e atrações temáticas.

AncientSite

Um local onde são preservados vestígios arqueológicos ou artefactos culturais de uma civilização antiga.

Aquarium

Uma instalação pública onde plantas e animais aquáticos são exibidos e estudados.

Archipelago

Um grupo ou cadeia de ilhas.

Basin

Uma depressão natural na superfície do terreno, frequentemente rodeada por terreno mais elevado.

Battlefield

Um local de uma batalha terrestre historicamente significativa.

Bay

Um corpo de água parcialmente cercado por terra, menor que um golfo e maior do que uma enseada.

Beach

Uma margem de areia, seixos ou outro sedimento não consolidado ao longo de um corpo de água.

Bridge

Uma estrutura que suporta uma estrada, caminho-de-ferro ou caminho através de um obstáculo, como um rio, vale ou outra estrada.

BusinessStructure

Um edifício usado para negócios gerais ou atividades comerciais que não se enquadra numa categoria mais específica.

Camp

Um local com abrigos ou instalações para ocupação temporária, como um parque de campismo ou assentamento sazonal.

Canal

Um curso de água artificial usado para transporte, irrigação ou drenagem.

Casino

Uma instalação usada para jogos de azar e jogos de azar.

Castle

Um edifício ou complexo historicamente fortificado, tipicamente associado a residências nobres ou reais.

Cave

Uma câmara ou passagem natural subterrânea formada na rocha.

Cemetery

Um local de sepultamento ou cemitério.

Channel

Uma via navegável navegável entre dois corpos de terra ou o principal caminho de fluxo de um corpo de água maior.

Church

Um edifício utilizado para culto cristão público.

Cliff

Uma face alta e íngreme de rocha ou terra, frequentemente com vista para uma costa ou vale.

Coast

Um troço de terra nomeado que faz fronteira com o mar.

CommunityCenter

Uma instalação que acolhe atividades comunitárias, reuniões e serviços sociais.

Continent

Uma das principais massas terrestres da Terra.

CountryRegion

Um país ou região.

Crater

Uma depressão circular formada por atividade vulcânica ou impacto de meteorito.

CulturalRegion

Uma área distinguida por características culturais partilhadas, como língua, etnia ou herança.

Dam

Uma barreira construída através de um riacho ou rio para reter água.

Delta

Formou-se uma formação de depósitos aluviais onde um rio encontra um corpo de água maior.

Desert

Uma grande região árida com vegetação escassa devido à precipitação limitada.

DrainageBasin

Uma área de terra drenada por um sistema fluvial e seus afluentes.

Dune

Um monte ou crista de areia soprada pelo vento.

FacilityStructure

Uma estrutura que alberga uma instalação especializada, como uma central de serviços públicos ou uma instalação de serviço.

FerryTerminal

Uma instalação onde passageiros e veículos embarcam e desembarcam de ferries.

FinancialStructure

Um edifício que alberga um banco, cooperativa de crédito ou outra instituição de serviços financeiros.

FireStation

Um edifício que alberga bombeiros, equipamento e veículos de resposta a emergências.

Forest

Uma grande área de terra dominada por árvores.

Fort

Uma estrutura militar defensiva ou terraplenagem.

Garden

Uma área cultivada para expor plantas ornamentais ou cientificamente selecionadas.

Geyser

Uma fonte termal que periodicamente liberta jatos de água e vapor.

Glacier

Uma massa persistente de gelo que se move lentamente sob o seu próprio peso.

GolfCourse

Um campo preparado para jogar golfe.

GreaterPopulatedPlace

Uma área metropolitana ou conurbação que contém e se estende para além de um local povoado.

HigherEducationFacility

Uma faculdade, universidade ou instituição semelhante de ensino pós-secundário.

HistoricalSite

Um local de importância histórica, frequentemente preservado como património cultural.

Hospital

Uma unidade médica que presta cuidados de internamento e ambulatório.

HotSpring

Uma nascente natural onde a água subterrânea aquecida geotermicamente emerge à superfície.

Ice

Uma massa natural ou camada superficial de água congelada que cobre terra ou água.

IndigenousPeoplesReserve

Um território reconhecido como terra natal de um povo ou comunidade indígena.

IndustrialStructure

Um edifício ou instalação utilizada para fabrico, produção ou outras operações industriais.

Island

Uma massa terrestre rodeada de água, menor do que um continente.

Isthmus

Uma faixa estreita de terra que liga duas massas de terra maiores e separa dois corpos de água.

Lake

Um corpo de água parada no interior rodeado por terra.

LandArea

Uma região terrestre nomeada que não se enquadra numa categoria geográfica mais específica.

Landform

Uma característica natural do terreno que não se enquadra numa categoria mais específica, como um Mountain, Valley, ou Plateau.

LandmarkBuilding

Um edifício notável de importância arquitetónica, cultural ou histórica que serve como um marco reconhecível.

Library

Um edifício que alberga uma coleção de livros e outros suportes disponíveis para uso público.

Lighthouse

Uma estrutura costeira ou portuária que exibe uma luz de navegação para guiar os navios.

Marina

Uma instalação portuária que fornece amarrações e serviços para pequenas embarcações e iates.

Market

Um local onde os bens são comprados e vendidos, normalmente a retalho.

MedicalStructure

Um edifício utilizado para serviços médicos ou relacionados com a saúde, que não sejam , Hospitalcomo uma clínica ou consultório médico.

MetroStation

Uma estação num sistema de metro, subterrâneo ou outro sistema urbano de transporte rápido.

MilitaryBase

Uma instalação operada pelas forças armadas para treino, abastecimento ou operações.

Mission

Um complexo gerido por um grupo religioso para prestar serviços comunitários e propagar a fé.

Monument

Uma estrutura ou estátua comemorativa erguida para homenagear uma pessoa, evento ou ideia.

Mosque

Um edifício utilizado para culto islâmico público.

Mountain

Uma formação de relevo que se eleva significativamente acima do seu entorno, tipicamente com encostas íngremes e um cume definido.

MountainRange

Uma série interligada de montanhas que formam uma cadeia contínua.

MultiModalStation

Uma estação que serve vários modos de transporte, como serviços combinados de comboio, autocarro ou metro.

Museum

Uma instalação onde objetos de interesse artístico, científico ou histórico são preservados e exibidos.

NauticalStructure

Uma estrutura relacionada com atividade marítima ou náutica, como um cais, cais ou bóia.

Neighborhood

Uma área reconhecida localmente dentro de um local povoado, frequentemente com limites informais ou culturalmente definidos.

Oasis

Uma área fértil num deserto sustentada por uma fonte natural de água.

ObservationPoint

Um miradouro ou miradouro que oferece vistas panorâmicas da área envolvente.

Ocean

Uma das principais divisões do oceano global da Terra.

OfficeBuilding

Um edifício utilizado principalmente para escritórios profissionais ou administrativos.

Other

Uma sugestão que não se enquadra em nenhum outro tipo definido.

Park

Uma área mantida para recreação pública ou prazer cénico.

ParkingStructure

Uma estrutura de vários níveis dedicada ao estacionamento de veículos.

Pass

Uma rota navegável através ou sobre uma cadeia montanhosa ou obstáculo semelhante.

Peninsula

Uma massa de terra que se projetava num corpo de água e quase era rodeada por ela.

Plain

Uma extensa área de terreno relativamente plano ou suavemente ondulado.

Planet

Um corpo celeste a orbitar uma estrela, normalmente usado para representar a Terra como a raiz da hierarquia geográfica.

Plateau

Uma área elevada de terreno relativamente plano, com encostas íngremes em um ou mais lados.

Playground

Uma área de lazer equipada para brincadeiras infantis.

PlayingField

Uma área aberta utilizada para praticar desportos organizados.

Pole

Um polo geográfico, como o Polo Norte ou o Polo Sul.

PoliticalUnit

Uma entidade política autónoma, como um estado ou território independente ou dependente.

PopulatedPlace

Uma área concentrada de assentamento humano, como uma cidade, vila ou aldeia.

Port

Uma instalação marítima com terminais para carregamento e descarga de carga ou passageiros embarcados.

Postcode1

A menor categoria de código postal, como um código postal.

Promontory

Uma forma de relevo elevada e proeminente que se projeta numa planície ou corpo de água.

RaceTrack

Uma pista ou percurso preparado para veículos de corrida, animais ou atletas.

RailwayStation

Uma instalação onde os passageiros embarcam e desembarcam dos comboios.

Reef

Uma crista submersa ou parcialmente submersa de rocha, areia ou coral perto da superfície da água.

ReligiousStructure

Um edifício usado para culto ou prática religiosa que não se enquadra numa categoria mais específica, como Church, Mosque, ou Temple.

Reserve

Um terreno protegido reservado para conservação, vida selvagem ou outro uso restrito.

ResidentialStructure

Um edifício usado principalmente para habitação humana, como um complexo de apartamentos ou habitações.

River

Um curso de água natural que flui para uma altitude mais baixa, tipicamente em direção a um mar, lago ou outro rio.

RoadBlock

Um segmento de rua sem um número de casa específico, devolvido quando o serviço de geocodificação não consegue localizar um número exato para a consulta. Apesar do nome, este valor não indica um encerramento físico da estrada.

Ruin

Uma estrutura destruída ou degradada que já não cumpre a sua função original.

ScientificResearchBase

Uma instalação utilizada como base para investigação científica, muitas vezes em ambientes remotos ou extremos.

Sea

Um grande corpo de água salgada parcialmente fechado por terra, menor do que um oceano.

SeaplaneLandingArea

Uma área de água destinada a hidroaviões descolarem e aterrarem.

Shrine

Uma estrutura ou local que homenageia uma pessoa ou comemora um evento ou conceito sagrado.

SkiArea

Uma área recreativa desenvolvida para esqui e outros desportos de inverno.

Spring

Uma fonte natural onde a água subterrânea flui da superfície da terra.

Stadium

Um grande recinto com lugares em degraus para desportos ou eventos para espectadores.

StatisticalDistrict

Uma região definida para fins estatísticos ou censitários, como uma área estatística metropolitana ou um setor censitário.

Temple

Um edifício dedicado ao culto religioso.

Theater

Um espaço para apresentar peças de teatro, filmes ou outras atuações ao vivo ou gravadas.

TouristRailway

Uma ferrovia cénica ou histórica operava principalmente para turismo e não para transporte regular.

TouristStructure

Um edifício que serve turistas, como um centro de visitantes ou um escritório de informações turísticas.

Trailhead

O ponto de partida de um trilho para caminhadas, ciclismo ou recreação.

TransportationStructure

Uma estrutura que suporta infraestruturas de transporte, como uma praça de portagem, uma estação de pesagem ou um abrigo de trânsito.

Tunnel

Uma passagem subterrânea ou subaquática para transporte rodoviário, ferroviário ou pedonal.

Valley

Uma área alongada e baixa entre colinas ou montanhas, frequentemente contendo um curso de água.

Volcano

Uma montanha ou colina formada por atividade vulcânica, tipicamente com uma cratera no seu cume.

Walkway

Um caminho ou superfície pavimentada designada para uso pedonal.

Wall

Uma barreira construída que forma uma fronteira vertical contínua, frequentemente usada para defesa, separação ou comemoração.

Waterfall

Um ponto onde um riacho ou rio desce vertical ou abruptamente.

WaterFeature

Um corpo de água que não se enquadra numa categoria mais específica, como um Lake, River, ou Sea.

Wetland

Uma área de terra saturada com água e que suporta vegetação aquática, como um pântano ou pântano.

Winery

Uma instalação onde o vinho é produzido e frequentemente oferecido para prova ou venda.

Zoo

Uma instalação onde animais selvagens são mantidos para exposição pública e estudo.

AutocompleteResultTypeGroupsEnum

Uma classificação grosseira de uma sugestão autocompleta em dois grupos. Usado tanto Get Autocomplete como filtro de entrada através do resultTypeGroups parâmetro de consulta (restringindo que tipos de sugestões são devolvidas) como como classificador de saída através do typeGroup campo em cada AutocompleteProperties um (identificando a que grupo pertence uma sugestão devolvida). O Address grupo abrange endereços individuais e segmentos de rua; o Place grupo abrange todos os outros tipos de entidades (regiões administrativas, locais povoados, características naturais e pontos de interesse).

Valor Descrição
Address

Sugestões que se resumam a um endereço específico ou a um segmento de estrada.

Place

Sugestões que se resumem a locais nomeados, incluindo regiões administrativas, localidades povoadas, bairros, características naturais e pontos de interesse. Exemplos incluem AdminDivision1, Neighborhood, e PopulatedPlace.

Azure.Core.Foundations.Error

O objeto de erro.

Name Tipo Descrição
code

string

Um de um conjunto de códigos de erro definido pelo servidor.

details

Azure.Core.Foundations.Error[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.

innererror

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

message

string

Uma representação legível por humanos do erro.

target

string

O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta contendo detalhes do erro.

Name Tipo Descrição
error

Azure.Core.Foundations.Error

O objeto de erro.

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com Azure diretrizes da API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name Tipo Descrição
code

string

Um de um conjunto de códigos de erro definido pelo servidor.

innererror

Azure.Core.Foundations.InnerError

Erro interno.

FeatureCollectionEnum

O GeoJSON tipo de objeto utilizado na raiz das respostas bem-sucedidas das operações de geocodificação direta, geocodificação reversa e autocompletar (incluindo as suas variantes em lote). O único valor é FeatureCollection, conforme definido no RFC 7946. Get Polygon é a única exceção: a sua raiz de resposta é um GeoJSON Feature, veja FeatureTypeEnum.

Valor Descrição
FeatureCollection

O tipo de GeoJSON FeatureCollection objeto. Aparece como a raiz de todos os corpos de resposta de geocodificação, geocodificação reversa e autocompletamento bem-sucedidos. Get Polygon usa uma Feature raiz em vez disso.

FeatureTypeEnum

O GeoJSON tipo de objeto para Feature os objetos. Etiqueta cada entrada dentro do features array de uma FeatureCollection resposta (geocodificação, geocodificação reversa, autocompletamento) e aparece na raiz da Get Polygon resposta. O único valor é Feature, conforme definido no RFC 7946.

Valor Descrição
Feature

O tipo de GeoJSON Feature objeto. Aparece em todas as funcionalidades dentro de uma FeatureCollection resposta, e na raiz da resposta Get Polygon .

GeoJsonObjectType

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

Valor Descrição
Point

GeoJSON Point geometria.

MultiPoint

GeoJSON MultiPoint geometria.

LineString

GeoJSON LineString geometria.

MultiLineString

GeoJSON MultiLineString geometria.

Polygon

GeoJSON Polygon geometria.

MultiPolygon

GeoJSON MultiPolygon geometria.

GeometryCollection

GeoJSON GeometryCollection geometria.

Feature

GeoJSON Feature objeto.

FeatureCollection

GeoJSON FeatureCollection objeto.

GeoJsonPoint

Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.

Name Tipo Descrição
bbox

number[] (double)

Caixa delimitadora. Projeção utilizada - EPSG:3857. Consulte RFC 7946 para obter detalhes.

coordinates

number[] (double)

Um Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são longitude e latitude, precisamente nesta ordem. de Altitude/Elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.

type string:

Point

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

Intersection

Detalhes de interseção para um endereço resolvidos como um cruzamento rodoviário — a esquina onde duas ou mais ruas nomeadas se encontram. Preenchido apenas quando a entidade resolvida é um RoadIntersection; o pai Address.intersection é de outra forma omitido.

Name Tipo Descrição
baseStreet

string

A rua principal do cruzamento — normalmente a rua que o número de morada refere.

displayName

string

Um nome legível por humanos para o cruzamento que combina as ruas transversais, como "5th Avenue & Main Street".

intersectionType

string

Um pequeno rótulo que descreve a forma da interseção. Por exemplo, distinguir um cruzamento ao nível de um cruzamento a nível separado, como uma ponte ou um viaduto.

secondaryStreet1

string

A primeira rua transversal que se encontra baseStreet no cruzamento.

secondaryStreet2

string

A segunda rua transversal na interseção, quando há uma. Populado apenas para interseções de três ou mais ruas.