Search - Get Geocode Autocomplete

Se usa para obtener una lista clasificada de entidades sugeridas en función de la ubicación de un usuario y una consulta parcial.
Dada una solicitud con la ubicación del usuario y una consulta parcial que sirve como prefijo de una cadena de consulta completa (denominada prefijo de consulta), la API de Autocompletado de Azure Maps devuelve una lista de entidades sugeridas que el usuario probablemente está buscando. Estas entidades se clasifican de mayor a menor probabilidad.

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

Nombre En Requerido Tipo Description
endpoint
path True

string (uri)

El nombre de host del servicio Azure Maps. Usa https://atlas.microsoft.com para la nube pública Azure. Para dirigirse a una geografía Azure Maps específica o a una nube soberana, véase Azure Maps alcance geográfico.

api-version
query True

string

minLength: 1

Versión de API que se usará para esta operación.

query
query True

string

Obligatorio. El prefijo de consulta del usuario.

Ejemplo: "1 Micro" o "Muir Woods".

bbox
query

number[]

Requerido cuando coordinates no se proporciona. Un área rectangular en la tierra definida como un objeto de rectángulo delimitador. Los lados del rectángulo se definen mediante valores de longitud y latitud. Al especificar este parámetro, el área geográfica se tiene en cuenta al calcular los resultados de una consulta de ubicación.

Ejemplo: lon1,lat1,lon2,lat2.

Tamaño mínimo: aproximadamente 0,00001 grados (~0,01 metros).

Tamaño máximo: hasta la extensión global completa (-180,-90 a 180,90)

coordinates
query

number[]

Requerido cuando bbox no se proporciona. Un punto en la tierra especificado como longitud y latitud. Cuando especificas este parámetro, se tiene en cuenta la ubicación del usuario y los resultados devueltos pueden ser más relevantes para el usuario. Ejemplo: &coordinates=lon,lat

Nota:coordinates se convierte en una señal secundaria si bbox se proporciona.

countryRegion
query

string

Señal para el resultado de autocompletar a un código de región/país ISO 3166-1 Alpha-2 que se especifique, por ejemplo, FR. Solo se devolverán los resultados en el país o región especificados.

resultTypeGroups
query

AutocompleteResultTypeGroupsEnum[]

Una lista separada por comas de grupos de tipos de entidad devueltos. Los valores posibles son:

  • Dirección
  • Lugar
resultTypes
query

AutocompleteResultTypeEnum[]

Una lista separada por comas de tipos de entidad devueltos. Cuando el grupo de tipos se establece en Dirección, los tipos admitidos son:

  • Dirección
  • Barrera

Todos los demás tipos pertenecen al grupo de tipos Lugar. Estos pueden incluir entidades como AdminDivision1, Neighborhood, PopulatedPlace y más. El valor predeterminado es todos los tipos de entidad posibles.

top
query

integer (int32)

minimum: 1
maximum: 20

Número máximo de respuestas que se devolverán. Predeterminado: 5, mínimo: 1 y máximo: 20.

view
query

string

Cadena que representa un código de país o región ISO 3166-1 Alpha-2. Esto modificará los bordes y etiquetas disputados geopolíticas para alinearse con la región de usuario especificada. De forma predeterminada, el parámetro View se establece en "Auto" incluso si no lo ha definido en la solicitud.

Consulte vistas admitidas para obtener más información y ver las vistas disponibles.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-id

string

Especifica qué cuenta está destinada a usarse junto con el modelo de seguridad de Azure AD. Representa un ID único para la cuenta de Azure Maps y puede recuperarse desde la API de cuentas de Azure Maps Management Plane. Para más información sobre el uso de la seguridad Microsoft Entra ID en Azure Maps, consulte Gestionar la autenticación en Azure Maps.

Accept-Language

string

Idioma en el que se deben devolver los resultados de la búsqueda.

Consulte idiomas admitidos para obtener más información.

Respuestas

Nombre Tipo Description
200 OK

AutocompleteResponse

La solicitud se ha realizado correctamente.

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

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Una respuesta de error inesperada.

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

Encabezados

x-ms-error-code: string

Seguridad

AadToken

