Search - Get Geocode Autocomplete

Serviço:: Maps

Versão da API:: 2026-01-01

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}

Com parâmetros opcionais:

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	Necessário	Tipo	Description
endpoint	path	True	string
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 você especifica esse parâmetro, a localização do usuário é levada em conta e os resultados retornados podem ser mais relevantes para o usuário. 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 padrão, o parâmetro View é definido como "Auto", mesmo que você não o tenha definido na solicitação. Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
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.

Name

Necessário

Tipo

Description

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	Description
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

Name

Tipo

Description

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 utilizador, grupo ou principal de serviço pode receber acesso através de um papel incorporado ou de um papel personalizado composto por uma ou mais permissões para Azure Maps APIs REST.\n\nPara implementar cenários, recomendamos consultar conceitos autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações(ões) através de objetos capazes de controlo de acesso em APIs e escopos específicos.\n\n#### Notas\n* Esta definição de segurança exige a utilização do cabeçalho x-ms-client-id para indicar a que Azure Maps recurso a aplicação está a pedir acesso. Isto pode ser adquirido da API de gestão Maps.\n* \nO Authorization URL é específico para a instância Azure cloud pública. As clouds soberanas têm URLs de Autorização e configurações de Microsoft Entra ID únicas. \n* \nO controlo de acesso Azure baseado em funções é configurado a partir do plano de gestão Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n* \nUtilização do Azure Maps Web SDK permite a configuração de uma aplicação para múltiplos casos de uso.\n* Para mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft visão geral.

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 partilhada que é provisionada quando Cria uma conta Azure Maps no portal Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.\n\n Com esta chave, qualquer aplicação pode aceder a toda a API REST. Ou seja, esta chave pode ser usada como chave mestra na conta onde são emitidas.\n\n Para aplicações expostas publicamente, a nossa recomendação é usar a abordagem confidenciais de aplicações cliente para aceder às APIs REST Azure Maps para que a sua chave possa ser armazenada de forma segura.

Tipo: apiKey
Em: header

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso Azure Maps através do plano de gestão Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n\n Com este token, qualquer aplicação está autorizada a aceder com Azure controlos de acesso baseados em funções e controlo minucioso da expiração, taxa e região(s) de utilização para o token em questão. Por outras palavras, o Token SAS pode ser usado para permitir que aplicações controlem o acesso de forma mais segura do que a chave partilhada.\n\n Para aplicações publicamente expostas, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta Map para limitar abusos 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

HTTP

GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query=1 Microsoft&coordinates=-113.301894,49.201888

Resposta da amostra

Código de estado:: 200

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

HTTP

GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query=1 Microsoft Way, Redmond&coordinates=-113.301894,49.201888&resultTypeGroups=Place&resultTypes=RoadBlock

Resposta da amostra

Código de estado:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": []
}

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

Pedido de amostra

HTTP

GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address

Resposta da amostra

Código de estado:: 200

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": null,
      "properties": {
        "typeGroup": "Address",
        "type": "Address",
        "address": {
          "streetName": "Muir Woods Rd",
          "addressLine": " Muir Woods Rd",
          "locality": "Sausalito",
          "adminDistricts": [
            {
              "name": "California"
            },
            {
              "name": "Marin County"
            }
          ],
          "countryRegion": {
            "ISO": "US",
            "name": "United States"
          },
          "postalCode": "94965",
          "formattedAddress": "Muir Woods Rd, Sausalito, California 94965, United States"
        }
      }
    },
    {
      "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"
        }
      }
    }
  ]
}

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

Pedido de amostra

HTTP

GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place&resultTypes=Park,PopulatedPlace

Resposta da amostra

Código de estado:: 200

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

HTTP

GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypes=Park

Resposta da amostra

Código de estado:: 200

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

HTTP

GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place

Resposta da amostra

Código de estado:: 200

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

HTTP

GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address&resultTypes=RoadBlock

Resposta da amostra

Código de estado:: 200

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	Description
Address	O endereço do resultado
AddressAdminDistrictsItem	O nome da subdivisão no país ou região de um endereço.
AddressCountryRegion	País ou região com o seu nome e código ISO.
AutocompleteFeature	Características do resultado de preenchimento automático
AutocompleteProperties	Propriedades do resultado de preenchimento automático
AutocompleteResponse	Este objeto é retornado de uma chamada de preenchimento automático bem-sucedida.
AutocompleteResultTypeEnum	Tipo de sugestão
AutocompleteResultTypeGroupsEnum	Endereço ou Local
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	Especifica o tipo de `GeoJSON`. O único tipo de objeto suportado é `FeatureCollection`. Para obter mais informações, consulte RFC 7946.
FeatureTypeEnum	O tipo de recurso deve ser Recurso.
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	O endereço do resultado.

Address

Object

O endereço do resultado

