@azure-rest/maps-search package

Dirección del resultado

GeoJSON GeocodingFeature objeto que describe los límites de un área geográfica. La geometría de la característica se describe con GeoJSON GeometryCollection.

Tenga en cuenta que el servicio normalmente devuelve una clase GeometryCollection con subtipos Polygon o MultiPolygon.

Propiedades de un objeto Boundary.

Información adicional sobre el error de administración de recursos.

Detalle del error.

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Tipo de objeto GeoJSON FeatureCollection válido. Consulte RFC 7946 para obtener más información.

Tipo de objeto GeoJSON Feature válido. Consulte RFC 7946 para obtener más información.

Tipo de objeto GeoJSON GeometryCollection válido. Consulte RFC 7946 para obtener más información.

Un objeto geometry válido GeoJSON. El tipo debe ser uno de los siete tipos de geometría GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon y GeometryCollection. Consulte RFC 7946 para obtener más información.

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

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

Datos contenidos en un GeoJson MultiPoint.

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

Tipo de objeto GeoJSON MultiPolygon válido. Consulte RFC 7946 para obtener más información.

Objeto GeoJSON válido. Consulte RFC 7946 para obtener más información.

Datos contenidos en un GeoJson Point.

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

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

Lista de consultas o solicitudes de geocodificación de direcciones que se van a procesar. La lista puede contener un máximo de 100 consultas y debe contener al menos 1 consulta.

Batch Query (objeto)

Este objeto se devuelve de una llamada correcta al servicio Batch de geocodificación.

Resumen de la solicitud por lotes

Este objeto se devuelve de una llamada de geocodificación correcta.

Información de copyright de una geometría de un objeto Boundary.

Dirección del resultado.

Parámetros opcionales para el cliente

Lista de consultas o solicitudes de geocodificación inversa que se van a procesar. La lista puede contener un máximo de 100 consultas y debe contener al menos 1 consulta.

Batch Query (objeto)

La API de Get Geocoding es una solicitud de GET HTTP que devuelve las coordenadas de longitud y latitud de la ubicación en la que se busca.

En muchos casos, el servicio de búsqueda completo podría ser demasiado, por ejemplo, si solo está interesado en la geocodificación tradicional. También se puede acceder a la búsqueda de direcciones exclusivamente. La geocodificación se realiza presionando el punto de conexión de geocodificación con solo la dirección o la dirección parcial en cuestión. El índice de búsqueda de geocodificación se consultará para todo lo que está por encima de los datos del nivel de calle. No se devolverá ningún punto de interés (POIs). Tenga en cuenta que el geocodificador es muy tolerante a errores tipográficos y direcciones incompletas. También controlará todo desde direcciones postales exactas o calles o intersecciones, así como zonas geográficas de nivel superior, como centros de ciudad, condados y estados. La respuesta también devuelve propiedades de dirección detalladas, como la calle, el código postal, el municipio y la información de país o región.

La API de es una solicitud de HTTP que envía lotes de hasta 100 consultas a la API de de geocodificación en una sola solicitud.

Enviar solicitud por lotes sincrónica

Se recomienda la API sincrónica para solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá tan pronto como se calculen los elementos por lotes y no habrá posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes se limita a 100 para esta API.

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

Cuerpo POST para solicitud por lotes

Para enviar las consultas de de geocodificación , usará una solicitud de donde el cuerpo de la solicitud contendrá la matriz de en formato y el encabezado se establecerá en . Este es un cuerpo de solicitud de ejemplo que contiene 2 geocodificación consultas:

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Un objeto geocodificación batchItem puede aceptar cualquiera de los parámetros de geocodificación URI admitidos.

El lote debe contener al menos 1 consulta de.

Modelo de respuesta por lotes

La respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequests es decir, las consultas que se ejecutaron correctamente. La respuesta por lotes también incluye una matriz de batchItems que contiene una respuesta para cada consulta y cada consulta de la solicitud por lotes. El batchItems contendrá los resultados en el mismo orden en que se enviaron las consultas originales en la solicitud por lotes. Cada elemento es de uno de los siguientes tipos:

• GeocodingResponse: si la consulta se completó correctamente.

• Error: si se produjo un error en la consulta. La respuesta contendrá un code y un message en este caso.

La API de es una solicitud de HTTP que envía lotes de hasta 100 consultas a la API de de geocodificación en una sola solicitud.

Enviar solicitud por lotes sincrónica

Se recomienda la API sincrónica para solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá tan pronto como se calculen los elementos por lotes y no habrá posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes se limita a 100 para esta API.

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

Cuerpo POST para solicitud por lotes

Para enviar las consultas de de geocodificación , usará una solicitud de donde el cuerpo de la solicitud contendrá la matriz de en formato y el encabezado se establecerá en . Este es un cuerpo de solicitud de ejemplo que contiene 2 geocodificación consultas:

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Un objeto geocodificación batchItem puede aceptar cualquiera de los parámetros de geocodificación URI admitidos.

El lote debe contener al menos 1 consulta de.

Modelo de respuesta por lotes

La respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequests es decir, las consultas que se ejecutaron correctamente. La respuesta por lotes también incluye una matriz de batchItems que contiene una respuesta para cada consulta y cada consulta de la solicitud por lotes. El batchItems contendrá los resultados en el mismo orden en que se enviaron las consultas originales en la solicitud por lotes. Cada elemento es de uno de los siguientes tipos:

• GeocodingResponse: si la consulta se completó correctamente.

• Error: si se produjo un error en la consulta. La respuesta contendrá un code y un message en este caso.

La API de Get Geocoding es una solicitud de GET HTTP que devuelve las coordenadas de longitud y latitud de la ubicación en la que se busca.

