Route - Post Route Range
Api:et för routningsintervall skapar en polygon som visar det område som kan nås från en viss plats inom ett visst tröskelvärde baserat på den angivna tids- eller avståndsbudgeten. En polygongräns (eller Isochrone) returneras i en motsolsorientering samt det exakta polygoncentret som var resultatet av ursprungspunkten.
Den returnerade polygonen kan användas för rumslig filtrering för att söka efter funktioner av intresse i den angivna Isochrone.
För information om rutttillgänglighet i länder/regioner, se Azure Maps routingtäckning.
POST {endpoint}/route/range?api-version=2025-01-01
URI-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Azure Maps-tjänstens värdnamn. Använd |
|
api-version
|
query | True |
string minLength: 1 |
Den API-version som ska användas för den här åtgärden. |
Begärandehuvud
Media Types: "application/geo+json"
| Name | Obligatorisk | Typ | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Anger vilket konto som är avsett för användning med Microsoft Entra ID-säkerhetsmodellen. Detta unika ID för Azure Maps-kontot kan erhållas från Azure Maps Management Plane Account API. För mer information om hur man använder Microsoft Entra ID säkerhet i Azure Maps, se Hantera autentisering i Azure Maps. |
Begärandetext
Media Types: "application/geo+json"
| Name | Obligatorisk | Typ | Description |
|---|---|---|---|
| geometry | True |
Anger objektet |
|
| properties | True |
Anger de parametrar som ska användas för beräkningen av isochronpolygon. |
|
| type | True |
Anger |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Begäran har slutförts. Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Ett oväntat felsvar. Media Types: "application/geo+json", "application/json" |
Säkerhet
AadToken
Dessa är Microsoft Entra OAuth 2.0 flöden. När den kombineras med Azure rollbaserad åtkomst kontroll kan den användas för att kontrollera åtkomst till Azure Maps REST-API:er. Azure:s rollbaserade åtkomstkontroller används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller delresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Azure Maps REST-API:er.
För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.
Note
- Den här säkerhetsdefinitionen kräver användningen av
x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et. -
Authorization URLär specifik för den offentliga Azure-molninstansen. Suveräna moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer. - Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
- Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
- Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Det här är en delad nyckel som etableras när du Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.
Med den här nyckeln kan alla program komma åt alla REST API:er. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de har utfärdats i.
För offentligt exponerade program rekommenderar vi att du använder konfidentiella klientprogram metod för åtkomst till Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.
Typ:
apiKey
I:
header
SAS Token
Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll till förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.
För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på Map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.
Typ:
apiKey
I:
header
Exempel
Successfully retrieve a set of locations that can be reached from the origin point based on the specified conditions
Exempelbegäran
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
}
}
Exempelsvar
{
"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"
}
}
]
}
Definitioner
| Name | Description |
|---|---|
|
Adr |
Begränsningskoden för ADR-tunneln. Adr är ett europeiskt avtal om internationell transport av farligt gods på väg. Begränsningskoden för ADR-tunneln används för att fastställa om ett fordon tillåts passera genom en tunnel med begränsningar för transport av farligt gods. |
|
Features |
Anger |
|
Feature |
Anger |
|
Geo |
Anger |
|
Input |
Anger de parametrar som ska användas för beräkningen av isochronpolygon. |
|
Maps |
Detaljerna om felet. |
|
Maps |
Vanligt felsvar för Azure Maps API:er för att returnera feldetaljer för misslyckade operationer. |
|
Maps |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
|
Route |
Anger begränsningar som vägberäkningen ska uppfylla när du fastställer de nåbara platserna. Undvik stöder flera värden i en begäran. \n\nExempel: "undvik": ["limitedAccessHighways", "tollRoads"] |
|
Route |
Egenskaper för routningsintervall. |
|
Route |
GeoJSON-funktionsobjekt som innehåller geometriobjekt och ytterligare egenskaper för vägen. |
|
Route |
Anger den parameter som ska användas för att optimera vägen. Om den inte har definierats är standardvärdet "fastestWithoutTraffic" som returnerar vägen för att minimera restiden utan att använda aktuell trafikinformation. Exempel: "optimizeRoute":"shortest" |
|
Route |
Anger objektet |
|
Route |
Anger objektet |
|
Route |
Anger startpunkten för intervallberäkning.
|
|
Route |
Det här objektet returneras från ett lyckat anrop. |
|
Route |
Anger reseprofilen som ska beaktas vid beräkning av intervallpolygonen. Om det inte anges är standardvärdet "driving". Exempel: "travelMode":"driving" |
|
Route |
Funktionstyperna för funktionsobjekten som returneras i svaret. |
|
Route |
Anger fordonsattribut som fordonshöjd, vikt, maxhastighet, typ av last osv. att tänka på när du beräknar de nåbara platserna. Detta hjälper till att undvika låga broröjningar, vägbegränsningar, svåra högersvängar för att tillhandahålla den optimerade lastbilsvägen baserat på fordonsspecifikationerna. Fordonsattribut anges i egenskapen vehicleSpec. |
|
Vehicle |
Typer av last som kan klassificeras som farliga material och som är begränsade från vissa vägar. |
AdrTunnelRestrictionCodeEnum
Begränsningskoden för ADR-tunneln. Adr är ett europeiskt avtal om internationell transport av farligt gods på väg. Begränsningskoden för ADR-tunneln används för att fastställa om ett fordon tillåts passera genom en tunnel med begränsningar för transport av farligt gods.
| Värde | Description |
|---|---|
| B |
Fordon med kod B är begränsade från vägar med ADR-tunnelkategorierna B, C, D och E. |
| C |
Fordon med kod C är begränsade från vägar med ADR-tunnelkategorierna C, D och E |
| D |
Fordon med kod D är begränsade från vägar med ADR-tunnelkategorierna D och E. |
| E |
Fordon med kod E är begränsade från vägar med ADR-tunnel kategori E. |
FeaturesItemTypeEnum
Anger GeoJSON typ. Den enda objekttyp som stöds är Funktion. Mer information finns i RFC 7946.
| Värde | Description |
|---|---|
| Feature |
Anger objekttypen |
FeatureTypeEnum
Anger GeoJSON typ. Den enda objekttypen som stöds är FeatureCollection. Mer information finns i RFC 7946.
| Värde | Description |
|---|---|
| FeatureCollection |
Anger |
GeoJsonObjectType
Anger GeoJSON typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.
| Värde | Description |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
|
| FeatureCollection |
|
InputRouteRangeProperties
Anger de parametrar som ska användas för beräkningen av isochronpolygon.
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| avoid |
Anger begränsningar som vägberäkningen ska uppfylla när du fastställer de nåbara platserna. Undvik stöder flera värden i en begäran. Exempel: "avoid": ["limitedAccessHighways", "tollRoads"] |
||
| departAt |
string (date-time) |
Datum och tid för avgång från ursprungspunkten formaterat som ett dateTime-värde som definieras av RFC 3339, avsnitt 5.6. När en tidszonsförskjutning inte har angetts antas UTC. Om Exempel: "departAt": "2023-06-01T09:30:00.000-07:00" |
|
| distanceBudgetInMeters |
number (float) maximum: 500000 |
Avståndsbudgeten anger det maximala intervallet i meter som kan färdas från ursprungsvägspunkten. Det går inte att ange när När Exempel: "distanceBudgetInMeters":5000 |
|
| isSimplifiedPolygon |
boolean |
True |
Använd detta för att ange om du behöver förenklade polygoner som minskar antalet polygonhörn samtidigt som formen bevaras. API:et returnerar polygon med låg definition som standard. |
| optimizeRoute | fastestWithoutTraffic |
Anger den parameter som ska användas för att optimera vägen. Om den inte har definierats är standardvärdet "fastestWithoutTraffic" som returnerar vägen för att minimera restiden utan att använda aktuell trafikinformation. Exempel: "optimizeRoute":"shortest" |
|
| timeBudgetInSec |
number (float) maximum: 21600 |
Tidsbudgeten anger den maximala tid i sekunder som är tillgänglig för resor, vilket definierar hur långt man kan gå inom denna tidsbegränsning från ursprungsvägpunkten. Det går inte att ange när När Exempel: "timeBudgetInSec":3600 |
|
| travelMode | driving |
Anger reseprofilen som ska beaktas vid beräkning av intervallpolygonen. Om det inte anges är standardvärdet "driving". Exempel: "travelMode":"driving" |
|
| vehicleSpec |
Anger fordonsattribut som fordonshöjd, vikt, maxhastighet, typ av last osv. att tänka på när du beräknar de nåbara platserna. Detta hjälper till att undvika låga broröjningar, vägbegränsningar, svåra högersvängar för att tillhandahålla den optimerade lastbilsvägen baserat på fordonsspecifikationerna. Fordonsattribut anges i egenskapen vehicleSpec. |
MapsErrorDetail
Detaljerna om felet.
| Name | Typ | Description |
|---|---|---|
| code |
string |
En av en serverdefinierad uppsättning felkoder. |
| details |
En matris med information om specifika fel som ledde till det rapporterade felet. |
|
| innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
|
| message |
string |
En mänsklig läsbar representation av felet. |
| target |
string |
Målet för felet. |
MapsErrorResponse
Vanligt felsvar för Azure Maps API:er för att returnera feldetaljer för misslyckade operationer.
| Name | Typ | Description |
|---|---|---|
| error |
Detaljerna om felet. |
MapsInnerError
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
| Name | Typ | Description |
|---|---|---|
| code |
string |
Felkoden. |
| innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
RouteRangeAvoidEnum
Anger begränsningar som vägberäkningen ska uppfylla när du fastställer de nåbara platserna. Undvik stöder flera värden i en begäran. \n\nExempel: "undvik": ["limitedAccessHighways", "tollRoads"]
| Värde | Description |
|---|---|
| limitedAccessHighways |
Undviker användning av motorvägar med begränsad åtkomst i vägen. |
| tollRoads |
Undviker användning av avgiftsbelagda vägar i vägen. |
| ferries |
Undviker användning av färjor i rutten. |
| tunnels |
Undviker användning av tunnlar i vägen. |
| borderCrossings |
Undviker att korsa landsgränser i vägen. |
| lowEmissionZones |
Undviker utsläppssnåla zoner i rutten. |
| unpavedRoads |
Undviker osparade vägar i vägen. |
| carpools |
Undviker vägar som kräver användning av samåkning. |
| carTrains |
Undviker biltåg. |
RouteRangeFeatureProperties
Egenskaper för routningsintervall.
| Name | Typ | Description |
|---|---|---|
| type |
Funktionstyperna för funktionsobjekten som returneras i svaret. |
RouteRangeFeaturesItem
GeoJSON-funktionsobjekt som innehåller geometriobjekt och ytterligare egenskaper för vägen.
| Name | Typ | Description |
|---|---|---|
| bbox |
number[] (double) |
Ett rektangulärt område på jorden som definieras som ett avgränsningsramobjekt. Rektanglarnas sidor definieras av latitud- och longitudvärden. Mer information finns i RFC 7946, avsnitt 5. Exempel: "bbox": [-10.0, -10.0, 10.0, 10.0] |
| geometry | RouteRangeGeometry: |
Ett giltigt |
| properties |
Egenskaper för routningsintervall. |
|
| type |
Anger |
RouteRangeOptimizeRouteEnum
Anger den parameter som ska användas för att optimera vägen. Om den inte har definierats är standardvärdet "fastestWithoutTraffic" som returnerar vägen för att minimera restiden utan att använda aktuell trafikinformation.
Exempel: "optimizeRoute":"shortest"
| Värde | Description |
|---|---|
| shortest |
Vägen beräknas för att minimera avståndet. Trafikinformation används inte. |
| fastestWithoutTraffic |
Hittar den snabbaste vägen, utan att ta hänsyn till trafikinformation. |
| fastestWithTraffic |
Vägen beräknas för att minimera tiden med aktuell trafikinformation.
|
RouteRangePointGeometry
Anger objektet GeoJSON punktgeometri. Mer information finns i RFC 7946.
| Name | Typ | Description |
|---|---|---|
| coordinates |
number[] (double) |
En |
| type |
string:
Point |
Anger geometritypen för objektet |
RouteRangePolygonGeometry
Anger objektet GeoJSON polygongeometri. Mer information finns i RFC 7946.
| Name | Typ | Description |
|---|---|---|
| coordinates |
number[] (double) |
Koordinater för |
| type |
string:
Polygon |
Anger geometritypen för objektet |
RouteRangeRequest
Anger startpunkten för intervallberäkning.
GeoJSON funktionsobjekt och ytterligare egenskaper. Mer information finns i RFC 7946.
| Name | Typ | Description |
|---|---|---|
| geometry |
Anger objektet |
|
| properties |
Anger de parametrar som ska användas för beräkningen av isochronpolygon. |
|
| type |
Anger |
RouteRangeResponse
Det här objektet returneras från ett lyckat anrop.
| Name | Typ | Description |
|---|---|---|
| features |
|
|
| type |
Anger |
RouteRangeTravelModeEnum
Anger reseprofilen som ska beaktas vid beräkning av intervallpolygonen. Om det inte anges är standardvärdet "driving".
Exempel: "travelMode":"driving"
| Värde | Description |
|---|---|
| driving |
Routningsprofil som är lämplig för bilar används för intervallpolygonberäkning. |
| truck |
Routningsprofil som är lämplig för nyttofordon som lastbilar används för intervallpolygonberäkning. |
RouteRangeTypeEnum
Funktionstyperna för funktionsobjekten som returneras i svaret.
| Värde | Description |
|---|---|
| center |
Funktionstypen mittpunkt representerar den punkt som används för beräkningen av intervallets polygon. |
| boundary |
Gränsfunktionstypen representerar intervallets polygon. |
RouteRangeVehicleSpec
Anger fordonsattribut som fordonshöjd, vikt, maxhastighet, typ av last osv. att tänka på när du beräknar de nåbara platserna. Detta hjälper till att undvika låga broröjningar, vägbegränsningar, svåra högersvängar för att tillhandahålla den optimerade lastbilsvägen baserat på fordonsspecifikationerna. Fordonsattribut anges i egenskapen vehicleSpec.
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| adrTunnelRestrictionCode |
Begränsningskoden för ADR-tunneln. Adr är ett europeiskt avtal om internationell transport av farligt gods på väg. Begränsningskoden för ADR-tunneln används för att fastställa om ett fordon tillåts passera genom en tunnel med begränsningar för transport av farligt gods. |
||
| axleCount |
integer (int64) |
Antalet axlar på fordonet. |
|
| axleWeight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
Fordonets vikt per axel i kg. Värdet 0 innebär att viktbegränsningar per axel inte beaktas. |
| height |
number (double) minimum: 0maximum: 1000000 |
0 |
Fordonets höjd i meter. Värdet 0 innebär att höjdbegränsningar inte beaktas. |
| isVehicleCommercial |
boolean |
False |
Om fordonet används i kommersiellt syfte. Nyttofordon får inte köra på vissa vägar. |
| length |
number (double) minimum: 0maximum: 1000000 |
0 |
Fordonets längd i meter. Värdet 0 innebär att längdbegränsningar inte beaktas. |
| loadType |
Typer av last som kan klassificeras som farliga material och som är begränsade från vissa vägar. Tillgängliga vehicleLoadType-värden är amerikanska Hazmat-klasser 1 till 9, plus generiska klassificeringar för användning i andra länder. Värden som börjar med USHazmat är för USA-routning medan otherHazmat ska användas för alla andra länder. vehicleLoadType stöder flera värden i en begäran. |
||
| maxSpeed |
integer (int64) minimum: 0maximum: 250 |
0 |
Fordonets högsta hastighet i km/timme. Maxhastigheten i fordonsprofilen används för att kontrollera om ett fordon tillåts på motorvägar. Värdet 0 innebär att ett lämpligt värde för fordonet bestäms och tillämpas under ruttplaneringen. Ett värde som inte är noll kan åsidosättas under routningsplaneringen. Det aktuella trafikflödet är till exempel 60 km/timme. Om fordonets högsta hastighet är inställd på 50 km/timme kommer routningsmotorn att överväga 60 km/timme eftersom detta är den aktuella situationen. Om fordonets högsta hastighet anges som 80 km/timme, men det aktuella trafikflödet är 60 km/timme, använder routningsmotorn återigen 60 km/timme. |
| weight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
Fordonets vikt i kg. Värdet 0 innebär att viktbegränsningar inte beaktas. |
| width |
number (double) minimum: 0maximum: 1000000 |
0 |
Fordonets bredd i meter. Värdet 0 innebär att breddbegränsningar inte beaktas. |
VehicleLoadTypeEnum
Typer av last som kan klassificeras som farliga material och som är begränsade från vissa vägar.
| Värde | Description |
|---|---|
| USHazmatClass1 |
Sprängämnen |
| USHazmatClass2 |
Komprimerad gas |
| USHazmatClass3 |
Brandfarliga vätskor |
| USHazmatClass4 |
Brandfarliga fasta ämnen |
| USHazmatClass5 |
Oxidatorer |
| USHazmatClass6 |
Gifter |
| USHazmatClass7 |
Radioaktiv |
| USHazmatClass8 |
Frätande |
| USHazmatClass9 |
Miscellaneous |
| otherHazmatExplosive |
Sprängämnen |
| otherHazmatGeneral |
Miscellaneous |
| otherHazmatHarmfulToWater |
Skadligt för vatten |