Name	Tipo	Description
addressLine	string	AddressLine que inclui o nome e o número da rua
adminDistricts	AddressAdminDistrictsItem[]	O nome da subdivisão no país ou região de um endereço. Este elemento é normalmente tratado como a subdivisão administrativa de primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem em um país, dependência ou região.
countryRegion	AddressCountryRegion	País ou região com o seu nome e código ISO.
formattedAddress	string	Propriedade de endereço formatado
intersection	Intersection	O endereço do resultado.
locality	string	Propriedade de localidade
neighborhood	string	Propriedade do bairro
postalCode	string	Propriedade do código postal
streetName	string	O nome da rua de formattedAddress
streetNumber	string	O número na rua, se disponível, de formattedAddress

AddressAdminDistrictsItem

Object

O nome da subdivisão no país ou região de um endereço.

Name	Tipo	Description
name	string	O nome para o campo adminDistrict correspondente, Para adminDistrict[0], este poderia ser o nome completo do estado, como Washington, Para adminDistrict[1], este poderia ser o nome completo do condado
shortName	string	O nome curto para o campo adminDistrict correspondente, Para adminDistrict[0], este poderia ser o nome curto do estado, como WA, Para adminDistrict[1], este poderia ser o nome curto do condado

AddressCountryRegion

Object

País ou região com o seu nome e código ISO.

Name	Tipo	Description
ISO	string	ISO do país/região
name	string	nome do país/região

AutocompleteFeature

Object

Características do resultado de preenchimento automático

Name	Tipo	Description
geometry	GeoJsonPoint	Um tipo de geometria `GeoJSON Point` válido. Consulte RFC 7946 para obter detalhes.
properties	AutocompleteProperties	Propriedades do resultado de preenchimento automático
type	FeatureTypeEnum	Especifica o tipo de `GeoJSON`. O único tipo de objeto suportado é Feature. Para obter mais informações, consulte RFC 7946.

AutocompleteProperties

Object

Propriedades do resultado de preenchimento automático

Name	Tipo	Description
address	Address	O endereço do resultado
name	string	O nome do lugar. Este campo não aparecerá se o tipo retornado for Endereço.
type	AutocompleteResultTypeEnum	Tipo de sugestão
typeGroup	AutocompleteResultTypeGroupsEnum	Endereço ou Local

AutocompleteResponse

Object

Este objeto é retornado de uma chamada de preenchimento automático bem-sucedida.

Name	Tipo	Description
features	AutocompleteFeature[]	Funcionalidades do resultado de autopreenchimento
nextLink	string	O é o link para a próxima página dos recursos retornados. Se for a última página, não há este campo.
type	FeatureCollectionEnum	Especifica o tipo de `GeoJSON`. O único tipo de objeto suportado é `FeatureCollection`. Para obter mais informações, consulte RFC 7946.

AutocompleteResultTypeEnum

Enumeração

Tipo de sugestão

