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

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 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[]

Obrigató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 consideração e os resultados retornados podem ser mais relevantes para o usuário. Exemplo: &coordinates=lon,lat

Nota:coordinates torna-se um sinal secundário se bbox for fornecido.

countryRegion
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.

resultTypeGroups
query

AutocompleteResultTypeGroupsEnum[]

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

  • Endereço
  • Local
resultTypes
query

AutocompleteResultTypeEnum[]

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:

  • Endereço
  • Bloqueio

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: 1
maximum: 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.

Consulte de idiomas com suporte para obter detalhes.

Respostas

Nome Tipo Description
200 OK

AutocompleteResponse

A solicitação foi bem-sucedida.

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 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 principal de serviço pode receber acesso via um papel embutido ou um papel personalizado composto por uma ou mais permissões para Azure Mapas APIs REST.\n\nPara implementar cenários, recomendamos visualizar conceitos autenticação. Em resumo, essa definição de segurança fornece uma solução para modelagem de aplicações(ões) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.\n\n#### Notas\n* Esta definição de segurança exige o uso do cabeçalho x-ms-client-id para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento Maps.\n* \nO Authorization URL é específico para a instância Azure nuvem pública. As nuvens soberanas possuem URLs de Autorização e configurações de Microsoft Entra ID únicas. \n* \nO controle de acesso baseado em função Azure é configurado a partir do plano de gerenciamento Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n* \nUso do Azure Mapas Web SDK permite a configuração de uma aplicação baseada em configuração para múltiplos casos de uso.\n* Para mais informações sobre plataforma de identidade da Microsoft, veja plataforma de identidade da Microsoft visão geral.

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

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta Azure Mapas no portal Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.\n\n 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 são emitidas.\n\n Para aplicações publicamente expostas, nossa recomendação é usar a abordagem confidenciais de aplicativos clientes para acessar APIs REST Azure Mapas e assim 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 List SAS no recurso Azure Mapas através do plano de gerenciamento Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n\n Com este token, qualquer aplicativo está autorizado a acessar com Azure controles de acesso baseados em funções e controle detalhado da expiração, taxa e região(s) de uso do token específico. Em outras palavras, o Token SAS pode ser usado para permitir que aplicações controlem o acesso de forma mais segura do que a chave compartilhada.\n\n Para aplicações publicamente expostas, 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'

Solicitação de exemplo

GET {endpoint}/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 {endpoint}/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 {endpoint}/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": "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

Solicitação de exemplo

GET {endpoint}/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 {endpoint}/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 {endpoint}/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 {endpoint}/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 do resultado

AddressAdminDistrictsItem

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

AddressCountryRegion

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

AutocompleteFeature

Recursos do resultado de preenchimento automático

AutocompleteProperties

Propriedades do resultado do preenchimento automático

AutocompleteResponse

Esse 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 que contém detalhes do 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.

FeatureCollectionEnum

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

FeatureTypeEnum

O tipo de um recurso deve ser Feature.

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 de GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.

Intersection

O endereço do resultado.

Address

O endereço do resultado

Nome 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 para um endereço. Esse 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 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 CEP

streetName

string

O nome da rua de formattedAddress

streetNumber

string

O número na rua, se disponível, de formattedAddress

AddressAdminDistrictsItem

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

Nome Tipo Description
name

string

O nome do campo adminDistrict correspondente, For adminDistrict[0], pode ser o nome completo do estado, como Washington, For adminDistrict[1], este pode ser o nome completo do condado

shortName

string

O nome curto do campo adminDistrict correspondente, For adminDistrict[0], pode ser um nome curto de estado, como WA, For adminDistrict[1], esse pode ser o nome curto do município

AddressCountryRegion

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

Nome Tipo Description
ISO

string

ISO do país/região

name

string

nome do país/região

AutocompleteFeature

Recursos do resultado de preenchimento automático

Nome Tipo Description
geometry

GeoJsonPoint

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

properties

AutocompleteProperties

Propriedades do resultado do preenchimento automático

type

FeatureTypeEnum

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

AutocompleteProperties

Propriedades do resultado do preenchimento automático

Nome 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

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

Nome Tipo Description
features

AutocompleteFeature[]

Características do resultado do autopreenchimento

nextLink

string

É o link para a próxima página dos recursos retornados. Se for a última página, não este campo.

type

