@azure-rest/maps-route package
Schnittstellen
BatchRequest |
Dieser Typ stellt den Anforderungstext für den Batch-Dienst dar. |
BatchRequestItem |
Batch-Anforderungsobjekt |
BatchResultItemOutput |
Ein von der Batch-API zurückgegebenes Element. Erweitern Sie mit der Eigenschaft "response". |
BatchResultOutput |
Dieses Objekt wird von einem erfolgreichen Batch-Dienstaufruf zurückgegeben. Erweitern Sie mit der Eigenschaft "batchItems". |
BatchResultSummaryOutput |
Zusammenfassung der Ergebnisse für die Batchanforderung |
EffectiveSettingOutput |
Effektive Parameter oder Daten, die beim Aufrufen dieser Routen-API verwendet werden. |
ErrorDetailOutput |
Die Fehlerdetails. |
ErrorResponseOutput |
Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (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 Standort, der als Breiten- und Längengrad dargestellt wird. |
RequestRouteDirectionsBatch | |
RequestRouteDirectionsBatchSync | |
RequestRouteMatrix | |
RequestRouteMatrixSync | |
RouteDirectionParameters |
Posttextparameter für Routenrichtungen. |
RouteDirectionsBatchItemOutput |
Ein Element, das vom Batch-Dienstaufruf "Route Directions" zurückgegeben wird. |
RouteDirectionsBatchItemResponseOutput |
Das Ergebnis der Abfrage. RouteDirections, wenn die Abfrage erfolgreich abgeschlossen wurde, ErrorResponse andernfalls. |
RouteDirectionsBatchResultOutput |
Dieses Objekt wird von einem erfolgreichen Batch-Dienstaufruf für Routenanweisungen zurückgegeben. |
RouteDirectionsOutput |
Dieses Objekt wird von einem erfolgreichen Routenanweisungsaufruf zurückgegeben. |
RouteGetRouteDirections200Response |
Gilt für: Siehe Tarife. Gibt eine Route zwischen einem Ursprung und einem Ziel zurück und durchläuft Wegpunkte, sofern sie angegeben sind. Die Route berücksichtigt Faktoren wie den aktuellen Verkehr und die typischen Straßengeschwindigkeiten am gewünschten Wochentag und zur Tageszeit. Die zurückgegebenen Informationen umfassen die Entfernung, die geschätzte Reisezeit und eine Darstellung der Routengeometrie. Zusätzliche Routinginformationen wie optimierte Wegpunktreihenfolge oder Turn-by-Turn-Anweisungen sind ebenfalls verfügbar, abhängig von den ausgewählten Optionen. Der Routingdienst bietet eine Reihe von Parametern für eine detaillierte Beschreibung des fahrzeugspezifischen Verbrauchsmodells. Überprüfen Sie das Verbrauchsmodell , um die konzepte und parameter ausführlich zu erläutern. |
RouteGetRouteDirectionsBatch200Response |
Gilt für: Siehe Tarife. Herunterladen asynchroner BatchergebnisseZum Herunterladen der asynchronen Batchergebnisse stellen Sie eine
Hier sehen Sie die typische Abfolge von Vorgängen zum Herunterladen der Batchergebnisse:
BatchantwortmodellDer zurückgegebene Dateninhalt ähnelt für asynchrone Anforderungen und Synchronisierungsanforderungen. Wenn die Ergebnisse einer asynchronen Batchanforderung heruntergeladen werden, enthält der Antworttext die Batchantwort, wenn die Verarbeitung abgeschlossen ist. Diese Batchantwort enthält eine
Hier sehen Sie eine Beispiel-Batchantwort mit 1 erfolgreichem und 1 fehlgeschlagenem Ergebnis:
|
RouteGetRouteDirectionsBatch202Headers | |
RouteGetRouteDirectionsBatch202Response |
Gilt für: Siehe Tarife. Herunterladen asynchroner BatchergebnisseZum Herunterladen der asynchronen Batchergebnisse stellen Sie eine
Hier sehen Sie die typische Abfolge von Vorgängen zum Herunterladen der Batchergebnisse:
BatchantwortmodellDer zurückgegebene Dateninhalt ist für asynchrone und Synchronisierungsanforderungen ähnlich. Wenn die Verarbeitung des Batches abgeschlossen ist, enthält der Antworttext beim Herunterladen der Ergebnisse einer asynchronen Batchanforderung die Batchantwort. Diese Batchantwort enthält eine
Hier sehen Sie ein Beispiel für eine Batchantwort mit 1 erfolgreichem ergebnis und 1 fehlgeschlagenem Ergebnis:
|
RouteGetRouteDirectionsDefaultResponse |
Gilt für: Siehe Tarife. Gibt eine Route zwischen einem Ursprung und einem Ziel zurück, wobei Wegpunkte durchlaufen werden, sofern diese angegeben sind. Die Route berücksichtigt Faktoren wie den aktuellen Verkehr und die typischen Straßengeschwindigkeiten am angeforderten Wochentag und der gewünschten Tageszeit. Die zurückgegebenen Informationen umfassen die Entfernung, die geschätzte Reisezeit und eine Darstellung der Routengeometrie. Abhängig von den ausgewählten Optionen stehen auch zusätzliche Routinginformationen wie optimierte Wegpunktreihenfolge oder Turn by Turn-Anweisungen zur Verfügung. Der Routingdienst bietet eine Reihe von Parametern für eine detaillierte Beschreibung des fahrzeugspezifischen Verbrauchsmodells. Überprüfen Sie das Verbrauchsmodell , um detaillierte Erläuterungen der betreffenden Konzepte und Parameter zu finden. |
RouteGetRouteDirectionsQueryParam | |
RouteGetRouteDirectionsQueryParamProperties | |
RouteGetRouteDirectionsWithAdditionalParameters200Response |
Gilt für: Siehe Tarife. Gibt eine Route zwischen einem Ursprung und einem Ziel zurück, wobei Wegpunkte durchlaufen werden, sofern diese angegeben sind. Die Route berücksichtigt Faktoren wie den aktuellen Verkehr und die typischen Straßengeschwindigkeiten am angeforderten Wochentag und der gewünschten Tageszeit. Die zurückgegebenen Informationen umfassen die Entfernung, die geschätzte Reisezeit und eine Darstellung der Routengeometrie. Abhängig von den ausgewählten Optionen stehen auch zusätzliche Routinginformationen wie optimierte Wegpunktreihenfolge oder Turn by Turn-Anweisungen zur Verfügung. Der Routingdienst bietet eine Reihe von Parametern für eine detaillierte Beschreibung eines fahrzeugspezifischen Verbrauchsmodells. Überprüfen Sie das Verbrauchsmodell , um detaillierte Erläuterungen der betreffenden Konzepte und Parameter zu finden. |
RouteGetRouteDirectionsWithAdditionalParametersBodyParam | |
RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse |
Gilt für: Siehe Tarife. Gibt eine Route zwischen einem Ursprung und einem Ziel zurück, wobei Wegpunkte durchlaufen werden, sofern diese angegeben sind. Die Route berücksichtigt Faktoren wie den aktuellen Verkehr und die typischen Straßengeschwindigkeiten am angeforderten Wochentag und der gewünschten Tageszeit. Die zurückgegebenen Informationen umfassen die Entfernung, die geschätzte Reisezeit und eine Darstellung der Routengeometrie. Abhängig von den ausgewählten Optionen stehen auch zusätzliche Routinginformationen wie optimierte Wegpunktreihenfolge oder Turn by Turn-Anweisungen zur Verfügung. Der Routingdienst bietet eine Reihe von Parametern für eine detaillierte Beschreibung eines fahrzeugspezifischen Verbrauchsmodells. Überprüfen Sie das Verbrauchsmodell , um detaillierte Erläuterungen der betreffenden Konzepte und Parameter zu finden. |
RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam | |
RouteGetRouteDirectionsWithAdditionalParametersQueryParam | |
RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties | |
RouteGetRouteMatrix200Response |
Gilt für: Siehe Tarife. Wenn die Matrixroutenanforderung erfolgreich akzeptiert wurde, enthält der Location-Header in der Antwort die URL zum Herunterladen der Ergebnisse der Anforderung. Dieser status URI sieht wie folgt aus:
Herunterladen von SynchronisierungsergebnissenWenn Sie eine POST-Anforderung für die Routenmatrixsynchronisierungs-API durchführen, 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. Herunterladen von Asynchronen ErgebnissenWenn eine Anforderung eine
Die vom Standortheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine
|
RouteGetRouteMatrix202Headers | |
RouteGetRouteMatrix202Response |
Gilt für: Siehe Tarife. Wenn die Matrixroutenanforderung erfolgreich akzeptiert wurde, enthält der Location-Header in der Antwort die URL zum Herunterladen der Ergebnisse der Anforderung. Dieser status URI sieht wie folgt aus:
Herunterladen von SynchronisierungsergebnissenWenn Sie eine POST-Anforderung für die Routenmatrixsynchronisierungs-API durchführen, 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. Herunterladen von Asynchronen ErgebnissenWenn eine Anforderung eine
Die vom Standortheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine
|
RouteGetRouteRange200Response |
Routenbereichs-API (Isochrone) Gilt für: Siehe Tarife. Dieser Dienst berechnet eine Reihe von Standorten, die vom Ursprungspunkt aus erreicht werden können, basierend auf dem angegebenen Kraftstoff-, Energie-, Zeit- oder Entfernungsbudget. Eine Polygongrenze (oder Isochrone) wird in einer Ausrichtung gegen den Uhrzeigersinn sowie dem genauen Polygonmittelpunkt zurückgegeben, der das Ergebnis des Ursprungspunkts war. Das zurückgegebene Polygon kann für die weitere Verarbeitung verwendet werden, z . B. "Innerhalb der Geometrie suchen", um innerhalb der bereitgestellten Isochrone nach POIs zu suchen. |
RouteGetRouteRangeDefaultResponse |
Routenbereichs-API (Isochrone) Gilt für: Siehe Tarife. Dieser Dienst berechnet eine Reihe von Standorten, die vom Ursprungspunkt aus erreicht werden können, basierend auf dem angegebenen Kraftstoff-, Energie-, Zeit- oder Entfernungsbudget. Eine Polygongrenze (oder Isochrone) wird in einer Ausrichtung gegen den Uhrzeigersinn sowie dem genauen Polygonmittelpunkt zurückgegeben, der das Ergebnis des Ursprungspunkts war. Das zurückgegebene Polygon kann für die weitere Verarbeitung verwendet werden, z . B. "Innerhalb der Geometrie suchen", um innerhalb der bereitgestellten Isochrone nach POIs zu suchen. |
RouteGetRouteRangeQueryParam | |
RouteGetRouteRangeQueryParamProperties | |
RouteGuidanceOutput |
Enthält anleitungsbezogene Elemente. Dieses Feld ist nur vorhanden, wenn eine Anleitung angefordert wurde und verfügbar ist. |
RouteInstructionGroupOutput |
Gruppiert eine Sequenz von Anweisungselementen, die miteinander verknüpft sind. Der Sequenzbereich ist durch firstInstructionIndex und lastInstructionIndex eingeschränkt. Wenn lesbare Textnachrichten zur Anleitung angefordert werden (instructionType=text oder tagged), erhält die instructionGroup eine Zusammenfassungsmeldung, wenn sie verfügbar ist. |
RouteInstructionOutput |
Eine Reihe von Attributen, die ein Manöver beschreiben, z. B. "Rechts abbiegen", "Links halten", "Fähre nehmen", "Autobahn nehmen", "Ankommen". |
RouteLegOutput |
Eine Beschreibung eines Teils einer Route, bestehend aus einer Liste von Punkten. Jeder zusätzliche Wegpunkt, der in der Anforderung angegeben wird, führt zu einer zusätzlichen Etappe auf 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 angegeben werden, werden zwei Arrays mit jeweils drei Elementen verwendet. Der Inhalt jedes Elements hängt von den in der Abfrage bereitgestellten Optionen ab. |
RouteMatrixResultResponseOutput |
Antwortobjekt der aktuellen Zelle in der Eingabematrix. |
RouteMatrixSummaryOutput |
Summary-Objekt |
RouteOptimizedWaypointOutput |
Optimiertes Wegepunktobjekt. |
RouteOutput | |
RouteRangeOutput |
Erreichbarer Bereich |
RouteRangeResultOutput |
Dieses Objekt wird von einem erfolgreichen Aufruf von Route Reachable Range zurückgegeben. |
RouteReportOutput |
Meldet die effektiven Einstellungen, die im aktuellen Aufruf verwendet werden. |
RouteRequestRouteDirectionsBatch200Response |
Batch-API für Routenbeschreibungen Gilt für: Siehe Tarife. Die Route Directions Batch-API sendet Batches von Abfragen an die Routenbeschreibungs-API mit nur einem einzelnen API-Aufruf. Sie können die Batch-API für Routenanweisungen aufrufen, um entweder asynchron (asynchron) oder synchron (Synchronisierung) auszuführen. Die asynchrone API ermöglicht dem Aufrufer das Batchen von bis zu 700 Abfragen und die Synchronisierung der API mit bis zu 100 Abfragen. Übermitteln einer asynchronen BatchanforderungDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routenanforderungen.
Wenn Sie eine Anforderung mithilfe der asynchronen Anforderung stellen, gibt der Dienst standardmäßig einen 202-Antwortcode 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 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine Antwort 404 zurück, wenn sie nach dem Ablaufzeitraum verwendet wird. Beachten Sie, dass es sich bei der asynchronen Batchanforderung um eine Anforderung mit langer Ausführungsdauer handelt. Hier sehen Sie eine typische Abfolge von Vorgängen:
POST-Text für BatchanforderungZum Senden der Routenbeschreibungsabfragen verwenden Sie eine
Eine Routenbeschreibungsabfrage in einem Batch ist nur eine partielle URL ohne Protokoll, Basis-URL, Pfad, api-Version und Abonnementschlüssel. Er kann alle unterstützten Routenbeschreibungs-URI-Parameter akzeptieren. Die Zeichenfolgenwerte in der Routenbeschreibungsabfrage müssen ordnungsgemäß mit Escapezeichen versehen sein (z. B. "zeichen sollte mit \ ) gekennzeichnet werden, und es sollte auch ordnungsgemäß URL-codiert sein. Die asynchrone API ermöglicht dem Aufrufer das Batchieren von bis zu 700 Abfragen und die Synchronisierungs-API mit bis zu 100 Abfragen. Der Batch sollte mindestens eine Abfrage enthalten. Herunterladen asynchroner BatchergebnisseZum Herunterladen der asynchronen Batchergebnisse stellen Sie eine
Hier sehen Sie die typische Abfolge von Vorgängen zum Herunterladen der Batchergebnisse:
BatchantwortmodellDer zurückgegebene Dateninhalt ähnelt für asynchrone Anforderungen und Synchronisierungsanforderungen. Wenn die Ergebnisse einer asynchronen Batchanforderung heruntergeladen werden, enthält der Antworttext die Batchantwort, wenn die Verarbeitung abgeschlossen ist. Diese Batchantwort enthält eine
Hier sehen Sie eine Beispiel-Batchantwort mit 1 erfolgreichem und 1 fehlgeschlagenem Ergebnis:
|
RouteRequestRouteDirectionsBatch202Headers | |
RouteRequestRouteDirectionsBatch202Response |
Batch-API für Routenbeschreibungen Gilt für: Siehe Tarife. Die Route Directions Batch-API sendet Batches von Abfragen an die Routenbeschreibungs-API mit nur einem einzelnen API-Aufruf. Sie können die Batch-API für Routenanweisungen aufrufen, um entweder asynchron (asynchron) oder synchron (Synchronisierung) auszuführen. Die asynchrone API ermöglicht dem Aufrufer das Batchen von bis zu 700 Abfragen und die Synchronisierung der API mit bis zu 100 Abfragen. Übermitteln einer asynchronen BatchanforderungDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routenanforderungen.
Wenn Sie eine Anforderung mithilfe der asynchronen Anforderung stellen, gibt der Dienst standardmäßig einen 202-Antwortcode 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 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine Antwort 404 zurück, wenn sie nach dem Ablaufzeitraum verwendet wird. Beachten Sie, dass es sich bei der asynchronen Batchanforderung um eine Anforderung mit langer Ausführungsdauer handelt. Hier sehen Sie eine typische Abfolge von Vorgängen:
POST-Text für BatchanforderungZum Senden der Routenbeschreibungsabfragen verwenden Sie eine
Eine Routenbeschreibungsabfrage in einem Batch ist nur eine partielle URL ohne Protokoll, Basis-URL, Pfad, api-Version und Abonnementschlüssel. Er kann alle unterstützten Routenbeschreibungs-URI-Parameter akzeptieren. Die Zeichenfolgenwerte in der Routenbeschreibungsabfrage müssen ordnungsgemäß mit Escapezeichen versehen sein (z. B. "zeichen sollte mit \ ) gekennzeichnet werden, und es sollte auch ordnungsgemäß URL-codiert sein. Die asynchrone API ermöglicht dem Aufrufer das Batchieren von bis zu 700 Abfragen und die Synchronisierungs-API mit bis zu 100 Abfragen. Der Batch sollte mindestens eine Abfrage enthalten. Herunterladen asynchroner BatchergebnisseZum Herunterladen der asynchronen Batchergebnisse stellen Sie eine
Hier sehen Sie die typische Abfolge von Vorgängen zum Herunterladen der Batchergebnisse:
BatchantwortmodellDer zurückgegebene Dateninhalt ähnelt für asynchrone Anforderungen und Synchronisierungsanforderungen. Wenn die Ergebnisse einer asynchronen Batchanforderung heruntergeladen werden, enthält der Antworttext die Batchantwort, wenn die Verarbeitung abgeschlossen ist. Diese Batchantwort enthält eine
Hier sehen Sie eine Beispiel-Batchantwort mit 1 erfolgreichem und 1 fehlgeschlagenem Ergebnis:
|
RouteRequestRouteDirectionsBatchBodyParam | |
RouteRequestRouteDirectionsBatchMediaTypesParam | |
RouteRequestRouteDirectionsBatchSync200Response |
Batch-API für Routenbeschreibungen Gilt für: Siehe Tarife. Die Route Directions Batch-API sendet Batches von Abfragen an die Routenbeschreibungs-API mit nur einem einzelnen API-Aufruf. Sie können die Batch-API für Routenanweisungen aufrufen, um entweder asynchron (asynchron) oder synchron (Synchronisierung) auszuführen. Die asynchrone API ermöglicht dem Aufrufer das Batchen von bis zu 700 Abfragen und die Synchronisierung der API mit bis zu 100 Abfragen. Senden einer synchronen BatchanforderungDie synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet er, sobald die Batchelemente berechnet wurden, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (408-Antwort) zurück, wenn die Anforderung länger als 60 Sekunden dauert. Die Anzahl der Batchelemente ist für diese API auf 100 beschränkt.
BatchantwortmodellDer zurückgegebene Dateninhalt ähnelt für asynchrone Anforderungen und Synchronisierungsanforderungen. Wenn die Ergebnisse einer asynchronen Batchanforderung heruntergeladen werden, enthält der Antworttext die Batchantwort, wenn die Verarbeitung abgeschlossen ist. Diese Batchantwort enthält eine
Hier sehen Sie eine Beispiel-Batchantwort mit 1 erfolgreichem und 1 fehlgeschlagenem Ergebnis:
|
RouteRequestRouteDirectionsBatchSync408Response |
Batch-API für Routenbeschreibungen Gilt für: Siehe Tarife. Die Route Directions Batch-API sendet Batches von Abfragen an die Routenbeschreibungs-API mit nur einem einzelnen API-Aufruf. Sie können die Batch-API für Routenanweisungen aufrufen, um entweder asynchron (asynchron) oder synchron (Synchronisierung) auszuführen. Die asynchrone API ermöglicht dem Aufrufer das Batchen von bis zu 700 Abfragen und die Synchronisierung der API mit bis zu 100 Abfragen. Senden einer synchronen BatchanforderungDie synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet er, sobald die Batchelemente berechnet wurden, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (408-Antwort) zurück, wenn die Anforderung länger als 60 Sekunden dauert. Die Anzahl der Batchelemente ist für diese API auf 100 beschränkt.
BatchantwortmodellDer zurückgegebene Dateninhalt ähnelt für asynchrone Anforderungen und Synchronisierungsanforderungen. Wenn die Ergebnisse einer asynchronen Batchanforderung heruntergeladen werden, enthält der Antworttext die Batchantwort, wenn die Verarbeitung abgeschlossen ist. Diese Batchantwort enthält eine
Hier sehen Sie eine Beispiel-Batchantwort mit 1 erfolgreichem und 1 fehlgeschlagenem Ergebnis:
|
RouteRequestRouteDirectionsBatchSyncBodyParam | |
RouteRequestRouteDirectionsBatchSyncDefaultResponse |
Batch-API für Routenbeschreibungen Gilt für: Siehe Tarife. Die Route Directions Batch-API sendet Batches von Abfragen an die Routenbeschreibungs-API mit nur einem einzelnen API-Aufruf. Sie können die Batch-API für Routenanweisungen aufrufen, um entweder asynchron (asynchron) oder synchron (Synchronisierung) auszuführen. Die asynchrone API ermöglicht dem Aufrufer das Batchen von bis zu 700 Abfragen und die Synchronisierung der API mit bis zu 100 Abfragen. Senden einer synchronen BatchanforderungDie synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet er, sobald die Batchelemente berechnet wurden, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (408-Antwort) zurück, wenn die Anforderung länger als 60 Sekunden dauert. Die Anzahl der Batchelemente ist für diese API auf 100 beschränkt.
BatchantwortmodellDer zurückgegebene Dateninhalt ähnelt für asynchrone Anforderungen und Synchronisierungsanforderungen. Wenn die Ergebnisse einer asynchronen Batchanforderung heruntergeladen werden, enthält der Antworttext die Batchantwort, wenn die Verarbeitung abgeschlossen ist. Diese Batchantwort enthält eine
Hier sehen Sie eine Beispiel-Batchantwort mit 1 erfolgreichem und 1 fehlgeschlagenem Ergebnis:
|
RouteRequestRouteDirectionsBatchSyncMediaTypesParam | |
RouteRequestRouteMatrix200Response |
Gilt für: Siehe Tarife. Der Matrixroutingdienst ermöglicht die Berechnung einer Matrix von Routenzusammenfassungen für eine Gruppe von Routen, die von Ursprungs- und Zielstandorten definiert sind, indem eine asynchrone (asynchrone) oder synchrone (Synchronisierung) POST-Anforderung verwendet wird. Für jeden angegebenen Ursprung berechnet der Dienst die Kosten für das Routing von diesem Ursprung zu jedem angegebenen Ziel. Die Gruppe der Ursprünge und die Gruppe der Ziele können 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 zum Ziel für diese Zelle. Angenommen, ein Lebensmittellieferunternehmen hat 20 Fahrer und muss den nächstgelegenen Fahrer finden, um die Lieferung im Restaurant abzuholen. Um diesen Anwendungsfall zu beheben, können sie die Matrixroute-API aufrufen. Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Mithilfe der berechneten Kosten können Sie mithilfe der Routenbeschreibungs-API ermitteln, welche detaillierten Routen berechnet werden sollen. Die maximale Größe einer Matrix für eine asynchrone Anforderung beträgt 700 und für Synchronisierungsanforderung 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Übermitteln synchroner RoutenmatrixanforderungWenn 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 beträgt 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein).
Übermitteln einer asynchronen RoutenmatrixanforderungDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe der asynchronen Anforderung stellen, gibt der Dienst standardmäßig einen 202-Antwortcode 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 beträgt 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 50x10, 10x10, 28x25. 10x70 (es muss nicht quadratisch sein). Die asynchronen Antworten werden 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine Antwort 404 zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.
Hier sehen Sie eine typische Abfolge asynchroner Vorgänge:
Herunterladen von SynchronisierungsergebnissenWenn Sie eine POST-Anforderung für die Routenmatrixsynchronisierungs-API durchführen, 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. Herunterladen von Asynchronen ErgebnissenWenn eine Anforderung eine
Die vom Standortheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine
|
RouteRequestRouteMatrix202Headers | |
RouteRequestRouteMatrix202Response |
Gilt für: Siehe Tarife. Der Matrixroutingdienst ermöglicht die Berechnung einer Matrix von Routenzusammenfassungen für eine Gruppe von Routen, die durch Ursprungs- und Zielstandorte definiert sind, indem eine asynchrone (asynchrone) oder synchrone POST-Anforderung verwendet wird. Für jeden bestimmten Ursprung berechnet der Dienst die Kosten für das Routing von diesem Ursprung zu jedem bestimmten Ziel. Der Satz der Ursprünge 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 zum Ziel für diese Zelle. Angenommen, ein Lebensmittellieferunternehmen hat 20 Fahrer und muss den nächstgelegenen Fahrer finden, um die Lieferung im Restaurant abzuholen. Um diesen Anwendungsfall zu lösen, können sie die Matrixroute-API aufrufen. Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Sie können die berechneten Kosten verwenden, um zu bestimmen, welche detaillierten Routen mithilfe der Routenbeschreibungs-API berechnet werden sollen. Die maximale Größe einer Matrix für eine asynchrone Anforderung beträgt 700 und für Synchronisierungsanforderungen 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Übermitteln einer synchronen RoutenmatrixanforderungWenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie eine synchrone Anforderung durchführen. Die maximale Größe einer Matrix für diese API beträgt 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein).
Übermitteln einer asynchronen RoutenmatrixanforderungDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung erstellen, gibt der Dienst standardmäßig den Antwortcode 202 entlang einer Umleitungs-URL im Feld Speicherort des Antwortheaders zurück. Diese URL sollte in regelmäßigen Abständen überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn Die maximale Größe einer Matrix für diese API beträgt 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 50x10, 10x10, 28x25. 10x70 (es muss nicht quadratisch sein). Die asynchronen Antworten werden 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.
Dies ist eine typische Abfolge von asynchronen Vorgängen:
Herunterladen von SynchronisierungsergebnissenWenn Sie eine POST-Anforderung für die Routenmatrixsynchronisierungs-API durchführen, 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. Herunterladen von Asynchronen ErgebnissenWenn eine Anforderung eine
Die vom Standortheader bereitgestellte URL gibt die folgenden Antworten zurück, wenn eine
|
RouteRequestRouteMatrixBodyParam | |
RouteRequestRouteMatrixMediaTypesParam | |
RouteRequestRouteMatrixQueryParam | |
RouteRequestRouteMatrixQueryParamProperties | |
RouteRequestRouteMatrixSync200Response |
Gilt für: Siehe Tarife. Der Matrixroutingdienst ermöglicht die Berechnung einer Matrix von Routenzusammenfassungen für eine Gruppe von Routen, die durch Ursprungs- und Zielstandorte definiert sind, indem eine asynchrone (asynchrone) oder synchrone POST-Anforderung verwendet wird. Für jeden bestimmten Ursprung berechnet der Dienst die Kosten für das Routing von diesem Ursprung zu jedem bestimmten Ziel. Der Satz der Ursprünge 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 zum Ziel für diese Zelle. Angenommen, ein Lebensmittellieferunternehmen hat 20 Fahrer und muss den nächstgelegenen Fahrer finden, um die Lieferung im Restaurant abzuholen. Um diesen Anwendungsfall zu lösen, können sie die Matrixroute-API aufrufen. Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Sie können die berechneten Kosten verwenden, um zu bestimmen, welche detaillierten Routen mithilfe der Routenbeschreibungs-API berechnet werden sollen. Die maximale Größe einer Matrix für eine asynchrone Anforderung beträgt 700 und für Synchronisierungsanforderungen 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Übermitteln einer synchronen RoutenmatrixanforderungWenn Ihr Szenario synchrone Anforderungen erfordert und die maximale Größe der Matrix kleiner oder gleich 100 ist, sollten Sie eine synchrone Anforderung durchführen. Die maximale Größe einer Matrix für diese API beträgt 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein).
Übermitteln einer asynchronen RoutenmatrixanforderungDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe einer asynchronen Anforderung erstellen, gibt der Dienst standardmäßig den Antwortcode 202 entlang einer Umleitungs-URL im Feld Speicherort des Antwortheaders zurück. Diese URL sollte in regelmäßigen Abständen überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Wenn Die maximale Größe einer Matrix für diese API beträgt 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 50x10, 10x10, 28x25. 10x70 (es muss nicht quadratisch sein). Die asynchronen Antworten werden 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine 404-Antwort zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.
Dies ist eine typische Abfolge von asynchronen Vorgängen:
Herunterladen von SynchronisierungsergebnissenWenn Sie eine POST-Anforderung für die Routenmatrixsynchronisierungs-API durchführen, 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. Herunterladen von Asynchronen ErgebnissenWenn eine Anforderung eine
Die vom Standortheader angegebene URL gibt die folgenden Antworten zurück, wenn eine
|
RouteRequestRouteMatrixSync408Response |
Gilt für: Siehe Tarife. Der Matrixroutingdienst ermöglicht die Berechnung einer Matrix von Routenzusammenfassungen für eine Gruppe von Routen, die von Ursprungs- und Zielstandorten definiert sind, indem eine asynchrone (asynchrone) oder synchrone (Synchronisierung) POST-Anforderung verwendet wird. Für jeden angegebenen Ursprung berechnet der Dienst die Kosten für das Routing von diesem Ursprung zu jedem angegebenen Ziel. Die Gruppe der Ursprünge und die Gruppe der Ziele können 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 zum Ziel für diese Zelle. Angenommen, ein Lebensmittellieferunternehmen hat 20 Fahrer und muss den nächstgelegenen Fahrer finden, um die Lieferung im Restaurant abzuholen. Um diesen Anwendungsfall zu beheben, können sie die Matrixroute-API aufrufen. Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Mithilfe der berechneten Kosten können Sie mithilfe der Routenbeschreibungs-API ermitteln, welche detaillierten Routen berechnet werden sollen. Die maximale Größe einer Matrix für eine asynchrone Anforderung beträgt 700 und für Synchronisierungsanforderung 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Übermitteln synchroner RoutenmatrixanforderungWenn 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 beträgt 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein).
Übermitteln einer asynchronen RoutenmatrixanforderungDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe der asynchronen Anforderung stellen, gibt der Dienst standardmäßig einen 202-Antwortcode 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 beträgt 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 50x10, 10x10, 28x25. 10x70 (es muss nicht quadratisch sein). Die asynchronen Antworten werden 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine Antwort 404 zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.
Hier sehen Sie eine typische Abfolge asynchroner Vorgänge:
Herunterladen von SynchronisierungsergebnissenWenn Sie eine POST-Anforderung für die Routenmatrixsynchronisierungs-API stellen, gibt der Dienst 200 Antwortcode 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 Standortheader angegebene URL gibt die folgenden Antworten zurück, wenn eine
|
RouteRequestRouteMatrixSyncBodyParam | |
RouteRequestRouteMatrixSyncDefaultResponse |
Gilt für: Siehe Tarife. Der Matrixroutingdienst ermöglicht die Berechnung einer Matrix von Routenzusammenfassungen für eine Gruppe von Routen, die von Ursprungs- und Zielstandorten definiert sind, indem eine asynchrone (asynchrone) oder synchrone (Synchronisierung) POST-Anforderung verwendet wird. Für jeden angegebenen Ursprung berechnet der Dienst die Kosten für das Routing von diesem Ursprung zu jedem angegebenen Ziel. Die Gruppe der Ursprünge und die Gruppe der Ziele können 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 zum Ziel für diese Zelle. Angenommen, ein Lebensmittellieferunternehmen hat 20 Fahrer und muss den nächstgelegenen Fahrer finden, um die Lieferung im Restaurant abzuholen. Um diesen Anwendungsfall zu beheben, können sie die Matrixroute-API aufrufen. Für jede Route werden die Fahrzeiten und Entfernungen zurückgegeben. Mithilfe der berechneten Kosten können Sie mithilfe der Routenbeschreibungs-API ermitteln, welche detaillierten Routen berechnet werden sollen. Die maximale Größe einer Matrix für eine asynchrone Anforderung beträgt 700 und für Synchronisierungsanforderung 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Übermitteln synchroner RoutenmatrixanforderungWenn 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 beträgt 100 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 10x10, 6x8, 9x8 (es muss nicht quadratisch sein).
Übermitteln einer asynchronen RoutenmatrixanforderungDie asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Routinganforderungen. Wenn Sie eine Anforderung mithilfe der asynchronen Anforderung stellen, gibt der Dienst standardmäßig einen 202-Antwortcode 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 beträgt 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 50x10, 10x10, 28x25. 10x70 (es muss nicht quadratisch sein). Die asynchronen Antworten werden 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine Antwort 404 zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.
Hier sehen Sie eine typische Abfolge asynchroner Vorgänge:
Herunterladen von SynchronisierungsergebnissenWenn Sie eine POST-Anforderung für die Routenmatrixsynchronisierungs-API stellen, gibt der Dienst 200 Antwortcode 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 Standortheader angegebene 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 Verkehrsereignisses. Kann mainCauseCode- und subCauseCode-Elemente enthalten. Kann verwendet werden, um Ikonografie und Beschreibungen zu definieren. |
RouteSectionTecOutput |
Details zum Verkehrsereignis unter Verwendung von Definitionen im TPEG2-TEC-Standard . Kann effectCode enthalten und verursacht Elemente. |
RouteSummaryOutput |
Zusammenfassungsobjekt |
Routes |
Typaliase
GeoJsonGeometry |
Ein gültiges |
GeoJsonObject |
Ein gültiges |
MapsRouteClient | |
RouteGetRouteDirectionsBatchParameters | |
RouteGetRouteDirectionsParameters | |
RouteGetRouteDirectionsWithAdditionalParametersParameters | |
RouteGetRouteMatrixParameters | |
RouteGetRouteRangeParameters | |
RouteRequestRouteDirectionsBatchParameters | |
RouteRequestRouteDirectionsBatchSyncParameters | |
RouteRequestRouteMatrixParameters | |
RouteRequestRouteMatrixSyncParameters |
Functions
create |
Erstellen Sie einen Batchanforderungstext aus einer Reihe von Routenrichtungsanforderungen. |
default(Azure |
Erstellt eine instance von MapsRouteClient aus einem Abonnementschlüssel. Beispiel
|
default(Token |
Erstellt eine instance von MapsRoute aus einer Azure Identity Beispiel
|
default(Azure |
Erstellt eine instance von MapsRoute aus einer Azure Identity Beispiel
|
get |
Hilfsfunktion, die ein Poller-Objekt erstellt, 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
createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])
Erstellen Sie einen Batchanforderungstext aus einer Reihe von Routenrichtungsanforderungen.
function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest
Parameter
- queryParamProperties
Ein Objekt der Abfrageparameter für eine Routenrichtungsanforderung
Gibt zurück
Die zusammengesetzte Batchanforderung.
default(AzureKeyCredential, ClientOptions)
Erstellt eine instance 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): MapsRouteClient
Parameter
- credential
- AzureKeyCredential
Eine AzureKeyCredential-instance, die zum Authentifizieren von Anforderungen beim Dienst verwendet wird
- options
- ClientOptions
Optionen zum Konfigurieren des Route-Clients
Gibt zurück
default(TokenCredential, string, ClientOptions)
Erstellt eine instance 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): MapsRouteClient
Parameter
- credential
- TokenCredential
Eine TokenCredential-instance, die zum Authentifizieren von Anforderungen beim Dienst verwendet wird
- mapsAccountClientId
-
string
Die Azure Maps Client-ID einer bestimmten Kartenressource
- options
- ClientOptions
Optionen zum Konfigurieren des Route-Clients
Gibt zurück
default(AzureSASCredential, ClientOptions)
Erstellt eine instance 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): MapsRouteClient
Parameter
- credential
- AzureSASCredential
Eine AzureSASCredential-instance, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird
- options
- ClientOptions
Optionen zum Konfigurieren des Route-Clients
Gibt zurück
getLongRunningPoller<TResult>(Client, TResult, LroEngineOptions<TResult, PollOperationState<TResult>>)
Hilfsfunktion, die ein Poller-Objekt erstellt, um einen Vorgang mit langer Ausführung abzufragen.
function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: LroEngineOptions<TResult, PollOperationState<TResult>>): PollerLike<PollOperationState<TResult>, TResult>
Parameter
- client
- Client
Client, der zum Senden der Anforderung zum Abrufen zusätzlicher Seiten verwendet werden soll.
- initialResponse
-
TResult
Die anfängliche Antwort.
- options
-
LroEngineOptions<TResult, PollOperationState<TResult>>
Optionen zum Festlegen eines Fortsetzungszustands oder eines benutzerdefinierten Abrufintervalls.
Gibt zurück
PollerLike<PollOperationState<TResult>, TResult>
- Ein Pollerobjekt, um nach Vorgangsstatusaktualisierungen abzufragen und schließlich die endgültige Antwort zu erhalten.
isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
function isUnexpected(response: RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
function isUnexpected(response: RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse): response
Parameter
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[]): string
Parameter
- coordinates
-
LatLon[]
Ein Array von zu transformierenden Latitude/Longtitute-Paaren.
Gibt zurück
string
Die transformierte Zeichenfolge.
Azure SDK for JavaScript
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für