.. role:: raw-html-m2r(raw)
   :format: html


Azure Maps Route Package client library for Python
==================================================

This package contains a Python SDK for Azure Maps Services for Route.
Read more about Azure Maps Services `here <https://docs.microsoft.com/azure/azure-maps/>`_

`Source code <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/maps/azure-maps-route>`_ | `API reference documentation <https://docs.microsoft.com/rest/api/maps/route>`_ | `Product documentation <https://docs.microsoft.com/azure/azure-maps/>`_

*Disclaimer*
----------------

*Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691*

Getting started
---------------

Prerequisites
^^^^^^^^^^^^^


* Python 3.6 or later is required to use this package.
* An `Azure subscription <https://azure.microsoft.com/free/>`_ and an `Azure Maps account <https://docs.microsoft.com/azure/azure-maps/how-to-manage-account-keys>`_.
* A deployed Maps Services resource. You can create the resource via `Azure Portal <https://portal.azure.com>`_ or `Azure CLI <https://docs.microsoft.com/cli/azure>`_.

If you use Azure CLI, replace ``<resource-group-name>`` and ``<account-name>`` of your choice, and select a proper `pricing tier <https://docs.microsoft.com/azure/azure-maps/choose-pricing-tier>`_ based on your needs via the ``<sku-name>`` parameter. Please refer to `this page <https://docs.microsoft.com/cli/azure/maps/account?view=azure-cli-latest#az_maps_account_create>`_ for more details.

.. code-block:: bash

   az maps account create --resource-group <resource-group-name> --account-name <account-name> --sku <sku-name>

Install the package
^^^^^^^^^^^^^^^^^^^

Install the Azure Maps Service Route SDK.

.. code-block:: bash

   pip install azure-maps-route

Create and Authenticate the MapsRouteClient
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To create a client object to access the Azure Maps Route API, you will need a **credential** object. Azure Maps Route client also support two ways to authenticate.

1. Authenticate with a Subscription Key Credential
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can authenticate with your Azure Maps Subscription Key.
Once the Azure Maps Subscription Key is created, set the value of the key as environment variable: ``AZURE_SUBSCRIPTION_KEY``.
Then pass an ``AZURE_SUBSCRIPTION_KEY`` as the ``credential`` parameter into an instance of `AzureKeyCredential <https://aka.ms/azsdk/python/core/azurekeycredential>`_.

.. code-block:: python

   from azure.core.credentials import AzureKeyCredential
   from azure.maps.route import MapsRouteClient

   credential = AzureKeyCredential(os.environ.get("AZURE_SUBSCRIPTION_KEY"))

   route_client = MapsRouteClient(
       credential=credential,
   )

2. Authenticate with an Azure Active Directory credential
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can authenticate with `Azure Active Directory (AAD) token credential <https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication>`_ using the `Azure Identity library <https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/identity/azure-identity>`_.
Authentication by using AAD requires some initial setup:


* Install `azure-identity <https://aka.ms/azsdk/python/core/azurekeycredential>`_
* Register a `new AAD application <https://docs.microsoft.com/powershell/module/Az.Resources/New-AzADApplication?view=azps-8.0.0>`_
* Grant access to Azure Maps by assigning the suitable role to your service principal. Please refer to the `Manage authentication page <https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication>`_.

After setup, you can choose which type of `credential <https://aka.ms/azsdk/python/core/azurekeycredential>`_ from ``azure.identity`` to use.
As an example, `DefaultAzureCredential <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential>`_
can be used to authenticate the client:

Next, set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
``AZURE_CLIENT_ID``\ , ``AZURE_TENANT_ID``\ , ``AZURE_CLIENT_SECRET``

You will also need to specify the Azure Maps resource you intend to use by specifying the ``clientId`` in the client options. The Azure Maps resource client id can be found in the Authentication sections in the Azure Maps resource. Please refer to the `documentation <https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication#view-authentication-details>`_ on how to find it.

.. code-block:: python

   from azure.maps.route import MapsRouteClient
   from azure.identity import DefaultAzureCredential

   credential = DefaultAzureCredential()
   route_client = MapsRouteClient(
       client_id="<Azure Maps Client ID>",
       credential=credential
   )

Key concepts
------------

The Azure Maps Route client library for Python allows you to interact with each of the components through the use of a dedicated client object.

Sync Clients
^^^^^^^^^^^^

``MapsRouteClient`` is the primary client for developers using the Azure Maps Route client library for Python.
Once you initialized a ``MapsRouteClient`` class, you can explore the methods on this client object to understand the different features of the Azure Maps Route service that you can access.

Async Clients
^^^^^^^^^^^^^

This library includes a complete async API supported on Python 3.5+. To use it, you must first install an async transport, such as `aiohttp <https://pypi.org/project/aiohttp/>`_.
See `azure-core documentation <https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport>`_ for more information.

Async clients and credentials should be closed when they're no longer needed. These
objects are async context managers and define async ``close`` methods.

