Share via


MapsRoutingClient.GetDirectionsBatch 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 Azure.Maps.Routing.Models.GetDirectionsOperation GetDirectionsBatch (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.Maps.Routing.RouteDirectionQuery> queries, System.Threading.CancellationToken cancellationToken = default);
abstract member GetDirectionsBatch : Azure.WaitUntil * seq<Azure.Maps.Routing.RouteDirectionQuery> * System.Threading.CancellationToken -> Azure.Maps.Routing.Models.GetDirectionsOperation
override this.GetDirectionsBatch : Azure.WaitUntil * seq<Azure.Maps.Routing.RouteDirectionQuery> * System.Threading.CancellationToken -> Azure.Maps.Routing.Models.GetDirectionsOperation
Public Overridable Function GetDirectionsBatch (waitUntil As WaitUntil, queries As IEnumerable(Of RouteDirectionQuery), Optional cancellationToken As CancellationToken = Nothing) As GetDirectionsOperation

Parameters

waitUntil
WaitUntil

Whether to return once method is invoked or wait for the server operation to fully complete before returning. Possible value: WaitUntil.Completed and WaitUntil.Started

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