Share via


MapsRoutingClient.GetDirectionsBatchAsync Method

Definition

The Route Directions Batch API sends batches of queries to Route Directions API using just a single API call. TThis Route Directions Batch API will run asynchronously (async) and it allows caller to batch up to 700 queries.

public virtual System.Threading.Tasks.Task<Azure.Maps.Routing.Models.GetDirectionsOperation> GetDirectionsBatchAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.Maps.Routing.RouteDirectionQuery> queries, System.Threading.CancellationToken cancellationToken = default);
abstract member GetDirectionsBatchAsync : Azure.WaitUntil * seq<Azure.Maps.Routing.RouteDirectionQuery> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Maps.Routing.Models.GetDirectionsOperation>
override this.GetDirectionsBatchAsync : Azure.WaitUntil * seq<Azure.Maps.Routing.RouteDirectionQuery> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Maps.Routing.Models.GetDirectionsOperation>
Public Overridable Function GetDirectionsBatchAsync (waitUntil As WaitUntil, queries As IEnumerable(Of RouteDirectionQuery), Optional cancellationToken As CancellationToken = Nothing) As Task(Of GetDirectionsOperation)

Parameters

waitUntil
WaitUntil

If the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

queries
IEnumerable<RouteDirectionQuery>

The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and must contain at least 1 query.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

queries is null.

Applies to