@azure-rest/maps-search package

Interfészek

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput	Az eredmény címe
BoundaryOutput	GeoJSON GeocodingFeature objektum, amely egy földrajzi terület határait írja le. A funkció geometriája a következővel GeoJSON GeometryCollectionírható le: . Vegye figyelembe, hogy a szolgáltatás általában egy GeometryCollection függvényt ad vissza sokszög vagy többpolygon altípussal.
BoundaryPropertiesOutput	Egy Határ objektum tulajdonságai.
ErrorAdditionalInfoOutput	Az erőforrás-kezelési hiba további információi.
ErrorDetailOutput	A hiba részletei.
ErrorResponseOutput	Az összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)
FeaturesItemOutput
FeaturesItemPropertiesOutput
GeoJsonFeatureCollectionDataOutput
GeoJsonFeatureCollectionOutput	Érvényes GeoJSON FeatureCollection objektumtípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonFeatureDataOutput
GeoJsonFeatureOutputParent	Érvényes GeoJSON Feature objektumtípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonGeometryCollectionDataOutput
GeoJsonGeometryCollectionOutput	Érvényes GeoJSON GeometryCollection objektumtípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonGeometryOutputParent	Érvényes GeoJSON geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Pont, MultiPoint, Vonallánc, MultiLineString, Polygon, MultiPolygon és GeometryCollection. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonLineStringDataOutput
GeoJsonLineStringOutput	Érvényes GeoJSON LineString geometriatípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonMultiLineStringDataOutput
GeoJsonMultiLineStringOutput	Érvényes GeoJSON MultiLineString geometriatípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonMultiPointDataOutput	A (z) által GeoJson MultiPointtárolt adatok.
GeoJsonMultiPointOutput	Érvényes GeoJSON MultiPoint geometriatípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonMultiPolygonDataOutput
GeoJsonMultiPolygonOutput	Érvényes GeoJSON MultiPolygon objektumtípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonObjectOutputParent	Érvényes GeoJSON objektum. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonPointDataOutput	A (z) által GeoJson Pointtárolt adatok.
GeoJsonPointOutput	Érvényes GeoJSON Point geometriatípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonPolygonDataOutput
GeoJsonPolygonOutput	Érvényes GeoJSON Polygon geometriatípus. A részletekért tekintse meg az RFC 7946-ot .
GeocodePointsItemOutput
GeocodingBatchRequestBody	A feldolgozni kívánt cím geokódolási lekérdezéseinek/kéréseinek listája. A lista legfeljebb 100 lekérdezést tartalmazhat, és legalább 1 lekérdezést kell tartalmaznia.
GeocodingBatchRequestItem	Batch Query-objektum
GeocodingBatchResponseItemOutput
GeocodingBatchResponseOutput	Ezt az objektumot egy sikeres Geocoding Batch-szolgáltatáshívás adja vissza.
GeocodingBatchResponseSummaryOutput	A kötegkérelem összegzése
GeocodingResponseOutput	Ezt az objektumot egy sikeres geokódolási hívás adja vissza
GeometryCopyrightOutput	A Határ objektum geometriája szerzői jogi információi.
GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput	Az eredmény címe.
ReverseGeocodingBatchRequestBody	A feldolgozni kívánt fordított geokódolási lekérdezések/kérések listája. A lista legfeljebb 100 lekérdezést tartalmazhat, és legalább 1 lekérdezést kell tartalmaznia.
ReverseGeocodingBatchRequestItem	Batch Query-objektum
Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response	Geokódolás A következőkre vonatkozik: lásd: tarifacsomagok. Sok esetben a teljes keresési szolgáltatás túl sok lehet, például ha csak a hagyományos geokódolás érdekli. A keresés kizárólag a címkereséshez is elérhető. A geokódolás úgy történik, hogy csak a kérdéses címmel vagy részleges címmel éri el a geokódolási végpontot. A geokódolási keresési index lekérdezi az utcaszintű adatok fölötti összes adatot. A rendszer nem ad vissza érdeklődési pontot (POI-kat). Vegye figyelembe, hogy a geokódoló nagyon tolerálja az elírásokat és a hiányos címeket. Emellett mindent kezel a pontos utcacímektől, utca- vagy kereszteződésektől, valamint magasabb szintű földrajzi területektől, például városközpontoktól, megyéktől, államoktól stb.
SearchGetGeocodingBatch200Response	Geokódolási Batch API A következőkre vonatkozik: lásd: tarifacsomagok. A Geocoding Batch API lekérdezések kötegeit küldi a Geocoding API-nak egyetlen API-hívással. Az API-val a hívó legfeljebb 100 lekérdezést köthet össze. Szinkron batch-kérelem elküldése A szinkron API egyszerűsített kötegelt kérésekhez ajánlott. Amikor a szolgáltatás kérést kap, a rendszer azonnal válaszol a kötegelemek kiszámításakor, és később nem lesz lehetőség az eredmények lekérésére. A Szinkron API időtúllépési hibát (408-ra adott válasz) ad vissza, ha a kérés 60 másodpercnél tovább tart. Ehhez az API-hoz a kötegelemek száma legfeljebb 100 lehet. POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01 POST törzs a Batch-kérelemhez A geokódolási lekérdezések elküldéséhez olyan kérést POST fog használni, amelyben a kérelem törzse formátumában json a tömböt fogja tartalmaznibatchItems, a fejléc pedig a Content-Type következőre application/jsonlesz állítva: . Íme egy mintakérés törzse, amely 2 geokódolási lekérdezést tartalmaz: { "batchItems": [ { "addressLine": "One, Microsoft Way, Redmond, WA 98052", "top": 2 }, { "addressLine": "Pike Pl", "adminDistrict": "WA", "locality": "Seattle", "top": 3 } ] } A geokódolási batchItem objektum a támogatott geokódolásiURI-paraméterek bármelyikét elfogadhatja. A kötegnek legalább 1 lekérdezést kell tartalmaznia. Batch-válaszmodell A kötegelt válasz tartalmaz egy summary összetevőt, amely azt jelzi, hogy az totalRequests eredeti kötegelt kérelem successfulRequests része volt, azaz a sikeresen végrehajtott lekérdezések. A kötegelt válasz tartalmaz egy batchItems tömböt is, amely a batch-kérelem minden egyes lekérdezéséhez tartalmaz választ. A batchItems parancs pontosan ugyanabban a sorrendben tartalmazza az eredményeket, mint az eredeti lekérdezéseket a kötegelt kérelemben. Minden elem az alábbi típusok egyikét tartalmazza: GeocodingResponse – Ha a lekérdezés sikeresen befejeződött. Error – Ha a lekérdezés sikertelen volt. A válasz ebben az esetben egy code és egy message elemet fog tartalmazni.
SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse	Geokódolási Batch API A következőkre vonatkozik: lásd: tarifacsomagok. A Geocoding Batch API lekérdezések kötegeit küldi a Geocoding API-nak egyetlen API-hívással. Az API-val a hívó legfeljebb 100 lekérdezést köthet össze. Szinkron batch-kérelem elküldése A szinkron API használata egyszerű kötegelt kérésekhez ajánlott. Amikor a szolgáltatás kérést kap, a batch-elemek kiszámítása után azonnal válaszol, és később nem lesz lehetőség az eredmények lekérésére. A szinkron API időtúllépési hibát (408-ra adott válasz) ad vissza, ha a kérés 60 másodpercnél tovább tart. Ehhez az API-hoz a kötegelemek száma 100-ra van korlátozva. POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01 POST törzs a Batch-kérelemhez A geokódolási lekérdezések elküldéséhez olyan kérést POST kell használnia, amelyben a kérelem törzse formátumban fogja tartalmazni a batchItems tömböt json , a fejléc pedig értékre Content-Typeapplication/jsonlesz állítva. Íme egy mintakérés törzse, amely 2 geokódolási lekérdezést tartalmaz: { "batchItems": [ { "addressLine": "One, Microsoft Way, Redmond, WA 98052", "top": 2 }, { "addressLine": "Pike Pl", "adminDistrict": "WA", "locality": "Seattle", "top": 3 } ] } A geokódolási batchItem objektum a támogatott geokódolásiURI-paraméterek bármelyikét elfogadhatja. A kötegnek legalább 1 lekérdezést kell tartalmaznia. Batch-válaszmodell A batch-válasz tartalmaz egy summary összetevőt, amely azt jelzi, hogy azok totalRequests az eredeti kötegelt kérelem successfulRequests részei voltak, azaz a sikeresen végrehajtott lekérdezések. A batch-válasz egy batchItems tömböt is tartalmaz, amely a batch-kérelem minden egyes lekérdezésére választ tartalmaz. A batchItems pontosan ugyanabban a sorrendben tartalmazza az eredményeket, mint az eredeti lekérdezéseket a kötegelt kérelemben. Minden elem a következő típusok egyikét tartalmazza: GeocodingResponse – Ha a lekérdezés sikeresen befejeződött. Error – Ha a lekérdezés sikertelen volt. A válasz ebben az esetben egy code és egy message elemet fog tartalmazni.
SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse	Geokódolás A következőkre vonatkozik: lásd: tarifacsomagok. Sok esetben a teljes keresési szolgáltatás túl sok lehet, például ha csak a hagyományos geokódolás érdekli. A keresés kizárólag a címkereséshez is elérhető. A geokódolás úgy történik, hogy csak a kérdéses címmel vagy részleges címmel eléri a geokódolási végpontot. A geokódolási keresési index lekérdezi az utcaszintű adatok fölötti összes adatot. A rendszer nem ad vissza érdeklődési pontot (POI-kat). Vegye figyelembe, hogy a geokódoló nagyon tolerálja az elírásokat és a hiányos címeket. Emellett mindent kezelni fog a pontos utcacímektől, utca- vagy kereszteződésektől, valamint a magasabb szintű földrajzi területektől, például a városközpontoktól, megyéktől, államoktól stb.
SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response	Sokszög beolvasása A következőkre vonatkozik: lásd: tarifacsomagok. Sokszögadatokat szolgáltat egy földrajzi terület körvonaláról, például egy városról vagy egy országrégióról.
SearchGetPolygonDefaultResponse	Sokszög beolvasása A következőkre vonatkozik: lásd: tarifacsomagok. Sokszögadatokat szolgáltat egy földrajzi terület körvonaláról, például egy városról vagy egy országrégióról.
SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response	Fordított geokódolás A következőkre vonatkozik: lásd: tarifacsomagok. Egy koordinátát (például: 37.786505, -122.3862) lefordíthat egy érthető utcacímre. Ez leggyakrabban olyan alkalmazások nyomon követéséhez szükséges, amelyekben GPS-hírcsatornát kap az eszköztől vagy eszköztől, és tudni szeretné, hogy a koordináták hol találhatók. Ez a végpont egy adott koordinátára vonatkozó címadatokat ad vissza.
SearchGetReverseGeocodingBatch200Response	Fordított geokódolási Batch API A következőkre vonatkozik: lásd: tarifacsomagok. A Reverse Geocoding Batch API lekérdezéskötegeket küld a Reverse Geocoding API-nak egyetlen API-hívással. Az API lehetővé teszi, hogy a hívó legfeljebb 100 lekérdezést kötenek össze. Szinkron batch-kérelem elküldése A szinkron API használata egyszerű kötegelt kérésekhez ajánlott. Amikor a szolgáltatás kérést kap, a batch-elemek kiszámítása után azonnal válaszol, és később nem lesz lehetőség az eredmények lekérésére. A szinkron API időtúllépési hibát (408-ra adott válasz) ad vissza, ha a kérés 60 másodpercnél tovább tart. Ehhez az API-hoz a kötegelemek száma 100-ra van korlátozva. POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01 POST törzs a Batch-kérelemhez A fordított geokódolási lekérdezések elküldéséhez olyan kérést POST kell használnia, amelyben a kérelem törzse formátumban fogja tartalmazni a batchItems tömbötjson, a fejléc pedig értékre Content-Typeapplication/jsonlesz állítva. Íme egy mintakérés törzse, amely 2 fordított geokódolási lekérdezést tartalmaz: { "batchItems": [ { "coordinates": [-122.128275, 47.639429], "resultTypes": ["Address", "PopulatedPlace"] }, { "coordinates": [-122.341979399674, 47.6095253501216] } ] } A fordított geokódolási batchItem objektum a támogatott fordított geokódolásiURI-paraméterek bármelyikét elfogadhatja. A kötegnek legalább 1 lekérdezést kell tartalmaznia. Batch-válaszmodell A batch-válasz tartalmaz egy summary összetevőt, amely azt jelzi, hogy azok totalRequests az eredeti kötegelt kérelem successfulRequests részei voltak, azaz a sikeresen végrehajtott lekérdezések. A batch-válasz egy batchItems tömböt is tartalmaz, amely a batch-kérelem minden egyes lekérdezésére választ tartalmaz. A batchItems pontosan ugyanabban a sorrendben tartalmazza az eredményeket, mint az eredeti lekérdezéseket a kötegelt kérelemben. Minden elem a következő típusok egyikét tartalmazza: GeocodingResponse – Ha a lekérdezés sikeresen befejeződött. Error – Ha a lekérdezés sikertelen volt. A válasz ebben az esetben egy code és egy message elemet fog tartalmazni.
SearchGetReverseGeocodingBatchBodyParam
SearchGetReverseGeocodingBatchDefaultResponse	Fordított geokódolási Batch API A következőkre vonatkozik: lásd: tarifacsomagok. A Reverse Geocoding Batch API lekérdezéskötegeket küld a Reverse Geocoding API-nak egyetlen API-hívással. Az API lehetővé teszi, hogy a hívó legfeljebb 100 lekérdezést kötenek össze. Szinkron batch-kérelem elküldése A szinkron API használata egyszerű kötegelt kérésekhez ajánlott. Amikor a szolgáltatás kérést kap, a batch-elemek kiszámítása után azonnal válaszol, és később nem lesz lehetőség az eredmények lekérésére. A szinkron API időtúllépési hibát (408-ra adott válasz) ad vissza, ha a kérés 60 másodpercnél tovább tart. Ehhez az API-hoz a kötegelemek száma 100-ra van korlátozva. POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01 POST törzs a Batch-kérelemhez A fordított geokódolási lekérdezések elküldéséhez olyan kérést POST kell használnia, amelyben a kérelem törzse formátumban fogja tartalmazni a batchItems tömbötjson, a fejléc pedig értékre Content-Typeapplication/jsonlesz állítva. Íme egy mintakérés törzse, amely 2 fordított geokódolási lekérdezést tartalmaz: { "batchItems": [ { "coordinates": [-122.128275, 47.639429], "resultTypes": ["Address", "PopulatedPlace"] }, { "coordinates": [-122.341979399674, 47.6095253501216] } ] } A fordított geokódolási batchItem objektum a támogatott fordított geokódolásiURI-paraméterek bármelyikét elfogadhatja. A kötegnek legalább 1 lekérdezést kell tartalmaznia. Batch-válaszmodell A batch-válasz tartalmaz egy summary összetevőt, amely azt jelzi, hogy azok totalRequests az eredeti kötegelt kérelem successfulRequests részei voltak, azaz a sikeresen végrehajtott lekérdezések. A batch-válasz egy batchItems tömböt is tartalmaz, amely a batch-kérelem minden egyes lekérdezésére választ tartalmaz. A batchItems pontosan ugyanabban a sorrendben tartalmazza az eredményeket, mint az eredeti lekérdezéseket a kötegelt kérelemben. Minden elem a következő típusok egyikét tartalmazza: GeocodingResponse – Ha a lekérdezés sikeresen befejeződött. Error – Ha a lekérdezés sikertelen volt. A válasz ebben az esetben egy code és egy message elemet fog tartalmazni.
SearchGetReverseGeocodingBatchMediaTypesParam
SearchGetReverseGeocodingDefaultResponse	Fordított geokódolás A következőkre vonatkozik: lásd: tarifacsomagok. Egy koordinátát (például: 37.786505, -122.3862) lefordíthat egy érthető utcacímre. Ez leggyakrabban olyan alkalmazások nyomon követéséhez szükséges, amelyekben GPS-hírcsatornát kap az eszköztől vagy eszköztől, és tudni szeretné, hogy a koordináták hol találhatók. Ez a végpont egy adott koordinátára vonatkozó címadatokat ad vissza.
SearchGetReverseGeocodingQueryParam
SearchGetReverseGeocodingQueryParamProperties

