@azure-rest/maps-search package
Gränssnitt
AddressAdminDistrictsItemOutput | |
AddressCountryRegionOutput | |
AddressOutput |
Resultatets adress |
BoundaryOutput |
Observera att tjänsten vanligtvis returnerar ett GeometryCollection med polygon- eller multipolygonundertyper. |
BoundaryPropertiesOutput |
Egenskaper för ett gränsobjekt. |
ErrorAdditionalInfoOutput |
Ytterligare information om resurshanteringsfelet. |
ErrorDetailOutput |
Felinformationen. |
ErrorResponseOutput |
Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.). |
FeaturesItemOutput | |
FeaturesItemPropertiesOutput | |
GeoJsonFeatureCollectionDataOutput | |
GeoJsonFeatureCollectionOutput |
En giltig |
GeoJsonFeatureDataOutput | |
GeoJsonFeatureOutputParent |
En giltig |
GeoJsonGeometryCollectionDataOutput | |
GeoJsonGeometryCollectionOutput |
En giltig |
GeoJsonGeometryOutputParent |
Ett giltigt |
GeoJsonLineStringDataOutput | |
GeoJsonLineStringOutput |
En giltig |
GeoJsonMultiLineStringDataOutput | |
GeoJsonMultiLineStringOutput |
En giltig |
GeoJsonMultiPointDataOutput |
Data som finns i en |
GeoJsonMultiPointOutput |
En giltig |
GeoJsonMultiPolygonDataOutput | |
GeoJsonMultiPolygonOutput |
En giltig |
GeoJsonObjectOutputParent |
Ett giltigt |
GeoJsonPointDataOutput |
Data som finns i en |
GeoJsonPointOutput |
En giltig |
GeoJsonPolygonDataOutput | |
GeoJsonPolygonOutput |
En giltig |
GeocodePointsItemOutput | |
GeocodingBatchRequestBody |
Listan över adresser för geokodningsfrågor/begäranden som ska bearbetas. Listan kan innehålla högst 100 frågor och måste innehålla minst 1 fråga. |
GeocodingBatchRequestItem |
Batch Query-objekt |
GeocodingBatchResponseItemOutput | |
GeocodingBatchResponseOutput |
Det här objektet returneras från ett lyckat Batch-tjänstanrop för geokodning. |
GeocodingBatchResponseSummaryOutput |
Sammanfattning av batchbegäran |
GeocodingResponseOutput |
Det här objektet returneras från ett lyckat geokodningsanrop |
GeometryCopyrightOutput |
Copyrightinformation om en geometri för ett gränsobjekt. |
GetGeocoding | |
GetGeocodingBatch | |
GetPolygon | |
GetReverseGeocoding | |
GetReverseGeocodingBatch | |
IntersectionOutput |
Resultatets adress. |
MapsSearchClientOptions |
Valfria parametrar för klienten |
ReverseGeocodingBatchRequestBody |
Listan över frågor/begäranden om omvänd geokodning som ska bearbetas. Listan kan innehålla högst 100 frågor och måste innehålla minst 1 fråga. |
ReverseGeocodingBatchRequestItem |
Batch Query-objekt |
Routes | |
SearchGetGeocoding200Headers | |
SearchGetGeocoding200Response |
I många fall kan den fullständiga söktjänsten vara för mycket, till exempel om du bara är intresserad av traditionell geokodning. Du kan också söka efter adresssökning exklusivt. Geokodningen utförs genom att träffa geokodningsslutpunkten med bara adressen eller den partiella adressen i fråga. Indexet för geokodningssökning efterfrågas för allt över gatunivådata. Ingen intressepunkt returneras. Observera att geokodaren är mycket tolerant mot stavfel och ofullständiga adresser. Det kommer också att hantera allt från exakta gatuadresser eller gata eller korsningar samt geografiska områden på högre nivå som stadskärnor, län och stater. Svaret returnerar också detaljerade adressegenskaper som gata, postnummer, kommun och land-/regioninformation. |
SearchGetGeocodingBatch200Response |
Skicka synkron Batch-begäranSynkront API rekommenderas för enkla batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten har beräknats och det finns ingen möjlighet att hämta resultatet senare. Synkront API returnerar ett timeout-fel (ett 408-svar) om begäran tar längre tid än 60 sekunder. Antalet batchobjekt är begränsat till 100 för det här API:et.
POST-brödtext för Batch-begäranOm du vill skicka geokodning frågor använder du en
Ett batchItem-objekt kan acceptera någon av de geokodningsparametrar som stödsURI-parametrar. Batchen ska innehålla minst 1 fråga. Batch-svarsmodellBatchsvaret innehåller en
|
SearchGetGeocodingBatchBodyParam | |
SearchGetGeocodingBatchDefaultResponse |
Skicka synkron Batch-begäranSynkront API rekommenderas för enkla batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten har beräknats och det finns ingen möjlighet att hämta resultatet senare. Synkront API returnerar ett timeout-fel (ett 408-svar) om begäran tar längre tid än 60 sekunder. Antalet batchobjekt är begränsat till 100 för det här API:et.
POST-brödtext för Batch-begäranOm du vill skicka geokodning frågor använder du en
Ett batchItem-objekt kan acceptera någon av de geokodningsparametrar som stödsURI-parametrar. Batchen ska innehålla minst 1 fråga. Batch-svarsmodellBatchsvaret innehåller en
|
SearchGetGeocodingBatchMediaTypesParam | |
SearchGetGeocodingDefaultResponse |
I många fall kan den fullständiga söktjänsten vara för mycket, till exempel om du bara är intresserad av traditionell geokodning. Du kan också söka efter adresssökning exklusivt. Geokodningen utförs genom att träffa geokodningsslutpunkten med bara adressen eller den partiella adressen i fråga. Indexet för geokodningssökning efterfrågas för allt över gatunivådata. Ingen intressepunkt returneras. Observera att geokodaren är mycket tolerant mot stavfel och ofullständiga adresser. Det kommer också att hantera allt från exakta gatuadresser eller gata eller korsningar samt geografiska områden på högre nivå som stadskärnor, län och stater. Svaret returnerar också detaljerade adressegenskaper som gata, postnummer, kommun och land-/regioninformation. |
SearchGetGeocodingQueryParam | |
SearchGetGeocodingQueryParamProperties | |
SearchGetPolygon200Response |
|
SearchGetPolygonDefaultResponse |
|
SearchGetPolygonQueryParam | |
SearchGetPolygonQueryParamProperties | |
SearchGetReverseGeocoding200Response |
|
SearchGetReverseGeocodingBatch200Response |
Skicka synkron Batch-begäranSynkront API rekommenderas för enkla batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten har beräknats och det finns ingen möjlighet att hämta resultatet senare. Synkront API returnerar ett timeout-fel (ett 408-svar) om begäran tar längre tid än 60 sekunder. Antalet batchobjekt är begränsat till 100 för det här API:et.
POST-brödtext för Batch-begäranOm du vill skicka omvänd geokodning frågor använder du en
Ett omvänd geokodning batchItem-objekt kan acceptera någon av de omvänd geokodningURI-parametrar som stöds. Batchen ska innehålla minst 1 fråga. Batch-svarsmodellBatchsvaret innehåller en
|
SearchGetReverseGeocodingBatchBodyParam | |
SearchGetReverseGeocodingBatchDefaultResponse |
Skicka synkron Batch-begäranSynkront API rekommenderas för enkla batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten har beräknats och det finns ingen möjlighet att hämta resultatet senare. Synkront API returnerar ett timeout-fel (ett 408-svar) om begäran tar längre tid än 60 sekunder. Antalet batchobjekt är begränsat till 100 för det här API:et.
POST-brödtext för Batch-begäranOm du vill skicka omvänd geokodning frågor använder du en
Ett omvänd geokodning batchItem-objekt kan acceptera någon av de omvänd geokodningURI-parametrar som stöds. Batchen ska innehålla minst 1 fråga. Batch-svarsmodellBatchsvaret innehåller en
|
SearchGetReverseGeocodingBatchMediaTypesParam | |
SearchGetReverseGeocodingDefaultResponse |
|
SearchGetReverseGeocodingQueryParam | |
SearchGetReverseGeocodingQueryParamProperties |
Typalias
GeoJsonFeatureOutput |
En giltig |
GeoJsonGeometryOutput |
Ett giltigt |
GeoJsonObjectOutput |
Ett giltigt |
MapsSearchClient | |
SearchGetGeocodingBatchParameters | |
SearchGetGeocodingParameters | |
SearchGetPolygonParameters | |
SearchGetReverseGeocodingBatchParameters | |
SearchGetReverseGeocodingParameters |
Funktioner
default(Azure |
Skapar en instans av MapsSearchClient från en prenumerationsnyckel. Exempel
|
default(Token |
Skapar en instans av MapsSearch från en Azure Identity- Exempel
|
default(Azure |
Skapar en instans av MapsSearch från en Azure Identity- Exempel
|
is |
|
is |
|
is |
|
is |
|
is |
Funktionsinformation
default(AzureKeyCredential, ClientOptions)
Skapar en instans av MapsSearchClient från en prenumerationsnyckel.
Exempel
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
Parametrar
- credential
- AzureKeyCredential
En AzureKeyCredential-instans som används för att autentisera begäranden till tjänsten
- options
- ClientOptions
Alternativ som används för att konfigurera sökklienten
Returer
default(TokenCredential, string, ClientOptions)
Skapar en instans av MapsSearch från en Azure Identity-TokenCredential
.
Exempel
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
Parametrar
- credential
- TokenCredential
En TokenCredential-instans som används för att autentisera begäranden till tjänsten
- mapsAccountClientId
-
string
Azure Maps-klient-ID för en specifik kartresurs
- options
- ClientOptions
Alternativ som används för att konfigurera sökklienten
Returer
default(AzureSASCredential, ClientOptions)
Skapar en instans av MapsSearch från en Azure Identity-AzureSASCredential
.
Exempel
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
Parametrar
- credential
- AzureSASCredential
En AzureSASCredential-instans som används för att autentisera begäranden till tjänsten
- options
- ClientOptions
Alternativ som används för att konfigurera sökklienten
Returer
isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)
function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response
Parametrar
Returer
response
isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)
function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response
Parametrar
Returer
response
isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)
function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response
Parametrar
Returer
response
isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)
function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response
Parametrar
Returer
response
isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)
function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response
Parametrar
Returer
response
Azure SDK for JavaScript