Estos son los flujos Microsoft Entra OAuth 2.0. Cuando se combina con el control de acceso basado en roles Azure puede usarse para controlar el acceso a Azure Maps APIs REST. Los controles de acceso basados en roles de Azure se utilizan para designar el acceso a una o más cuentas o subrecursos de recursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o de un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Note

  • Esta definición de seguridad requiere el uso del encabezado x-ms-client-id para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.
  • El Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen URLs de Autorización y configuraciones de Microsoft Entra ID únicas.
  • El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
  • El uso de SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
  • Para obtener más información sobre la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
https://atlas.microsoft.com/.default

subscription-key

Se trata de una clave compartida que se aprovisiona al Creación de una cuenta de Azure Maps en Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

Para las aplicaciones expuestas públicamente, nuestra recomendación es usar las aplicaciones cliente confidenciales enfoque acceder a las API REST de Azure Maps para que la clave se pueda almacenar de forma segura.

Tipo: apiKey
En: header

SAS Token

Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

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'

Solicitud de ejemplo

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

Respuesta de muestra

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

Solicitud de ejemplo

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

Respuesta de muestra

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

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

Solicitud de ejemplo

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

Respuesta de muestra

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

Solicitud de ejemplo

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

Respuesta de muestra

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

Solicitud de ejemplo

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

Respuesta de muestra

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

Solicitud de ejemplo

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

Respuesta de muestra

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

Solicitud de ejemplo

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

Respuesta de muestra

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"
        }
      }
    }
  ]
}

Definiciones

Nombre Description
Address

La dirección de una ubicación sugerida por geocodificación o autocompletado, analizada en campos estructurados. La escasez es normal: solo se llenan los campos que suministra la entidad resuelta. Por ejemplo, streetName y streetNumber aparecen solo para direcciones a nivel de calle, y intersection aparecen solo para resultados de intersecciones de carretera.

AddressAdminDistrictsItem

Una subdivisión administrativa que contiene una dirección. Por ejemplo, un estado, provincia o condado. Se devuelve como una entrada en el array principal Address.adminDistricts , donde las entradas se ordenan de más grueso a fino.

AddressCountryRegion

El país o región que contiene la dirección, identificado por su nombre de visualización y el código de país ISO 3166-1 Alpha-2. Cualquiera de los dos campos puede omitirse en una respuesta dada.

AutocompleteFeature

Una sola entrada en el features array de un AutocompleteResponse, que se ajusta a la forma del GeoJSON Feature objeto. Representa una sugerencia de autocompletado: clasificación (type, typeGroup), dirección analizada y nombre de lugar opcional se exponen mediante properties, con una coordenada representativa en geometry cuándo hay uno disponible.

AutocompleteProperties

La properties carga útil de un AutocompleteFeature. Lleva la clasificación del resultado (typeGroup, type), su dirección analizada y (para muchos Placeresultados con tipo -) un nombre de visualización separado.

AutocompleteResponse

El cuerpo de respuesta exitosa devuelto por Get Autocomplete. Codificado como un GeoJSON FeatureCollection cuyo features array contiene uno Feature por sugerencia de autocompletado, clasificado de más a menos probable.

AutocompleteResultTypeEnum

Una clasificación de sugerencias de autocompletado usadas tanto Get Autocomplete como filtro de entrada (a través del resultTypes parámetro de consulta) como etiqueta de salida (a través del type campo en cada AutocompleteProperties). Los miembros definen una taxonomía tipo gazetteer que abarca direcciones, segmentos de carretera, regiones administrativas, lugares poblados, características naturales y puntos de interés. Esta taxonomía se divide en dos grupos más amplios por AutocompleteResultTypeGroupsEnum: Address, que cubre direcciones y segmentos de carretera; y Place, que cubre todos los demás tipos de resultados.

AutocompleteResultTypeGroupsEnum

Una clasificación grosera de una sugerencia de autocompletado en uno de dos grupos. Usado tanto Get Autocomplete como filtro de entrada mediante el resultTypeGroups parámetro de consulta (restringiendo qué tipos de sugerencias se devuelven) como clasificador de salida mediante el typeGroup campo de cada AutocompleteProperties uno (identificando a qué grupo pertenece una sugerencia devuelta). El Address grupo abarca direcciones individuales y segmentos de calle; el Place grupo abarca todos los demás tipos de entidades (regiones administrativas, lugares poblados, elementos naturales y puntos de interés).

Azure.Core.Foundations.Error

