@azure-rest/maps-search package

Interfejsy

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput	Adres wyniku
BoundaryOutput	GeoJSON GeocodingFeature obiekt opisujący granice obszaru geograficznego. Geometria funkcji została opisana przy użyciu GeoJSON GeometryCollection. Należy pamiętać, że usługa zwykle zwraca element GeometryCollection z podtypami Polygon lub MultiPolygon.
BoundaryPropertiesOutput	Właściwości obiektu Granica.
ErrorAdditionalInfoOutput	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetailOutput	Szczegóły błędu.
ErrorResponseOutput	Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
FeaturesItemOutput
FeaturesItemPropertiesOutput
GeoJsonFeatureCollectionDataOutput
GeoJsonFeatureCollectionOutput	Prawidłowy typ obiektu GeoJSON FeatureCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonFeatureDataOutput
GeoJsonFeatureOutputParent	Prawidłowy typ obiektu GeoJSON Feature. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonGeometryCollectionDataOutput
GeoJsonGeometryCollectionOutput	Prawidłowy typ obiektu GeoJSON GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonGeometryOutputParent	Prawidłowy obiekt geometrii GeoJSON. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonLineStringDataOutput
GeoJsonLineStringOutput	Prawidłowy typ geometrii GeoJSON LineString. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonMultiLineStringDataOutput
GeoJsonMultiLineStringOutput	Prawidłowy typ geometrii GeoJSON MultiLineString. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonMultiPointDataOutput	Dane zawarte w GeoJson MultiPoint.
GeoJsonMultiPointOutput	Prawidłowy typ geometrii GeoJSON MultiPoint. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonMultiPolygonDataOutput
GeoJsonMultiPolygonOutput	Prawidłowy typ obiektu GeoJSON MultiPolygon. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonObjectOutputParent	Prawidłowy obiekt GeoJSON. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonPointDataOutput	Dane zawarte w GeoJson Point.
GeoJsonPointOutput	Prawidłowy typ geometrii GeoJSON Point. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonPolygonDataOutput
GeoJsonPolygonOutput	Prawidłowy typ geometrii GeoJSON Polygon. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeocodePointsItemOutput
GeocodingBatchRequestBody	Lista adresów geokodowania zapytań/żądań do przetworzenia. Lista może zawierać maksymalnie 100 zapytań i musi zawierać co najmniej 1 kwerendę.
GeocodingBatchRequestItem	Obiekt Zapytania wsadowego
GeocodingBatchResponseItemOutput
GeocodingBatchResponseOutput	Ten obiekt jest zwracany z pomyślnego wywołania usługi Batch Geokoding.
GeocodingBatchResponseSummaryOutput	Podsumowanie żądania wsadowego
GeocodingResponseOutput	Ten obiekt jest zwracany z pomyślnego wywołania geokodowania
GeometryCopyrightOutput	Informacje o prawach autorskich geometrii obiektu granic.
GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput	Adres wyniku.
MapsSearchClientOptions	Opcjonalne parametry klienta
ReverseGeocodingBatchRequestBody	Lista odwrotnych zapytań/żądań geokodowania do przetworzenia. Lista może zawierać maksymalnie 100 zapytań i musi zawierać co najmniej 1 kwerendę.
ReverseGeocodingBatchRequestItem	Obiekt Zapytania wsadowego
Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response	Interfejs API Get Geocoding to żądanie GET HTTP, które zwraca współrzędne długości i szerokości geograficznej przeszukiwanej lokalizacji. W wielu przypadkach kompletna usługa wyszukiwania może być zbyt duża, na przykład jeśli interesuje Cię tylko tradycyjne geokodowanie. Dostęp do wyszukiwania adresów można również uzyskać w trybie wyłącznym. Geokodowanie odbywa się przez trafienie punktu końcowego geokodowania tylko do adresu lub adresu częściowego. Indeks wyszukiwania geokodowania zostanie zapytany o wszystkie elementy powyżej danych na poziomie ulicy. Nie zostanie zwrócony żaden punkt orientacyjny (POI). Należy pamiętać, że geokoder jest bardzo odporny na literówki i niekompletne adresy. Będzie również obsługiwać wszystko, od dokładnych adresów ulicznych lub ulic lub skrzyżowania, a także lokalizacji geograficznych wyższego poziomu, takich jak centra miasta, powiaty i stany. Odpowiedź zwraca również szczegółowe właściwości adresu, takie jak ulica, kod pocztowy, gminy i informacje o kraju/regionie.
SearchGetGeocodingBatch200Response	Interfejs API Get Geocoding Batch to żądanie POST HTTP, które wysyła partie do 100 zapytań do interfejsu API geokodowania w jednym żądaniu. Przesyłanie synchronicznego żądania usługi Batch Interfejs API synchroniczny jest zalecany w przypadku lekkich żądań wsadowych. Gdy usługa odbierze żądanie, odpowie natychmiast po obliczeniu elementów wsadowych i nie będzie możliwe późniejsze pobranie wyników. Interfejs API synchroniczny zwróci błąd limitu czasu (odpowiedź 408), jeśli żądanie trwa dłużej niż 60 sekund. Liczba elementów wsadowych jest ograniczona do 100 dla tego interfejsu API. POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01 Treść POST dla żądania wsadowego Aby wysłać zapytania geokodowania, użyjesz żądania , w którym treść żądania będzie zawierać tablicę w formacie , a nagłówek zostanie ustawiony na wartość . Oto przykładowa treść żądania zawierająca 2 geokodowanie zapytań: { "batchItems": [ { "addressLine": "One, Microsoft Way, Redmond, WA 98052", "top": 2 }, { "addressLine": "Pike Pl", "adminDistrict": "WA", "locality": "Seattle", "top": 3 } ] } Obiekt geokodowania batchItem może zaakceptować dowolny z obsługiwanych parametrów geokodowania identyfikatora URI. Partia powinna zawierać co najmniej 1 kwerendy. Model odpowiedzi wsadowej Odpowiedź wsadowa zawiera składnik summary wskazujący totalRequests, które były częścią oryginalnego żądania wsadowego i successfulRequests tj. zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę batchItems zawierającą odpowiedź dla każdego zapytania w żądaniu wsadowym. batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element jest jednym z następujących typów: GeocodingResponse — jeśli zapytanie zostało ukończone pomyślnie. Error — jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać code i message w tym przypadku.
SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse	Interfejs API Get Geocoding Batch to żądanie POST HTTP, które wysyła partie do 100 zapytań do interfejsu API geokodowania w jednym żądaniu. Przesyłanie synchronicznego żądania usługi Batch Interfejs API synchroniczny jest zalecany w przypadku lekkich żądań wsadowych. Gdy usługa odbierze żądanie, odpowie natychmiast po obliczeniu elementów wsadowych i nie będzie możliwe późniejsze pobranie wyników. Interfejs API synchroniczny zwróci błąd limitu czasu (odpowiedź 408), jeśli żądanie trwa dłużej niż 60 sekund. Liczba elementów wsadowych jest ograniczona do 100 dla tego interfejsu API. POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01 Treść POST dla żądania wsadowego Aby wysłać zapytania geokodowania, użyjesz żądania , w którym treść żądania będzie zawierać tablicę w formacie , a nagłówek zostanie ustawiony na wartość . Oto przykładowa treść żądania zawierająca 2 geokodowanie zapytań: { "batchItems": [ { "addressLine": "One, Microsoft Way, Redmond, WA 98052", "top": 2 }, { "addressLine": "Pike Pl", "adminDistrict": "WA", "locality": "Seattle", "top": 3 } ] } Obiekt geokodowania batchItem może zaakceptować dowolny z obsługiwanych parametrów geokodowania identyfikatora URI. Partia powinna zawierać co najmniej 1 kwerendy. Model odpowiedzi wsadowej Odpowiedź wsadowa zawiera składnik summary wskazujący totalRequests, które były częścią oryginalnego żądania wsadowego i successfulRequests tj. zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę batchItems zawierającą odpowiedź dla każdego zapytania w żądaniu wsadowym. batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element jest jednym z następujących typów: GeocodingResponse — jeśli zapytanie zostało ukończone pomyślnie. Error — jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać code i message w tym przypadku.
SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse	Interfejs API Get Geocoding to żądanie GET HTTP, które zwraca współrzędne długości i szerokości geograficznej przeszukiwanej lokalizacji. W wielu przypadkach kompletna usługa wyszukiwania może być zbyt duża, na przykład jeśli interesuje Cię tylko tradycyjne geokodowanie. Dostęp do wyszukiwania adresów można również uzyskać w trybie wyłącznym. Geokodowanie odbywa się przez trafienie punktu końcowego geokodowania tylko do adresu lub adresu częściowego. Indeks wyszukiwania geokodowania zostanie zapytany o wszystkie elementy powyżej danych na poziomie ulicy. Nie zostanie zwrócony żaden punkt orientacyjny (POI). Należy pamiętać, że geokoder jest bardzo odporny na literówki i niekompletne adresy. Będzie również obsługiwać wszystko, od dokładnych adresów ulicznych lub ulic lub skrzyżowania, a także lokalizacji geograficznych wyższego poziomu, takich jak centra miasta, powiaty i stany. Odpowiedź zwraca również szczegółowe właściwości adresu, takie jak ulica, kod pocztowy, gminy i informacje o kraju/regionie.
SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response	Interfejs API Get Polygon to żądanie GET HTTP, które dostarcza dane wielokątne konturu obszaru geograficznego, takiego jak miasto lub region kraju.
SearchGetPolygonDefaultResponse	Interfejs API Get Polygon to żądanie GET HTTP, które dostarcza dane wielokątne konturu obszaru geograficznego, takiego jak miasto lub region kraju.
SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response	Interfejs API Get Reverse Geocoding to żądanie GET HTTP używane do tłumaczenia współrzędnych (na przykład: 37.786505, -122.3862) na zrozumiały dla człowieka adres ulicy. Przydatne w aplikacjach do śledzenia, w których otrzymujesz kanał informacyjny GPS z urządzenia lub elementu zawartości i chcesz znać adres skojarzony ze współrzędnymi. Ten punkt końcowy zwróci informacje o adresie dla danej współrzędnej.
SearchGetReverseGeocodingBatch200Response	Interfejs API Get Reverse Geocoding Batch to żądanie POST HTTP, które wysyła partie do 100 zapytań w celu odwrotnego geokodowania interfejsu API przy użyciu pojedynczego żądania. Przesyłanie synchronicznego żądania usługi Batch Interfejs API synchroniczny jest zalecany w przypadku lekkich żądań wsadowych. Gdy usługa odbierze żądanie, odpowie natychmiast po obliczeniu elementów wsadowych i nie będzie możliwe późniejsze pobranie wyników. Interfejs API synchroniczny zwróci błąd limitu czasu (odpowiedź 408), jeśli żądanie trwa dłużej niż 60 sekund. Liczba elementów wsadowych jest ograniczona do 100 dla tego interfejsu API. POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01 Treść POST dla żądania wsadowego Aby wysłać zapytania odwrotnego geokodowania, użyjesz żądania , w którym treść żądania będzie zawierać tablicę w formacie , a nagłówek zostanie ustawiony na wartość . Oto przykładowa treść żądania zawierająca 2 odwrotne geokodowanie zapytań: { "batchItems": [ { "coordinates": [-122.128275, 47.639429], "resultTypes": ["Address", "PopulatedPlace"] }, { "coordinates": [-122.341979399674, 47.6095253501216] } ] } Obiekt odwrotnego geokodowania batchItem może zaakceptować dowolny z obsługiwanych odwrotnego geokodowaniaparametrów identyfikatora URI. Partia powinna zawierać co najmniej 1 kwerendy. Model odpowiedzi wsadowej Odpowiedź wsadowa zawiera składnik summary wskazujący totalRequests, które były częścią oryginalnego żądania wsadowego i successfulRequests tj. zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę batchItems zawierającą odpowiedź dla każdego zapytania w żądaniu wsadowym. batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element jest jednym z następujących typów: GeocodingResponse — jeśli zapytanie zostało ukończone pomyślnie. Error — jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać code i message w tym przypadku.
SearchGetReverseGeocodingBatchBodyParam
SearchGetReverseGeocodingBatchDefaultResponse	Interfejs API Get Reverse Geocoding Batch to żądanie POST HTTP, które wysyła partie do 100 zapytań w celu odwrotnego geokodowania interfejsu API przy użyciu pojedynczego żądania. Przesyłanie synchronicznego żądania usługi Batch Interfejs API synchroniczny jest zalecany w przypadku lekkich żądań wsadowych. Gdy usługa odbierze żądanie, odpowie natychmiast po obliczeniu elementów wsadowych i nie będzie możliwe późniejsze pobranie wyników. Interfejs API synchroniczny zwróci błąd limitu czasu (odpowiedź 408), jeśli żądanie trwa dłużej niż 60 sekund. Liczba elementów wsadowych jest ograniczona do 100 dla tego interfejsu API. POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01 Treść POST dla żądania wsadowego Aby wysłać zapytania odwrotnego geokodowania, użyjesz żądania , w którym treść żądania będzie zawierać tablicę w formacie , a nagłówek zostanie ustawiony na wartość . Oto przykładowa treść żądania zawierająca 2 odwrotne geokodowanie zapytań: { "batchItems": [ { "coordinates": [-122.128275, 47.639429], "resultTypes": ["Address", "PopulatedPlace"] }, { "coordinates": [-122.341979399674, 47.6095253501216] } ] } Obiekt odwrotnego geokodowania batchItem może zaakceptować dowolny z obsługiwanych odwrotnego geokodowaniaparametrów identyfikatora URI. Partia powinna zawierać co najmniej 1 kwerendy. Model odpowiedzi wsadowej Odpowiedź wsadowa zawiera składnik summary wskazujący totalRequests, które były częścią oryginalnego żądania wsadowego i successfulRequests tj. zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę batchItems zawierającą odpowiedź dla każdego zapytania w żądaniu wsadowym. batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element jest jednym z następujących typów: GeocodingResponse — jeśli zapytanie zostało ukończone pomyślnie. Error — jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać code i message w tym przypadku.
SearchGetReverseGeocodingBatchMediaTypesParam
SearchGetReverseGeocodingDefaultResponse	Interfejs API Get Reverse Geocoding to żądanie GET HTTP używane do tłumaczenia współrzędnych (na przykład: 37.786505, -122.3862) na zrozumiały dla człowieka adres ulicy. Przydatne w aplikacjach do śledzenia, w których otrzymujesz kanał informacyjny GPS z urządzenia lub elementu zawartości i chcesz znać adres skojarzony ze współrzędnymi. Ten punkt końcowy zwróci informacje o adresie dla danej współrzędnej.
SearchGetReverseGeocodingQueryParam
SearchGetReverseGeocodingQueryParamProperties

