@azure-rest/maps-search package
Schnittstellen
AddressAdminDistrictsItemOutput | |
AddressCountryRegionOutput | |
AddressOutput |
Die Adresse des Ergebnisses |
BoundaryOutput |
Bitte beachten Sie, dass der Dienst in der Regel eine GeometryCollection mit Polygon- oder MultiPolygon-Untertypen zurückgibt. |
BoundaryPropertiesOutput |
Eigenschaften eines Boundary-Objekts. |
ErrorAdditionalInfoOutput |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
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.) |
FeaturesItemOutput | |
FeaturesItemPropertiesOutput | |
GeoJsonFeatureCollectionDataOutput | |
GeoJsonFeatureCollectionOutput |
Ein gültiger |
GeoJsonFeatureDataOutput | |
GeoJsonFeatureOutputParent |
Ein gültiger |
GeoJsonGeometryCollectionDataOutput | |
GeoJsonGeometryCollectionOutput |
Ein gültiger |
GeoJsonGeometryOutputParent |
Ein gültiges |
GeoJsonLineStringDataOutput | |
GeoJsonLineStringOutput |
Ein gültiger |
GeoJsonMultiLineStringDataOutput | |
GeoJsonMultiLineStringOutput |
Ein gültiger |
GeoJsonMultiPointDataOutput |
Daten, die in einem |
GeoJsonMultiPointOutput |
Ein gültiger |
GeoJsonMultiPolygonDataOutput | |
GeoJsonMultiPolygonOutput |
Ein gültiger |
GeoJsonObjectOutputParent |
Ein gültiges |
GeoJsonPointDataOutput |
Daten, die in einem |
GeoJsonPointOutput |
Ein gültiger |
GeoJsonPolygonDataOutput | |
GeoJsonPolygonOutput |
Ein gültiger |
GeocodePointsItemOutput | |
GeocodingBatchRequestBody |
Die Liste der Zu verarbeitenden Adress-Geocodierungsabfragen/Anforderungen. Die Liste kann maximal 100 Abfragen enthalten und muss mindestens 1 Abfrage enthalten. |
GeocodingBatchRequestItem |
Batchabfrageobjekt |
GeocodingBatchResponseItemOutput | |
GeocodingBatchResponseOutput |
Dieses Objekt wird von einem erfolgreichen Geocoding Batch-Dienstaufruf zurückgegeben. |
GeocodingBatchResponseSummaryOutput |
Zusammenfassung für die Batchanforderung |
GeocodingResponseOutput |
Dieses Objekt wird von einem erfolgreichen Geocodierungsaufruf zurückgegeben. |
GeometryCopyrightOutput |
Copyrightinformationen einer Geometrie eines Boundary-Objekts. |
GetGeocoding | |
GetGeocodingBatch | |
GetPolygon | |
GetReverseGeocoding | |
GetReverseGeocodingBatch | |
IntersectionOutput |
Die Adresse des Ergebnisses. |
ReverseGeocodingBatchRequestBody |
Die Liste der umgekehrten Geocodierungsabfragen/Anforderungen, die verarbeitet werden sollen. Die Liste kann maximal 100 Abfragen enthalten und muss mindestens 1 Abfrage enthalten. |
ReverseGeocodingBatchRequestItem |
Batchabfrageobjekt |
Routes | |
SearchGetGeocoding200Headers | |
SearchGetGeocoding200Response |
Geocodierung Gilt für:Tarifeanzeigen. In vielen Fällen ist der vollständige Suchdienst möglicherweise zu viel, z. B. wenn Sie nur an herkömmlicher Geocodierung interessiert sind. Auf die Suche kann auch ausschließlich nach Adressen zugegriffen werden. Die Geocodierung erfolgt durch Drücken des Geocodierungsendpunkts mit nur der adresse oder teilweisen Adresse. Der Geocodierungssuchindex wird für alles über den Daten auf Straßenebene abgefragt. Es wird kein Point of Interest (POIs) zurückgegeben. Beachten Sie, dass der Geocoder sehr tolerant von Tippfehlern und unvollständigen Adressen ist. Es wird auch alles von genauen Straßenadressen oder Straßen oder Kreuzungen sowie von höheren Regionen wie Stadtzentren, Landkreisen, Staaten usw. behandeln. |
SearchGetGeocodingBatch200Response |
der Geocodierungsbatch-API Gilt für: Siehe Preise Stufen. Die Geocodierungsbatch-API sendet Batches von Abfragen an Geocodierungs-API nur mithilfe eines einzelnen API-Aufrufs. Mit der API kann der Aufrufer bis zu 100 Abfragen stapeln. 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.
POST-Text für BatchanforderungUm die Geocodierung Abfragen zu senden, verwenden Sie eine
Ein Geocodierungsobjekt batchItem-Objekt kann alle unterstützten GeocodierungsparameterURI-Parameterakzeptieren. Der Batch sollte mindestens 1 Abfrage enthalten. BatchantwortmodellDie Batchantwort enthält eine
|
SearchGetGeocodingBatchBodyParam | |
SearchGetGeocodingBatchDefaultResponse |
der Geocodierungsbatch-API Gilt für: Siehe Preise Stufen. Die Geocodierungsbatch-API sendet Batches von Abfragen an Geocodierungs-API nur mithilfe eines einzelnen API-Aufrufs. Mit der API kann der Aufrufer bis zu 100 Abfragen stapeln. 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.
POST-Text für BatchanforderungUm die Geocodierung Abfragen zu senden, verwenden Sie eine
Ein Geocodierungsobjekt batchItem-Objekt kann alle unterstützten GeocodierungsparameterURI-Parameterakzeptieren. Der Batch sollte mindestens 1 Abfrage enthalten. BatchantwortmodellDie Batchantwort enthält eine
|
SearchGetGeocodingBatchMediaTypesParam | |
SearchGetGeocodingDefaultResponse |
Geocodierung Gilt für:Tarifeanzeigen. In vielen Fällen ist der vollständige Suchdienst möglicherweise zu viel, z. B. wenn Sie nur an herkömmlicher Geocodierung interessiert sind. Auf die Suche kann auch ausschließlich nach Adressen zugegriffen werden. Die Geocodierung erfolgt durch Drücken des Geocodierungsendpunkts mit nur der adresse oder teilweisen Adresse. Der Geocodierungssuchindex wird für alles über den Daten auf Straßenebene abgefragt. Es wird kein Point of Interest (POIs) zurückgegeben. Beachten Sie, dass der Geocoder sehr tolerant von Tippfehlern und unvollständigen Adressen ist. Es wird auch alles von genauen Straßenadressen oder Straßen oder Kreuzungen sowie von höheren Regionen wie Stadtzentren, Landkreisen, Staaten usw. behandeln. |
SearchGetGeocodingQueryParam | |
SearchGetGeocodingQueryParamProperties | |
SearchGetPolygon200Response |
Polygon- abrufen Gilt für:Tarifeanzeigen. Liefert Polygondaten eines geografischen Gebiets, z. B. einer Stadt oder einer Landregion. |
SearchGetPolygonDefaultResponse |
Polygon- abrufen Gilt für:Tarifeanzeigen. Liefert Polygondaten eines geografischen Gebiets, z. B. einer Stadt oder einer Landregion. |
SearchGetPolygonQueryParam | |
SearchGetPolygonQueryParamProperties | |
SearchGetReverseGeocoding200Response |
Umgekehrte Geocodierung Gilt für:Tarifeanzeigen. Übersetzen Sie eine Koordinate (Beispiel: 37.786505, -122.3862) in eine menschliche verständliche Straße. Dies ist meistens in Tracking-Anwendungen erforderlich, bei denen Sie einen GPS-Feed vom Gerät oder Objekt erhalten und wissen möchten, welche Adresse sich die Koordinate befindet. Dieser Endpunkt gibt Adressinformationen für eine bestimmte Koordinate zurück. |
SearchGetReverseGeocodingBatch200Response |
Reverse Geocoding Batch API Gilt für: Siehe Preise Stufen. Die Reverse Geocoding Batch-API sendet Batches von Abfragen an Reverse Geocoding API nur mithilfe eines einzelnen API-Aufrufs. Mit der API kann der Aufrufer bis zu 100 Abfragen stapeln. 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.
POST-Text für BatchanforderungUm die umgekehrte Geocodierung Abfragen zu senden, verwenden Sie eine
Ein umgekehrte Geocodierung batchItem-Objekt kann jedes der unterstützten umgekehrten GeocodierungsparameterURI-Parameterakzeptieren. Der Batch sollte mindestens 1 Abfrage enthalten. BatchantwortmodellDie Batchantwort enthält eine
|
SearchGetReverseGeocodingBatchBodyParam | |
SearchGetReverseGeocodingBatchDefaultResponse |
Reverse Geocoding Batch API Gilt für: Siehe Preise Stufen. Die Reverse Geocoding Batch-API sendet Batches von Abfragen an Reverse Geocoding API nur mithilfe eines einzelnen API-Aufrufs. Mit der API kann der Aufrufer bis zu 100 Abfragen stapeln. 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.
POST-Text für BatchanforderungUm die umgekehrte Geocodierung Abfragen zu senden, verwenden Sie eine
Ein umgekehrte Geocodierung batchItem-Objekt kann jedes der unterstützten umgekehrten GeocodierungsparameterURI-Parameterakzeptieren. Der Batch sollte mindestens 1 Abfrage enthalten. BatchantwortmodellDie Batchantwort enthält eine
|
SearchGetReverseGeocodingBatchMediaTypesParam | |
SearchGetReverseGeocodingDefaultResponse |
Umgekehrte Geocodierung Gilt für:Tarifeanzeigen. Übersetzen Sie eine Koordinate (Beispiel: 37.786505, -122.3862) in eine menschliche verständliche Straße. Dies ist meistens in Tracking-Anwendungen erforderlich, bei denen Sie einen GPS-Feed vom Gerät oder Objekt erhalten und wissen möchten, welche Adresse sich die Koordinate befindet. Dieser Endpunkt gibt Adressinformationen für eine bestimmte Koordinate zurück. |
SearchGetReverseGeocodingQueryParam | |
SearchGetReverseGeocodingQueryParamProperties |
Typaliase
GeoJsonFeatureOutput |
Ein gültiger |
GeoJsonGeometryOutput |
Ein gültiges |
GeoJsonObjectOutput |
Ein gültiges |
MapsSearchClient | |
SearchGetGeocodingBatchParameters | |
SearchGetGeocodingParameters | |
SearchGetPolygonParameters | |
SearchGetReverseGeocodingBatchParameters | |
SearchGetReverseGeocodingParameters |
Functions
default(Azure |
Erstellt eine Instanz von MapsSearchClient aus einem Abonnementschlüssel. Beispiel
|
default(Token |
Erstellt eine Instanz von MapsSearch aus einer Azure Identity Beispiel
|
default(Azure |
Erstellt eine Instanz von MapsSearch aus einer Azure Identity Beispiel
|
is |
|
is |
|
is |
|
is |
|
is |
Details zur Funktion
default(AzureKeyCredential, ClientOptions)
Erstellt eine Instanz von MapsSearchClient aus einem Abonnementschlüssel.
Beispiel
import MapsSearch from "@azure-rest/maps-search";
import { AzureKeyCredential } from "@azure/core-auth";
const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsSearch(credential);
function default(credential: AzureKeyCredential, options?: ClientOptions): MapsSearchClient
Parameter
- credential
- AzureKeyCredential
Eine AzureKeyCredential-Instanz, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird
- options
- ClientOptions
Optionen zum Konfigurieren des Suchclients
Gibt zurück
default(TokenCredential, string, ClientOptions)
Erstellt eine Instanz von MapsSearch aus einer Azure Identity TokenCredential
.
Beispiel
import MapsSearch from "@azure-rest/maps-search";
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential();
const client = MapsSearch(credential, "<maps-account-client-id>");
function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsSearchClient
Parameter
- 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 Suchclients
Gibt zurück
default(AzureSASCredential, ClientOptions)
Erstellt eine Instanz von MapsSearch aus einer Azure Identity AzureSASCredential
.
Beispiel
import MapsSearch from "@azure-rest/maps-search";
import { AzureSASCredential } from "@azure/core-auth";
const credential = new AzureSASCredential("<SAS Token>");
const client = MapsSearch(credential);
function default(credential: AzureSASCredential, options?: ClientOptions): MapsSearchClient
Parameter
- credential
- AzureSASCredential
Eine AzureSASCredential-Instanz, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird
- options
- ClientOptions
Optionen zum Konfigurieren des Suchclients
Gibt zurück
isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)
function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)
function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)
function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)
function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)
function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response
Parameter
Gibt zurück
response
Azure SDK for JavaScript