Objeto de error.

Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

FeatureCollectionEnum

El GeoJSON tipo de objeto utilizado en la raíz de las respuestas exitosas de las operaciones de geocodificación directa, geocodificación inversa y autocompletado (incluyendo sus variantes por lotes). El único valor es FeatureCollection, según se define en el RFC 7946. Get Polygon es la única excepción: su raíz de respuesta es un GeoJSON Feature, véase FeatureTypeEnum.

FeatureTypeEnum

El GeoJSON tipo de objeto para Feature los objetos. Etiqueta cada entrada dentro del features array de una FeatureCollection respuesta (geocodificación, geocodificación inversa, autocompletado) y aparece en la raíz de la Get Polygon respuesta. El único valor es Feature, según se define en el RFC 7946.

GeoJsonObjectType

Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonPoint

Un tipo de geometría GeoJSON Point válido. Consulte RFC 7946 para obtener más información.

Intersection

Los detalles de la intersección de una dirección se resolvían como una intersección de carretera — la esquina donde se encuentran dos o más calles con nombre. Se puede repoblar solo cuando la entidad resuelta es un RoadIntersection; el padre Address.intersection se omite de otro modo.

Address

La dirección de una ubicación sugerida por geocodificación o autocompletado, analizada en campos estructurados. La escasez es normal: solo se llenan los campos que suministra la entidad resuelta. Por ejemplo, streetName y streetNumber aparecen solo para direcciones a nivel de calle, y intersection aparecen solo para resultados de intersecciones de carretera.

Nombre Tipo Description
addressLine

string

La primera línea de la dirección, normalmente el nombre y número de la calle. Por ejemplo: "15127 NE 24th St".

adminDistricts

AddressAdminDistrictsItem[]

Las subdivisiones administrativas que contienen la dirección, ordenadas de lo más grueso a lo más fino. La primera entrada suele ser la subdivisión de primer orden (como un estado de EE. UU. o una provincia canadiense); Las entradas posteriores cubren divisiones más detalladas donde el país, dependencia o región las define (como un condado en el índice 1).

countryRegion

AddressCountryRegion

El país o región que contiene la dirección, con su nombre de visualización y el código de país ISO 3166-1 Alpha-2.

formattedAddress

string

La dirección completa se representa como una única cadena legible por humanos, con los componentes unidos según las convenciones del país o región de la dirección. Ejemplo: "15127 NE 24th St, Redmond, WA 98052".

intersection

Intersection

Los detalles de las calles que se cruzan para la dirección, se llenan cuando la entidad resuelta es una RoadIntersection (como la esquina de dos calles nombradas).

locality

string

La localidad en la que se encuentra la dirección: normalmente una ciudad, pueblo o aldea. Por ejemplo: "Redmond".

neighborhood

string

El barrio nombrado dentro de la localidad, cuando se identifica uno.

postalCode

string

El código postal de la dirección, cuando se define uno. Ejemplo: "98052".

streetName

string

El componente de nombre de calle de la dirección, cuando la entidad resuelta es una dirección a nivel de calle. Ejemplo: "NE 24th St".

streetNumber

string

El número de casa o edificio en la calle, cuando la entidad resuelta es una dirección a nivel de calle. Ejemplo: "15127".

AddressAdminDistrictsItem

Una subdivisión administrativa que contiene una dirección. Por ejemplo, un estado, provincia o condado. Se devuelve como una entrada en el array principal Address.adminDistricts , donde las entradas se ordenan de más grueso a fino.

Nombre Tipo Description
name

string

El nombre completo de la urbanización. Por ejemplo, "Washington" para un estado de EE. UU. o "King County" para un condado.

shortName

string

La forma corta o abreviada del nombre de la subdivisión, cuando se define uno. Por ejemplo, "WA" para un estado de EE. UU. Las subdivisiones más finas a menudo no tienen una forma corta distinta, en cuyo caso shortName se repiten name (como "King County").

AddressCountryRegion

El país o región que contiene la dirección, identificado por su nombre de visualización y el código de país ISO 3166-1 Alpha-2. Cualquiera de los dos campos puede omitirse en una respuesta dada.

Nombre Tipo Description
ISO

string

El código de país ISO 3166-1 Alpha-2 para el país o región. Por ejemplo, "US" para Estados Unidos o "GB" para el Reino Unido.

