Compartir a través de

@azure-rest/maps-route package

  • Referencia

Interfaces

BatchRequest

Este tipo representa el cuerpo de la solicitud para el servicio Batch.
BatchRequestItem

Objeto de solicitud de Batch
BatchResultItemOutput

Un elemento devuelto por Batch API. Extienda con la propiedad 'response'.
BatchResultOutput

Este objeto se devuelve de una llamada de servicio de Batch correcta. Extienda con la propiedad "batchItems".
BatchResultSummaryOutput

Resumen de los resultados de la solicitud por lotes
EffectiveSettingOutput

Parámetro o datos efectivos que se usan al llamar a esta ROUTE API.
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).
GeoJsonFeature

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

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

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

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

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

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

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

Datos contenidos en un GeoJson MultiPoint.
GeoJsonMultiPolygon

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

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

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

Datos contenidos en un GeoJson Point.
GeoJsonPolygon

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

Ubicación representada como latitud y longitud.
RequestRouteDirectionsBatch
RequestRouteDirectionsBatchSync
RequestRouteMatrix
RequestRouteMatrixSync
RouteDirectionParameters

Publique los parámetros del cuerpo para las direcciones de ruta.
RouteDirectionsBatchItemOutput

Un elemento devuelto desde la llamada al servicio Route Directions Batch.
RouteDirectionsBatchItemResponseOutput

Resultado de la consulta. RouteDirections si la consulta se completó correctamente, ErrorResponse de lo contrario.
RouteDirectionsBatchResultOutput

Este objeto se devuelve de una llamada de servicio de Route Directions Batch correcta.
RouteDirectionsOutput

Este objeto se devuelve de una llamada a Route Directions correcta.
RouteGetRouteDirections200Response

Se aplica a: consulte precios niveles.

Devuelve una ruta entre un origen y un destino, pasando por puntos de acceso si se especifican. La ruta tendrá en cuenta factores como el tráfico actual y las velocidades típicas de la carretera en el día solicitado de la semana y la hora del día.

La información devuelta incluye la distancia, el tiempo de desplazamiento estimado y una representación de la geometría de ruta. También hay disponible información de enrutamiento adicional, como el orden optimizado del punto de acceso o las instrucciones de turno por turno, en función de las opciones seleccionadas.

El servicio de enrutamiento proporciona un conjunto de parámetros para una descripción detallada del modelo de consumo específico del vehículo. Consulte modelo de consumo para obtener una explicación detallada de los conceptos y parámetros implicados.
RouteGetRouteDirectionsBatch200Response

Se aplica a: consulte precios niveles.

Descargar resultados de lotes asincrónicos

Para descargar los resultados del lote asincrónico, emitirá una solicitud de GET al punto de conexión de descarga por lotes. Esta dirección URL de descarga se puede obtener del encabezado Location de una solicitud por lotes de POST correcta y tiene el siguiente aspecto:

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Esta es la secuencia típica de operaciones para descargar los resultados del lote:

  1. El cliente envía una solicitud de GET mediante la dirección URL de descarga de .

  2. El servidor responderá con uno de los siguientes elementos:

    HTTP 202 Accepted: se aceptó la solicitud por lotes, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

    HTTP 200 OK: solicitud de Batch procesada correctamente. El cuerpo de la respuesta contiene todos los resultados del lote.

Modelo de respuesta por lotes

El contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequestses decir, 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 de batchItems contiene campos statusCode y response. Cada response de batchItems es de uno de los siguientes tipos:

  • RouteDirections: 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.

Esta es una respuesta por lotes de ejemplo con 1 correcto y 1 error resultado:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsBatch202Headers
RouteGetRouteDirectionsBatch202Response

Se aplica a: consulte precios niveles.

Descargar resultados de lotes asincrónicos

Para descargar los resultados del lote asincrónico, emitirá una solicitud de GET al punto de conexión de descarga por lotes. Esta dirección URL de descarga se puede obtener del encabezado Location de una solicitud por lotes de POST correcta y tiene el siguiente aspecto:

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Esta es la secuencia típica de operaciones para descargar los resultados del lote:

  1. El cliente envía una solicitud de GET mediante la dirección URL de descarga de .

  2. El servidor responderá con uno de los siguientes elementos:

    HTTP 202 Accepted: se aceptó la solicitud por lotes, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

    HTTP 200 OK: solicitud de Batch procesada correctamente. El cuerpo de la respuesta contiene todos los resultados del lote.

Modelo de respuesta por lotes

El contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequestses decir, 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 de batchItems contiene campos statusCode y response. Cada response de batchItems es de uno de los siguientes tipos:

  • RouteDirections: 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.

Esta es una respuesta por lotes de ejemplo con 1 correcto y 1 error resultado:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsDefaultResponse

Se aplica a: consulte precios niveles.

Devuelve una ruta entre un origen y un destino, pasando por puntos de acceso si se especifican. La ruta tendrá en cuenta factores como el tráfico actual y las velocidades típicas de la carretera en el día solicitado de la semana y la hora del día.

La información devuelta incluye la distancia, el tiempo de desplazamiento estimado y una representación de la geometría de ruta. También hay disponible información de enrutamiento adicional, como el orden optimizado del punto de acceso o las instrucciones de turno por turno, en función de las opciones seleccionadas.