Aliasy typu

GeoJsonFeatureOutput	Prawidłowy typ obiektu GeoJSON Feature. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonGeometryOutput	Prawidłowy obiekt geometrii GeoJSON. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonObjectOutput	Prawidłowy obiekt GeoJSON. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
MapsSearchClient
SearchGetGeocodingBatchParameters
SearchGetGeocodingParameters
SearchGetPolygonParameters
SearchGetReverseGeocodingBatchParameters
SearchGetReverseGeocodingParameters

Funkcje

default(AzureKeyCredential, ClientOptions)	Tworzy wystąpienie elementu MapsSearchClient na podstawie klucza subskrypcji. Przykład 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)	Tworzy wystąpienie usługi MapsSearch na podstawie TokenCredentialtożsamości platformy Azure. Przykład 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)	Tworzy wystąpienie usługi MapsSearch na podstawie AzureSASCredentialtożsamości platformy Azure. Przykład 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)

Szczegóły funkcji

default(AzureKeyCredential, ClientOptions)

Tworzy wystąpienie elementu MapsSearchClient na podstawie klucza subskrypcji.

Przykład

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

Wystąpienie azureKeyCredential używane do uwierzytelniania żądań w usłudze

options

ClientOptions

Opcje używane do konfigurowania klienta wyszukiwania

