@azure-rest/maps-search package

Rozhraní

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput	Adresa výsledku
BoundaryOutput	GeoJSON GeocodingFeature objekt, který popisuje hranice zeměpisné oblasti. Geometrie vlastnosti je popsána pomocí GeoJSON GeometryCollectionpříkazu . Upozorňujeme, že služba obvykle vrací GeometryCollection s podtypy Polygon nebo MultiPolygon.
BoundaryPropertiesOutput	Vlastnosti objektu Boundary.
ErrorAdditionalInfoOutput	Další informace o chybě správy prostředků
ErrorDetailOutput	Podrobnosti o chybě.
ErrorResponseOutput	Běžná odpověď na chybu pro všechna rozhraní API azure Resource Manager, která vrací podrobnosti o chybě pro neúspěšné operace. (To také odpovídá formátu odpovědi na chybu OData.)
FeaturesItemOutput
FeaturesItemPropertiesOutput
GeoJsonFeatureCollectionDataOutput
GeoJsonFeatureCollectionOutput	Platný GeoJSON FeatureCollection typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonFeatureDataOutput
GeoJsonFeatureOutputParent	Platný GeoJSON Feature typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonGeometryCollectionDataOutput
GeoJsonGeometryCollectionOutput	Platný GeoJSON GeometryCollection typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonGeometryOutputParent	Platný GeoJSON objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonLineStringDataOutput
GeoJsonLineStringOutput	Platný GeoJSON LineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonMultiLineStringDataOutput
GeoJsonMultiLineStringOutput	Platný GeoJSON MultiLineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonMultiPointDataOutput	Data obsažená v objektu GeoJson MultiPoint.
GeoJsonMultiPointOutput	Platný GeoJSON MultiPoint typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonMultiPolygonDataOutput
GeoJsonMultiPolygonOutput	Platný GeoJSON MultiPolygon typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonObjectOutputParent	Platný GeoJSON objekt. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonPointDataOutput	Data obsažená v objektu GeoJson Point.
GeoJsonPointOutput	Platný GeoJSON Point typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonPolygonDataOutput
GeoJsonPolygonOutput	Platný GeoJSON Polygon typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeocodePointsItemOutput
GeocodingBatchRequestBody	Seznam dotazů a požadavků na geografické kódování adres ke zpracování. Seznam může obsahovat maximálně 100 dotazů a musí obsahovat alespoň 1 dotaz.
GeocodingBatchRequestItem	Objekt batch query
GeocodingBatchResponseItemOutput
GeocodingBatchResponseOutput	Tento objekt se vrátí z úspěšného volání služby Batch geokódování.
GeocodingBatchResponseSummaryOutput	Shrnutí dávkové žádosti
GeocodingResponseOutput	Tento objekt se vrátí z úspěšného volání geokódování.
GeometryCopyrightOutput	Informace o autorských právech geometrie objektu Boundary.
GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput	Adresa výsledku.
ReverseGeocodingBatchRequestBody	Seznam dotazů a požadavků na zpracování zpětné geografického kódování. Seznam může obsahovat maximálně 100 dotazů a musí obsahovat alespoň 1 dotaz.
ReverseGeocodingBatchRequestItem	Objekt batch query
Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response	Geokódování Platí pro: viz cenové úrovně. V mnoha případech může být kompletní vyhledávací služba příliš mnoho, například pokud vás zajímá pouze tradiční geokódování. Vyhledávání je také přístupné pro výhradní vyhledávání adres. Geokódování se provádí tak, že do koncového bodu geokódování zasáhnete jenom příslušnou adresu nebo částečnou adresu. Index vyhledávání geokódování se bude dotazovat na vše nad daty na úrovni ulice. Nebudou vráceny žádné body zájmu (BŽ). Všimněte si, že geokódér je velmi tolerantní k překlepům a neúplným adresům. Bude také zpracovávat vše od přesných adres ulic nebo ulic nebo křižovatek, stejně jako vyšší úrovně geografických míst, jako jsou centra měst, okresy, státy atd.
SearchGetGeocodingBatch200Response	Rozhraní API služby Batch pro geokódování Platí pro: viz cenové úrovně. Rozhraní API služby Batch pro geokódování odesílá dávky dotazů do rozhraní API pro geokódování pomocí jediného volání rozhraní API. Rozhraní API umožňuje volajícímu dávkovat až 100 dotazů. Odeslání synchronní dávkové žádosti Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží požadavek, zareaguje hned po výpočtu dávkových položek a nebude možné později načíst výsledky. Synchronní rozhraní API vrátí chybu časového limitu (odpověď 408), pokud požadavek trvá déle než 60 sekund. Počet dávkových položek je pro toto rozhraní API omezený na 100 . POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01 Text POST pro dávkový požadavek K odeslání dotazů geokódování použijete POST požadavek, kde text požadavku bude obsahovat batchItems pole ve json formátu a hlavička Content-Type bude nastavena na application/json. Tady je ukázkový text požadavku obsahující 2 dotazy geokódování : { "batchItems": [ { "addressLine": "One, Microsoft Way, Redmond, WA 98052", "top": 2 }, { "addressLine": "Pike Pl", "adminDistrict": "WA", "locality": "Seattle", "top": 3 } ] } Objekt batchItem geografického kódování může přijmout kterýkoli z podporovaných parametrů identifikátoru URIgeografického kódování. Dávka by měla obsahovat alespoň 1 dotaz. Model dávkové odpovědi Dávková odpověď obsahuje komponentu summarytotalRequests , která označuje, které byly součástí původního dávkového požadavku, a successfulRequests tj. dotazy, které byly úspěšně provedeny. Dávková odpověď obsahuje batchItems také pole, které obsahuje odpověď pro každý dotaz v dávkovém požadavku. Bude batchItems obsahovat výsledky v přesně stejném pořadí, v jakém byly původní dotazy odeslány v dávkovém požadavku. Každá položka má jeden z následujících typů: GeocodingResponse – Pokud se dotaz úspěšně dokončil. Error – Pokud dotaz selhal. Odpověď bude v tomto případě obsahovat a code .message
SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse	Rozhraní API služby Batch pro geokódování Platí pro: viz cenové úrovně. Rozhraní API služby Batch pro geokódování odesílá dávky dotazů do rozhraní API pro geokódování pomocí jediného volání rozhraní API. Rozhraní API umožňuje volajícímu dávkovat až 100 dotazů. Odeslání synchronní dávkové žádosti Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží požadavek, zareaguje hned po výpočtu dávkových položek a nebude možné později načíst výsledky. Synchronní rozhraní API vrátí chybu časového limitu (odpověď 408), pokud požadavek trvá déle než 60 sekund. Počet dávkových položek je pro toto rozhraní API omezený na 100 . POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01 Text POST pro dávkový požadavek K odeslání dotazů geokódování použijete POST požadavek, kde text požadavku bude obsahovat batchItems pole ve json formátu a hlavička Content-Type bude nastavena na application/json. Tady je ukázkový text požadavku obsahující 2 dotazy geokódování : { "batchItems": [ { "addressLine": "One, Microsoft Way, Redmond, WA 98052", "top": 2 }, { "addressLine": "Pike Pl", "adminDistrict": "WA", "locality": "Seattle", "top": 3 } ] } Objekt batchItem geografického kódování může přijmout kterýkoli z podporovaných parametrů identifikátoru URIgeografického kódování. Dávka by měla obsahovat alespoň 1 dotaz. Model dávkové odpovědi Dávková odpověď obsahuje komponentu summarytotalRequests , která označuje, které byly součástí původního dávkového požadavku, a successfulRequests tj. dotazy, které byly úspěšně provedeny. Dávková odpověď obsahuje batchItems také pole, které obsahuje odpověď pro každý dotaz v dávkovém požadavku. Bude batchItems obsahovat výsledky v přesně stejném pořadí, v jakém byly původní dotazy odeslány v dávkovém požadavku. Každá položka má jeden z následujících typů: GeocodingResponse – Pokud se dotaz úspěšně dokončil. Error – Pokud dotaz selhal. Odpověď bude v tomto případě obsahovat a code .message
SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse	Geokódování Platí pro: viz cenové úrovně. V mnoha případech může být kompletní vyhledávací služba příliš mnoho, například pokud vás zajímá pouze tradiční geokódování. Vyhledávání je také přístupné pro výhradní vyhledávání adres. Geokódování se provádí tak, že do koncového bodu geokódování zasáhnete jenom příslušnou adresu nebo částečnou adresu. Index vyhledávání geokódování se bude dotazovat na vše nad daty na úrovni ulice. Nebudou vráceny žádné body zájmu (BŽ). Všimněte si, že geokódér je velmi tolerantní k překlepům a neúplným adresům. Bude také zpracovávat vše od přesných adres ulic nebo ulic nebo křižovatek, stejně jako vyšší úrovně geografických míst, jako jsou centra měst, okresy, státy atd.
SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response	Získat mnohoúhelník Platí pro: viz cenové úrovně. Poskytuje mnohoúhelníková data obrysu zeměpisné oblasti, jako je město nebo oblast země.
SearchGetPolygonDefaultResponse	Získat mnohoúhelník Platí pro: viz cenové úrovně. Poskytuje mnohoúhelníková data obrysu zeměpisné oblasti, jako je město nebo oblast země.
SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response	Reverzní geokódování Platí pro: viz cenové úrovně. Přeloží souřadnici (příklad: 37,786505, -122,3862) na srozumitelnou adresu. Nejčastěji je to potřeba ve sledovacích aplikacích, kde přijímáte informační kanál GPS ze zařízení nebo prostředku a chcete vědět, na jaké adrese se souřadnice nachází. Tento koncový bod vrátí informace o adrese pro danou souřadnici.
SearchGetReverseGeocodingBatch200Response	Rozhraní API služby Batch pro reverzní geokódování Platí pro: viz cenové úrovně. Rozhraní BATCH API pro reverzní geokódování odesílá dávky dotazů do rozhraní API pro reverzní geokódování pomocí jediného volání rozhraní API. Rozhraní API umožňuje volajícímu dávkovat až 100 dotazů. Odeslání synchronní dávkové žádosti Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží požadavek, zareaguje hned po výpočtu dávkových položek a nebude možné později načíst výsledky. Synchronní rozhraní API vrátí chybu časového limitu (odpověď 408), pokud požadavek trvá déle než 60 sekund. Počet dávkových položek je pro toto rozhraní API omezený na 100 . POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01 Text POST pro dávkový požadavek K odeslání dotazů zpětného geografického kódování použijete POST požadavek, kde text požadavku bude obsahovat batchItems pole ve json formátu a hlavička Content-Type bude nastavena na application/json. Tady je ukázkový text požadavku obsahující 2 dotazy zpětného geografického kódování : { "batchItems": [ { "coordinates": [-122.128275, 47.639429], "resultTypes": ["Address", "PopulatedPlace"] }, { "coordinates": [-122.341979399674, 47.6095253501216] } ] } Objekt batchItem reverzního geokódování může přijmout některý z podporovaných parametrů identifikátoru URIzpětného geografického kódování. Dávka by měla obsahovat alespoň 1 dotaz. Model dávkové odpovědi Dávková odpověď obsahuje komponentu summarytotalRequests , která označuje, které byly součástí původního dávkového požadavku, a successfulRequests tj. dotazy, které byly úspěšně provedeny. Dávková odpověď obsahuje batchItems také pole, které obsahuje odpověď pro každý dotaz v dávkovém požadavku. Bude batchItems obsahovat výsledky v přesně stejném pořadí, v jakém byly původní dotazy odeslány v dávkovém požadavku. Každá položka má jeden z následujících typů: GeocodingResponse – Pokud se dotaz úspěšně dokončil. Error – Pokud dotaz selhal. Odpověď bude v tomto případě obsahovat a code .message
SearchGetReverseGeocodingBatchBodyParam
SearchGetReverseGeocodingBatchDefaultResponse	Rozhraní API služby Batch pro reverzní geokódování Platí pro: viz cenové úrovně. Rozhraní BATCH API pro reverzní geokódování odesílá dávky dotazů do rozhraní API pro reverzní geokódování pomocí jediného volání rozhraní API. Rozhraní API umožňuje volajícímu dávkovat až 100 dotazů. Odeslání synchronní dávkové žádosti Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží požadavek, zareaguje hned po výpočtu dávkových položek a nebude možné později načíst výsledky. Synchronní rozhraní API vrátí chybu časového limitu (odpověď 408), pokud požadavek trvá déle než 60 sekund. Počet dávkových položek je pro toto rozhraní API omezený na 100 . POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01 Text POST pro dávkový požadavek K odeslání dotazů zpětného geografického kódování použijete POST požadavek, kde text požadavku bude obsahovat batchItems pole ve json formátu a hlavička Content-Type bude nastavena na application/json. Tady je ukázkový text požadavku obsahující 2 dotazy zpětného geografického kódování : { "batchItems": [ { "coordinates": [-122.128275, 47.639429], "resultTypes": ["Address", "PopulatedPlace"] }, { "coordinates": [-122.341979399674, 47.6095253501216] } ] } Objekt batchItem reverzního geokódování může přijmout některý z podporovaných parametrů identifikátoru URIzpětného geografického kódování. Dávka by měla obsahovat alespoň 1 dotaz. Model dávkové odpovědi Dávková odpověď obsahuje komponentu summarytotalRequests , která označuje, které byly součástí původního dávkového požadavku, a successfulRequests tj. dotazy, které byly úspěšně provedeny. Dávková odpověď obsahuje batchItems také pole, které obsahuje odpověď pro každý dotaz v dávkovém požadavku. Bude batchItems obsahovat výsledky v přesně stejném pořadí, v jakém byly původní dotazy odeslány v dávkovém požadavku. Každá položka má jeden z následujících typů: GeocodingResponse – Pokud se dotaz úspěšně dokončil. Error – Pokud dotaz selhal. Odpověď bude v tomto případě obsahovat a code .message
SearchGetReverseGeocodingBatchMediaTypesParam
SearchGetReverseGeocodingDefaultResponse	Reverzní geokódování Platí pro: viz cenové úrovně. Přeloží souřadnici (příklad: 37,786505, -122,3862) na srozumitelnou adresu. Nejčastěji je to potřeba ve sledovacích aplikacích, kde přijímáte informační kanál GPS ze zařízení nebo prostředku a chcete vědět, na jaké adrese se souřadnice nachází. Tento koncový bod vrátí informace o adrese pro danou souřadnici.
SearchGetReverseGeocodingQueryParam
SearchGetReverseGeocodingQueryParamProperties