Típusaliasok

GeoJsonFeatureOutput	Érvényes GeoJSON Feature objektumtípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonGeometryOutput	Érvényes GeoJSON geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Pont, MultiPoint, Vonallánc, MultiLineString, Polygon, MultiPolygon és GeometryCollection. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonObjectOutput	Érvényes GeoJSON objektum. A részletekért tekintse meg az RFC 7946-ot .
MapsSearchClient
SearchGetGeocodingBatchParameters
SearchGetGeocodingParameters
SearchGetPolygonParameters
SearchGetReverseGeocodingBatchParameters
SearchGetReverseGeocodingParameters

Függvények

default(AzureKeyCredential, ClientOptions)	Létrehozza a MapsSearchClient egy példányát egy előfizetési kulcsból. Példa import MapsSearch from "@azure-rest/maps-search"; import { AzureKeyCredential } from "@azure/core-auth"; const credential = new AzureKeyCredential("<subscription-key>"); const client = MapsSearch(credential);
default(TokenCredential, string, ClientOptions)	Létrehozza a MapsSearch egy példányát egy Azure-identitásból TokenCredential. Példa import MapsSearch from "@azure-rest/maps-search"; import { DefaultAzureCredential } from "@azure/identity"; const credential = new DefaultAzureCredential(); const client = MapsSearch(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)	Létrehozza a MapsSearch egy példányát egy Azure-identitásból AzureSASCredential. Példa import MapsSearch from "@azure-rest/maps-search"; import { AzureSASCredential } from "@azure/core-auth"; const credential = new AzureSASCredential("<SAS Token>"); const client = MapsSearch(credential);
isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)
isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)
isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)
isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)
isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)