El servicio de enrutamiento proporciona un conjunto de parámetros para una descripción detallada del modelo de consumo específico del vehículo. Consulte modelo de consumo para obtener una explicación detallada de los conceptos y parámetros implicados.
RouteGetRouteDirectionsQueryParam
RouteGetRouteDirectionsQueryParamProperties
RouteGetRouteDirectionsWithAdditionalParameters200Response

Se aplica a: consulte precios niveles.

Devuelve una ruta entre un origen y un destino, pasando por puntos de acceso si se especifican. La ruta tendrá en cuenta factores como el tráfico actual y las velocidades típicas de la carretera en el día solicitado de la semana y la hora del día.

La información devuelta incluye la distancia, el tiempo de desplazamiento estimado y una representación de la geometría de ruta. También hay disponible información de enrutamiento adicional, como el orden optimizado del punto de acceso o las instrucciones de turno por turno, en función de las opciones seleccionadas.

El servicio de enrutamiento proporciona un conjunto de parámetros para una descripción detallada de un modelo de consumo específico del vehículo. Consulte modelo de consumo para obtener una explicación detallada de los conceptos y parámetros implicados.
RouteGetRouteDirectionsWithAdditionalParametersBodyParam
RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Se aplica a: consulte precios niveles.

Devuelve una ruta entre un origen y un destino, pasando por puntos de acceso si se especifican. La ruta tendrá en cuenta factores como el tráfico actual y las velocidades típicas de la carretera en el día solicitado de la semana y la hora del día.

La información devuelta incluye la distancia, el tiempo de desplazamiento estimado y una representación de la geometría de ruta. También hay disponible información de enrutamiento adicional, como el orden optimizado del punto de acceso o las instrucciones de turno por turno, en función de las opciones seleccionadas.

El servicio de enrutamiento proporciona un conjunto de parámetros para una descripción detallada de un modelo de consumo específico del vehículo. Consulte modelo de consumo para obtener una explicación detallada de los conceptos y parámetros implicados.
RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties
RouteGetRouteMatrix200Response

Se aplica a: consulte precios niveles.

Si la solicitud de ruta de matriz se aceptó correctamente, el encabezado Location de la respuesta contiene la dirección URL para descargar los resultados de la solicitud. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. El cliente emite una solicitud GET en la dirección URL de descarga obtenida en el paso 3 para descargar los resultados

Descargar resultados de sincronización

Cuando se realiza una solicitud POST para Route Matrix Sync API, el servicio devuelve el código de respuesta 200 para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante.

Descargar resultados asincrónicos

Cuando una solicitud emite una respuesta 202 Accepted, la solicitud se procesa mediante nuestra canalización asincrónica. Se le proporcionará una dirección URL para comprobar el progreso de la solicitud asincrónica en el encabezado de ubicación de la respuesta. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de GET.

HTTP 202 Accepted: se aceptó la solicitud de matriz, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

HTTP 200 OK: solicitud de matriz procesada correctamente. El cuerpo de la respuesta contiene todos los resultados.
RouteGetRouteMatrix202Headers
RouteGetRouteMatrix202Response

Se aplica a: consulte precios niveles.

Si la solicitud de ruta de matriz se aceptó correctamente, el encabezado Location de la respuesta contiene la dirección URL para descargar los resultados de la solicitud. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. El cliente emite una solicitud GET en la dirección URL de descarga obtenida en el paso 3 para descargar los resultados

Descargar resultados de sincronización

Cuando se realiza una solicitud POST para Route Matrix Sync API, el servicio devuelve el código de respuesta 200 para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante.

Descargar resultados asincrónicos

Cuando una solicitud emite una respuesta 202 Accepted, la solicitud se procesa mediante nuestra canalización asincrónica. Se le proporcionará una dirección URL para comprobar el progreso de la solicitud asincrónica en el encabezado de ubicación de la respuesta. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de GET.

HTTP 202 Accepted: se aceptó la solicitud de matriz, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

HTTP 200 OK: solicitud de matriz procesada correctamente. El cuerpo de la respuesta contiene todos los resultados.
RouteGetRouteRange200Response

API intervalo de rutas (Isochrone)

Se aplica a: consulte precios niveles.

Este servicio calculará un conjunto de ubicaciones a las que se puede llegar desde el punto de origen en función del presupuesto de combustible, energía, tiempo o distancia especificado. Se devuelve un límite de polígono (o Isochrone) en una orientación en sentido contrario a las agujas del reloj, así como el centro de polígono preciso que era el resultado del punto de origen.

El polígono devuelto se puede usar para su posterior procesamiento, como Buscar dentro de geometry para buscar pois en el Isochrone proporcionado.
RouteGetRouteRangeDefaultResponse

API intervalo de rutas (Isochrone)

Se aplica a: consulte precios niveles.

Este servicio calculará un conjunto de ubicaciones a las que se puede llegar desde el punto de origen en función del presupuesto de combustible, energía, tiempo o distancia especificado. Se devuelve un límite de polígono (o Isochrone) en una orientación en sentido contrario a las agujas del reloj, así como el centro de polígono preciso que era el resultado del punto de origen.

El polígono devuelto se puede usar para su posterior procesamiento, como Buscar dentro de geometry para buscar pois en el Isochrone proporcionado.
RouteGetRouteRangeQueryParam
RouteGetRouteRangeQueryParamProperties
RouteGuidanceOutput

Contiene elementos relacionados con instrucciones. Este campo solo está presente cuando se solicitó la guía y está disponible.
RouteInstructionGroupOutput