name

string

El nombre de muestra del país o región. Por ejemplo: "Estados Unidos".

AutocompleteFeature

Una sola entrada en el features array de un AutocompleteResponse, que se ajusta a la forma del GeoJSON Feature objeto. Representa una sugerencia de autocompletado: clasificación (type, typeGroup), dirección analizada y nombre de lugar opcional se exponen mediante properties, con una coordenada representativa en geometry cuándo hay uno disponible.

Nombre Tipo Description
geometry

GeoJsonPoint

La coordenada de la sugerencia de autocompletado es un GeoJSON Point, con valores en orden de longitud/latitud WGS 84. Puede omitirse cuando la sugerencia no se resuelve a una única coordenada representativa, por ejemplo, sugerencias regionales amplias o de topónimos.

properties

AutocompleteProperties

Datos estructurados sobre la sugerencia de autocompletado, incluyendo su clasificación, dirección analizada y (para Placesugerencias -tipadas) el nombre del lugar. Consulta AutocompleteProperties la forma por propiedad.

type

FeatureTypeEnum

El tipo de GeoJSON objeto. Siempre Feature, según se define en la RFC 7946.

AutocompleteProperties

La properties carga útil de un AutocompleteFeature. Lleva la clasificación del resultado (typeGroup, type), su dirección analizada y (para muchos Placeresultados con tipo -) un nombre de visualización separado.

Nombre Tipo Description
address

Address

La dirección del resultado de autocompletado, analizada en campos estructurados. Address-los resultados tipados suelen incluir detalles a nivel de calle; Place-los resultados tipados incluyen localidad, distritos administrativos y país/región (los campos a nivel de calle suelen omitirse).

name

string

El nombre de muestra del lugar sugerido. Se rellena para Placeresultados con -tipo cuando el nombre no está ya representado en la estructura address (por ejemplo, parques, puntos de referencia u otras características nombradas). Se omite para Addressresultados con -tipados y para Placepara resultados -tipados cuyo nombre ya está incluido en address (como un lugar poblado cuyo nombre aparece en address.locality).

type

AutocompleteResultTypeEnum

El tipo específico de entidad al que se resuelve el resultado. Por ejemplo, una dirección, un lugar poblado, un parque o un monumento. Véase AutocompleteResultTypeEnum para la lista completa de valores, particionada en y AddressPlace agrupa por AutocompleteResultTypeGroupsEnum.

typeGroup

AutocompleteResultTypeGroupsEnum

La clasificación amplia del resultado como una dirección o un lugar nombrado. Consulta AutocompleteResultTypeGroupsEnum la lista de valores.

AutocompleteResponse

El cuerpo de respuesta exitosa devuelto por Get Autocomplete. Codificado como un GeoJSON FeatureCollection cuyo features array contiene uno Feature por sugerencia de autocompletado, clasificado de más a menos probable.

Nombre Tipo Description
features

AutocompleteFeature[]

El array de GeoJSON Feature objetos devueltos por la consulta. Cada uno Feature representa una única sugerencia de autocompletado: su clasificación (type, typeGroup), dirección analizada y nombre opcional de lugar se exponen mediante properties, y su coordenada principal mediante geometry.

nextLink

string

Contiene la URL para obtener la siguiente página de resultados si la respuesta está paginada. Esto es útil cuando la respuesta es demasiado grande para ser devuelta en una sola llamada, permitiendo a los usuarios navegar por varias páginas de resultados.

type

FeatureCollectionEnum

El GeoJSON tipo de objeto de un cuerpo de respuesta exitoso Get Autocomplete . Siempre FeatureCollection, según se define en la RFC 7946.

AutocompleteResultTypeEnum

Una clasificación de sugerencias de autocompletado usadas tanto Get Autocomplete como filtro de entrada (a través del resultTypes parámetro de consulta) como etiqueta de salida (a través del type campo en cada AutocompleteProperties). Los miembros definen una taxonomía tipo gazetteer que abarca direcciones, segmentos de carretera, regiones administrativas, lugares poblados, características naturales y puntos de interés. Esta taxonomía se divide en dos grupos más amplios por AutocompleteResultTypeGroupsEnum: Address, que cubre direcciones y segmentos de carretera; y Place, que cubre todos los demás tipos de resultados.