Függvény adatai

default(AzureKeyCredential, ClientOptions)

Létrehozza a MapsSearchClient egy példányát egy előfizetési kulcsból.

Példa

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

Paraméterek

credential

AzureKeyCredential

Egy AzureKeyCredential-példány, amely a szolgáltatásnak küldött kérések hitelesítésére szolgál

options

ClientOptions

A keresési ügyfél konfigurálásához használt beállítások

Válaszok

MapsSearchClient

default(TokenCredential, string, ClientOptions)

Létrehozza a MapsSearch egy példányát egy Azure-identitásból TokenCredential.

Példa

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

Paraméterek

credential

TokenCredential

A szolgáltatásnak küldött kérések hitelesítéséhez használt TokenCredential-példány

mapsAccountClientId

string

Egy adott leképezési erőforrás Azure Maps ügyfél-azonosítója

options

ClientOptions

A keresési ügyfél konfigurálásához használt beállítások

Válaszok

MapsSearchClient

default(AzureSASCredential, ClientOptions)

Létrehozza a MapsSearch egy példányát egy Azure-identitásból AzureSASCredential.

Példa

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

Paraméterek

credential

AzureSASCredential

Egy AzureSASCredential példány, amely a szolgáltatás felé irányuló kérések hitelesítésére szolgál

options

ClientOptions

A keresési ügyfél konfigurálásához használt beállítások

Válaszok

MapsSearchClient

isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)

function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response

Paraméterek

response

SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse

Válaszok

response

isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)

function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response

Paraméterek

response

SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse

Válaszok

response

isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)

function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response

Paraméterek

response

SearchGetPolygon200Response | SearchGetPolygonDefaultResponse

Válaszok

response

isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)

function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response

Paraméterek

response

SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse

Válaszok

response

isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)

function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response

Paraméterek

response

SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse

Válaszok

response