Valor	Description
Address	Morada
AdminDivision1	AdminDivision1
AdminDivision2	AdminDivision2
AdminDivision3	AdminDivision3
AdministrativeBuilding	Edifício Administrativo
Airport	Aeroporto
AirportTerminal	AeroportoTerminal
AmusementPark	Parque de Diversões
AncientSite	Sítio Antigo
Aquarium	Aquário
Archipelago	Arquipélago
Basin	Bacia
Battlefield	Campo de batalha
Bay	Bay
Beach	Praia
Bridge	Ponte
BusinessStructure	Estrutura Empresarial
Camp	Campo
Canal	Canal
Casino	Cassino
Castle	Castelo
Cave	Gruta
Cemetery	Cemitério
Channel	Canal
Church	Igreja
Cliff	Penhasco
Coast	Costa
CommunityCenter	Centro Comunitário
Continent	Continent
CountryRegion	País/Região
Crater	Cratera
CulturalRegion	Região Cultural
Dam	Barragem
Delta	Delta
Desert	Deserto
DrainageBasin	Bacia hidrográfica
Dune	Duna
FacilityStructure	Estrutura da Infraestrutura
FerryTerminal	Terminal de Ferry
FinancialStructure	Estrutura Financeira
FireStation	Quartel de Bombeiros
Forest	Forest
Fort	Forte
Garden	Jardim
Geyser	Géiser
Glacier	Glaciar
GolfCourse	Campo de Golfe
GreaterPopulatedPlace	Lugar MaiorPovoado
HigherEducationFacility	Ensino Superior
HistoricalSite	Sítio Histórico
Hospital	Hospital
HotSpring	Terma
Ice	Ice
IndigenousPeoplesReserve	Reserva dos Povos Indígenas
IndustrialStructure	Estrutura Industrial
Island	Ilha
Isthmus	Istmo
Lake	Lago
LandArea	LandArea
Landform	Formação do relevo
LandmarkBuilding	Edifício Marco
Library	Biblioteca
Lighthouse	Farol
Marina	Marina
Market	Mercado
MedicalStructure	Estrutura Médica
MetroStation	MetroStation
MilitaryBase	Base Militar
Mission	Missão
Monument	Monumento
Mosque	Mesquita
Mountain	Montanha
MountainRange	Cordilheira
MultiModalStation	MultiModalStation
Museum	Museu
NauticalStructure	Estrutura Náutica
Neighborhood	Bairro
Oasis	Oasis
ObservationPoint	ObservationPoint
Ocean	Oceano
OfficeBuilding	Edifício de Escritórios
Other	Outros
Park	Parque
ParkingStructure	Estrutura de estacionamento
Pass	Pass
Peninsula	Península
Plain	Simples
Planet	Planeta
Plateau	Planalto
Playground	Parque Infantil
PlayingField	PlayingField
Pole	Polo
PoliticalUnit	Unidade Política
PopulatedPlace	PopulatedPlace
Port	Porto
Postcode1	Código postal1
Promontory	Promontório
RaceTrack	RaceTrack
RailwayStation	Estação Ferroviária
Reef	Recife
ReligiousStructure	Estrutura Religiosa
Reserve	Reserva
ResidentialStructure	Estrutura Residencial
River	Rio
RoadBlock	Bloqueio de estrada
Ruin	Ruína
ScientificResearchBase	ScientificResearchBase
Sea	Mar
SeaplaneLandingArea	Área de Aterragem de Hidroavião
Shrine	Santuário
SkiArea	SkiArea
Spring	Primavera
Stadium	Estádio
StatisticalDistrict	Distrito Estatístico
Temple	Templo
Theater	Teatro
TouristRailway	Caminho-de-Ferro Turístico
TouristStructure	Estrutura Turística
Trailhead	Início do trilho
TransportationStructure	Estrutura do Transporte
Tunnel	Túnel
Valley	Vale
Volcano	Vulcão
Walkway	Passadeira
Wall	Parede
Waterfall	Cascata
WaterFeature	Elemento Aquático
Wetland	Zona húmida
Winery	Adega
Zoo	Zoo

AutocompleteResultTypeGroupsEnum

Enumeração

Endereço ou Local

Valor	Description
Address	Um local de endereço específico. Os tipos suportados são: Morada Bloqueio de estrada
Place	Todos os outros tipos pertencem ao grupo Tipo de lugar. Isso pode incluir entidades como AdminDivision1, Neighborhood, PopulatedPlace e muito mais.

Valor

Description

Address

Um local de endereço específico. Os tipos suportados são:

Morada
Bloqueio de estrada

Place

Todos os outros tipos pertencem ao grupo Tipo de lugar. Isso pode incluir entidades como AdminDivision1, Neighborhood, PopulatedPlace e muito mais.

Azure.Core.Foundations.Error

Object

O objeto de erro.

Name	Tipo	Description
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

Object

Uma resposta contendo detalhes do erro.

Name	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Object

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	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

FeatureCollectionEnum

Enumeração

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é FeatureCollection. Para obter mais informações, consulte RFC 7946.

Valor	Description
FeatureCollection	Especifica o tipo de objeto `GeoJSONFeatureCollection`.

FeatureTypeEnum

Enumeração

O tipo de recurso deve ser Recurso.

Valor	Description
Feature	Especifica o tipo de objeto `GeoJSON` Feature.

GeoJsonObjectType

Enumeração

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	Description
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

Object

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

Name	Tipo	Description
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

Object

O endereço do resultado.

Name	Tipo	Description
baseStreet	string	Rua principal para o local.
displayName	string	Nome completo do cruzamento.
intersectionType	string	Tipo de intersecção.
secondaryStreet1	string	A primeira rua que se cruza.
secondaryStreet2	string	Se houver, a segunda rua que se cruza.

Partilhar via

Search - Get Geocode Autocomplete

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

AadToken

Âmbitos

subscription-key

SAS Token

Exemplos

Autocomplete API call to search for '1 Microsoft'

Pedido de amostra

Resposta da amostra

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

Pedido de amostra

Resposta da amostra

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

Pedido de amostra

Resposta da amostra

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

Pedido de amostra

Resposta da amostra

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

Pedido de amostra

Resposta da amostra

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

Pedido de amostra

Resposta da amostra

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

Pedido de amostra

Resposta da amostra

Definições

Address

AddressAdminDistrictsItem

AddressCountryRegion

AutocompleteFeature

AutocompleteProperties

AutocompleteResponse

AutocompleteResultTypeEnum

AutocompleteResultTypeGroupsEnum

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

FeatureCollectionEnum

FeatureTypeEnum

GeoJsonObjectType

GeoJsonPoint

Intersection