Valor Description
Address

Una dirección específica.

AdminDivision1

Primer nivel administrativo dentro del país o región, como un estado o una provincia.

AdminDivision2

Segundo nivel administrativo dentro del país/región, como un condado.

AdminDivision3

Tercer nivel administrativo dentro del país/región, como un distrito, parroquia o municipio.

AdministrativeBuilding

Un edificio que alberga oficinas gubernamentales o funciones administrativas públicas.

Airport

Una instalación donde los aviones despegan y aterrizan regularmente, con instalaciones para pasajeros y carga.

AirportTerminal

Un edificio terminal de pasajeros dentro de un aeropuerto.

AmusementPark

Una instalación de entretenimiento con atracciones, juegos y atracciones temáticas.

AncientSite

Un lugar donde se conservan restos arqueológicos o artefactos culturales de una civilización antigua.

Aquarium

Una instalación pública donde se exhiben y estudian plantas y animales acuáticos.

Archipelago

Un grupo o cadena de islas.

Basin

Una depresión natural en la superficie terrestre, a menudo rodeada por terreno más elevado.

Battlefield

Un lugar de una batalla terrestre históricamente significativa.

Bay

Un cuerpo de agua parcialmente cerrado por tierra, más pequeño que un golfo y más grande que una cala.

Beach

Una orilla de arena, guijarros u otros sedimentos no consolidados a lo largo de un cuerpo de agua.

Bridge

Una estructura que sostiene una carretera, ferrocarril o camino a través de un obstáculo como un río, un valle u otra carretera.

BusinessStructure

Un edificio utilizado para negocios generales o actividades comerciales que no encaja en una categoría más específica.

Camp

Un lugar con refugios o instalaciones para ocupación temporal, como un campamento o un asentamiento estacional.

Canal

Un cauce artificial utilizado para transporte, riego o drenaje.

Casino

Una instalación utilizada para juegos de azar y juegos de azar.

Castle

Un edificio o complejo históricamente fortificado, típicamente asociado a residencias nobles o reales.

Cave

Una cámara o pasaje natural subterráneo formado en la roca.

Cemetery

Un lugar de enterramiento o cementerio.

Channel

Una vía navegable entre dos cuerpos de tierra o el camino principal de flujo de un cuerpo de agua mayor.

Church

Un edificio utilizado para el culto cristiano público.

Cliff

Una cara alta y empinada de roca o tierra, a menudo con vistas a una costa o un valle.

Coast

Un tramo de tierra nombrado que bordea el mar.

CommunityCenter

Una instalación que acoge actividades comunitarias, reuniones y servicios sociales.

Continent

Una de las principales masas terrestres de la Tierra.

CountryRegion

Un país o región.

Crater

Una depresión circular formada por actividad volcánica o impacto de meteoritos.

CulturalRegion

Una zona caracterizada por características culturales compartidas, como la lengua, la etnia o el patrimonio.

Dam

Una barrera construida a lo largo de un arroyo o río para retener agua.

Delta

Se formó una formación de depósitos aluviales donde un río se encuentra con un cuerpo de agua más grande.

Desert

Una gran región árida con vegetación escasa debido a la escasa precipitación.

DrainageBasin

Una zona de tierra drenada por un sistema fluvial y sus afluentes.

Dune

Un montículo o cresta de arena arrastrada por el viento.

FacilityStructure

Una estructura que alberga una instalación especializada, como una planta de servicios públicos o una instalación de servicios.

FerryTerminal

Una instalación donde pasajeros y vehículos suben y desembarcan de los ferris.

FinancialStructure

Un edificio que alberga un banco, cooperativa de crédito u otra institución de servicios financieros.

FireStation

Un edificio que alberga bomberos, equipos y vehículos de respuesta a emergencias.

Forest

Una gran extensión de terreno dominada por árboles.

Fort

Una estructura militar defensiva o terraplén.

Garden

Un área cultivada para exhibir plantas ornamentales o seleccionadas científicamente.

Geyser

Un manantial termal que periódicamente expulsa chorros de agua y vapor.

Glacier

Una masa persistente de hielo que se mueve lentamente bajo su propio peso.

GolfCourse

Un campo preparado para jugar al golf.

GreaterPopulatedPlace

Un área metropolitana o conurbación que contiene y se extiende más allá de un lugar habitado.