En muchos casos, el servicio de búsqueda completo podría ser demasiado, por ejemplo, si solo está interesado en la geocodificación tradicional. También se puede acceder a la búsqueda de direcciones exclusivamente. La geocodificación se realiza presionando el punto de conexión de geocodificación con solo la dirección o la dirección parcial en cuestión. El índice de búsqueda de geocodificación se consultará para todo lo que está por encima de los datos del nivel de calle. No se devolverá ningún punto de interés (POIs). Tenga en cuenta que el geocodificador es muy tolerante a errores tipográficos y direcciones incompletas. También controlará todo desde direcciones postales exactas o calles o intersecciones, así como zonas geográficas de nivel superior, como centros de ciudad, condados y estados. La respuesta también devuelve propiedades de dirección detalladas, como la calle, el código postal, el municipio y la información de país o región.

La API de Get Polygon es una solicitud http GET que proporciona datos de polígono de un esquema de área geográfica, como una ciudad o una región de país.

La API de Get Polygon es una solicitud http GET que proporciona datos de polígono de un esquema de área geográfica, como una ciudad o una región de país.

La API de Get Reverse Geocoding es una solicitud de GET HTTP que se usa para traducir una coordenada (ejemplo: 37.786505, -122.3862) en una dirección postal comprensible humana. Resulta útil en el seguimiento de aplicaciones en las que recibe una fuente GPS del dispositivo o recurso y desea conocer la dirección asociada a las coordenadas. Este punto de conexión devolverá información de dirección para una coordenada determinada.

La API de Get Reverse Geocoding Batch es una solicitud de POST HTTP que envía lotes de hasta 100 consultas a API de geocodificación inversa mediante una sola solicitud.

Enviar solicitud por lotes sincrónica

Se recomienda la API sincrónica para solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá tan pronto como se calculen los elementos por lotes y no habrá posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes se limita a 100 para esta API.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

Cuerpo POST para solicitud por lotes

Para enviar las consultas de de geocodificación inversa , usará una solicitud de donde el cuerpo de la solicitud contendrá la matriz de en formato y el encabezado se establecerá en . Este es un cuerpo de solicitud de ejemplo que contiene 2 geocodificación inversa consultas:

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Un objeto geocodificación inversa batchItem puede aceptar cualquiera de los parámetros de geocodificación inversa admitidos URI.

El lote debe contener al menos 1 consulta de.

Modelo de respuesta por lotes

La respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequests es decir, las consultas que se ejecutaron correctamente. La respuesta por lotes también incluye una matriz de batchItems que contiene una respuesta para cada consulta y cada consulta de la solicitud por lotes. El batchItems contendrá los resultados en el mismo orden en que se enviaron las consultas originales en la solicitud por lotes. Cada elemento es de uno de los siguientes tipos:

• GeocodingResponse: si la consulta se completó correctamente.

• Error: si se produjo un error en la consulta. La respuesta contendrá un code y un message en este caso.

La API de Get Reverse Geocoding Batch es una solicitud de POST HTTP que envía lotes de hasta 100 consultas a API de geocodificación inversa mediante una sola solicitud.

Enviar solicitud por lotes sincrónica

Se recomienda la API sincrónica para solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá tan pronto como se calculen los elementos por lotes y no habrá posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes se limita a 100 para esta API.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

Cuerpo POST para solicitud por lotes

Para enviar las consultas de de geocodificación inversa , usará una solicitud de donde el cuerpo de la solicitud contendrá la matriz de en formato y el encabezado se establecerá en . Este es un cuerpo de solicitud de ejemplo que contiene 2 geocodificación inversa consultas:

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Un objeto geocodificación inversa batchItem puede aceptar cualquiera de los parámetros de geocodificación inversa admitidos URI.

El lote debe contener al menos 1 consulta de.

Modelo de respuesta por lotes

La respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequests es decir, las consultas que se ejecutaron correctamente. La respuesta por lotes también incluye una matriz de batchItems que contiene una respuesta para cada consulta y cada consulta de la solicitud por lotes. El batchItems contendrá los resultados en el mismo orden en que se enviaron las consultas originales en la solicitud por lotes. Cada elemento es de uno de los siguientes tipos:

• GeocodingResponse: si la consulta se completó correctamente.

• Error: si se produjo un error en la consulta. La respuesta contendrá un code y un message en este caso.

La API de Get Reverse Geocoding es una solicitud de GET HTTP que se usa para traducir una coordenada (ejemplo: 37.786505, -122.3862) en una dirección postal comprensible humana. Resulta útil en el seguimiento de aplicaciones en las que recibe una fuente GPS del dispositivo o recurso y desea conocer la dirección asociada a las coordenadas. Este punto de conexión devolverá información de dirección para una coordenada determinada.

Tipo de objeto GeoJSON Feature válido. Consulte RFC 7946 para obtener más información.

Un objeto geometry válido GeoJSON. El tipo debe ser uno de los siete tipos de geometría GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon y GeometryCollection. Consulte RFC 7946 para obtener más información.

Objeto GeoJSON válido. Consulte RFC 7946 para obtener más información.

Crea una instancia de MapsSearchClient a partir de una clave de suscripción.

Ejemplo

import MapsSearch from "@azure-rest/maps-search";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsSearch(credential);

Crea una instancia de MapsSearch a partir de una instancia de Azure Identity TokenCredential.

Ejemplo

import MapsSearch from "@azure-rest/maps-search";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsSearch(credential, "<maps-account-client-id>");

Crea una instancia de MapsSearch a partir de una instancia de Azure Identity AzureSASCredential.

Ejemplo

import MapsSearch from "@azure-rest/maps-search";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsSearch(credential);