MapsRoutingClient Class

Definition

Namespace:

Azure.Maps.Routing

Assembly:

Azure.Maps.Routing.dll

Package:

Azure.Maps.Routing v1.0.0-beta.2

Source:

MapsRoutingClient.cs

The Route service client.

public class MapsRoutingClient

type MapsRoutingClient = class

Public Class MapsRoutingClient

Inheritance

Object

MapsRoutingClient

Constructors

MapsRoutingClient()	Initializes a new instance of MapsRoutingClient.
MapsRoutingClient(AzureKeyCredential)	Initializes a new instance of MapsRoutingClient.
MapsRoutingClient(AzureKeyCredential, MapsRoutingClientOptions)	Initializes a new instance of MapsRoutingClient.
MapsRoutingClient(AzureSasCredential)	Initializes a new instance of MapsRoutingClient.
MapsRoutingClient(AzureSasCredential, MapsRoutingClientOptions)	Initializes a new instance of MapsRoutingClient.
MapsRoutingClient(TokenCredential, String)	Initializes a new instance of MapsRoutingClient.
MapsRoutingClient(TokenCredential, String, MapsRoutingClientOptions)	Initializes a new instance of MapsRoutingClient.

Methods

GetDirections(RouteDirectionQuery, CancellationToken)	Returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day. Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected. Routing service provides a set of parameters for a detailed description of vehicle-specific Consumption Model. Please check Consumption Model for detailed explanation of the concepts and parameters involved.
GetDirectionsAsync(RouteDirectionQuery, CancellationToken)	Returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day. Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected. Routing service provides a set of parameters for a detailed description of vehicle-specific Consumption Model. Please check Consumption Model for detailed explanation of the concepts and parameters involved.
GetDirectionsBatch(WaitUntil, IEnumerable<RouteDirectionQuery>, CancellationToken)	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.
GetDirectionsBatchAsync(WaitUntil, IEnumerable<RouteDirectionQuery>, CancellationToken)	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.
GetDirectionsImmediateBatch(IEnumerable<RouteDirectionQuery>, CancellationToken)	The Route Directions Batch API sends batches of queries to Route Directions API using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The sync API up to 100 queries.
GetDirectionsImmediateBatchAsync(IEnumerable<RouteDirectionQuery>, CancellationToken)	The Route Directions Batch API sends batches of queries to Route Directions API using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The sync API up to 100 queries.
GetImmediateRouteMatrix(RouteMatrixOptions, CancellationToken)	The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API. For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API. The maximum size of a matrix for sync request is 100 (the number of origins multiplied by the number of destinations).
GetImmediateRouteMatrix(RouteMatrixQuery, CancellationToken)	The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API. For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API. The maximum size of a matrix for sync request is 100 (the number of origins multiplied by the number of destinations).
GetImmediateRouteMatrixAsync(RouteMatrixOptions, CancellationToken)	The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API. For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API. The maximum size of a matrix for sync request is 100 (the number of origins multiplied by the number of destinations).
GetImmediateRouteMatrixAsync(RouteMatrixQuery, CancellationToken)	The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API. For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API. The maximum size of a matrix for sync request is 100 (the number of origins multiplied by the number of destinations).
GetRouteMatrix(WaitUntil, RouteMatrixOptions, CancellationToken)	The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API. The maximum size of a matrix for async request is 700 (the number of origins multiplied by the number of destinations).
GetRouteMatrixAsync(WaitUntil, RouteMatrixOptions, CancellationToken)	The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API. The maximum size of a matrix for async request is 700 (the number of origins multiplied by the number of destinations).
GetRouteRange(RouteRangeOptions, CancellationToken)	This service will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point. The returned polygon can be used for further processing such as Search Inside Geometry to search for POIs within the provided Isochrone.
GetRouteRangeAsync(RouteRangeOptions, CancellationToken)	This service will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point. The returned polygon can be used for further processing such as Search Inside Geometry to search for POIs within the provided Isochrone.