Compartir a través de

@azure-rest/maps-search package

  • Referencia

Interfaces

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput

Dirección del resultado
BoundaryOutput

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

Propiedades de un objeto Boundary.
ErrorAdditionalInfoOutput

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

Detalle del error.
ErrorResponseOutput

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).
FeaturesItemOutput
FeaturesItemPropertiesOutput
GeoJsonFeatureCollectionDataOutput
GeoJsonFeatureCollectionOutput

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

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

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

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.
GeoJsonLineStringDataOutput
GeoJsonLineStringOutput

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

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

Datos contenidos en un GeoJson MultiPoint.
GeoJsonMultiPointOutput

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

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

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

Datos contenidos en un GeoJson Point.
GeoJsonPointOutput

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

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

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

Batch Query (objeto)
GeocodingBatchResponseItemOutput
GeocodingBatchResponseOutput

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

Resumen de la solicitud por lotes
GeocodingResponseOutput

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

Información de copyright de una geometría de un objeto Boundary.
GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput

Dirección del resultado.
ReverseGeocodingBatchRequestBody

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

Batch Query (objeto)
Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response

de geocodificación

Se aplica a: consulte precios planes.

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, estados, etc.
SearchGetGeocodingBatch200Response

de Batch API de geocodificación

Se aplica a: consulte precios niveles.

La API de Batch de geocodificación envía lotes de consultas a API de geocodificación mediante una sola llamada API. La API permite al autor de la llamada procesar por lotes hasta 100 consultas.

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.
SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse

de Batch API de geocodificación

Se aplica a: consulte precios niveles.

La API de Batch de geocodificación envía lotes de consultas a API de geocodificación mediante una sola llamada API. La API permite al autor de la llamada procesar por lotes hasta 100 consultas.

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.
SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse

de geocodificación

Se aplica a: consulte precios planes.

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, estados, etc.
SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response

Obtener polígono

Se aplica a: consulte precios planes.

Proporciona datos de polígono de un contorno de área geográfica, como una ciudad o una región de país.
SearchGetPolygonDefaultResponse

Obtener polígono

Se aplica a: consulte precios planes.

Proporciona datos de polígono de un contorno de área geográfica, como una ciudad o una región de país.
SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response

de geocodificación inversa

Se aplica a: consulte precios planes.

Traduzca una coordenada (ejemplo: 37.786505, -122.3862) en una dirección postal comprensible humana. La mayoría de las veces esto es necesario en las aplicaciones de seguimiento donde se recibe una fuente GPS del dispositivo o recurso y desea saber qué dirección se encuentra la coordenada. Este punto de conexión devolverá información de dirección para una coordenada determinada.
SearchGetReverseGeocodingBatch200Response

de Batch API de geocodificación inversa

Se aplica a: consulte precios niveles.

La API de Batch de geocodificación inversa envía lotes de consultas a API de geocodificación inversa mediante una sola llamada API. La API permite al autor de la llamada procesar por lotes hasta 100 consultas.

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.
SearchGetReverseGeocodingBatchBodyParam
SearchGetReverseGeocodingBatchDefaultResponse

de Batch API de geocodificación inversa

Se aplica a: consulte precios niveles.

La API de Batch de geocodificación inversa envía lotes de consultas a API de geocodificación inversa mediante una sola llamada API. La API permite al autor de la llamada procesar por lotes hasta 100 consultas.

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.
SearchGetReverseGeocodingBatchMediaTypesParam
SearchGetReverseGeocodingDefaultResponse

de geocodificación inversa

Se aplica a: consulte precios planes.

Traduzca una coordenada (ejemplo: 37.786505, -122.3862) en una dirección postal comprensible humana. La mayoría de las veces esto es necesario en las aplicaciones de seguimiento donde se recibe una fuente GPS del dispositivo o recurso y desea saber qué dirección se encuentra la coordenada. Este punto de conexión devolverá información de dirección para una coordenada determinada.
SearchGetReverseGeocodingQueryParam
SearchGetReverseGeocodingQueryParamProperties

Alias de tipos

GeoJsonFeatureOutput

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

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

Objeto GeoJSON válido. Consulte RFC 7946 para obtener más información.
MapsSearchClient
SearchGetGeocodingBatchParameters
SearchGetGeocodingParameters
SearchGetPolygonParameters
SearchGetReverseGeocodingBatchParameters
SearchGetReverseGeocodingParameters

Funciones

default(AzureKeyCredential, ClientOptions)

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

de ejemplo de 

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

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsSearch(credential);
default(TokenCredential, string, ClientOptions)

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

de ejemplo de 

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

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

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

de ejemplo de 

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

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsSearch(credential);
isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)
isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)
isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)
isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)
isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)

Detalles de la función

default(AzureKeyCredential, ClientOptions)

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

de ejemplo de 

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

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

function default(credential: AzureKeyCredential, options?: ClientOptions): MapsSearchClient

Parámetros

credential
AzureKeyCredential

Una instancia de AzureKeyCredential que se usa para autenticar solicitudes en el servicio

options
ClientOptions

Opciones usadas para configurar el cliente de búsqueda

Devoluciones

MapsSearchClient

default(TokenCredential, string, ClientOptions)

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

de ejemplo de 

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

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

function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsSearchClient

Parámetros

credential
TokenCredential

Una instancia de TokenCredential que se usa para autenticar las solicitudes en el servicio

mapsAccountClientId

string

Identificador de cliente de Azure Maps de un recurso de mapa específico

options
ClientOptions

Opciones usadas para configurar el cliente de búsqueda

Devoluciones

MapsSearchClient

default(AzureSASCredential, ClientOptions)

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

de ejemplo de 

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

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

function default(credential: AzureSASCredential, options?: ClientOptions): MapsSearchClient

Parámetros

credential
AzureSASCredential

Una instancia de AzureSASCredential que se usa para autenticar solicitudes en el servicio

options
ClientOptions

Opciones usadas para configurar el cliente de búsqueda

Devoluciones

MapsSearchClient

isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response

Parámetros

response

SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse

Devoluciones

response

isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response

Parámetros

response

SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse

Devoluciones

response

isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse) 

function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response

Parámetros

response

SearchGetPolygon200Response | SearchGetPolygonDefaultResponse

Devoluciones

response

isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response

Parámetros

response

SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse

Devoluciones

response

isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response

Parámetros

response

SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse

Devoluciones

response