Agrupa una secuencia de elementos de instrucción que se relacionan entre sí. El intervalo de secuencia está restringido con firstInstructionIndex y lastInstructionIndex. Cuando se solicitan mensajes de texto legibles para instrucciones (instructionType=text o etiquetados), el elemento instructionGroup tiene un mensaje de resumen devuelto cuando está disponible.
RouteInstructionOutput

Un conjunto de atributos que describen una maniobra, por ejemplo, "Girar a la derecha", "Mantener la izquierda", "Tomar el ferry", "Tomar la autopista", "Llegar".
RouteLegOutput

Descripción de una parte de una ruta, formada por una lista de puntos. Cada punto de acceso adicional proporcionado en la solicitud dará como resultado una etapa adicional en la ruta devuelta.
RouteMatrixOutput

Objeto de resultado de matriz
RouteMatrixQuery

Objeto con una matriz de coordenadas.
RouteMatrixResultOutput

Este objeto se devuelve de una llamada a Route Matrix correcta. Por ejemplo, si se proporcionan 2 orígenes y 3 destinos, habrá 2 matrices con 3 elementos en cada uno. El contenido de cada elemento depende de las opciones proporcionadas en la consulta.
RouteMatrixResultResponseOutput

Objeto response de la celda actual de la matriz de entrada.
RouteMatrixSummaryOutput

Summary (objeto)
RouteOptimizedWaypointOutput

Objeto de punto de forma optimizado.
RouteOutput
RouteRangeOutput

Rango accesible
RouteRangeResultOutput

Este objeto se devuelve de una llamada a Route Reachable Range correcta.
RouteReportOutput

Informa de la configuración efectiva que se usa en la llamada actual.
RouteRequestRouteDirectionsBatch200Response

Route Directions Batch API

Se aplica a: consulte precios niveles.

Route Directions Batch API envía lotes de consultas a Route Directions API con una sola llamada API. Puede llamar a Route Directions Batch API para que se ejecute de forma asincrónica (asincrónica) o sincrónica (sincrónica). La API asincrónica permite al autor de la llamada procesar por lotes hasta 700 consultas y sincronizar la API hasta 100 consultas.

Enviar solicitud por lotes asincrónica

La API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de ruta relativamente complejas.

  • Permite la recuperación de resultados en una llamada independiente (se pueden realizar varias descargas).
  • La API asincrónica está optimizada para la confiabilidad y no se espera que se ejecute en un tiempo de espera.
  • El número de elementos por lotes se limita a 700 para esta API.

Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Las respuestas asincrónicas se almacenan durante 14 días. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración.

Tenga en cuenta que la solicitud por lotes asincrónica es una solicitud de larga duración. Esta es una secuencia típica de operaciones:

  1. El cliente envía una solicitud de POST de Route Directions Batch a Azure Maps

  2. El servidor responderá con uno de los siguientes elementos:

    HTTP 202 Accepted: se ha aceptado la solicitud por lotes.

    HTTP Error: se produjo un error al procesar la solicitud de Batch. Esto podría ser un 400 Bad Request o cualquier otro código de estado de Error.

  3. Si la solicitud por lotes se aceptó correctamente, el encabezado Location de la respuesta contiene la dirección URL para descargar los resultados de la solicitud por lotes. Este URI de estado es similar al siguiente:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0 Nota: Recuerde agregar información de AUTH (clave de suscripción/azure_auth - Consulte Security) al URI de estado de antes de ejecutarlo.
4. El cliente emite una solicitud de GET en la dirección URL de descarga de obtenida en el paso 3 para descargar los resultados del lote.

Cuerpo POST para solicitud por lotes

Para enviar las direcciones de ruta consultas, usará una solicitud de POST donde el cuerpo de la solicitud contendrá la matriz de batchItems en formato json y el encabezado Content-Type se establecerá en application/json. Este es un cuerpo de solicitud de ejemplo que contiene 3 direcciones de ruta consultas:

{
    "batchItems": [
        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

Una direcciones de ruta consulta en un lote es simplemente una dirección URL parcial sin el protocolo, la dirección URL base, la ruta de acceso, la versión de api y la clave de suscripción. Puede aceptar cualquiera de las direcciones de ruta de admitidasparámetros de URI. Los valores de cadena de la direcciones de ruta consulta deben tener un escape correcto (por ejemplo, " el carácter debe ser de escape con \ ) y también debe estar correctamente codificado con dirección URL.

La API asincrónica permite al autor de la llamada procesar por lotes hasta 700 consultas y sincronizar la API hasta 100 consultas de y el lote debe contener al menos 1 consulta de.

Descargar resultados de lotes asincrónicos

Para descargar los resultados del lote asincrónico, emitirá una solicitud de GET al punto de conexión de descarga por lotes. Esta dirección URL de descarga se puede obtener del encabezado Location de una solicitud por lotes de POST correcta y tiene el siguiente aspecto:

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Esta es la secuencia típica de operaciones para descargar los resultados del lote:

  1. El cliente envía una solicitud de GET mediante la dirección URL de descarga de .

  2. El servidor responderá con uno de los siguientes elementos:

    HTTP 202 Accepted: se aceptó la solicitud por lotes, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

    HTTP 200 OK: solicitud de Batch procesada correctamente. El cuerpo de la respuesta contiene todos los resultados del lote.

Modelo de respuesta por lotes

El contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequestses decir, 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 de batchItems contiene campos statusCode y response. Cada response de batchItems es de uno de los siguientes tipos:

  • RouteDirections: 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.

Esta es una respuesta por lotes de ejemplo con 1 correcto y 1 error resultado:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatch202Headers
RouteRequestRouteDirectionsBatch202Response

Route Directions Batch API

Se aplica a: consulte precios niveles.

Route Directions Batch API envía lotes de consultas a Route Directions API con una sola llamada API. Puede llamar a Route Directions Batch API para que se ejecute de forma asincrónica (asincrónica) o sincrónica (sincrónica). La API asincrónica permite al autor de la llamada procesar por lotes hasta 700 consultas y sincronizar la API hasta 100 consultas.

Enviar solicitud por lotes asincrónica

La API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de ruta relativamente complejas.

  • Permite la recuperación de resultados en una llamada independiente (se pueden realizar varias descargas).
  • La API asincrónica está optimizada para la confiabilidad y no se espera que se ejecute en un tiempo de espera.
  • El número de elementos por lotes se limita a 700 para esta API.

Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Las respuestas asincrónicas se almacenan durante 14 días. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración.

Tenga en cuenta que la solicitud por lotes asincrónica es una solicitud de larga duración. Esta es una secuencia típica de operaciones:

  1. El cliente envía una solicitud de POST de Route Directions Batch a Azure Maps

  2. El servidor responderá con uno de los siguientes elementos:

    HTTP 202 Accepted: se ha aceptado la solicitud por lotes.

    HTTP Error: se produjo un error al procesar la solicitud de Batch. Esto podría ser un 400 Bad Request o cualquier otro código de estado de Error.

  3. Si la solicitud por lotes se aceptó correctamente, el encabezado Location de la respuesta contiene la dirección URL para descargar los resultados de la solicitud por lotes. Este URI de estado es similar al siguiente:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0 Nota: Recuerde agregar información de AUTH (clave de suscripción/azure_auth - Consulte Security) al URI de estado de antes de ejecutarlo.
4. El cliente emite una solicitud de GET en la dirección URL de descarga de obtenida en el paso 3 para descargar los resultados del lote.

Cuerpo POST para solicitud por lotes

Para enviar las direcciones de ruta consultas, usará una solicitud de POST donde el cuerpo de la solicitud contendrá la matriz de batchItems en formato json y el encabezado Content-Type se establecerá en application/json. Este es un cuerpo de solicitud de ejemplo que contiene 3 direcciones de ruta consultas:

{
    "batchItems": [
        { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
        { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

Una direcciones de ruta consulta en un lote es simplemente una dirección URL parcial sin el protocolo, la dirección URL base, la ruta de acceso, la versión de api y la clave de suscripción. Puede aceptar cualquiera de las direcciones de ruta de admitidasparámetros de URI. Los valores de cadena de la direcciones de ruta consulta deben tener un escape correcto (por ejemplo, " el carácter debe ser de escape con \ ) y también debe estar correctamente codificado con dirección URL.

La API asincrónica permite al autor de la llamada procesar por lotes hasta 700 consultas y sincronizar la API hasta 100 consultas de y el lote debe contener al menos 1 consulta de.

Descargar resultados de lotes asincrónicos

Para descargar los resultados del lote asincrónico, emitirá una solicitud de GET al punto de conexión de descarga por lotes. Esta dirección URL de descarga se puede obtener del encabezado Location de una solicitud por lotes de POST correcta y tiene el siguiente aspecto:

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Esta es la secuencia típica de operaciones para descargar los resultados del lote:

  1. El cliente envía una solicitud de GET mediante la dirección URL de descarga de .

  2. El servidor responderá con uno de los siguientes elementos:

    HTTP 202 Accepted: se aceptó la solicitud por lotes, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

    HTTP 200 OK: solicitud de Batch procesada correctamente. El cuerpo de la respuesta contiene todos los resultados del lote.

Modelo de respuesta por lotes

El contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequestses decir, 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 de batchItems contiene campos statusCode y response. Cada response de batchItems es de uno de los siguientes tipos:

  • RouteDirections: 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.

Esta es una respuesta por lotes de ejemplo con 1 correcto y 1 error resultado:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchBodyParam
RouteRequestRouteDirectionsBatchMediaTypesParam
RouteRequestRouteDirectionsBatchSync200Response

Route Directions Batch API

Se aplica a: consulte precios niveles.

Route Directions Batch API envía lotes de consultas a Route Directions API con una sola llamada API. Puede llamar a Route Directions Batch API para que se ejecute de forma asincrónica (asincrónica) o sincrónica (sincrónica). La API asincrónica permite al autor de la llamada procesar por lotes hasta 700 consultas y sincronizar la API 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/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Modelo de respuesta por lotes

El contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequestses decir, 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 de batchItems contiene campos statusCode y response. Cada response de batchItems es de uno de los siguientes tipos:

  • RouteDirections: 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.

Esta es una respuesta por lotes de ejemplo con 1 correcto y 1 error resultado:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSync408Response

Route Directions Batch API

Se aplica a: consulte precios niveles.

Route Directions Batch API envía lotes de consultas a Route Directions API con una sola llamada API. Puede llamar a Route Directions Batch API para que se ejecute de forma asincrónica (asincrónica) o sincrónica (sincrónica). La API asincrónica permite al autor de la llamada procesar por lotes hasta 700 consultas y sincronizar la API 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/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Modelo de respuesta por lotes

El contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequestses decir, 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 de batchItems contiene campos statusCode y response. Cada response de batchItems es de uno de los siguientes tipos:

  • RouteDirections: 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.

Esta es una respuesta por lotes de ejemplo con 1 correcto y 1 error resultado:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncBodyParam
RouteRequestRouteDirectionsBatchSyncDefaultResponse

Route Directions Batch API

Se aplica a: consulte precios niveles.

Route Directions Batch API envía lotes de consultas a Route Directions API con una sola llamada API. Puede llamar a Route Directions Batch API para que se ejecute de forma asincrónica (asincrónica) o sincrónica (sincrónica). La API asincrónica permite al autor de la llamada procesar por lotes hasta 700 consultas y sincronizar la API 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/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Modelo de respuesta por lotes

El contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequestses decir, 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 de batchItems contiene campos statusCode y response. Cada response de batchItems es de uno de los siguientes tipos:

  • RouteDirections: 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.

Esta es una respuesta por lotes de ejemplo con 1 correcto y 1 error resultado:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncMediaTypesParam
RouteRequestRouteMatrix200Response

Se aplica a: consulte precios niveles.

El servicio de enrutamiento de matriz permite calcular una matriz de resúmenes de ruta para un conjunto de rutas definidas por ubicaciones de origen y destino mediante una solicitud POST asincrónica (asincrónica) o sincrónica (sincrónica). Para cada origen determinado, el servicio calcula el costo de enrutamiento desde ese origen a cada destino determinado. El conjunto de orígenes y el conjunto de destinos se pueden considerar como los encabezados de columna y fila de una tabla y cada celda de la tabla contiene los costos de enrutamiento desde el origen hasta el destino de esa celda. Por ejemplo, supongamos que una empresa de entrega de comida tiene 20 conductores y necesitan encontrar el conductor más cercano para recoger la entrega del restaurante. Para resolver este caso de uso, pueden llamar a Matrix Route API.

Para cada ruta, se devuelven los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar qué rutas detalladas se van a calcular mediante Route Directions API.

El tamaño máximo de una matriz para una solicitud asincrónica es 700 y para la solicitud de sincronización se 100 (el número de orígenes multiplicado por el número de destinos).

Enviar solicitud de matriz de ruta sincrónica

Si el escenario requiere solicitudes sincrónicas y el tamaño máximo de la matriz es menor o igual que 100, es posible que desee realizar una solicitud sincrónica. El tamaño máximo de una matriz para esta API es 100 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 10x10, 6x8, 9x8 (no es necesario que sea cuadrado).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitud de matriz de ruta asincrónica

La API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de enrutamiento relativamente complejas. Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Si waitForResults parámetro de la solicitud se establece en true, el usuario obtendrá una respuesta de 200 si la solicitud ha finalizado en menos de 120 segundos.

El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, los ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado).

Las respuestas asincrónicas se almacenan durante 14 días. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Esta es una secuencia típica de operaciones asincrónicas:

  1. El cliente envía una solicitud POST de matriz de rutas a Azure Maps

  2. El servidor responderá con uno de los siguientes elementos:

    HTTP 202 Accepted: se ha aceptado la solicitud Route Matrix.

    HTTP Error: se produjo un error al procesar la solicitud route Matrix. Puede ser una solicitud incorrecta 400 o cualquier otro código de estado de error.

  3. Si la solicitud de ruta de matriz se aceptó correctamente, el encabezado Location de la respuesta contiene la dirección URL para descargar los resultados de la solicitud. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. El cliente emite una solicitud GET en la dirección URL de descarga obtenida en el paso 3 para descargar los resultados

Descargar resultados de sincronización

Cuando se realiza una solicitud POST para Route Matrix Sync API, el servicio devuelve el código de respuesta 200 para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante.

Descargar resultados asincrónicos

Cuando una solicitud emite una respuesta 202 Accepted, la solicitud se procesa mediante nuestra canalización asincrónica. Se le proporcionará una dirección URL para comprobar el progreso de la solicitud asincrónica en el encabezado de ubicación de la respuesta. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de GET.

HTTP 202 Accepted: se aceptó la solicitud de matriz, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

HTTP 200 OK: solicitud de matriz procesada correctamente. El cuerpo de la respuesta contiene todos los resultados.
RouteRequestRouteMatrix202Headers
RouteRequestRouteMatrix202Response

Se aplica a: consulte precios niveles.

El servicio de enrutamiento de matriz permite calcular una matriz de resúmenes de ruta para un conjunto de rutas definidas por ubicaciones de origen y destino mediante una solicitud POST asincrónica (asincrónica) o sincrónica (sincrónica). Para cada origen determinado, el servicio calcula el costo de enrutamiento desde ese origen a cada destino determinado. El conjunto de orígenes y el conjunto de destinos se pueden considerar como los encabezados de columna y fila de una tabla y cada celda de la tabla contiene los costos de enrutamiento desde el origen hasta el destino de esa celda. Por ejemplo, supongamos que una empresa de entrega de comida tiene 20 conductores y necesitan encontrar el conductor más cercano para recoger la entrega del restaurante. Para resolver este caso de uso, pueden llamar a Matrix Route API.

Para cada ruta, se devuelven los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar qué rutas detalladas se van a calcular mediante Route Directions API.

El tamaño máximo de una matriz para una solicitud asincrónica es 700 y para la solicitud de sincronización se 100 (el número de orígenes multiplicado por el número de destinos).

Enviar solicitud de matriz de ruta sincrónica

Si el escenario requiere solicitudes sincrónicas y el tamaño máximo de la matriz es menor o igual que 100, es posible que desee realizar una solicitud sincrónica. El tamaño máximo de una matriz para esta API es 100 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 10x10, 6x8, 9x8 (no es necesario que sea cuadrado).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitud de matriz de ruta asincrónica

La API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de enrutamiento relativamente complejas. Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Si waitForResults parámetro de la solicitud se establece en true, el usuario obtendrá una respuesta de 200 si la solicitud ha finalizado en menos de 120 segundos.

El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, los ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado).

Las respuestas asincrónicas se almacenan durante 14 días. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Esta es una secuencia típica de operaciones asincrónicas:

  1. El cliente envía una solicitud POST de matriz de rutas a Azure Maps

  2. El servidor responderá con uno de los siguientes elementos:

    HTTP 202 Accepted: se ha aceptado la solicitud Route Matrix.

    HTTP Error: se produjo un error al procesar la solicitud route Matrix. Puede ser una solicitud incorrecta 400 o cualquier otro código de estado de error.

  3. Si la solicitud de ruta de matriz se aceptó correctamente, el encabezado Location de la respuesta contiene la dirección URL para descargar los resultados de la solicitud. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. El cliente emite una solicitud GET en la dirección URL de descarga obtenida en el paso 3 para descargar los resultados

Descargar resultados de sincronización

Cuando se realiza una solicitud POST para Route Matrix Sync API, el servicio devuelve el código de respuesta 200 para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante.

Descargar resultados asincrónicos

Cuando una solicitud emite una respuesta 202 Accepted, la solicitud se procesa mediante nuestra canalización asincrónica. Se le proporcionará una dirección URL para comprobar el progreso de la solicitud asincrónica en el encabezado de ubicación de la respuesta. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de GET.

HTTP 202 Accepted: se aceptó la solicitud de matriz, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

HTTP 200 OK: solicitud de matriz procesada correctamente. El cuerpo de la respuesta contiene todos los resultados.
RouteRequestRouteMatrixBodyParam
RouteRequestRouteMatrixMediaTypesParam
RouteRequestRouteMatrixQueryParam
RouteRequestRouteMatrixQueryParamProperties
RouteRequestRouteMatrixSync200Response

Se aplica a: consulte precios niveles.

El servicio de enrutamiento de matriz permite calcular una matriz de resúmenes de ruta para un conjunto de rutas definidas por ubicaciones de origen y destino mediante una solicitud POST asincrónica (asincrónica) o sincrónica (sincrónica). Para cada origen determinado, el servicio calcula el costo de enrutamiento desde ese origen a cada destino determinado. El conjunto de orígenes y el conjunto de destinos se pueden considerar como los encabezados de columna y fila de una tabla y cada celda de la tabla contiene los costos de enrutamiento desde el origen hasta el destino de esa celda. Por ejemplo, supongamos que una empresa de entrega de comida tiene 20 conductores y necesitan encontrar el conductor más cercano para recoger la entrega del restaurante. Para resolver este caso de uso, pueden llamar a Matrix Route API.

Para cada ruta, se devuelven los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar qué rutas detalladas se van a calcular mediante Route Directions API.

El tamaño máximo de una matriz para una solicitud asincrónica es 700 y para la solicitud de sincronización se 100 (el número de orígenes multiplicado por el número de destinos).

Enviar solicitud de matriz de ruta sincrónica

Si el escenario requiere solicitudes sincrónicas y el tamaño máximo de la matriz es menor o igual que 100, es posible que desee realizar una solicitud sincrónica. El tamaño máximo de una matriz para esta API es 100 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 10x10, 6x8, 9x8 (no es necesario que sea cuadrado).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitud de matriz de ruta asincrónica

La API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de enrutamiento relativamente complejas. Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Si waitForResults parámetro de la solicitud se establece en true, el usuario obtendrá una respuesta de 200 si la solicitud ha finalizado en menos de 120 segundos.

El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, los ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado).

Las respuestas asincrónicas se almacenan durante 14 días. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Esta es una secuencia típica de operaciones asincrónicas:

  1. El cliente envía una solicitud POST de matriz de rutas a Azure Maps

  2. El servidor responderá con uno de los siguientes elementos:

    HTTP 202 Accepted: se ha aceptado la solicitud Route Matrix.

    HTTP Error: se produjo un error al procesar la solicitud route Matrix. Puede ser una solicitud incorrecta 400 o cualquier otro código de estado de error.

  3. Si la solicitud de ruta de matriz se aceptó correctamente, el encabezado Location de la respuesta contiene la dirección URL para descargar los resultados de la solicitud. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. El cliente emite una solicitud GET en la dirección URL de descarga obtenida en el paso 3 para descargar los resultados

Descargar resultados de sincronización

Cuando se realiza una solicitud POST para Route Matrix Sync API, el servicio devuelve el código de respuesta 200 para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante.

Descargar resultados asincrónicos

Cuando una solicitud emite una respuesta 202 Accepted, la solicitud se procesa mediante nuestra canalización asincrónica. Se le proporcionará una dirección URL para comprobar el progreso de la solicitud asincrónica en el encabezado de ubicación de la respuesta. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de GET.

HTTP 202 Accepted: se aceptó la solicitud de matriz, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

HTTP 200 OK: solicitud de matriz procesada correctamente. El cuerpo de la respuesta contiene todos los resultados.
RouteRequestRouteMatrixSync408Response

Se aplica a: consulte precios niveles.

El servicio de enrutamiento de matriz permite calcular una matriz de resúmenes de ruta para un conjunto de rutas definidas por ubicaciones de origen y destino mediante una solicitud POST asincrónica (asincrónica) o sincrónica (sincrónica). Para cada origen determinado, el servicio calcula el costo de enrutamiento desde ese origen a cada destino determinado. El conjunto de orígenes y el conjunto de destinos se pueden considerar como los encabezados de columna y fila de una tabla y cada celda de la tabla contiene los costos de enrutamiento desde el origen hasta el destino de esa celda. Por ejemplo, supongamos que una empresa de entrega de comida tiene 20 conductores y necesitan encontrar el conductor más cercano para recoger la entrega del restaurante. Para resolver este caso de uso, pueden llamar a Matrix Route API.

Para cada ruta, se devuelven los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar qué rutas detalladas se van a calcular mediante Route Directions API.

El tamaño máximo de una matriz para una solicitud asincrónica es 700 y para la solicitud de sincronización se 100 (el número de orígenes multiplicado por el número de destinos).

Enviar solicitud de matriz de ruta sincrónica

Si el escenario requiere solicitudes sincrónicas y el tamaño máximo de la matriz es menor o igual que 100, es posible que desee realizar una solicitud sincrónica. El tamaño máximo de una matriz para esta API es 100 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 10x10, 6x8, 9x8 (no es necesario que sea cuadrado).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitud de matriz de ruta asincrónica

La API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de enrutamiento relativamente complejas. Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Si waitForResults parámetro de la solicitud se establece en true, el usuario obtendrá una respuesta de 200 si la solicitud ha finalizado en menos de 120 segundos.

El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, los ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado).

Las respuestas asincrónicas se almacenan durante 14 días. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Esta es una secuencia típica de operaciones asincrónicas:

  1. El cliente envía una solicitud POST de matriz de rutas a Azure Maps

  2. El servidor responderá con uno de los siguientes elementos:

    HTTP 202 Accepted: se ha aceptado la solicitud Route Matrix.

    HTTP Error: se produjo un error al procesar la solicitud route Matrix. Puede ser una solicitud incorrecta 400 o cualquier otro código de estado de error.

  3. Si la solicitud de ruta de matriz se aceptó correctamente, el encabezado Location de la respuesta contiene la dirección URL para descargar los resultados de la solicitud. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. El cliente emite una solicitud GET en la dirección URL de descarga obtenida en el paso 3 para descargar los resultados

Descargar resultados de sincronización

Cuando se realiza una solicitud POST para Route Matrix Sync API, el servicio devuelve el código de respuesta 200 para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante.

Descargar resultados asincrónicos

Cuando una solicitud emite una respuesta 202 Accepted, la solicitud se procesa mediante nuestra canalización asincrónica. Se le proporcionará una dirección URL para comprobar el progreso de la solicitud asincrónica en el encabezado de ubicación de la respuesta. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de GET.

HTTP 202 Accepted: se aceptó la solicitud de matriz, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

HTTP 200 OK: solicitud de matriz procesada correctamente. El cuerpo de la respuesta contiene todos los resultados.
RouteRequestRouteMatrixSyncBodyParam
RouteRequestRouteMatrixSyncDefaultResponse

Se aplica a: consulte precios niveles.

El servicio de enrutamiento de matriz permite calcular una matriz de resúmenes de ruta para un conjunto de rutas definidas por ubicaciones de origen y destino mediante una solicitud POST asincrónica (asincrónica) o sincrónica (sincrónica). Para cada origen determinado, el servicio calcula el costo de enrutamiento desde ese origen a cada destino determinado. El conjunto de orígenes y el conjunto de destinos se pueden considerar como los encabezados de columna y fila de una tabla y cada celda de la tabla contiene los costos de enrutamiento desde el origen hasta el destino de esa celda. Por ejemplo, supongamos que una empresa de entrega de comida tiene 20 conductores y necesitan encontrar el conductor más cercano para recoger la entrega del restaurante. Para resolver este caso de uso, pueden llamar a Matrix Route API.

Para cada ruta, se devuelven los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar qué rutas detalladas se van a calcular mediante Route Directions API.

El tamaño máximo de una matriz para una solicitud asincrónica es 700 y para la solicitud de sincronización se 100 (el número de orígenes multiplicado por el número de destinos).

Enviar solicitud de matriz de ruta sincrónica

Si el escenario requiere solicitudes sincrónicas y el tamaño máximo de la matriz es menor o igual que 100, es posible que desee realizar una solicitud sincrónica. El tamaño máximo de una matriz para esta API es 100 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 10x10, 6x8, 9x8 (no es necesario que sea cuadrado).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitud de matriz de ruta asincrónica

La API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de enrutamiento relativamente complejas. Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Si waitForResults parámetro de la solicitud se establece en true, el usuario obtendrá una respuesta de 200 si la solicitud ha finalizado en menos de 120 segundos.

El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, los ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado).

Las respuestas asincrónicas se almacenan durante 14 días. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Esta es una secuencia típica de operaciones asincrónicas:

  1. El cliente envía una solicitud POST de matriz de rutas a Azure Maps

  2. El servidor responderá con uno de los siguientes elementos:

    HTTP 202 Accepted: se ha aceptado la solicitud Route Matrix.

    HTTP Error: se produjo un error al procesar la solicitud route Matrix. Puede ser una solicitud incorrecta 400 o cualquier otro código de estado de error.

  3. Si la solicitud de ruta de matriz se aceptó correctamente, el encabezado Location de la respuesta contiene la dirección URL para descargar los resultados de la solicitud. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. El cliente emite una solicitud GET en la dirección URL de descarga obtenida en el paso 3 para descargar los resultados

Descargar resultados de sincronización

Cuando se realiza una solicitud POST para Route Matrix Sync API, el servicio devuelve el código de respuesta 200 para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante.

Descargar resultados asincrónicos

Cuando una solicitud emite una respuesta 202 Accepted, la solicitud se procesa mediante nuestra canalización asincrónica. Se le proporcionará una dirección URL para comprobar el progreso de la solicitud asincrónica en el encabezado de ubicación de la respuesta. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de GET.

HTTP 202 Accepted: se aceptó la solicitud de matriz, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

HTTP 200 OK: solicitud de matriz procesada correctamente. El cuerpo de la respuesta contiene todos los resultados.
RouteRequestRouteMatrixSyncMediaTypesParam
RouteRequestRouteMatrixSyncQueryParam
RouteRequestRouteMatrixSyncQueryParamProperties
RouteSectionOutput

Las secciones de ruta contienen información adicional sobre las partes de una ruta. Cada sección contiene al menos los elementos startPointIndex, endPointIndexy sectionType.
RouteSectionTecCauseOutput

Causa del evento de tráfico. Puede contener elementos mainCauseCode y subCauseCode. Se puede usar para definir la iconografía y las descripciones.
RouteSectionTecOutput

Detalles del evento de tráfico, usando definiciones en el estándar TPEG2-TEC de . Puede contener effectCode y provoca elementos.
RouteSummaryOutput

Summary (objeto)
Routes

Alias de tipos

GeoJsonGeometry

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

Objeto GeoJSON válido. Consulte RFC 7946 para obtener más información.
MapsRouteClient
RouteGetRouteDirectionsBatchParameters
RouteGetRouteDirectionsParameters
RouteGetRouteDirectionsWithAdditionalParametersParameters
RouteGetRouteMatrixParameters
RouteGetRouteRangeParameters
RouteRequestRouteDirectionsBatchParameters
RouteRequestRouteDirectionsBatchSyncParameters
RouteRequestRouteMatrixParameters
RouteRequestRouteMatrixSyncParameters

Funciones

createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Cree un cuerpo de solicitud por lotes de un montón de solicitudes de dirección de ruta.
default(AzureKeyCredential, ClientOptions)

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

de ejemplo de 

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

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

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

de ejemplo de 

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

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

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

de ejemplo de 

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);
getLongRunningPoller<TResult>(Client, TResult, LroEngineOptions<TResult, PollOperationState<TResult>>)

Función auxiliar que compila un objeto Poller para ayudar a sondear una operación de larga duración.
isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
toColonDelimitedLatLonString(LatLon[])

Transforme una matriz de [Latitude, Longtitute] en una cadena con el siguiente formato: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

Detalles de la función

createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Cree un cuerpo de solicitud por lotes de un montón de solicitudes de dirección de ruta.

function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest

Parámetros

queryParamProperties

RouteGetRouteDirectionsQueryParamProperties[]

Objeto de los parámetros de consulta para una solicitud de dirección de ruta

Devoluciones

BatchRequest

Solicitud por lotes compuesta.

default(AzureKeyCredential, ClientOptions)

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

de ejemplo de 

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

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

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

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 ruta

Devoluciones

MapsRouteClient

default(TokenCredential, string, ClientOptions)

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

de ejemplo de 

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

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

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

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 ruta

Devoluciones

MapsRouteClient

default(AzureSASCredential, ClientOptions)

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

de ejemplo de 

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

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

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

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 ruta

Devoluciones

MapsRouteClient

getLongRunningPoller<TResult>(Client, TResult, LroEngineOptions<TResult, PollOperationState<TResult>>)

Función auxiliar que compila un objeto Poller para ayudar a sondear una operación de larga duración.

function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: LroEngineOptions<TResult, PollOperationState<TResult>>): PollerLike<PollOperationState<TResult>, TResult>

Parámetros

client
Client

Cliente que se va a usar para enviar la solicitud para obtener páginas adicionales.

initialResponse

TResult

Respuesta inicial.

options

@azure/core-lro.LroEngineOptions<TResult, @azure/core-lro.PollOperationState<TResult>>

Opciones para establecer un estado de reanudación o un intervalo de sondeo personalizado.

Devoluciones

PollerLike<@azure/core-lro.PollOperationState<TResult>, TResult>

  • Objeto de sondeo para sondear las actualizaciones de estado de la operación y, finalmente, obtener la respuesta final.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse) 

function isUnexpected(response: RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse): response

Parámetros

response

RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse

Devoluciones

response

isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response

Parámetros

response

RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse

Devoluciones

response

isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response

Parámetros

response

RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Devoluciones

response

isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse) 

function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response

Parámetros

response

RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse

Devoluciones

response

isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse) 

function isUnexpected(response: RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse): response

Parámetros

response

RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse

Devoluciones

response

toColonDelimitedLatLonString(LatLon[])

Transforme una matriz de [Latitude, Longtitute] en una cadena con el siguiente formato: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

function toColonDelimitedLatLonString(coordinates: LatLon[]): string

Parámetros

coordinates

LatLon[]

Matriz de par Latitud/Longtitute que se va a transformar.

Devoluciones

string

Cadena transformada.