Route - Post Route Range
L'API Intervallo di route crea un poligono che illustra l'area raggiungibile da una determinata posizione entro una determinata soglia in base al budget di tempo o distanza specificato. Un limite poligono (o Isocrona) viene restituito in un orientamento antiorario, nonché il centro poligono preciso che era il risultato del punto di origine.
Il poligono restituito può essere usato per il filtro spaziale per cercare le caratteristiche di interesse all'interno dell'isocrona fornito.
Per informazioni sulla disponibilità di routing in paesi/regioni, vedi Azure Maps routing coverage.
POST https://atlas.microsoft.com/route/range?api-version=2025-01-01
Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Numero di versione di Azure Maps API. |
Intestazione della richiesta
Media Types: "application/geo+json"
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| x-ms-client-id |
string |
Indica l'account destinato all'uso con il modello di sicurezza Microsoft Entra ID. Questo ID univoco per l'account Azure Maps può essere ottenuto dall'Account API Azure Maps piano di gestione. Per maggiori informazioni sull'uso della sicurezza Microsoft Entra ID in Azure Maps, vedi Gestire l'autenticazione in Azure Maps. |
Corpo della richiesta
Media Types: "application/geo+json"
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| geometry | True |
Specifica l'oggetto Geometry punto |
|
| properties | True |
Specifica i parametri da utilizzare per il calcolo del poligono isocrona. |
|
| type | True |
Specifica il tipo di |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
Va bene Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Errore imprevisto. Media Types: "application/geo+json", "application/json" Intestazioni x-ms-error-code: string |
Sicurezza
AADToken
Questi sono i flussi Microsoft Entra OAuth 2.0. Quando abbinata al controllo Azure basato su ruolo può essere utilizzata per controllare l'accesso alle API REST di Azure Maps. I controlli di accesso basati su ruoli di Azure sono utilizzati per designare l'accesso a uno o più account o sottorisorse risorse di Azure Maps. Qualsiasi utente, gruppo o principale di servizio può ricevere l'accesso tramite un ruolo integrato o un ruolo personalizzato composto da uno o più permessi alle API REST di Azure Maps.
Per implementare scenari, è consigliabile visualizzare concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.
Annotazioni
- Questa definizione di sicurezza richiede l'uso dell'intestazione
x-ms-client-idper indicare a quale Azure Maps risorsa l'applicazione richiede accesso. Questa operazione può essere acquisita dall'API di gestione di mappe . - Il
Authorization URLè specifico per l'istanza Azure cloud pubblico. I cloud sovrani hanno URL di autorizzazione unici e configurazioni Microsoft Entra ID. - Il controllo degli accessi basato sul ruolo Azure viene configurato dal piano di gestione Azure tramite portale Azure, PowerShell, CLI, Azure SDKs o API REST.
- L'uso del Web SDK Azure Maps consente la configurazione di un'applicazione per più casi d'uso.
- Per altre informazioni su Microsoft Identity Platform, vedere panoramica di Microsoft Identity Platform.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
| Nome | Descrizione |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Questa è una chiave condivisa che viene fornita quando si crea una risorsa Azure Maps tramite il piano di gestione Azure tramite Azure portale, PowerShell, CLI, Azure SDKs o API REST.
Con questa chiave, qualsiasi applicazione è autorizzata ad accedere a tutte le API REST. In altre parole, questi possono essere attualmente considerati chiavi master per l'account per cui vengono rilasciati.
Per applicazioni pubblicamente esposte, la nostra raccomandazione è di utilizzare l'accesso server-to-server alle API REST di Azure Maps, dove questa chiave può essere memorizzata in modo sicuro.
Tipo:
apiKey
In:
header
SAS Token
Questo è un token di firma di accesso condiviso creato dall'operazione List SAS sulla risorsa Azure Maps tramite il piano di gestione Azure tramite Azure portale, PowerShell, CLI, Azure SDKs o API REST.
Con questo token, qualsiasi applicazione è autorizzata ad accedere tramite Azure ai controlli di accesso basati su ruoli e a un controllo fine della scadenza, del tasso e delle regioni di utilizzo per il particolare token. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.
Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.
Tipo:
apiKey
In:
header
Esempio
Successfully retrieve a set of locations that can be reached from the origin point based on the specified conditions
Esempio di richiesta
POST https://atlas.microsoft.com/route/range?api-version=2025-01-01
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
5.86605,
50.9745
]
},
"properties": {
"timeBudgetInSec": 6000
}
}
Risposta di esempio
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
5.86605,
50.9745
]
},
"properties": {
"type": "center"
}
},
{
"type": "Feature",
"bbox": [
3.62838,
49.83259,
7.9826,
52.25674
],
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
5.73602,
52.03704
],
[
5.59435,
52.09456
],
[
5.42279,
52.16815
],
[
5.21276,
52.25047
],
[
5.15355,
52.21374
],
[
4.96687,
52.25674
],
[
4.739,
52.07834
],
[
4.72513,
52.05647
],
[
4.53237,
51.94553
],
[
4.31165,
51.70119
],
[
4.28917,
51.5837
],
[
3.82685,
51.48463
],
[
3.62838,
51.21096
],
[
3.89244,
50.6814
],
[
3.93493,
50.66791
],
[
3.98156,
50.49042
],
[
4.47995,
50.30944
],
[
4.60502,
50.24448
],
[
4.89999,
50.24467
],
[
5.04206,
50.08735
],
[
5.23042,
49.99214
],
[
5.40994,
49.88478
],
[
5.46178,
49.85797
],
[
5.7196,
49.86279
],
[
5.74151,
49.83259
],
[
5.9387,
50.22239
],
[
6.08535,
50.0011
],
[
6.12089,
50.04616
],
[
6.28373,
50.09472
],
[
6.51654,
49.95863
],
[
6.61034,
50.00485
],
[
6.70295,
50.00587
],
[
6.65865,
50.2947
],
[
6.79276,
50.36903
],
[
7.32163,
50.31614
],
[
7.58782,
50.36737
],
[
7.7626,
50.46919
],
[
7.9826,
50.96246
],
[
7.55924,
51.07086
],
[
7.58138,
51.36614
],
[
7.67861,
51.52015
],
[
7.35175,
51.65781
],
[
7.21664,
51.81916
],
[
7.0467,
51.9587
],
[
6.67267,
51.82713
],
[
6.48424,
51.81133
],
[
6.27316,
51.9368
],
[
6.14452,
52.01701
],
[
6.09312,
52.20847
],
[
6.01297,
52.23705
],
[
5.86605,
50.9745
],
[
5.73602,
52.03704
]
]
]
},
"properties": {
"type": "boundary"
}
}
]
}
Definizioni
| Nome | Descrizione |
|---|---|
|
Adr |
Codice di restrizione del tunnel ADR. L'ADR è un accordo europeo relativo al trasporto internazionale di merci pericolose per strada. Il codice di restrizione del tunnel ADR viene utilizzato per determinare se un veicolo può attraversare un tunnel con restrizioni sul trasporto di merci pericolose. |
|
Features |
Specifica il tipo di |
|
Feature |
Specifica il tipo di |
|
Input |
Specifica i parametri da utilizzare per il calcolo del poligono isocrona. |
|
Maps |
Dettagli dell'errore. |
|
Maps |
Risposta comune all'errore per le API di Azure Maps per restituire dettagli di errore per operazioni fallite. |
|
Maps |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
|
Route |
Specifica le restrizioni che il calcolo della route deve rispettare quando si determinano le posizioni raggiungibili. Evitare di supportare più valori in una richiesta. Esempio: "avoid": ["limitedAccessHighways", "tollRoads"] |
|
Route |
Proprietà degli intervalli di route. |
|
Route |
Oggetto funzionalità GeoJSON che contiene l'oggetto Geometry e proprietà aggiuntive della route. |
|
Route |
Specifica il parametro da usare per ottimizzare la route. Se non definito, il valore predefinito è "fastestWithoutTraffic" che restituisce il percorso per ridurre al minimo il tempo di viaggio senza usare le informazioni sul traffico correnti. Esempio: "optimizeRoute":"shortest" |
|
Route |
Specifica l'oggetto Geometry punto |
|
Route |
Specifica l'oggetto Geometry polygon |
|
Route |
Specifica il punto iniziale per il calcolo dell'intervallo.
|
|
Route |
Questo oggetto viene restituito da una chiamata riuscita. |
|
Route |
Specifica il profilo di viaggio da considerare durante il calcolo del poligono di intervallo. Se non specificato, il valore predefinito è "driving". Esempio: "travelMode":"driving" |
|
Route |
Tipi di funzionalità per gli oggetti funzionalità restituiti nella risposta. |
|
Route |
Specifica gli attributi del veicolo, ad esempio altezza del veicolo, peso, velocità massima, tipo di carico e così via, da considerare durante il calcolo delle posizioni raggiungibili. Ciò consente di evitare spazi di ponte bassi, restrizioni stradali, turni di destra difficili per fornire il percorso ottimizzato dei camion in base alle specifiche del veicolo. Gli attributi del veicolo vengono specificati all'interno della proprietà vehicleSpec. |
|
Vehicle |
Tipi di carico che possono essere classificati come materiali pericolosi e limitati da alcune strade. I valori di vehicleLoadType disponibili sono classi Us Hazmat da 1 a 9, oltre a classificazioni generiche da usare in altri paesi. I valori che iniziano con USHazmat sono per l'instradamento degli Stati Uniti, mentre altrihazmat devono essere usati per tutti gli altri paesi. vehicleLoadType supporta più valori in una richiesta. |
AdrTunnelRestrictionCodeEnum
Codice di restrizione del tunnel ADR. L'ADR è un accordo europeo relativo al trasporto internazionale di merci pericolose per strada. Il codice di restrizione del tunnel ADR viene utilizzato per determinare se un veicolo può attraversare un tunnel con restrizioni sul trasporto di merci pericolose.
| Valore | Descrizione |
|---|---|
| B |
I veicoli con codice B sono limitati dalle strade con categorie di tunnel ADR B, C, D ed E. |
| C |
I veicoli con codice C sono limitati dalle strade con categorie di tunnel ADR C, D ed E |
| D |
I veicoli con codice D sono limitati dalle strade con categorie di tunnel ADR D ed E. |
| E |
I veicoli con codice E sono limitati dalle strade con categoria tunnel ADR E. |
FeaturesItemTypeEnum
Specifica il tipo di GeoJSON. L'unico tipo di oggetto supportato è Feature. Per altre informazioni, vedere RFC 7946.
| Valore | Descrizione |
|---|---|
| Feature |
Specifica il tipo di oggetto Feature |
FeatureTypeEnum
Specifica il tipo di GeoJSON. L'unico tipo di oggetto supportato è FeatureCollection. Per altre informazioni, vedere RFC 7946.
| Valore | Descrizione |
|---|---|
| FeatureCollection |
Specifica il tipo di oggetto |
InputRouteRangeProperties
Specifica i parametri da utilizzare per il calcolo del poligono isocrona.
| Nome | Tipo | Valore predefinito | Descrizione |
|---|---|---|---|
| avoid |
Specifica le restrizioni che il calcolo della route deve rispettare quando si determinano le posizioni raggiungibili. Evitare di supportare più valori in una richiesta. Esempio: "avoid": ["limitedAccessHighways", "tollRoads"] |
||
| departAt |
string (date-time) |
Data e ora di partenza dal punto di origine formattato come valore dateTime definito da RFC 3339, sezione 5.6. Quando non viene specificata una differenza di fuso orario, si presuppone l'ora UTC. Se il Esempio: "departAt": "2023-06-01T09:30:00.000-07:00" |
|
| distanceBudgetInMeters |
number (float) minimum: 0maximum: 500000 |
Il budget della distanza specifica l'intervallo massimo in metri che può essere viaggiato dal punto di partenza. Non può essere impostata quando viene specificato Quando Esempio: "distanceBudgetInMeters":5000 |
|
| isSimplifiedPolygon |
boolean |
True |
Utilizzare questa opzione per specificare se sono necessari poligoni semplificati che riducono il numero di vertici poligoni mantenendo la forma. L'API restituisce il poligono a bassa definizione per impostazione predefinita. |
| optimizeRoute | fastestWithoutTraffic |
Specifica il parametro da usare per ottimizzare la route. Se non definito, il valore predefinito è "fastestWithoutTraffic" che restituisce il percorso per ridurre al minimo il tempo di viaggio senza usare le informazioni sul traffico correnti. Esempio: "optimizeRoute":"shortest" |
|
| timeBudgetInSec |
number (float) minimum: 0maximum: 21600 |
Il budget temporale specifica il tempo massimo in secondi disponibili per il viaggio, definendo la distanza entro questo vincolo temporale dal punto di partenza. Non può essere impostata quando viene specificato Quando Esempio: "timeBudgetInSec":3600 |
|
| travelMode | driving |
Specifica il profilo di viaggio da considerare durante il calcolo del poligono di intervallo. Se non specificato, il valore predefinito è "driving". Esempio: "travelMode":"driving" |
|
| vehicleSpec |
Specifica gli attributi del veicolo, ad esempio altezza del veicolo, peso, velocità massima, tipo di carico e così via, da considerare durante il calcolo delle posizioni raggiungibili. Ciò consente di evitare spazi di ponte bassi, restrizioni stradali, turni di destra difficili per fornire il percorso ottimizzato dei camion in base alle specifiche del veicolo. Gli attributi del veicolo vengono specificati all'interno della proprietà vehicleSpec. |
MapsErrorDetail
Dettagli dell'errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
string |
Uno di un set definito dal server di codici di errore. |
| details |
Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato. |
|
| innererror |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
|
| message |
string |
Rappresentazione leggibile dell'errore. |
| target |
string |
Destinazione dell'errore. |
MapsErrorResponse
Risposta comune all'errore per le API di Azure Maps per restituire dettagli di errore per operazioni fallite.
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
Dettagli dell'errore. |
MapsInnerError
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
string |
Codice di errore. |
| innererror |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
RouteRangeAvoidEnum
Specifica le restrizioni che il calcolo della route deve rispettare quando si determinano le posizioni raggiungibili. Evitare di supportare più valori in una richiesta.
Esempio: "avoid": ["limitedAccessHighways", "tollRoads"]
| Valore | Descrizione |
|---|---|
| limitedAccessHighways |
Evita l'uso di autostrade ad accesso limitato nel percorso. |
| tollRoads |
Evita l'uso di strade a pedaggio nel percorso. |
| ferries |
Evita l'uso di traghetti nel percorso. |
| tunnels |
Evita l'uso di tunnel nella route. |
| borderCrossings |
Evita di attraversare i confini del paese nel percorso. |
| lowEmissionZones |
Evita zone a basse emissioni nel percorso. |
| unpavedRoads |
Evita strade non pavimentate nel percorso. |
| carpools |
Evita itinerari che richiedono l'uso di carpooling. |
| carTrains |
Evita treni auto. |
RouteRangeFeatureProperties
Proprietà degli intervalli di route.
| Nome | Tipo | Descrizione |
|---|---|---|
| type |
Tipi di funzionalità per gli oggetti funzionalità restituiti nella risposta. |
RouteRangeFeaturesItem
Oggetto funzionalità GeoJSON che contiene l'oggetto Geometry e proprietà aggiuntive della route.
| Nome | Tipo | Descrizione |
|---|---|---|
| bbox |
number[] (double) |
Area rettangolare sulla terra definita come oggetto rettangolo delimitatore. I lati dei rettangoli sono definiti dai valori di latitudine e longitudine. Per altre informazioni, vedere RFC 7946, sezione 5. Esempio: "bbox": [-10.0, -10.0, 10.0, 10.0] |
| geometry | RouteRangeGeometry: |
Oggetto Geometry valido |
| properties |
Proprietà degli intervalli di route. |
|
| type |
Specifica il tipo di |
RouteRangeOptimizeRouteEnum
Specifica il parametro da usare per ottimizzare la route. Se non definito, il valore predefinito è "fastestWithoutTraffic" che restituisce il percorso per ridurre al minimo il tempo di viaggio senza usare le informazioni sul traffico correnti.
Esempio: "optimizeRoute":"shortest"
| Valore | Descrizione |
|---|---|
| shortest |
Il percorso viene calcolato per ridurre al minimo la distanza. Le informazioni sul traffico non vengono usate. |
| fastestWithoutTraffic |
Trova la route più veloce, senza considerare le informazioni sul traffico. |
| fastestWithTraffic |
La route viene calcolata per ridurre al minimo il tempo usando le informazioni sul traffico correnti.
|
RouteRangePointGeometry
Specifica l'oggetto Geometry punto GeoJSON. Per informazioni dettagliate, vedere RFC 7946.
RouteRangePolygonGeometry
Specifica l'oggetto Geometry polygon GeoJSON. Per informazioni dettagliate, vedere RFC 7946.
RouteRangeRequest
Specifica il punto iniziale per il calcolo dell'intervallo.
GeoJSON oggetto funzionalità e proprietà aggiuntive. Per informazioni dettagliate, vedere RFC 7946.
| Nome | Tipo | Descrizione |
|---|---|---|
| geometry |
Specifica l'oggetto Geometry punto |
|
| properties |
Specifica i parametri da utilizzare per il calcolo del poligono isocrona. |
|
| type |
Specifica il tipo di |
RouteRangeResponse
Questo oggetto viene restituito da una chiamata riuscita.
| Nome | Tipo | Descrizione |
|---|---|---|
| features |
|
|
| type |
Specifica il tipo di |
RouteRangeTravelModeEnum
Specifica il profilo di viaggio da considerare durante il calcolo del poligono di intervallo. Se non specificato, il valore predefinito è "driving".
Esempio: "travelMode":"driving"
| Valore | Descrizione |
|---|---|
| driving |
Il profilo di routing adatto per le automobili viene usato per il calcolo poligono di intervallo. |
| truck |
Il profilo di routing adatto per veicoli commerciali come i camion viene usato per il calcolo del poligono di intervallo. |
RouteRangeTypeEnum
Tipi di funzionalità per gli oggetti funzionalità restituiti nella risposta.
| Valore | Descrizione |
|---|---|
| center |
Il tipo di caratteristica punto centrale rappresenta il punto utilizzato per il calcolo del poligono di intervallo. |
| boundary |
Il tipo di funzionalità limite rappresenta il poligono dell'intervallo. |
RouteRangeVehicleSpec
Specifica gli attributi del veicolo, ad esempio altezza del veicolo, peso, velocità massima, tipo di carico e così via, da considerare durante il calcolo delle posizioni raggiungibili. Ciò consente di evitare spazi di ponte bassi, restrizioni stradali, turni di destra difficili per fornire il percorso ottimizzato dei camion in base alle specifiche del veicolo. Gli attributi del veicolo vengono specificati all'interno della proprietà vehicleSpec.
| Nome | Tipo | Valore predefinito | Descrizione |
|---|---|---|---|
| adrTunnelRestrictionCode |
Codice di restrizione del tunnel ADR. L'ADR è un accordo europeo relativo al trasporto internazionale di merci pericolose per strada. Il codice di restrizione del tunnel ADR viene utilizzato per determinare se un veicolo può attraversare un tunnel con restrizioni sul trasporto di merci pericolose. |
||
| axleCount |
integer (int64) |
Numero di assi sul veicolo. |
|
| axleWeight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
Peso per asse del veicolo in kg. Il valore 0 indica che le restrizioni di peso per asse non vengono considerate. |
| height |
number (double) minimum: 0maximum: 1000000 |
0 |
Altezza del veicolo in metri. Il valore 0 indica che le restrizioni di altezza non vengono considerate. |
| isVehicleCommercial |
boolean |
False |
Indica se il veicolo viene utilizzato per scopi commerciali. I veicoli commerciali potrebbero non essere autorizzati a guidare su alcune strade. |
| length |
number (double) minimum: 0maximum: 1000000 |
0 |
Lunghezza del veicolo in metri. Il valore 0 indica che le restrizioni di lunghezza non vengono considerate. |
| loadType |
Tipi di carico che possono essere classificati come materiali pericolosi e limitati da alcune strade. I valori di vehicleLoadType disponibili sono classi Us Hazmat da 1 a 9, oltre a classificazioni generiche da usare in altri paesi. I valori che iniziano con USHazmat sono per l'instradamento degli Stati Uniti, mentre altrihazmat devono essere usati per tutti gli altri paesi. vehicleLoadType supporta più valori in una richiesta. |
||
| maxSpeed |
integer (int64) minimum: 0maximum: 250 |
0 |
Velocità massima del veicolo in km/ora. La velocità massima nel profilo del veicolo viene utilizzata per verificare se un veicolo è consentito sulle autostrade. Il valore 0 indica che un valore appropriato per il veicolo verrà determinato e applicato durante la pianificazione del percorso. È possibile eseguire l'override di un valore diverso da zero durante la pianificazione della route. Ad esempio, il flusso di traffico corrente è di 60 km/ora. Se la velocità massima del veicolo è impostata su 50 km/ora, il motore di instradamento considererà 60 km/ora in quanto si tratta della situazione attuale. Se la velocità massima del veicolo viene fornita come 80 km/ora, ma il flusso di traffico corrente è di 60 km/ora, il motore di instradamento utilizzerà di nuovo 60 km/ora. |
| weight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
Peso del veicolo in kg. Il valore 0 indica che le restrizioni di peso non vengono considerate. |
| width |
number (double) minimum: 0maximum: 1000000 |
0 |
Larghezza del veicolo in metri. Il valore 0 indica che le restrizioni di larghezza non vengono considerate. |
VehicleLoadTypeEnum
Tipi di carico che possono essere classificati come materiali pericolosi e limitati da alcune strade. I valori di vehicleLoadType disponibili sono classi Us Hazmat da 1 a 9, oltre a classificazioni generiche da usare in altri paesi. I valori che iniziano con USHazmat sono per l'instradamento degli Stati Uniti, mentre altrihazmat devono essere usati per tutti gli altri paesi. vehicleLoadType supporta più valori in una richiesta.
| Valore | Descrizione |
|---|---|
| USHazmatClass1 |
Esplosivi |
| USHazmatClass2 |
Gas compresso |
| USHazmatClass3 |
Liquidi flammable |
| USHazmatClass4 |
Solidi flammable |
| USHazmatClass5 |
Ossidanti |
| USHazmatClass6 |
Veleni |
| USHazmatClass7 |
Radioattivo |
| USHazmatClass8 |
Corrosivi |
| USHazmatClass9 |
Miscellaneous |
| otherHazmatExplosive |
Esplosivi |
| otherHazmatGeneral |
Miscellaneous |
| otherHazmatHarmfulToWater |
Dannoso per l'acqua |