HigherEducationFacility

Un colegio, universidad o institución similar de educación postsecundaria.

HistoricalSite

Un sitio de importancia histórica, a menudo preservado como patrimonio cultural.

Hospital

Un centro médico que ofrece atención hospitalaria y ambulatoria.

HotSpring

Un manantial natural donde emerge en la superficie agua subterránea calentada geotérmicamente.

Ice

Una masa natural o capa superficial de agua congelada que cubre tierra o agua.

IndigenousPeoplesReserve

Un territorio reconocido como la tierra natal de un pueblo o comunidad indígena.

IndustrialStructure

Un edificio o instalación utilizado para la fabricación, producción u otras operaciones industriales.

Island

Una masa de tierra rodeada de agua, más pequeña que un continente.

Isthmus

Una estrecha franja de tierra que conecta dos masas de tierra más grandes y separa dos cuerpos de agua.

Lake

Un cuerpo de agua estancada tierra adentro rodeado de tierra.

LandArea

Una región terrestre con nombre que no encaja en una categoría geográfica más específica.

Landform

Una característica natural de la tierra que no encaja en una categoría más específica, como un Mountain, Valley, o Plateau.

LandmarkBuilding

Un edificio notable de importancia arquitectónica, cultural o histórica que sirve como un punto de referencia reconocible.

Library

Un edificio que alberga una colección de libros y otros medios disponibles para uso público.

Lighthouse

Una estructura costera o portuaria que exhibe una luz de navegación para guiar a los barcos.

Marina

Una instalación portuaria que proporciona amarres y servicios para embarcaciones pequeñas y yates.

Market

Un lugar donde se compran y venden productos, normalmente en tiendas minoristas.

MedicalStructure

Un edificio utilizado para servicios médicos o relacionados con la salud distintos a un Hospital, como una clínica o una consulta médica.

MetroStation

Una estación en un sistema de metro, metro u otro sistema urbano de tren rápido.

MilitaryBase

Una instalación operada por las fuerzas armadas para entrenamiento, suministro u operaciones.

Mission

Un complejo gestionado por un grupo religioso para ofrecer servicios comunitarios y propagar la fe.

Monument

Una estructura conmemorativa o estatua erigida para honrar a una persona, un evento o una idea.

Mosque

Un edificio utilizado para el culto islámico público.

Mountain

Una formación geográfica que se eleva significativamente por encima de su entorno, normalmente con pendientes pronunciadas y una cima definida.

MountainRange

Una serie conectada de montañas que forman una cadena continua.

MultiModalStation

Una estación que sirve a múltiples modos de transporte, como tren, autobús o metro combinados.

Museum

Una instalación donde se conservan y exhiben objetos de interés artístico, científico o histórico.

NauticalStructure

Una estructura relacionada con la actividad marítima o náutica, como un muelle, muelle o boya.

Neighborhood

Un área reconocida localmente dentro de un lugar poblado, a menudo con límites informales o culturalmente definidos.

Oasis

Una zona fértil en un desierto sostenida por una fuente natural de agua.

ObservationPoint

Un mirador o mirador que ofrece vistas panorámicas de la zona circundante.

Ocean

Una de las principales divisiones del océano global de la Tierra.

OfficeBuilding

Un edificio utilizado principalmente como oficinas profesionales o administrativas.

Other

Una sugerencia que no encaja con ningún otro tipo definido.

Park

Un área mantenida para la recreación pública o el disfrute paisajístico.

ParkingStructure

Una estructura de varios niveles dedicada al aparcamiento de vehículos.

Pass

Una ruta navegable a través de o sobre una cadena montañosa o un obstáculo similar.

Peninsula

Una masa de tierra que se proyecta en un cuerpo de agua y casi rodeada por ella.

Plain

Una extensa zona de terreno relativamente llano o suavemente ondulado.

Planet

Un cuerpo celeste orbitando una estrella, típicamente usado para representar la Tierra como raíz de la jerarquía geográfica.

Plateau

Una zona elevada de terreno relativamente llano con pendientes pronunciadas en uno o más lados.

Playground

Una zona recreativa equipada para juegos infantiles.

PlayingField

Un espacio abierto utilizado para practicar deportes organizados.

Pole

Un polo geográfico, como el Polo Norte o el Polo Sur.