Zwraca

MapsSearchClient

default(TokenCredential, string, ClientOptions)

Tworzy wystąpienie usługi MapsSearch na podstawie TokenCredentialtożsamości platformy Azure.

Przykład

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

Wystąpienie TokenCredential używane do uwierzytelniania żądań w usłudze

mapsAccountClientId

string

Identyfikator klienta usługi Azure Maps określonego zasobu mapy

options

ClientOptions

Opcje używane do konfigurowania klienta wyszukiwania

Zwraca

MapsSearchClient

default(AzureSASCredential, ClientOptions)

Tworzy wystąpienie usługi MapsSearch na podstawie AzureSASCredentialtożsamości platformy Azure.

Przykład

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

Wystąpienie AzureSASCredential używane do uwierzytelniania żądań w usłudze

options

ClientOptions

Opcje używane do konfigurowania klienta wyszukiwania

Zwraca

MapsSearchClient

isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)

function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response

Parametry

response

SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse

Zwraca

response

isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)

function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response

Parametry

response

SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse

Zwraca

response

isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)

function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response

Parametry

response

SearchGetPolygon200Response | SearchGetPolygonDefaultResponse

Zwraca

response

isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)

function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response

Parametry

response

SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse

Zwraca

response

isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)

function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response

Parametry

response

SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse

Zwraca

response