FeatureCollectionEnum

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

AutocompleteResultTypeEnum

Tipo de sugestão

Valor Description
Address

Endereço

AdminDivision1

AdminDivision1

AdminDivision2

AdminDivision2

AdminDivision3

AdminDivision3

AdministrativeBuilding

Edifício Administrativo

Airport

Aeroporto

AirportTerminal

AirportTerminal

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 do Negócio

Camp

Acampamento

Canal

Canal

Casino

Cassino

Castle

Castelo

Cave

Caverna

Cemetery

Cemitério

Channel

Canal

Church

Igreja

Cliff

Penhasco

Coast

Costa

CommunityCenter

Centro Comunitário

Continent

Continente

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

FerryTerminal

Terminal de Balsas

FinancialStructure

Estrutura Financeira

FireStation

Estação de Bombeiros

Forest

Floresta

Fort

Forte

Garden

Jardim

Geyser

Gêiser

Glacier

Glaciar

GolfCourse

GolfCourse

GreaterPopulatedPlace

Lugar MaiorPovoado

HigherEducationFacility

Ensino Superior

HistoricalSite

Sítio Histórico

Hospital

Hospital

HotSpring

TermalÁgua

Ice

Gelo

IndigenousPeoplesReserve

Reserva dos Povos Indígenas

IndustrialStructure

Estrutura Industrial

Island

Island

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

Estação de Metrô

MilitaryBase

Base Militar

Mission

Missão

Monument

Monumento

Mosque

Mesquita

Mountain

Montanha

MountainRange

Cordilheira

MultiModalStation

MultiModalStation

Museum

Museu

NauticalStructure

Estrutura Nêutica

Neighborhood

Vizinhança

Oasis

Oasis

ObservationPoint

ObservationPoint

Ocean

Mar

OfficeBuilding

Edifício de Escritórios

Other

Outras

Park

Parque

ParkingStructure

Estacionamento Estrutura

Pass

Aprovado

Peninsula

Península

Plain

Sem formatação

Planet

Planeta

Plateau

Planalto

Playground

Playground

PlayingField

PlayingField

Pole

Polo

PoliticalUnit

Unidade Política

PopulatedPlace

PopulatedPlace

Port

Porto

Postcode1

Postcode1

Promontory

Promontório

RaceTrack

RaceTrack

RailwayStation

Estação Ferroviária

Reef

Recife

ReligiousStructure

Estrutura Religiosa

Reserve

Reserva

ResidentialStructure

Estrutura Residencial

River

Rio

RoadBlock

Bloqueio

Ruin

Ruína

ScientificResearchBase

Base de Pesquisa Científica

Sea

Mar

SeaplaneLandingArea

Área de Pouso de Hidroavião

Shrine

Santuário

SkiArea

SkiArea

Spring

Primavera

Stadium

Estádio

StatisticalDistrict

Distrito Estatístico

Temple

Templo

Theater

Teatro

TouristRailway

Ferrovia Turística

TouristStructure

Estrutura Turística

Trailhead

Início da trilha

TransportationStructure

Estrutura de Transporte

Tunnel

Túnel

Valley

Vale

Volcano

Vulcão

Walkway

Caminho

Wall

Mural

Waterfall

Cascata

WaterFeature

Elemento Aquático

Wetland

Área úmida

Winery

Vinícola

Zoo

Zoológico

AutocompleteResultTypeGroupsEnum

Endereço ou local

Valor Description
Address

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

  • Endereço
  • Bloqueio
Place

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

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

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

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

Azure.Core.Foundations.InnerError

Erro interno.

FeatureCollectionEnum

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

Valor Description
FeatureCollection

Especifica o tipo de objeto GeoJSONFeatureCollection.

FeatureTypeEnum

O tipo de um recurso deve ser Feature.

Valor Description
Feature

Especifica o tipo de objeto GeoJSON Feature.

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

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 de GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
bbox

number[] (double)

Caixa delimitadora. Projeção usada – 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 de longitude e de latitude, precisamente nessa ordem. 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

O endereço do resultado.

Nome Tipo Description
baseStreet

string

Rua primária para o local.

displayName

string

Nome completo da interseção.

intersectionType

string

Tipo de interseção.

secondaryStreet1

string

A primeira rua de interseção.

secondaryStreet2

string

Se houver, a segunda rua de interseção.