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 usuário e uma consulta parcial que serve como prefixo de uma string completa de consulta (referida como prefixo de consulta), a API de Autopreenchimento do Azure Mapas retorna uma lista de entidades sugeridas que o usuário provavelmente está procurando. Essas entidades são classificadas da mais para a 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 de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
O nome de host do serviço Azure Mapas. Use |
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a ser usada para esta operação. |
|
query
|
query | True |
string |
Obrigatório O prefixo de consulta do usuário. Exemplo: "1 Micro" ou "Muir Woods". |
|
bbox
|
query |
number[] |
Obrigatório quando 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[] |
Obrigatório quando
Nota: |
|
|
country
|
query |
string |
Sinalize o resultado do preenchimento automático para um código de região/país ISO 3166-1 Alfa-2 especificado, por exemplo, FR. Somente os resultados no país/região especificado serão retornados. |
|
|
result
|
query |
Uma lista separada por vírgulas de grupos de tipos de entidade retornados. Os valores possíveis são
|
||
|
result
|
query |
Uma lista separada por vírgulas de tipos de entidade retornados. Quando o grupo de tipos é definido como Endereço, os tipos com suporte são:
Todos os outros tipos pertencem ao grupo de tipos 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: 1maximum: 20 |
Número máximo de respostas que serão retornadas. 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 Alfa-2. Isso alterará as bordas e rótulos contestados geopolíticos para se alinharem com a região de usuário especificada. Por padrão, o parâmetro View é definido como "Automático", mesmo que você não o tenha definido na solicitação. Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis. |
Cabeçalho da solicitação
| Nome | Obrigatório | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Especifica qual conta deve ser usada em conjunto com o modelo de segurança do Azure AD. Ele representa um ID único para a conta do Azure Mapas e pode ser recuperado na API de Contas do plano de gerenciamento do Azure Mapas. Para mais informações sobre o uso da segurança Microsoft Entra ID em Azure Mapas, veja Gerencie autenticação em Azure Mapas. |
|
| Accept-Language |
string |
Idioma no qual os resultados da pesquisa devem ser retornados. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
A solicitação foi bem-sucedida. Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
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 o controle de acesso baseado em funções Azure , pode ser usado para controlar o acesso às APIs REST Azure Mapas. Controles de acesso baseados em função do Azure são usados para designar acesso a uma ou mais contas ou subrecursos de recursos do Azure Mapas. 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 Mapas.
Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de controlar o acesso em APIs e escopos específicos.
Note
- Essa definição de segurança requer o uso do cabeçalho
x-ms-client-idpara indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas. - O
Authorization URLé específico para a instância de nuvem pública do Azure. As nuvens soberanas possuem URLs de Autorização e configurações de Microsoft Entra ID únicas. - O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
- O uso do SDK da Web do do Azure Mapas 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
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
| Nome | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Essa é uma chave compartilhada provisionada quando você Criar uma conta do Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.
Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que elas são emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar o aplicativos cliente confidenciais abordagem para acessar AS APIs REST do Azure Mapas para que sua chave possa ser armazenada com segurança.
Tipo:
apiKey
Em:
header
SAS Token
Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) 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 protegida 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 de mapa de
Tipo:
apiKey
Em:
header
Exemplos
Autocomplete API call to search for '1 Microsoft'
Solicitação de exemplo
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=1 Microsoft&coordinates=-113.301894,49.201888
Resposta de exemplo
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
Solicitação de exemplo
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 de exemplo
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": []
}
Autocomplete API call to search for 'Muir Woods', filtered by address resultTypeGroups
Solicitação de exemplo
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address
Resposta de exemplo
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
Solicitação de exemplo
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 de exemplo
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
Solicitação de exemplo
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypes=Park
Resposta de exemplo
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
Solicitação de exemplo
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place
Resposta de exemplo
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
Solicitação de exemplo
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 de exemplo
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
| Nome | Description |
|---|---|
| Address |
O endereço de um local sugerido por geocodificação ou autocompletamento, analisado em campos estruturados.
A escassez é normal: apenas os campos que a entidade resolvida fornece são preenchidos. Por exemplo, |
|
Address |
Uma subdivisão administrativa que contém um endereço. Por exemplo, um estado, província ou condado. Devolvido como uma entrada no arranjo pai |
|
Address |
O país ou região que contém o endereço, identificado pelo nome de exibição e código de país ISO 3166-1 Alpha-2. Qualquer um dos campos pode ser omitido em uma determinada resposta. |
|
Autocomplete |
Uma única entrada no |
|
Autocomplete |
A |
|
Autocomplete |
O corpo de resposta bem-sucedida retornou por |
|
Autocomplete |
Uma classificação de sugestões de autopreenchimento usadas tanto |
|
Autocomplete |
Uma classificação grosseira de uma sugestão de autocompleto em um de dois grupos. Usado tanto |
|
Azure. |
O objeto de erro. |
|
Azure. |
Uma resposta que contém detalhes do erro. |
|
Azure. |
Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors. |
|
Feature |
O |
|
Feature |
O |
|
Geo |
Especifica o tipo de |
|
Geo |
Um tipo de geometria de |
| Intersection |
Detalhes do cruzamento para um endereço resolvidos como um cruzamento de estrada — a esquina onde duas ou mais ruas nomeadas se encontram. Preenchido apenas quando a entidade resolvida é um |
Address
O endereço de um local sugerido por geocodificação ou autocompletamento, analisado em campos estruturados.
A escassez é normal: apenas os campos que a entidade resolvida fornece são preenchidos. Por exemplo, streetName e streetNumber aparece apenas para endereços no nível da rua, e intersection aparece apenas para resultados de interseções rodoviárias.
| Nome | Tipo | Description |
|---|---|---|
| addressLine |
string |
A primeira linha do endereço, normalmente o nome e número da rua. Por exemplo, |
| adminDistricts |
As subdivisões administrativas que contêm o endereço, ordenadas do mais grosseiro ao mais refinado. A primeira entrada é tipicamente a subdivisão de primeira ordem (como um estado dos EUA ou uma província canadense); Entradas subsequentes cobrem divisões mais detalhadas onde o país, dependência ou região as define (como um condado no índice 1). |
|
| countryRegion |
O país ou região que contém o endereço, com 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 string legível por humanos, com os componentes unidos de acordo com as convenções do país ou região do endereço. Exemplo: |
| intersection |
Os detalhes das ruas que se cruzam para o endereço, preenchidos quando a entidade resolvida é um |
|
| locality |
string |
A localidade onde o endereço se encontra: geralmente uma cidade, vila ou vila. Por exemplo: |
| neighborhood |
string |
O bairro nomeado dentro da localidade, quando um é identificado. |
| postalCode |
string |
O código postal do endereço, quando um é definido. Exemplo: |
| streetName |
string |
O componente de nome de rua do endereço, quando a entidade resolvida é um endereço de nível de rua. Exemplo: |
| streetNumber |
string |
O número da casa ou prédio na rua, quando a entidade resolvida é um endereço no nível da rua. Exemplo: |
AddressAdminDistrictsItem
Uma subdivisão administrativa que contém um endereço. Por exemplo, um estado, província ou condado. Devolvido como uma entrada no arranjo pai Address.adminDistricts , onde as entradas são ordenadas do mais grosseiro para o mais fino.
| Nome | Tipo | Description |
|---|---|---|
| name |
string |
O nome completo do loteamento. Por exemplo, |
| shortName |
string |
A forma curta ou abreviada do nome da subdivisão, quando definido um. Por exemplo, |
AddressCountryRegion
O país ou região que contém o endereço, identificado pelo nome de exibição e código de país ISO 3166-1 Alpha-2. Qualquer um dos campos pode ser omitido em uma determinada resposta.
| Nome | Tipo | Description |
|---|---|---|
| ISO |
string |
O código de país ISO 3166-1 Alpha-2 para o país ou região. Por exemplo, |
| name |
string |
O nome de exibição do país ou região. Por exemplo, |
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 lugar são expostos via properties, com uma coordenada representativa em geometry quando um está disponível.
| Nome | Tipo | Description |
|---|---|---|
| geometry |
A coordenada da sugestão de autopreenchimento como , |
|
| properties |
Dados estruturados sobre a sugestão de autocompletamento, incluindo sua classificação, endereço analisado e (para |
|
| type |
O tipo de |
AutocompleteProperties
A properties carga útil de um AutocompleteFeature. Carrega a classificação do resultado (typeGroup, type), seu endereço analisado e (para muitos Placeresultados -tipados) um nome de exibição separado.
| Nome | Tipo | Description |
|---|---|---|
| address |
O endereço do resultado de autocompletamento, analisado em campos estruturados.
|
|
| name |
string |
O nome de exibição do local sugerido. Preenchido para |
| type |
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 ponto de referência. Veja |
|
| typeGroup |
A classificação ampla do resultado como endereço ou lugar nomeado. Veja |
AutocompleteResponse
O corpo de resposta bem-sucedida retornou por Get Autocomplete. Codificado como um GeoJSON FeatureCollection cujo features array contém um Feature por sugestão de autocompletamento, classificado do mais ao menos provável.
| Nome | Tipo | Description |
|---|---|---|
| features |
O array de |
|
| nextLink |
string |
Contém a URL para buscar a próxima página de resultados caso a resposta seja paginada. Isso é útil quando a resposta é grande demais para ser retornada em uma única chamada, permitindo que os usuários naveguem por várias páginas de resultados. |
| type |
O |
AutocompleteResultTypeEnum
Uma classificação de sugestões de autopreenchimento usadas tanto Get Autocomplete como filtro de entrada (via o parâmetro de resultTypes consulta) quanto como rótulo de saída (via o type campo em cada AutocompleteProperties). Os membros definem uma taxonomia no estilo gazetteer, abrangendo endereços, segmentos de ruas, regiões administrativas, locais povoados, características naturais e pontos de interesse. Essa taxonomia é dividida em dois grupos mais amplos por AutocompleteResultTypeGroupsEnum: Address, que cobre endereços e segmentos de estrada; e Place, que cobre todos os outros tipos de resultados.
| Valor | Description |
|---|---|
| Address |
Um endereço específico. |
| 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, paróquia ou município. |
| AdministrativeBuilding |
Um edifício que abriga escritórios governamentais ou funções administrativas públicas. |
| Airport |
Uma instalação onde aeronaves decolam e pousam regularmente, com instalações para passageiros e carga. |
| AirportTerminal |
Um terminal de passageiros dentro de um aeroporto. |
| AmusementPark |
Uma instalação de entretenimento com brinquedos, jogos e atrações temáticas. |
| AncientSite |
Um local onde restos arqueológicos ou artefatos culturais de uma civilização antiga são preservados. |
| 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 solo, frequentemente cercada por terrenos mais elevados. |
| Battlefield |
Um local de uma batalha terrestre historicamente significativa. |
| Bay |
Um corpo d'água parcialmente cercado por terra, menor que um golfo e maior que uma enseada. |
| Beach |
Uma margem de areia, pedrinha ou outro sedimento não consolidado ao longo de um corpo d'água. |
| Bridge |
Uma estrutura que sustenta uma estrada, ferrovia ou caminho sobre 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 encaixa em uma categoria mais específica. |
| Camp |
Um local com abrigos ou instalações para ocupação temporária, como um acampamento ou assentamento sazonal. |
| Canal |
Um curso d'á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 à residência nobre ou real. |
| 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 d'água maior. |
| Church |
Um edifício usado para cultos cristãos públicos. |
| Cliff |
Uma face alta e íngreme de rocha ou terra, frequentemente com vista para uma costa ou vale. |
| Coast |
Um trecho de terra nomeado que margeia o mar. |
| CommunityCenter |
Uma instalação que hospeda atividades comunitárias, reuniões e serviços sociais. |
| Continent |
Uma das principais massas de terra 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 compartilhadas, como língua, etnia ou herança. |
| Dam |
Uma barreira construída sobre um riacho ou rio para represar água. |
| Delta |
Uma formação de depósitos aluviais formada onde um rio encontra um corpo d'água maior. |
| Desert |
Uma grande região árida com vegetação esparsa 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 abriga uma instalação especializada, como uma usina de utilidade ou instalação de serviços. |
| FerryTerminal |
Uma instalação onde passageiros e veículos embarcam e desembarcam de balsas. |
| FinancialStructure |
Um prédio que abriga um banco, cooperativa de crédito ou outra instituição de serviços financeiros. |
| FireStation |
Um prédio que abriga bombeiros, equipamentos e veículos de resposta a emergências. |
| Forest |
Uma grande área de terra dominada por árvores. |
| Fort |
Uma estrutura militar defensiva ou fortificações. |
| Garden |
Uma área cultivada para exibir 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 seu próprio peso. |
| GolfCourse |
Um campo planejado para jogar golfe. |
| GreaterPopulatedPlace |
Uma área metropolitana ou conurbação que contém e se estende além de um local povoado. |
| HigherEducationFacility |
Uma faculdade, universidade ou instituição semelhante de ensino pós-secundário. |
| HistoricalSite |
Um sítio de importância histórica, frequentemente preservado como patrimônio cultural. |
| Hospital |
Uma unidade médica que oferece cuidados hospitalares e ambulatoriais. |
| HotSpring |
Uma nascente natural onde água subterrânea aquecida geotermicamente emerge na superfície. |
| Ice |
Uma massa natural ou camada superficial de água congelada cobrindo 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 usada para manufatura, produção ou outras operações industriais. |
| Island |
Uma massa de terra cercada por água, menor que um continente. |
| Isthmus |
Uma faixa estreita de terra conectando duas massas de terra maiores e separando dois corpos d'água. |
| Lake |
Um corpo de água parada no interior cercado por terra. |
| LandArea |
Uma região terrestre nomeada que não se encaixa em uma categoria geográfica mais específica. |
| Landform |
Uma característica natural do terreno que não se encaixa em uma categoria mais específica, como um |
| LandmarkBuilding |
Um edifício notável de importância arquitetônica, cultural ou histórica que serve como um marco reconhecível. |
| Library |
Um prédio que abriga uma coleção de livros e outros materiais disponíveis para uso público. |
| Lighthouse |
Uma estrutura costeira ou portuária exibindo 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 lugar onde mercadorias são compradas e vendidas, normalmente no varejo. |
| MedicalStructure |
Um edifício utilizado para serviços médicos ou relacionados à saúde que não sejam , |
| MetroStation |
Uma estação em um sistema de metrô, metrô ou outro sistema urbano de trânsito rápido. |
| MilitaryBase |
Uma instalação operada pelas forças armadas para treinamento, suprimentos ou operações. |
| Mission |
Um complexo operado por um grupo religioso para fornecer 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 usado para culto islâmico público. |
| Mountain |
Uma formação de relevo que se eleva significativamente acima de seus arredores, tipicamente com encostas íngremes e um cume definido. |
| MountainRange |
Uma série conectada de montanhas formando uma cadeia contínua. |
| MultiModalStation |
Uma estação que atende a múltiplos modos de transporte, como trens combinados, ônibus ou metrô. |
| Museum |
Uma instalação onde objetos de interesse artístico, científico ou histórico são preservados e exibidos. |
| NauticalStructure |
Uma estrutura relacionada à atividade marítima ou náutica, como um píer, doca ou boia. |
| Neighborhood |
Uma área reconhecida localmente dentro de um local povoado, frequentemente com limites informais ou culturalmente definidos. |
| Oasis |
Uma área fértil em um deserto sustentada por uma fonte natural de água. |
| ObservationPoint |
Um mirante ou mirante que oferece vistas cênicas da área ao redor. |
| Ocean |
Uma das principais divisões do oceano global da Terra. |
| OfficeBuilding |
Um edifício usado principalmente para escritórios profissionais ou administrativos. |
| Other |
Uma sugestão que não se encaixa em nenhum outro tipo definido. |
| Park |
Uma área mantida para recreação pública ou desfrute 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 de montanhas ou obstrução semelhante. |
| Peninsula |
Uma massa de terra projetada em um corpo d'água e quase cercada por ela. |
| Plain |
Uma extensa área de terreno relativamente plano ou suavemente ondulado. |
| Planet |
Um corpo celeste orbitando uma estrela, tipicamente 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 recreativa equipada para brincadeiras infantis. |
| PlayingField |
Uma área aberta usada para praticar esportes organizados. |
| Pole |
Um polo geográfico, como o Polo Norte ou 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 vila. |
| Port |
Uma instalação marítima com terminais para carregamento e descarga de cargas ou passageiros por via marítima. |
| Postcode1 |
A menor categoria de código postal, como um CEP. |
| Promontory |
Uma formação elevada e proeminente projetando-se em uma planície ou corpo d'água. |
| RaceTrack |
Uma pista ou percurso projetado para veículos de corrida, animais ou atletas. |
| RailwayStation |
Uma instalação onde os passageiros embarcam e desembarcam dos trens. |
| Reef |
Uma crista submersa ou parcialmente submersa de rocha, areia ou coral próxima à superfície da água. |
| ReligiousStructure |
Um edifício usado para culto ou prática religiosa que não se encaixa em uma categoria mais específica, como |
| Reserve |
Um terreno protegido reservado para conservação, vida selvagem ou outro uso restrito. |
| ResidentialStructure |
Um edifício usado principalmente para residência humana, como um complexo de apartamentos ou moradias. |
| River |
Um curso d'água natural que flui para uma elevação mais baixa, tipicamente em direção a um mar, lago ou outro rio. |
| RoadBlock |
Um segmento de rua sem um número específico da casa, retornado quando o serviço de geocodificação não consegue localizar um número exato da casa para a consulta. Apesar do nome, esse valor não indica um fechamento físico da estrada. |
| Ruin |
Uma estrutura destruída ou deteriorada que não cumpre mais sua função original. |
| ScientificResearchBase |
Uma instalação usada como base para pesquisas científicas, frequentemente em ambientes remotos ou extremos. |
| Sea |
Um grande corpo de água salgada parcialmente cercado por terra, menor que um oceano. |
| SeaplaneLandingArea |
Uma área de água destinada para hidroaviões decolarem e pousarem. |
| 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 esportes de inverno. |
| Spring |
Uma fonte natural onde a água subterrânea flui da superfície da terra. |
| Stadium |
Um grande local com assentos em níveis para esportes ou eventos para espectadores. |
| StatisticalDistrict |
Uma região definida para fins estatísticos ou censitários, como uma área estatística metropolitana ou setores censitários. |
| Temple |
Um edifício dedicado ao culto religioso. |
| Theater |
Um espaço para apresentar peças, filmes ou outras apresentaçõ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 atende turistas, como um centro de visitantes ou um escritório de informações turísticas. |
| Trailhead |
O ponto de partida de uma trilha para caminhadas, ciclismo ou recreação. |
| TransportationStructure |
Uma estrutura que apoie infraestrutura de transporte, como uma praça de pedágio, uma balança ou um abrigo de trânsito. |
| Tunnel |
Uma passagem subterrânea ou subaquática para transporte rodoviário, ferroviário ou de pedestres. |
| Valley |
Uma área alongada e baixa entre colinas ou montanhas, frequentemente contendo um curso d'água. |
| Volcano |
Uma montanha ou colina formada por atividade vulcânica, tipicamente com uma cratera no topo. |
| Walkway |
Um caminho ou superfície pavimentada destinada ao uso de pedestres. |
| Wall |
Uma barreira construída formando 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 d'água que não se encaixa em uma categoria mais específica, como um |
| Wetland |
Uma área de terra saturada de água e que sustenta vegetação aquática, como um pântano ou pântano. |
| Winery |
Uma instalação onde o vinho é produzido e frequentemente oferecido para degustação 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 de autocompleto em um de dois grupos. Usado tanto Get Autocomplete como filtro de entrada via parâmetro resultTypeGroups de consulta (restringindo quais tipos de sugestões são retornadas) quanto como classificador de saída via campo typeGroup em cada AutocompleteProperties um (identificando a qual grupo pertence uma sugestão retornada). 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 | Description |
|---|---|
| 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, locais povoados, bairros, características naturais e pontos de interesse. Exemplos incluem |
Azure.Core.Foundations.Error
O objeto de erro.
| Nome | Tipo | Description |
|---|---|---|
| code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
| details |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
|
| 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 pelo ser humano do erro. |
| target |
string |
O destino do erro. |
Azure.Core.Foundations.ErrorResponse
Uma resposta que contém detalhes do erro.
| Nome | Tipo | Description |
|---|---|---|
| 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 as diretrizes Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Nome | Tipo | Description |
|---|---|---|
| code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
| innererror |
Erro interno. |
FeatureCollectionEnum
O GeoJSON tipo de objeto usado na raiz das respostas bem-sucedidas das operações de geocodificação direta, geocodificação reversa e autocompletar (incluindo suas variantes em lote). O único valor é FeatureCollection, conforme definido no RFC 7946.
Get Polygon é a única exceção: sua raiz de resposta é um GeoJSON Feature, veja FeatureTypeEnum.
| Valor | Description |
|---|---|
| FeatureCollection |
O tipo de |
FeatureTypeEnum
O GeoJSON tipo de objeto para Feature 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 | Description |
|---|---|
| Feature |
O tipo de |
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 | Description |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
|
| FeatureCollection |
|
GeoJsonPoint
Um tipo de geometria de GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
Intersection
Detalhes do cruzamento para um endereço resolvidos como um cruzamento de estrada — a esquina onde duas ou mais ruas nomeadas se encontram. Preenchido apenas quando a entidade resolvida é um RoadIntersection; o pai Address.intersection é omitido.
| Nome | Tipo | Description |
|---|---|---|
| baseStreet |
string |
A rua principal do cruzamento — normalmente a rua que o número do endereço menciona. |
| displayName |
string |
Um nome legível para o cruzamento que combina as ruas transversais, como |
| intersectionType |
string |
Um pequeno rótulo descrevendo a forma da interseção. Por exemplo, distinguir um cruzamento em nível de um cruzamento em nível, como uma ponte ou viaduta. |
| secondaryStreet1 |
string |
A primeira rua transversal que se encontra |
| secondaryStreet2 |
string |
A segunda rua transversal no cruzamento, quando há uma. Habitado apenas para cruzamentos de três ou mais ruas. |