Package: azure-maps-route
Azure Maps Route Package client library for PythonThis package contains a Python SDK for Azure Maps Services for Route.
Read more about Azure Maps ServiceshereSource code|API reference documentation|Product documentationDisclaimerAzure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer tohttps://github.com/Azure/azure-sdk-for-python/issues/20691Getting startedPrerequisitesPython 3.6 or later is required to use this package.AnAzure subscriptionand anAzure Maps account.A deployed Maps Services resource. You can create the resource viaAzure PortalorAzure CLI.If you use Azure CLI, replace<resource-group-name>and<account-name>of your choice, and select a properpricing tierbased on your needs via the<sku-name>parameter. Please refer tothis pagefor more details.azmapsaccountcreate--resource-group<resource-group-name>--account-name<account-name>--sku<sku-name>Install the packageInstall the Azure Maps Service Route SDK.pipinstallazure-maps-routeCreate and Authenticate the MapsRouteClientTo create a client object to access the Azure Maps Route API, you will need acredentialobject. Azure Maps Route client also support two ways to authenticate.1. Authenticate with a Subscription Key CredentialYou 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 anAZURE_SUBSCRIPTION_KEYas thecredentialparameter into an instance ofAzureKeyCredential.fromazure.core.credentialsimportAzureKeyCredentialfromazure.maps.routeimportMapsRouteClientcredential=AzureKeyCredential(os.environ.get("AZURE_SUBSCRIPTION_KEY"))route_client=MapsRouteClient(credential=credential,)2. Authenticate with an Azure Active Directory credentialYou can authenticate withAzure Active Directory (AAD) token credentialusing theAzure Identity library.
Authentication by using AAD requires some initial setup:Installazure-identityRegister anew AAD applicationGrant access to Azure Maps by assigning the suitable role to your service principal. Please refer to theManage authentication page.After setup, you can choose which type ofcredentialfromazure.identityto use.
As an example,DefaultAzureCredentialcan 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_SECRETYou will also need to specify the Azure Maps resource you intend to use by specifying theclientIdin the client options. The Azure Maps resource client id can be found in the Authentication sections in the Azure Maps resource. Please refer to thedocumentationon how to find it.fromazure.maps.routeimportMapsRouteClientfromazure.identityimportDefaultAzureCredentialcredential=DefaultAzureCredential()route_client=MapsRouteClient(client_id="<Azure Maps Client ID>",credential=credential)Key conceptsThe 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 ClientsMapsRouteClientis the primary client for developers using the Azure Maps Route client library for Python.
Once you initialized aMapsRouteClientclass, 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 ClientsThis library includes a complete async API supported on Python 3.5+. To use it, you must first install an async transport, such asaiohttp.
Seeazure-core documentationfor more information.Async clients and credentials should be closed when they're no longer needed. These
objects are async context managers and define asyncclosemethods.ExamplesThe following sections provide several code snippets covering some of the most common Azure Maps Route tasks, including:Request and Get Route DirectionsRequest and Get Route RangeGet Route MatrixGet Route Directions BatchRequest and Get Route DirectionsThis 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.fromazure.maps.routeimportMapsRouteClientroute_directions_result=client.get_route_directions(route_points=[LatLon(47.60323,-122.33028),LatLon(53.2,-106)]);Request and Get Route RangeThis 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.fromazure.maps.routeimportMapsRouteClientroute_range_result=client.get_route_range(coordinates=LatLon(47.60323,-122.33028),time_budget_in_sec=6000);Get Route MatrixIf 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.fromazure.maps.routeimportMapsRouteClientroute_matrix_result=client.begin_get_route_matrix_result(matrix_id="11111111-2222-3333-4444-555555555555");Get Route Directions BatchRetrieves the result of a previous route direction batch request.
The method returns a poller for retrieving the result.fromazure.maps.routeimportMapsRouteClientroute_directions_batch_poller_result=client.begin_get_route_directions_batch_result(batch_id="11111111-2222-3333-4444-555555555555");TroubleshootingGeneralMaps Route clients raise exceptions defined inAzure Core.This list can be used for reference to catch thrown exceptions. To get the specific error code of the exception, use theerror_codeattribute, i.e,exception.error_code.LoggingThis library uses the standardlogginglibrary 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 thelogging_enableargument:importsysimportloggingfromazure.maps.routeimportMapsRouteClient# Create a logger for the 'azure.maps.route' SDKlogger=logging.getLogger('azure.maps.route')logger.setLevel(logging.DEBUG)# Configure a console outputhandler=logging.StreamHandler(stream=sys.stdout)logger.addHandler(handler)AdditionalStill running into issues? If you encounter any bugs or have suggestions, please file an issue in theIssuessection of the project.Next stepsMore sample codeGet started with ourMaps Route samples(Async Version 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 RoutesetAZURE_SUBSCRIPTION_KEY="<RealSubscriptionKey>"pipinstallazure-maps-route--pre

pythonsamples/sample_authentication.py
pythonsample/sample_get_route_range.py
pythonsamples/sample_get_route_directions.py
pythonsamples/sample_request_route_matrix.py
pythonsamples/async_samples/sample_authentication_async.py
pythonsamples/async_samples/sample_get_route_range_async.py
pythonsamples/async_samples/sample_request_route_matrix_async.py
pythonsamples/async_samples/sample_get_route_directions_async.pyNotes:--preflag can be optionally added, it is to include pre-release and development versions forpip install. By default,piponly finds stable versions.Further detail please refer toSamples IntroductionAdditional documentationFor more extensive documentation on Azure Maps Route, see theAzure Maps Route documentationon docs.microsoft.com.ContributingThis 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, visithttps://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 theMicrosoft Open Source Code of Conduct. For more information see theCode of Conduct FAQor contactopencode@microsoft.comwith any additional questions or comments.Release History1.0.0b1 (2022-10-13)Initial Release