PoliticalUnit

Una entidad política autónoma, como un estado o territorio independiente o dependiente.

PopulatedPlace

Un área concentrada de asentamiento humano, como una ciudad, pueblo o aldea.

Port

Una instalación marítima con terminales para cargar y descargar carga o pasajeros por vía de agua.

Postcode1

La categoría de código postal más pequeña, como un código postal.

Promontory

Una formación elevada prominente que se proyecta hacia una llanura o cuerpo de agua.

RaceTrack

Un circuito o pista diseñado para vehículos de carreras, animales o atletas.

RailwayStation

Una instalación donde los pasajeros suben y desembarcan de los trenes.

Reef

Una cresta sumergida o parcialmente sumergida de roca, arena o coral cerca de la superficie del agua.

ReligiousStructure

Un edificio utilizado para el culto o práctica religiosa que no encaja en una categoría más específica, como Church, Mosque, o Temple.

Reserve

Una extensión protegida de tierra reservada para la conservación, la fauna u otro uso restringido.

ResidentialStructure

Un edificio utilizado principalmente para la residencia humana, como un complejo de apartamentos o viviendas.

River

Un curso de agua natural que fluye hacia una elevación más baja, típicamente hacia un mar, un lago u otro río.

RoadBlock

Un segmento de calle sin un número de casa específico, devuelto cuando el servicio de geocodificación no puede localizar un número exacto de casa para la consulta. A pesar de su nombre, este valor no indica un cierre físico de la carretera.

Ruin

Una estructura destruida o en ruinas que ya no cumple su función original.

ScientificResearchBase

Una instalación utilizada como base para la investigación científica, a menudo en entornos remotos o extremos.

Sea

Un gran cuerpo de agua salada parcialmente cerrado por tierra, más pequeño que un océano.

SeaplaneLandingArea

Una zona de agua designada para que los hidroaviones despegen y aterricen.

Shrine

Una estructura o lugar que conmemora a una persona o conmemora un evento o concepto sagrado.

SkiArea

Una zona recreativa desarrollada para el esquí y otros deportes de invierno.

Spring

Una fuente natural por donde el agua subterránea fluye desde la superficie de la tierra.

Stadium

Un gran recinto con asientos escalonados para deportes o eventos para espectadores.

StatisticalDistrict

Una región definida para fines estadísticos o censales, como un área estadística metropolitana o un sector censal.

Temple

Un edificio dedicado al culto religioso.

Theater

Un espacio para presentar obras de teatro, películas u otras actuaciones en directo o grabadas.

TouristRailway

Un ferrocarril panorámico o patrimonial operaba principalmente para el turismo en lugar del transporte regular.

TouristStructure

Un edificio que sirve a turistas, como un centro de visitantes o una oficina de información turística.

Trailhead

El punto de partida de un sendero para senderismo, ciclismo o recreación.

TransportationStructure

Una estructura que soporte infraestructuras de transporte, como una plaza de peaje, una estación de pesaje o un refugio de transporte.

Tunnel

Un pasaje subterráneo o submarino para transporte por carretera, ferrocarril o peatones.

Valley

Una zona baja alargada entre colinas o montañas, que a menudo contiene un curso de agua.

Volcano

Una montaña o colina formada por actividad volcánica, normalmente con un cráter en su cima.

Walkway

Un camino o superficie pavimentada destinada al uso peatonal.

Wall

Una barrera construida que forma un límite vertical continuo, a menudo utilizada para defensa, separación o conmemoración.

Waterfall

Un punto donde un arroyo o río desciende vertical o de forma pronunciada.

WaterFeature

Un cuerpo de agua que no encaja en una categoría más específica, como un Lake, River, o Sea.

Wetland

Una zona de tierra saturada de agua y que sostiene vegetación acuática, como un pantano o un humedal.

Winery

Una instalación donde se produce vino y a menudo se ofrece para catar o vender.

Zoo

Una instalación donde se mantienen animales salvajes para exhibición pública y estudio.

AutocompleteResultTypeGroupsEnum