Aliasy typu

GeoJsonFeatureOutput	Platný GeoJSON Feature typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonGeometryOutput	Platný GeoJSON objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonObjectOutput	Platný GeoJSON objekt. Podrobnosti najdete v dokumentu RFC 7946 .
MapsSearchClient
SearchGetGeocodingBatchParameters
SearchGetGeocodingParameters
SearchGetPolygonParameters
SearchGetReverseGeocodingBatchParameters
SearchGetReverseGeocodingParameters

Funkce

default(AzureKeyCredential, ClientOptions)	Vytvoří instanci MapsSearchClient z klíče předplatného. Příklad 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)	Vytvoří instanci MapsSearch z identity TokenCredentialAzure . Příklad 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)	Vytvoří instanci MapsSearch z identity AzureSASCredentialAzure . Příklad 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)

Podrobnosti funkce

default(AzureKeyCredential, ClientOptions)

Vytvoří instanci MapsSearchClient z klíče předplatného.

Příklad

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

Parametry

credential

AzureKeyCredential

Instance AzureKeyCredential používaná k ověřování požadavků na službu

options

ClientOptions

Možnosti použité ke konfiguraci klienta vyhledávání

Návraty

MapsSearchClient

default(TokenCredential, string, ClientOptions)

Vytvoří instanci MapsSearch z identity TokenCredentialAzure .

Příklad

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

Parametry

credential

TokenCredential

Instance TokenCredential používaná k ověřování požadavků na službu

mapsAccountClientId

string

ID klienta Azure Maps konkrétního prostředku mapování

options

ClientOptions

Možnosti použité ke konfiguraci klienta vyhledávání

Návraty

MapsSearchClient

default(AzureSASCredential, ClientOptions)

Vytvoří instanci MapsSearch z identity AzureSASCredentialAzure .

Příklad

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

Parametry

credential

AzureSASCredential

Instance AzureSASCredential používaná k ověřování požadavků na službu

options

ClientOptions

Možnosti použité ke konfiguraci klienta vyhledávání

Návraty

MapsSearchClient

isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)

function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response

Parametry

response

SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse

Návraty

response

isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)

function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response

Parametry

response

SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse

Návraty

response

isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)

function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response

Parametry

response

SearchGetPolygon200Response | SearchGetPolygonDefaultResponse

Návraty

response

isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)

function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response

Parametry

response

SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse

Návraty

response

isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)

function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response

Parametry

response

SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse

Návraty

response