@azure-rest/maps-search package

Rozhraní

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput	Adresa výsledku
BoundaryOutput	GeoJSON GeocodingFeature objekt, který popisuje hranice geografické oblasti. Geometrie funkce je popsána pomocí GeoJSON GeometryCollection. Upozorňujeme, že služba obvykle vrací geometryCollection s polygonem nebo multipolygon podtypy.
BoundaryPropertiesOutput	Vlastnosti objektu hranice.
ErrorAdditionalInfoOutput	Další informace o chybě správy prostředků
ErrorDetailOutput	Podrobnosti o chybě.
ErrorResponseOutput	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
FeaturesItemOutput
FeaturesItemPropertiesOutput
GeoJsonFeatureCollectionDataOutput
GeoJsonFeatureCollectionOutput	Platný typ objektu GeoJSON FeatureCollection. Podrobnosti najdete v RFC 7946.
GeoJsonFeatureDataOutput
GeoJsonFeatureOutputParent	Platný typ objektu GeoJSON Feature. Podrobnosti najdete v RFC 7946.
GeoJsonGeometryCollectionDataOutput
GeoJsonGeometryCollectionOutput	Platný typ objektu GeoJSON GeometryCollection. Podrobnosti najdete v RFC 7946.
GeoJsonGeometryOutputParent	Platný objekt geometrie GeoJSON. Typ musí být jedním z sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v RFC 7946.
GeoJsonLineStringDataOutput
GeoJsonLineStringOutput	Platný typ geometrie GeoJSON LineString. Podrobnosti najdete v RFC 7946.
GeoJsonMultiLineStringDataOutput
GeoJsonMultiLineStringOutput	Platný typ geometrie GeoJSON MultiLineString. Podrobnosti najdete v RFC 7946.
GeoJsonMultiPointDataOutput	Data obsažená GeoJson MultiPoint.
GeoJsonMultiPointOutput	Platný typ geometrie GeoJSON MultiPoint. Podrobnosti najdete v RFC 7946.
GeoJsonMultiPolygonDataOutput
GeoJsonMultiPolygonOutput	Platný typ objektu GeoJSON MultiPolygon. Podrobnosti najdete v RFC 7946.
GeoJsonObjectOutputParent	Platný objekt GeoJSON. Podrobnosti najdete v RFC 7946.
GeoJsonPointDataOutput	Data obsažená GeoJson Point.
GeoJsonPointOutput	Platný typ geometrie GeoJSON Point. Podrobnosti najdete v RFC 7946.
GeoJsonPolygonDataOutput
GeoJsonPolygonOutput	Platný typ geometrie GeoJSON Polygon. Podrobnosti najdete v RFC 7946.
GeocodePointsItemOutput
GeocodingBatchRequestBody	Seznam dotazů nebo požadavků na geokódování adres, které se mají zpracovat. 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ódingu.
GeocodingBatchResponseSummaryOutput	Souhrn 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 hranice.
GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput	Adresa výsledku.
MapsSearchClientOptions	Volitelné parametry klienta
ReverseGeocodingBatchRequestBody	Seznam reverzních geokódovacích dotazů nebo požadavků, které se mají zpracovat. Seznam může obsahovat maximálně 100 dotazů a musí obsahovat alespoň 1 dotaz.
ReverseGeocodingBatchRequestItem	Objekt Batch Query
Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response	Rozhraní Get Geocoding API je požadavek HTTP GET, který vrací souřadnice zeměpisné délky a zeměpisné šířky prohledávaného umístění. V mnoha případech může být kompletní vyhledávací služba příliš velká, například pokud vás zajímá pouze tradiční geokódování. K vyhledávání adres se dá přistupovat také výhradně. Geokódování se provádí tak, že na koncový bod geokódování dosáhnete jenom adresy nebo částečné adresy. Index vyhledávání geokódování bude dotazován na vše nad daty na úrovni ulice. Nebudou vráceny žádné body zájmu (POI). Mějte na paměti, že geokódér je velmi odolný proti překlepům a neúplným adresům. Bude také zpracovávat vše od přesných adres ulic nebo ulic nebo průsečíků i zeměpisných oblastí vyšší úrovně, jako jsou centra měst, okresy a státy. Odpověď také vrátí podrobné vlastnosti adresy, jako je ulice, PSČ, obec a informace o zemi/oblasti.
SearchGetGeocodingBatch200Response	Rozhraní API Get Geocoding Batch je požadavek HTTP POST, který odesílá dávky až 100 dotazů do rozhraní API geokódování v jednom požadavku. Odeslat synchronní dávkový požadavek Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží požadavek, odpoví hned po výpočtu dávkových položek a později nebude možné 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 omezený na 100 pro toto rozhraní API. POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01 Text POST pro dávkový požadavek K odeslání geokódování dotazů použijete požadavek POST, kde text požadavku bude obsahovat pole batchItems ve formátu json a hlavička Content-Type bude nastavená na application/json. Tady je ukázkový text požadavku obsahující 2 geokódování dotazů: { "batchItems": [ { "addressLine": "One, Microsoft Way, Redmond, WA 98052", "top": 2 }, { "addressLine": "Pike Pl", "adminDistrict": "WA", "locality": "Seattle", "top": 3 } ] } Objekt batchItem geokódování může přijmout některý z podporovaných parametrů geografického kódováníidentifikátoru URI. Dávka by měla obsahovat alespoň 1 dotazu. Model dávkové odpovědi Dávková odpověď obsahuje komponentu summary, která označuje totalRequests, které byly součástí původní dávkové žádosti a successfulRequests tj. dotazy, které byly úspěšně provedeny. Dávková odpověď obsahuje také pole batchItems, které obsahuje odpověď pro každý dotaz v dávkovém požadavku. batchItems bude obsahovat výsledky ve stejném pořadí, v jakém byly původní dotazy odeslány v dávkové žádosti. 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 obsahovat code a v tomto případě message.
SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse	Rozhraní API Get Geocoding Batch je požadavek HTTP POST, který odesílá dávky až 100 dotazů do rozhraní API geokódování v jednom požadavku. Odeslat synchronní dávkový požadavek Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží požadavek, odpoví hned po výpočtu dávkových položek a později nebude možné 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 omezený na 100 pro toto rozhraní API. POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01 Text POST pro dávkový požadavek K odeslání geokódování dotazů použijete požadavek POST, kde text požadavku bude obsahovat pole batchItems ve formátu json a hlavička Content-Type bude nastavená na application/json. Tady je ukázkový text požadavku obsahující 2 geokódování dotazů: { "batchItems": [ { "addressLine": "One, Microsoft Way, Redmond, WA 98052", "top": 2 }, { "addressLine": "Pike Pl", "adminDistrict": "WA", "locality": "Seattle", "top": 3 } ] } Objekt batchItem geokódování může přijmout některý z podporovaných parametrů geografického kódováníidentifikátoru URI. Dávka by měla obsahovat alespoň 1 dotazu. Model dávkové odpovědi Dávková odpověď obsahuje komponentu summary, která označuje totalRequests, které byly součástí původní dávkové žádosti a successfulRequests tj. dotazy, které byly úspěšně provedeny. Dávková odpověď obsahuje také pole batchItems, které obsahuje odpověď pro každý dotaz v dávkovém požadavku. batchItems bude obsahovat výsledky ve stejném pořadí, v jakém byly původní dotazy odeslány v dávkové žádosti. 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 obsahovat code a v tomto případě message.
SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse	Rozhraní Get Geocoding API je požadavek HTTP GET, který vrací souřadnice zeměpisné délky a zeměpisné šířky prohledávaného umístění. V mnoha případech může být kompletní vyhledávací služba příliš velká, například pokud vás zajímá pouze tradiční geokódování. K vyhledávání adres se dá přistupovat také výhradně. Geokódování se provádí tak, že na koncový bod geokódování dosáhnete jenom adresy nebo částečné adresy. Index vyhledávání geokódování bude dotazován na vše nad daty na úrovni ulice. Nebudou vráceny žádné body zájmu (POI). Mějte na paměti, že geokódér je velmi odolný proti překlepům a neúplným adresům. Bude také zpracovávat vše od přesných adres ulic nebo ulic nebo průsečíků i zeměpisných oblastí vyšší úrovně, jako jsou centra měst, okresy a státy. Odpověď také vrátí podrobné vlastnosti adresy, jako je ulice, PSČ, obec a informace o zemi/oblasti.
SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response	Rozhraní API Get Polygon je požadavek HTTP GET, který poskytuje mnohoúhelníková data obrysu geografické oblasti, jako je město nebo oblast země.
SearchGetPolygonDefaultResponse	Rozhraní API Get Polygon je požadavek HTTP GET, který poskytuje mnohoúhelníková data obrysu geografické oblasti, jako je město nebo oblast země.
SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response	Rozhraní API Get Reverse Geocoding je požadavek HTTP GET, který se používá k překladu souřadnic (například 37.786505, -122.3862) do srozumitelné poštovní adresy člověka. Užitečné při sledování aplikací, kde obdržíte GPS informační kanál ze zařízení nebo prostředku a chcete znát adresu přidruženou ke souřadnicům. Tento koncový bod vrátí informace o adrese pro danou souřadnici.
SearchGetReverseGeocodingBatch200Response	Rozhraní API Get Reverse Geocoding Batch je požadavek HTTP POST, který odesílá dávky až 100 dotazů do zpětného geokódování api pomocí jednoho požadavku. Odeslat synchronní dávkový požadavek Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží požadavek, odpoví hned po výpočtu dávkových položek a později nebude možné 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 omezený na 100 pro toto rozhraní API. POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01 Text POST pro dávkový požadavek K odeslání zpětného geografického kódování dotazů použijete požadavek POST, kde text požadavku bude obsahovat pole batchItems ve formátu json a hlavička Content-Type bude nastavena na application/json. Tady je ukázkový text požadavku obsahující 2 zpětné geografické kódování dotazů: { "batchItems": [ { "coordinates": [-122.128275, 47.639429], "resultTypes": ["Address", "PopulatedPlace"] }, { "coordinates": [-122.341979399674, 47.6095253501216] } ] } zpětné geografické kódování objekt batchItem může přijmout kterýkoli z podporovaných reverzní geokódováníparametry identifikátoru URI. Dávka by měla obsahovat alespoň 1 dotazu. Model dávkové odpovědi Dávková odpověď obsahuje komponentu summary, která označuje totalRequests, které byly součástí původní dávkové žádosti a successfulRequests tj. dotazy, které byly úspěšně provedeny. Dávková odpověď obsahuje také pole batchItems, které obsahuje odpověď pro každý dotaz v dávkovém požadavku. batchItems bude obsahovat výsledky ve stejném pořadí, v jakém byly původní dotazy odeslány v dávkové žádosti. 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 obsahovat code a v tomto případě message.
SearchGetReverseGeocodingBatchBodyParam
SearchGetReverseGeocodingBatchDefaultResponse	Rozhraní API Get Reverse Geocoding Batch je požadavek HTTP POST, který odesílá dávky až 100 dotazů do zpětného geokódování api pomocí jednoho požadavku. Odeslat synchronní dávkový požadavek Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží požadavek, odpoví hned po výpočtu dávkových položek a později nebude možné 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 omezený na 100 pro toto rozhraní API. POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01 Text POST pro dávkový požadavek K odeslání zpětného geografického kódování dotazů použijete požadavek POST, kde text požadavku bude obsahovat pole batchItems ve formátu json a hlavička Content-Type bude nastavena na application/json. Tady je ukázkový text požadavku obsahující 2 zpětné geografické kódování dotazů: { "batchItems": [ { "coordinates": [-122.128275, 47.639429], "resultTypes": ["Address", "PopulatedPlace"] }, { "coordinates": [-122.341979399674, 47.6095253501216] } ] } zpětné geografické kódování objekt batchItem může přijmout kterýkoli z podporovaných reverzní geokódováníparametry identifikátoru URI. Dávka by měla obsahovat alespoň 1 dotazu. Model dávkové odpovědi Dávková odpověď obsahuje komponentu summary, která označuje totalRequests, které byly součástí původní dávkové žádosti a successfulRequests tj. dotazy, které byly úspěšně provedeny. Dávková odpověď obsahuje také pole batchItems, které obsahuje odpověď pro každý dotaz v dávkovém požadavku. batchItems bude obsahovat výsledky ve stejném pořadí, v jakém byly původní dotazy odeslány v dávkové žádosti. 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 obsahovat code a v tomto případě message.
SearchGetReverseGeocodingBatchMediaTypesParam
SearchGetReverseGeocodingDefaultResponse	Rozhraní API Get Reverse Geocoding je požadavek HTTP GET, který se používá k překladu souřadnic (například 37.786505, -122.3862) do srozumitelné poštovní adresy člověka. Užitečné při sledování aplikací, kde obdržíte GPS informační kanál ze zařízení nebo prostředku a chcete znát adresu přidruženou ke souřadnicům. Tento koncový bod vrátí informace o adrese pro danou souřadnici.
SearchGetReverseGeocodingQueryParam
SearchGetReverseGeocodingQueryParamProperties

Aliasy typu

GeoJsonFeatureOutput	Platný typ objektu GeoJSON Feature. Podrobnosti najdete v RFC 7946.
GeoJsonGeometryOutput	Platný objekt geometrie GeoJSON. Typ musí být jedním z sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v RFC 7946.
GeoJsonObjectOutput	Platný objekt GeoJSON. Podrobnosti najdete v 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 azure Identity TokenCredential. 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 azure Identity AzureSASCredential. 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žitá k ověření požadavků na službu

options

ClientOptions

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

Návraty

MapsSearchClient

default(TokenCredential, string, ClientOptions)

Vytvoří instanci MapsSearch z azure Identity TokenCredential.

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žitá k ověření požadavků na službu

mapsAccountClientId

string

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

options

ClientOptions

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

Návraty

MapsSearchClient

default(AzureSASCredential, ClientOptions)

Vytvoří instanci MapsSearch z azure Identity AzureSASCredential.

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žitá k ověřování požadavků na službu

options

ClientOptions

Možnosti používané 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