Una clasificación grosera de una sugerencia de autocompletado en uno de dos grupos. Usado tanto Get Autocomplete como filtro de entrada mediante el resultTypeGroups parámetro de consulta (restringiendo qué tipos de sugerencias se devuelven) como clasificador de salida mediante el typeGroup campo de cada AutocompleteProperties uno (identificando a qué grupo pertenece una sugerencia devuelta). El Address grupo abarca direcciones individuales y segmentos de calle; el Place grupo abarca todos los demás tipos de entidades (regiones administrativas, lugares poblados, elementos naturales y puntos de interés).

Valor Description
Address

Sugerencias que se resuelvan a una dirección específica o a un tramo de carretera.

Place

Sugerencias que se resumen a lugares nombrados, incluyendo regiones administrativas, zonas pobladas, barrios, elementos naturales y puntos de interés. Algunos ejemplos son AdminDivision1, Neighborhoody PopulatedPlace.

Azure.Core.Foundations.Error

Objeto de error.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.

details

Azure.Core.Foundations.Error[]

Matriz de detalles sobre errores específicos que llevaron a este error notificado.

innererror

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica que el objeto actual sobre el error.

message

string

Representación legible del error.

target

string

Destino del error.

Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.

Nombre Tipo Description
error

Azure.Core.Foundations.Error

Objeto de error.

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.

innererror

Azure.Core.Foundations.InnerError

Error interno.

FeatureCollectionEnum

El GeoJSON tipo de objeto utilizado en la raíz de las respuestas exitosas de las operaciones de geocodificación directa, geocodificación inversa y autocompletado (incluyendo sus variantes por lotes). El único valor es FeatureCollection, según se define en el RFC 7946. Get Polygon es la única excepción: su raíz de respuesta es un GeoJSON Feature, véase FeatureTypeEnum.

Valor Description
FeatureCollection

El tipo de GeoJSON FeatureCollection objeto. Aparece como la raíz de todos los cuerpos de respuesta de geocodificación, geocodificación inversa y autocompletado. Get Polygon Usa una Feature raíz en su lugar.

FeatureTypeEnum

El GeoJSON tipo de objeto para Feature los objetos. Etiqueta cada entrada dentro del features array de una FeatureCollection respuesta (geocodificación, geocodificación inversa, autocompletado) y aparece en la raíz de la Get Polygon respuesta. El único valor es Feature, según se define en el RFC 7946.

Valor Description
Feature

El tipo de GeoJSON Feature objeto. Aparece en cada característica dentro de una FeatureCollection respuesta y en la raíz de la respuesta Get Polygon .

GeoJsonObjectType

Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

Valor Description
Point

GeoJSON Point geometría.

MultiPoint

GeoJSON MultiPoint geometría.

LineString

GeoJSON LineString geometría.

MultiLineString

GeoJSON MultiLineString geometría.

Polygon

GeoJSON Polygon geometría.

MultiPolygon

GeoJSON MultiPolygon geometría.

GeometryCollection

GeoJSON GeometryCollection geometría.

Feature

Objeto GeoJSON Feature.

FeatureCollection

Objeto GeoJSON FeatureCollection.

GeoJsonPoint

Un tipo de geometría GeoJSON Point válido. Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
bbox

number[] (double)

Rectángulo de límite. Proyección usada: EPSG:3857. Consulte RFC 7946 para obtener más información.

coordinates

number[] (double)

Un Position es una matriz de números con dos o más elementos. Los dos primeros elementos son longitud y latitud, precisamente en ese orden. altitud/elevación es un tercer elemento opcional. Consulte RFC 7946 para obtener más información.

type string:

Point

Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

Intersection

Los detalles de la intersección de una dirección se resolvían como una intersección de carretera — la esquina donde se encuentran dos o más calles con nombre. Se puede repoblar solo cuando la entidad resuelta es un RoadIntersection; el padre Address.intersection se omite de otro modo.

Nombre Tipo Description
baseStreet

string

La calle principal de la intersección — normalmente la calle a la que se refiere el número de dirección.

displayName

string

Un nombre legible para humanos para la intersección que combina las calles transversales, como "5th Avenue & Main Street".

intersectionType

string

Una etiqueta corta que describe la forma de la intersección. Por ejemplo, distinguir un cruce a nivel de uno a desnivel como un puente o un paso elevado.

secondaryStreet1

string

La primera calle transversal que se encuentra baseStreet en la intersección.

secondaryStreet2

string

La segunda calle transversal en la intersección, cuando hay uno. Poblada solo para intersecciones de tres o más calles.