@azure-rest/maps-route package
Schnittstellen
| BatchRequest |
Dieser Typ stellt den Anforderungstext für den Batchdienst dar. |
| BatchRequestItem |
Batchanforderungsobjekt |
| BatchResultItemOutput |
Ein Element, das von der Batch-API zurückgegeben wird. Erweitern mit der Eigenschaft "response". |
| BatchResultOutput |
Dieses Objekt wird von einem erfolgreichen Batchdienstaufruf zurückgegeben. Erweitern mit der Eigenschaft "batchItems". |
| BatchResultSummaryOutput |
Zusammenfassung der Ergebnisse für die Batchanforderung |
| EffectiveSettingOutput |
Effektive Parameter oder Daten, die beim Aufrufen dieser Route-API verwendet werden. |
| ErrorDetailOutput |
Das Fehlerdetails. |
| ErrorResponseOutput |
Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.) |
| GeoJsonFeature |
Ein gültiger |
| GeoJsonFeatureCollection |
Ein gültiger |
| GeoJsonFeatureCollectionData | |
| GeoJsonFeatureData | |
| GeoJsonGeometryCollection |
Ein gültiger |
| GeoJsonGeometryCollectionData | |
| GeoJsonGeometryParent |
Ein gültiges |
| GeoJsonLineString |
Ein gültiger |
| GeoJsonLineStringData | |
| GeoJsonMultiLineString |
Ein gültiger |
| GeoJsonMultiLineStringData | |
| GeoJsonMultiPoint |
Ein gültiger |
| GeoJsonMultiPointData |
Daten, die in einem |
| GeoJsonMultiPolygon |
Ein gültiger |
| GeoJsonMultiPolygonData | |
| GeoJsonObjectParent |
Ein gültiges |
| GeoJsonPoint |
Ein gültiger |
| GeoJsonPointData |
Daten, die in einem |
| GeoJsonPolygon |
Ein gültiger |
| GeoJsonPolygonData | |
| GetRouteDirections | |
| GetRouteRange | |
| LatLongPairOutput |
Ein Ort, der als Breiten- und Längengrad dargestellt wird. |
| MapsRouteClientOptions |
Die optionalen Parameter für den Client |
| RequestRouteDirectionsBatch | |
| RequestRouteDirectionsBatchSync | |
| RequestRouteMatrix | |
| RequestRouteMatrixSync | |
| RouteDirectionParameters |
Post body parameters for Route directions. |
| RouteDirectionsBatchItemOutput |
Ein Element, das vom Anruf des Route Directions Batch-Diensts zurückgegeben wurde. |
| RouteDirectionsBatchItemResponseOutput |
Das Ergebnis der Abfrage. RouteDirections, wenn die Abfrage erfolgreich abgeschlossen wurde, andernfalls ErrorResponse. |
| RouteDirectionsBatchResultOutput |
Dieses Objekt wird von einem erfolgreichen Route Directions Batch-Dienstaufruf zurückgegeben. |
| RouteDirectionsOutput |
Dieses Objekt wird von einem erfolgreichen Route Directions-Aufruf zurückgegeben. |
| RouteGetRouteDirections200Response |
Die Die zurückgegebenen Informationen umfassen die Entfernung, die geschätzte Fahrzeit und eine Darstellung der Routengeometrie. Je nach ausgewählten Optionen stehen auch zusätzliche Routinginformationen wie optimierte Waypoint-Reihenfolge oder Turn by Turn-Anweisungen zur Verfügung. Der Routingdienst bietet eine Reihe von Parametern für eine detaillierte Beschreibung eines fahrzeugspezifischen Verbrauchsmodells. Weitere Informationen finden Sie unter Verbrauchsmodell. |
| RouteGetRouteDirectionsBatch200Response |
Die Asynchrone Batchergebnisse herunterladenUm die asynchronen Batchergebnisse herunterzuladen, geben Sie eine Dies ist die typische Abfolge von Vorgängen zum Herunterladen der Batchergebnisse:
BatchantwortmodellDer zurückgegebene Dateninhalt ist für asynchrone und Synchronisierungsanforderungen ähnlich. Wenn der Batch die Verarbeitung abgeschlossen hat, enthält der Antworttext beim Herunterladen der Ergebnisse einer asynchronen Batchanforderung die Batchantwort. Diese Batchantwort enthält eine
Hier ist eine Beispielbatchantwort mit 1 erfolgreichen und 1 Ergebnis fehlgeschlagen: |
| RouteGetRouteDirectionsBatch202Headers | |
| RouteGetRouteDirectionsBatch202Response |
Die Asynchrone Batchergebnisse herunterladenUm die asynchronen Batchergebnisse herunterzuladen, geben Sie eine Dies ist die typische Abfolge von Vorgängen zum Herunterladen der Batchergebnisse:
BatchantwortmodellDer zurückgegebene Dateninhalt ist für asynchrone und Synchronisierungsanforderungen ähnlich. Wenn der Batch die Verarbeitung abgeschlossen hat, enthält der Antworttext beim Herunterladen der Ergebnisse einer asynchronen Batchanforderung die Batchantwort. Diese Batchantwort enthält eine
Hier ist eine Beispielbatchantwort mit 1 erfolgreichen und 1 Ergebnis fehlgeschlagen: |
| RouteGetRouteDirectionsDefaultResponse |
Die Die zurückgegebenen Informationen umfassen die Entfernung, die geschätzte Fahrzeit und eine Darstellung der Routengeometrie. Je nach ausgewählten Optionen stehen auch zusätzliche Routinginformationen wie optimierte Waypoint-Reihenfolge oder Turn by Turn-Anweisungen zur Verfügung. Der Routingdienst bietet eine Reihe von Parametern für eine detaillierte Beschreibung eines fahrzeugspezifischen Verbrauchsmodells. Weitere Informationen finden Sie unter Verbrauchsmodell. |
| RouteGetRouteDirectionsQueryParam | |
| RouteGetRouteDirectionsQueryParamProperties | |
| RouteGetRouteDirectionsWithAdditionalParameters200Response |
Die Die zurückgegebenen Informationen umfassen die Entfernung, die geschätzte Fahrzeit und eine Darstellung der Routengeometrie. Je nach ausgewählten Optionen stehen auch zusätzliche Routinginformationen wie optimierte Waypoint-Reihenfolge oder Turn by Turn-Anweisungen zur Verfügung. Der Routingdienst bietet eine Reihe von Parametern für eine detaillierte Beschreibung eines fahrzeugspezifischen Verbrauchsmodells. Bitte überprüfen Sie Verbrauchsmodell, um detaillierte Erläuterungen zu den beteiligten Konzepten und Parametern zu finden. |
| RouteGetRouteDirectionsWithAdditionalParametersBodyParam | |
| RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse |
Die Die zurückgegebenen Informationen umfassen die Entfernung, die geschätzte Fahrzeit und eine Darstellung der Routengeometrie. Je nach ausgewählten Optionen stehen auch zusätzliche Routinginformationen wie optimierte Waypoint-Reihenfolge oder Turn by Turn-Anweisungen zur Verfügung. Der Routingdienst bietet eine Reihe von Parametern für eine detaillierte Beschreibung eines fahrzeugspezifischen Verbrauchsmodells. Bitte überprüfen Sie Verbrauchsmodell, um detaillierte Erläuterungen zu den beteiligten Konzepten und Parametern zu finden. |
| RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam | |
| RouteGetRouteDirectionsWithAdditionalParametersQueryParam | |
| RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties | |
| RouteGetRouteMatrix200Response |
Die Für jeden bestimmten Ursprung berechnet der Dienst die Kosten des Routings von diesem Ursprung an jedes bestimmte Ziel. Der Satz von Ursprüngen und der Zielsatz kann als Spalten- und Zeilenüberschriften einer Tabelle betrachtet werden, und jede Zelle in der Tabelle enthält die Kosten für das Routing vom Ursprung an das Ziel für diese Zelle. Angenommen, ein Lebensmittellieferunternehmen hat 20 Fahrer und sie müssen den nächstgelegenen Fahrer finden, um die Lieferung aus dem Restaurant aufzunehmen. Um diesen Anwendungsfall zu lösen, können sie die Matrixrouten-API aufrufen. Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Mit den berechneten Kosten können Sie ermitteln, welche detaillierten Routen mithilfe der Routenbeschreibungs-API berechnet werden sollen. Die maximale Größe einer Matrix für asynchrone Anforderung ist 700 und für die Synchronisierungsanforderung ist sie 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Synchrone Routenmatrixanforderung übermittelnWenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie synchrone Anforderungen stellen. Die maximale Größe einer Matrix für diese API ist 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Bei dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein). Asynchrone Routenmatrixanforderung übermittelnDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung vornehmen, gibt der Dienst standardmäßig einen Antwortcode 202 entlang einer Umleitungs-URL im Feld "Speicherort" des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn Die maximale Größe einer Matrix für diese API ist 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 50x10, 10x10, 28 x 25. 10x70 (es muss nicht quadratisch sein). Die asynchronen Antworten werden für 24 Stunden gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird. Hier ist eine typische Abfolge asynchroner Vorgänge:
Synchronisierungsergebnisse herunterladenWenn Sie eine GET-Anforderung für die Route Matrix-Synchronisierungs-API vornehmen, gibt der Dienst den Antwortcode 200 für eine erfolgreiche Anforderung und ein Antwortarray zurück. Der Antworttext enthält die Daten, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen. Asynchrone Ergebnisse herunterladenWenn eine Anforderung eine Die vom Positionsheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine
|
| RouteGetRouteMatrix202Headers | |
| RouteGetRouteMatrix202Response |
Die Für jeden bestimmten Ursprung berechnet der Dienst die Kosten des Routings von diesem Ursprung an jedes bestimmte Ziel. Der Satz von Ursprüngen und der Zielsatz kann als Spalten- und Zeilenüberschriften einer Tabelle betrachtet werden, und jede Zelle in der Tabelle enthält die Kosten für das Routing vom Ursprung an das Ziel für diese Zelle. Angenommen, ein Lebensmittellieferunternehmen hat 20 Fahrer und sie müssen den nächstgelegenen Fahrer finden, um die Lieferung aus dem Restaurant aufzunehmen. Um diesen Anwendungsfall zu lösen, können sie die Matrixrouten-API aufrufen. Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Mit den berechneten Kosten können Sie ermitteln, welche detaillierten Routen mithilfe der Routenbeschreibungs-API berechnet werden sollen. Die maximale Größe einer Matrix für asynchrone Anforderung ist 700 und für die Synchronisierungsanforderung ist sie 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Synchrone Routenmatrixanforderung übermittelnWenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie synchrone Anforderungen stellen. Die maximale Größe einer Matrix für diese API ist 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Bei dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein). Asynchrone Routenmatrixanforderung übermittelnDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung vornehmen, gibt der Dienst standardmäßig einen Antwortcode 202 entlang einer Umleitungs-URL im Feld "Speicherort" des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn Die maximale Größe einer Matrix für diese API ist 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 50x10, 10x10, 28 x 25. 10x70 (es muss nicht quadratisch sein). Die asynchronen Antworten werden für 24 Stunden gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird. Hier ist eine typische Abfolge asynchroner Vorgänge:
Synchronisierungsergebnisse herunterladenWenn Sie eine GET-Anforderung für die Route Matrix-Synchronisierungs-API vornehmen, gibt der Dienst den Antwortcode 200 für eine erfolgreiche Anforderung und ein Antwortarray zurück. Der Antworttext enthält die Daten, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen. Asynchrone Ergebnisse herunterladenWenn eine Anforderung eine Die vom Positionsheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine
|
| RouteGetRouteRange200Response |
Die Das zurückgegebene Polygon kann für die weitere Verarbeitung wie Search Inside Geometry verwendet werden, um innerhalb der bereitgestellten Isochrone nach POIs zu suchen. |
| RouteGetRouteRangeDefaultResponse |
Die Das zurückgegebene Polygon kann für die weitere Verarbeitung wie Search Inside Geometry verwendet werden, um innerhalb der bereitgestellten Isochrone nach POIs zu suchen. |
| RouteGetRouteRangeQueryParam | |
| RouteGetRouteRangeQueryParamProperties | |
| RouteGuidanceOutput |
Enthält anleitungsbezogene Elemente. Dieses Feld ist nur vorhanden, wenn Anleitungen angefordert und verfügbar sind. |
| RouteInstructionGroupOutput |
Gruppiert eine Abfolge von Anweisungselementen, die miteinander verknüpft sind. Der Sequenzbereich ist mit firstInstructionIndex und lastInstructionIndex eingeschränkt. Wenn für Anleitungen lesbare Textnachrichten angefordert werden (instructionType=text oder tagged), wird von der instructionGroup eine Zusammenfassungsmeldung zurückgegeben, wenn sie verfügbar ist. |
| RouteInstructionOutput |
Eine Reihe von Attributen, die ein Manöver beschreiben, z. B. "Turn right", "Keep left", "Take the ferry", "Take the autobahn", "Arrive". |
| RouteLegOutput |
Eine Beschreibung eines Teils einer Route, bestehend aus einer Liste von Punkten. Jeder zusätzliche Wegpunkt, der in der Anforderung bereitgestellt wird, führt zu einem zusätzlichen Abschnitt in der zurückgegebenen Route. |
| RouteMatrixOutput |
Matrixergebnisobjekt |
| RouteMatrixQuery |
Ein Objekt mit einer Matrix von Koordinaten. |
| RouteMatrixResultOutput |
Dieses Objekt wird von einem erfolgreichen Route Matrix-Aufruf zurückgegeben. Wenn z. B. 2 Ursprünge und 3 Ziele bereitgestellt werden, gibt es jeweils 2 Arrays mit 3 Elementen. Der Inhalt jedes Elements hängt von den optionen ab, die in der Abfrage bereitgestellt werden. |
| RouteMatrixResultResponseOutput |
Antwortobjekt der aktuellen Zelle in der Eingabematrix. |
| RouteMatrixSummaryOutput |
Summary-Objekt |
| RouteOptimizedWaypointOutput |
Optimierte Art des Punktobjekts. |
| RouteOutput | |
| RouteRangeOutput |
Erreichbarer Bereich |
| RouteRangeResultOutput |
Dieses Objekt wird von einem erfolgreichen Route Reachable Range-Aufruf zurückgegeben. |
| RouteReportOutput |
Meldet die effektiven Einstellungen, die im aktuellen Anruf verwendet werden. |
| RouteRequestRouteDirectionsBatch200Response |
Die Asynchrone Batchanforderung übermittelnDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routenanforderungen.
Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung vornehmen, gibt der Dienst standardmäßig einen Antwortcode 202 entlang einer Umleitungs-URL im Feld "Speicherort" des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Die asynchronen Antworten werden für 24 Stunden gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird. Beachten Sie, dass die asynchrone Batchanforderung ein lang ausgeführter Vorgang ist. Hier ist eine typische Abfolge von Vorgängen:
POST-Text für BatchanforderungUm die Routenbeschreibungen Abfragen zu senden, verwenden Sie eine Eine Routenbeschreibung Abfrage in einem Batch ist nur eine partielle URL ohne Protokoll, Basis-URL, Pfad, API-Version und Abonnementschlüssel. Sie kann jede der unterstützten RoutenbeschreibungenURI-Parameterakzeptieren. Die Zeichenfolgenwerte in der Routenbeschreibung Abfrage müssen ordnungsgemäß escaped sein (z. B. " Zeichen sollte mit \ ) escapet werden, und sie sollte auch ordnungsgemäß URL-codiert sein. Mit der asynchronen API können Aufrufer bis zu 700 Abfragen und Synchronisierungs-API bis zu 100 Abfragen stapeln, und der Batch sollte mindestens 1 Abfrage enthalten. Asynchrone Batchergebnisse herunterladenUm die asynchronen Batchergebnisse herunterzuladen, geben Sie eine Dies ist die typische Abfolge von Vorgängen zum Herunterladen der Batchergebnisse:
BatchantwortmodellDer zurückgegebene Dateninhalt ist für asynchrone und Synchronisierungsanforderungen ähnlich. Wenn der Batch die Verarbeitung abgeschlossen hat, enthält der Antworttext beim Herunterladen der Ergebnisse einer asynchronen Batchanforderung die Batchantwort. Diese Batchantwort enthält eine
Hier ist eine Beispielbatchantwort mit 1 erfolgreichen und 1 Ergebnis fehlgeschlagen: |
| RouteRequestRouteDirectionsBatch202Headers | |
| RouteRequestRouteDirectionsBatch202Response |
Die Asynchrone Batchanforderung übermittelnDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routenanforderungen.
Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung vornehmen, gibt der Dienst standardmäßig einen Antwortcode 202 entlang einer Umleitungs-URL im Feld "Speicherort" des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Die asynchronen Antworten werden für 24 Stunden gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird. Beachten Sie, dass die asynchrone Batchanforderung ein lang ausgeführter Vorgang ist. Hier ist eine typische Abfolge von Vorgängen:
POST-Text für BatchanforderungUm die Routenbeschreibungen Abfragen zu senden, verwenden Sie eine Eine Routenbeschreibung Abfrage in einem Batch ist nur eine partielle URL ohne Protokoll, Basis-URL, Pfad, API-Version und Abonnementschlüssel. Sie kann jede der unterstützten RoutenbeschreibungenURI-Parameterakzeptieren. Die Zeichenfolgenwerte in der Routenbeschreibung Abfrage müssen ordnungsgemäß escaped sein (z. B. " Zeichen sollte mit \ ) escapet werden, und sie sollte auch ordnungsgemäß URL-codiert sein. Mit der asynchronen API können Aufrufer bis zu 700 Abfragen und Synchronisierungs-API bis zu 100 Abfragen stapeln, und der Batch sollte mindestens 1 Abfrage enthalten. Asynchrone Batchergebnisse herunterladenUm die asynchronen Batchergebnisse herunterzuladen, geben Sie eine Dies ist die typische Abfolge von Vorgängen zum Herunterladen der Batchergebnisse:
BatchantwortmodellDer zurückgegebene Dateninhalt ist für asynchrone und Synchronisierungsanforderungen ähnlich. Wenn der Batch die Verarbeitung abgeschlossen hat, enthält der Antworttext beim Herunterladen der Ergebnisse einer asynchronen Batchanforderung die Batchantwort. Diese Batchantwort enthält eine
Hier ist eine Beispielbatchantwort mit 1 erfolgreichen und 1 Ergebnis fehlgeschlagen: |
| RouteRequestRouteDirectionsBatchBodyParam | |
| RouteRequestRouteDirectionsBatchMediaTypesParam | |
| RouteRequestRouteDirectionsBatchSync200Response |
Die Synchrone Batchanforderung übermittelnDie synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet er, sobald die Batchelemente berechnet werden, und es besteht keine Möglichkeit, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (eine 408-Antwort) zurück, wenn die Anforderung länger als 60 Sekunden dauert. Die Anzahl der Batchelemente ist auf 100 für diese API beschränkt. BatchantwortmodellDer zurückgegebene Dateninhalt ist für asynchrone und Synchronisierungsanforderungen ähnlich. Wenn der Batch die Verarbeitung abgeschlossen hat, enthält der Antworttext beim Herunterladen der Ergebnisse einer asynchronen Batchanforderung die Batchantwort. Diese Batchantwort enthält eine
Hier ist eine Beispielbatchantwort mit 1 erfolgreichen und 1 Ergebnis fehlgeschlagen: |
| RouteRequestRouteDirectionsBatchSync408Response |
Die Synchrone Batchanforderung übermittelnDie synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet er, sobald die Batchelemente berechnet werden, und es besteht keine Möglichkeit, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (eine 408-Antwort) zurück, wenn die Anforderung länger als 60 Sekunden dauert. Die Anzahl der Batchelemente ist auf 100 für diese API beschränkt. BatchantwortmodellDer zurückgegebene Dateninhalt ist für asynchrone und Synchronisierungsanforderungen ähnlich. Wenn der Batch die Verarbeitung abgeschlossen hat, enthält der Antworttext beim Herunterladen der Ergebnisse einer asynchronen Batchanforderung die Batchantwort. Diese Batchantwort enthält eine
Hier ist eine Beispielbatchantwort mit 1 erfolgreichen und 1 Ergebnis fehlgeschlagen: |
| RouteRequestRouteDirectionsBatchSyncBodyParam | |
| RouteRequestRouteDirectionsBatchSyncDefaultResponse |
Die Synchrone Batchanforderung übermittelnDie synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet er, sobald die Batchelemente berechnet werden, und es besteht keine Möglichkeit, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (eine 408-Antwort) zurück, wenn die Anforderung länger als 60 Sekunden dauert. Die Anzahl der Batchelemente ist auf 100 für diese API beschränkt. BatchantwortmodellDer zurückgegebene Dateninhalt ist für asynchrone und Synchronisierungsanforderungen ähnlich. Wenn der Batch die Verarbeitung abgeschlossen hat, enthält der Antworttext beim Herunterladen der Ergebnisse einer asynchronen Batchanforderung die Batchantwort. Diese Batchantwort enthält eine
Hier ist eine Beispielbatchantwort mit 1 erfolgreichen und 1 Ergebnis fehlgeschlagen: |
| RouteRequestRouteDirectionsBatchSyncMediaTypesParam | |
| RouteRequestRouteMatrix200Response |
Die Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Mit den berechneten Kosten können Sie ermitteln, welche detaillierten Routen mithilfe der Routenbeschreibungs-API berechnet werden sollen. Die maximale Größe einer Matrix für asynchrone Anforderung ist 700 und für die Synchronisierungsanforderung ist sie 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Hinweis Alle Ursprünge und Ziele sollten in einem achsenbündigen 400 km x 400 km umgebenden Feld enthalten sein. Andernfalls werden einige Matrixzellen als OUT_OF_REGION aufgelöst. Synchrone Routenmatrixanforderung übermittelnWenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie synchrone Anforderungen stellen. Die maximale Größe einer Matrix für diese API ist 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Bei dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein). Asynchrone Routenmatrixanforderung übermittelnDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung vornehmen, gibt der Dienst standardmäßig einen Antwortcode 202 entlang einer Umleitungs-URL im Feld "Speicherort" des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn Die maximale Größe einer Matrix für diese API ist 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 50x10, 10x10, 28 x 25. 10x70 (es muss nicht quadratisch sein). Die asynchronen Antworten werden für 24 Stunden gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird. Hier ist eine typische Abfolge asynchroner Vorgänge:
Synchronisierungsergebnisse herunterladenWenn Sie eine POST-Anforderung für die Route Matrix-Synchronisierungs-API vornehmen, gibt der Dienst den Antwortcode 200 für eine erfolgreiche Anforderung und ein Antwortarray zurück. Der Antworttext enthält die Daten, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen. Asynchrone Ergebnisse herunterladenWenn eine Anforderung eine Die vom Positionsheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine
|
| RouteRequestRouteMatrix202Headers | |
| RouteRequestRouteMatrix202Response |
Die Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Mit den berechneten Kosten können Sie ermitteln, welche detaillierten Routen mithilfe der Routenbeschreibungs-API berechnet werden sollen. Die maximale Größe einer Matrix für asynchrone Anforderung ist 700 und für die Synchronisierungsanforderung ist sie 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Hinweis Alle Ursprünge und Ziele sollten in einem achsenbündigen 400 km x 400 km umgebenden Feld enthalten sein. Andernfalls werden einige Matrixzellen als OUT_OF_REGION aufgelöst. Synchrone Routenmatrixanforderung übermittelnWenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie synchrone Anforderungen stellen. Die maximale Größe einer Matrix für diese API ist 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Bei dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein). Asynchrone Routenmatrixanforderung übermittelnDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung vornehmen, gibt der Dienst standardmäßig einen Antwortcode 202 entlang einer Umleitungs-URL im Feld "Speicherort" des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn Die maximale Größe einer Matrix für diese API ist 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 50x10, 10x10, 28 x 25. 10x70 (es muss nicht quadratisch sein). Die asynchronen Antworten werden für 24 Stunden gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird. Hier ist eine typische Abfolge asynchroner Vorgänge:
Synchronisierungsergebnisse herunterladenWenn Sie eine POST-Anforderung für die Route Matrix-Synchronisierungs-API vornehmen, gibt der Dienst den Antwortcode 200 für eine erfolgreiche Anforderung und ein Antwortarray zurück. Der Antworttext enthält die Daten, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen. Asynchrone Ergebnisse herunterladenWenn eine Anforderung eine Die vom Positionsheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine
|
| RouteRequestRouteMatrixBodyParam | |
| RouteRequestRouteMatrixMediaTypesParam | |
| RouteRequestRouteMatrixQueryParam | |
| RouteRequestRouteMatrixQueryParamProperties | |
| RouteRequestRouteMatrixSync200Response |
Die Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Mit den berechneten Kosten können Sie ermitteln, welche detaillierten Routen mithilfe der Routenbeschreibungs-API berechnet werden sollen. Die maximale Größe einer Matrix für asynchrone Anforderung ist 700 und für die Synchronisierungsanforderung ist sie 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Synchrone Routenmatrixanforderung übermittelnWenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie synchrone Anforderungen stellen. Die maximale Größe einer Matrix für diese API ist 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Bei dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein). Asynchrone Routenmatrixanforderung übermittelnDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung vornehmen, gibt der Dienst standardmäßig einen Antwortcode 202 entlang einer Umleitungs-URL im Feld "Speicherort" des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn Die maximale Größe einer Matrix für diese API ist 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 50x10, 10x10, 28 x 25. 10x70 (es muss nicht quadratisch sein). Die asynchronen Antworten werden für 24 Stunden gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird. Hier ist eine typische Abfolge asynchroner Vorgänge:
Synchronisierungsergebnisse herunterladenWenn Sie eine POST-Anforderung für die Route Matrix-Synchronisierungs-API vornehmen, gibt der Dienst den Antwortcode 200 für eine erfolgreiche Anforderung und ein Antwortarray zurück. Der Antworttext enthält die Daten, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen. Asynchrone Ergebnisse herunterladenWenn eine Anforderung eine Die vom Positionsheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine
|
| RouteRequestRouteMatrixSync408Response |
Die Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Mit den berechneten Kosten können Sie ermitteln, welche detaillierten Routen mithilfe der Routenbeschreibungs-API berechnet werden sollen. Die maximale Größe einer Matrix für asynchrone Anforderung ist 700 und für die Synchronisierungsanforderung ist sie 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Synchrone Routenmatrixanforderung übermittelnWenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie synchrone Anforderungen stellen. Die maximale Größe einer Matrix für diese API ist 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Bei dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein). Asynchrone Routenmatrixanforderung übermittelnDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung vornehmen, gibt der Dienst standardmäßig einen Antwortcode 202 entlang einer Umleitungs-URL im Feld "Speicherort" des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn Die maximale Größe einer Matrix für diese API ist 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 50x10, 10x10, 28 x 25. 10x70 (es muss nicht quadratisch sein). Die asynchronen Antworten werden für 24 Stunden gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird. Hier ist eine typische Abfolge asynchroner Vorgänge:
Synchronisierungsergebnisse herunterladenWenn Sie eine POST-Anforderung für die Route Matrix-Synchronisierungs-API vornehmen, gibt der Dienst den Antwortcode 200 für eine erfolgreiche Anforderung und ein Antwortarray zurück. Der Antworttext enthält die Daten, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen. Asynchrone Ergebnisse herunterladenWenn eine Anforderung eine Die vom Positionsheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine
|
| RouteRequestRouteMatrixSyncBodyParam | |
| RouteRequestRouteMatrixSyncDefaultResponse |
Die Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Mit den berechneten Kosten können Sie ermitteln, welche detaillierten Routen mithilfe der Routenbeschreibungs-API berechnet werden sollen. Die maximale Größe einer Matrix für asynchrone Anforderung ist 700 und für die Synchronisierungsanforderung ist sie 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Synchrone Routenmatrixanforderung übermittelnWenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie synchrone Anforderungen stellen. Die maximale Größe einer Matrix für diese API ist 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Bei dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein). Asynchrone Routenmatrixanforderung übermittelnDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung vornehmen, gibt der Dienst standardmäßig einen Antwortcode 202 entlang einer Umleitungs-URL im Feld "Speicherort" des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn Die maximale Größe einer Matrix für diese API ist 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixabmessungen: 50x10, 10x10, 28 x 25. 10x70 (es muss nicht quadratisch sein). Die asynchronen Antworten werden für 24 Stunden gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird. Hier ist eine typische Abfolge asynchroner Vorgänge:
Synchronisierungsergebnisse herunterladenWenn Sie eine POST-Anforderung für die Route Matrix-Synchronisierungs-API vornehmen, gibt der Dienst den Antwortcode 200 für eine erfolgreiche Anforderung und ein Antwortarray zurück. Der Antworttext enthält die Daten, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen. Asynchrone Ergebnisse herunterladenWenn eine Anforderung eine Die vom Positionsheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine
|
| RouteRequestRouteMatrixSyncMediaTypesParam | |
| RouteRequestRouteMatrixSyncQueryParam | |
| RouteRequestRouteMatrixSyncQueryParamProperties | |
| RouteSectionOutput |
Routenabschnitte enthalten zusätzliche Informationen zu Teilen einer Route. Jeder Abschnitt enthält mindestens die Elemente |
| RouteSectionTecCauseOutput |
Die Ursache des Datenverkehrsereignisses. Kann mainCauseCode- und subCauseCode-Elemente enthalten. Kann verwendet werden, um Symbolografie und Beschreibungen zu definieren. |
| RouteSectionTecOutput |
Details zum Datenverkehrsereignis mithilfe von Definitionen im TPEG2-TEC Standard. Kann effectCode enthalten und bewirkt Elemente. |
| RouteSummaryOutput |
Summary-Objekt |
| Routes | |
| SimplePollerLike |
Ein einfacher Poller, der zum Abrufen eines vorgangs mit langer Ausführung verwendet werden kann. |
Typaliase
| GeoJsonGeometry |
Ein gültiges |
| GeoJsonObject |
Ein gültiges |
| MapsRouteClient | |
| RouteGetRouteDirectionsBatchParameters | |
| RouteGetRouteDirectionsParameters | |
| RouteGetRouteDirectionsWithAdditionalParametersParameters | |
| RouteGetRouteMatrixParameters | |
| RouteGetRouteRangeParameters | |
| RouteRequestRouteDirectionsBatchParameters | |
| RouteRequestRouteDirectionsBatchSyncParameters | |
| RouteRequestRouteMatrixParameters | |
| RouteRequestRouteMatrixSyncParameters | |
Functions
| build |
|
| create |
Erstellen Sie einen Batchanforderungstext einer Reihe von Routenrichtungsanforderungen. |
| default(Azure |
Erstellt eine Instanz von MapsRouteClient aus einem Abonnementschlüssel. Beispiel |
| default(Token |
Erstellt eine Instanz von MapsRoute aus einer Azure Identity Beispiel |
| default(Azure |
Erstellt eine Instanz von MapsRoute aus einer Azure Identity Beispiel |
| get |
Hilfsfunktion, mit der ein Poller-Objekt erstellt wird, um einen vorgang mit langer Ausführung abzufragen. |
| is |
|
| is |
|
| is |
|
| is |
|
| is |
|
| to |
Transformieren Sie ein Array von [Latitude, Longtitute] in eine Zeichenfolge im folgenden Format: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..." |
Details zur Funktion
buildMultiCollection(string[], string)
function buildMultiCollection(items: string[], parameterName: string): stringParameter
- items
-
string[]
- parameterName
-
string
Gibt zurück
string
createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])
Erstellen Sie einen Batchanforderungstext einer Reihe von Routenrichtungsanforderungen.
function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequestParameter
- queryParamProperties
Ein Objekt der Abfrageparameter für eine Routenrichtungsanforderung
Gibt zurück
Die zusammengesetzte Batchanforderung.
default(AzureKeyCredential, ClientOptions)
Erstellt eine Instanz von MapsRouteClient aus einem Abonnementschlüssel.
Beispiel
import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";
const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);
function default(credential: AzureKeyCredential, options?: ClientOptions): MapsRouteClientParameter
- credential
- AzureKeyCredential
Eine AzureKeyCredential-Instanz, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird
- options
- ClientOptions
Optionen zum Konfigurieren des Routingclients
Gibt zurück
default(TokenCredential, string, ClientOptions)
Erstellt eine Instanz von MapsRoute aus einer Azure Identity TokenCredential.
Beispiel
import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");
function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRouteClientParameter
- credential
- TokenCredential
Eine TokenCredential-Instanz, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird
- mapsAccountClientId
-
string
Die Azure Maps-Client-ID einer bestimmten Kartenressource
- options
- ClientOptions
Optionen zum Konfigurieren des Routingclients
Gibt zurück
default(AzureSASCredential, ClientOptions)
Erstellt eine Instanz von MapsRoute aus einer Azure Identity AzureSASCredential.
Beispiel
import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";
const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);
function default(credential: AzureSASCredential, options?: ClientOptions): MapsRouteClientParameter
- credential
- AzureSASCredential
Eine AzureSASCredential-Instanz, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird
- options
- ClientOptions
Optionen zum Konfigurieren des Routingclients
Gibt zurück
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Hilfsfunktion, mit der ein Poller-Objekt erstellt wird, um einen vorgang mit langer Ausführung abzufragen.
function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>Parameter
- client
- Client
Client, der zum Senden der Anforderung zum Abrufen zusätzlicher Seiten verwendet werden soll.
- initialResponse
-
TResult
Die erste Antwort.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Optionen zum Festlegen eines Fortsetzungszustands oder eines benutzerdefinierten Abrufintervalls.
Gibt zurück
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- Ein Poller-Objekt zum Abrufen von Vorgangsstatusaktualisierungen und schließlich zum Abrufen der endgültigen Antwort.
isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
function isUnexpected(response: RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse): responseParameter
Gibt zurück
response
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): responseParameter
Gibt zurück
response
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): responseParameter
Gibt zurück
response
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): responseParameter
Gibt zurück
response
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
function isUnexpected(response: RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse): responseParameter
Gibt zurück
response
toColonDelimitedLatLonString(LatLon[])
Transformieren Sie ein Array von [Latitude, Longtitute] in eine Zeichenfolge im folgenden Format: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."
function toColonDelimitedLatLonString(coordinates: LatLon[]): stringParameter
- coordinates
-
LatLon[]
Ein Array von Latitude/Longtitute-Paar, das transformiert werden soll.
Gibt zurück
string
Die transformierte Zeichenfolge.
Azure SDK for JavaScript