Examples
--------

The following sections provide several code snippets covering some of the most common Azure Maps Route tasks, including:


* `Request and Get Route Directions <#request-and-get-route-directions>`_
* `Request and Get Route Range <#reqest-and-get-route-range>`_
* `Get Route Matrix <#get-route-matrix>`_
* `Get Route Directions Batch <#get-route-directions-batch>`_

Request and Get Route Directions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This service request 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.

.. code-block:: python

   from azure.maps.route import MapsRouteClient

   route_directions_result = client.get_route_directions(route_points=[LatLon(47.60323, -122.33028), LatLon(53.2, -106)]);

Request and Get Route Range
^^^^^^^^^^^^^^^^^^^^^^^^^^^

This service will calculate a set of locations that can be reached from the origin point by given coordinates and based on fuel, energy,  time or distance budget that is specified.

.. code-block:: python

   from azure.maps.route import MapsRouteClient

   route_range_result = client.get_route_range(coordinates=LatLon(47.60323, -122.33028), time_budget_in_sec=6000);

Get Route Matrix
^^^^^^^^^^^^^^^^

If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request.

Retrieves the result of a previous route matrix request.
The method returns a poller for retrieving the result.

.. code-block:: python

   from azure.maps.route import MapsRouteClient

   route_matrix_result = client.begin_get_route_matrix_result(matrix_id="11111111-2222-3333-4444-555555555555");

Get Route Directions Batch
^^^^^^^^^^^^^^^^^^^^^^^^^^

Retrieves the result of a previous route direction batch request.
The method returns a poller for retrieving the result.

.. code-block:: python

   from azure.maps.route import MapsRouteClient

   route_directions_batch_poller_result = client.begin_get_route_directions_batch_result(batch_id="11111111-2222-3333-4444-555555555555");

Troubleshooting
---------------

General
^^^^^^^

Maps Route clients raise exceptions defined in `Azure Core <https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md>`_.

This list can be used for reference to catch thrown exceptions. To get the specific error code of the exception, use the ``error_code`` attribute, i.e, ``exception.error_code``.

Logging
^^^^^^^

This library uses the standard `logging <https://docs.python.org/3/library/logging.html>`_ library for logging.
Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO level.

Detailed DEBUG level logging, including request/response bodies and unredacted headers, can be enabled on a client with the ``logging_enable`` argument:

.. code-block:: python

   import sys
   import logging
   from azure.maps.route import MapsRouteClient

   # Create a logger for the 'azure.maps.route' SDK
   logger = logging.getLogger('azure.maps.route')
   logger.setLevel(logging.DEBUG)

   # Configure a console output
   handler = logging.StreamHandler(stream=sys.stdout)
   logger.addHandler(handler)

Additional
^^^^^^^^^^

Still running into issues? If you encounter any bugs or have suggestions, please file an issue in the `Issues <https://github.com/Azure/azure-sdk-for-python/issues>`_ section of the project.

Next steps
----------

More sample code
^^^^^^^^^^^^^^^^

Get started with our `Maps Route samples <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/maps/azure-maps-route/samples>`_ (\ `Async Version samples <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/maps/azure-maps-route/samples/async_samples>`_\ ).

Several Azure Maps Route Python SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Maps Route

.. code-block:: bash

   set AZURE_SUBSCRIPTION_KEY="<RealSubscriptionKey>"

   pip install azure-maps-route --pre

   python samples/sample_authentication.py
   python sample/sample_get_route_range.py
   python samples/sample_get_route_directions.py
   python samples/sample_request_route_matrix.py
   python samples/async_samples/sample_authentication_async.py
   python samples/async_samples/sample_get_route_range_async.py
   python samples/async_samples/sample_request_route_matrix_async.py
   python samples/async_samples/sample_get_route_directions_async.py

..

   Notes: ``--pre`` flag can be optionally added, it is to include pre-release and development versions for ``pip install``. By default, ``pip`` only finds stable versions.


Further detail please refer to `Samples Introduction <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/maps/azure-maps-route/samples/README.md>`_

Additional documentation
^^^^^^^^^^^^^^^^^^^^^^^^

For more extensive documentation on Azure Maps Route, see the `Azure Maps Route documentation <https://docs.microsoft.com/rest/api/maps/route>`_ on docs.microsoft.com.

Contributing
------------

This project welcomes contributions and suggestions.  Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the `Microsoft Open Source Code of Conduct <https://opensource.microsoft.com/codeofconduct/>`_. For more information see the `Code of Conduct FAQ <https://opensource.microsoft.com/codeofconduct/faq/>`_ or contact `opencode@microsoft.com <mailto:opencode@microsoft.com>`_ with any additional questions or comments.

:raw-html-m2r:`<!-- LINKS -->`


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. toctree::
  :maxdepth: 5
  :glob:
  :caption: Developer Documentation

  azure.maps.route.rst