Dela via

@azure-rest/maps-search package

  • Referens

Gränssnitt

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput

Resultatets adress
BoundaryOutput

GeoJSON GeocodingFeature objekt som beskriver gränserna för ett geografiskt område. Geometri för funktionen beskrivs med GeoJSON GeometryCollection.

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 GeoJSON FeatureCollection objekttyp. Mer information finns i RFC 7946.
GeoJsonFeatureDataOutput
GeoJsonFeatureOutputParent

En giltig GeoJSON Feature objekttyp. Mer information finns i RFC 7946.
GeoJsonGeometryCollectionDataOutput
GeoJsonGeometryCollectionOutput

En giltig GeoJSON GeometryCollection objekttyp. Mer information finns i RFC 7946.
GeoJsonGeometryOutputParent

Ett giltigt GeoJSON geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946.
GeoJsonLineStringDataOutput
GeoJsonLineStringOutput

En giltig GeoJSON LineString geometrityp. Mer information finns i RFC 7946.
GeoJsonMultiLineStringDataOutput
GeoJsonMultiLineStringOutput

En giltig GeoJSON MultiLineString geometrityp. Mer information finns i RFC 7946.
GeoJsonMultiPointDataOutput

Data som finns i en GeoJson MultiPoint.
GeoJsonMultiPointOutput

En giltig GeoJSON MultiPoint geometrityp. Mer information finns i RFC 7946.
GeoJsonMultiPolygonDataOutput
GeoJsonMultiPolygonOutput

En giltig GeoJSON MultiPolygon objekttyp. Mer information finns i RFC 7946.
GeoJsonObjectOutputParent

Ett giltigt GeoJSON objekt. Mer information finns i RFC 7946.
GeoJsonPointDataOutput

Data som finns i en GeoJson Point.
GeoJsonPointOutput

En giltig GeoJSON Point geometrityp. Mer information finns i RFC 7946.
GeoJsonPolygonDataOutput
GeoJsonPolygonOutput

En giltig GeoJSON Polygon geometrityp. Mer information finns i RFC 7946.
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

Get Geocoding-API:et är en HTTP-GET begäran som returnerar longitud- och latitudkoordinaterna för platsen som genomsöks.

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

Get Geocoding Batch-API:et är en HTTP-POST begäran som skickar batchar med upp till 100 frågor till Geocoding API i en enda begäran.

Skicka synkron Batch-begäran

Synkront 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 https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

POST-brödtext för Batch-begäran

Om du vill skicka geokodning frågor använder du en POST begäran där begärandetexten innehåller batchItems matrisen i json format och Content-Type-huvudet anges till application/json. Här är ett exempel på begärandetext som innehåller 2 geokodning frågor:

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Ett batchItem-objekt kan acceptera någon av de geokodningsparametrar som stödsURI-parametrar.

Batchen ska innehålla minst 1 fråga.

Batch-svarsmodell

Batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequests dvs. frågor som har körts korrekt. Batch-svaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt är av någon av följande typer:

  • GeocodingResponse – Om frågan har slutförts.

  • Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.
SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse

Get Geocoding Batch-API:et är en HTTP-POST begäran som skickar batchar med upp till 100 frågor till Geocoding API i en enda begäran.

Skicka synkron Batch-begäran

Synkront 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 https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

POST-brödtext för Batch-begäran

Om du vill skicka geokodning frågor använder du en POST begäran där begärandetexten innehåller batchItems matrisen i json format och Content-Type-huvudet anges till application/json. Här är ett exempel på begärandetext som innehåller 2 geokodning frågor:

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Ett batchItem-objekt kan acceptera någon av de geokodningsparametrar som stödsURI-parametrar.

Batchen ska innehålla minst 1 fråga.

Batch-svarsmodell

Batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequests dvs. frågor som har körts korrekt. Batch-svaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt är av någon av följande typer:

  • GeocodingResponse – Om frågan har slutförts.

  • Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.
SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse

Get Geocoding-API:et är en HTTP-GET begäran som returnerar longitud- och latitudkoordinaterna för platsen som genomsöks.

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

Get Polygon-API:et är en HTTP-GET begäran som tillhandahåller polygondata för en geografisk områdesdisposition, till exempel en stad eller en landregion.
SearchGetPolygonDefaultResponse

Get Polygon-API:et är en HTTP-GET begäran som tillhandahåller polygondata för en geografisk områdesdisposition, till exempel en stad eller en landregion.
SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response

Get Reverse Geocoding-API:et är en HTTP-GET begäran som används för att översätta en koordinat (exempel: 37.786505, -122.3862) till en mänsklig begriplig gatuadress. Användbart för att spåra program där du får ett GPS-flöde från enheten eller tillgången och vill veta adressen som är associerad med koordinaterna. Den här slutpunkten returnerar adressinformation för en viss koordinat.
SearchGetReverseGeocodingBatch200Response

Get Reverse Geocoding Batch-API:et är en HTTP-POST begäran som skickar batchar med upp till 100 frågor till omvänd geokodning API med en enda begäran.

Skicka synkron Batch-begäran

Synkront 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 https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

POST-brödtext för Batch-begäran

Om du vill skicka omvänd geokodning frågor använder du en POST begäran där begärandetexten innehåller matrisen batchItems i json format och Content-Type-huvudet anges till application/json. Här är ett exempel på begärandetext som innehåller 2 omvänd geokodning frågor:

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

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-svarsmodell

Batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequests dvs. frågor som har körts korrekt. Batch-svaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt är av någon av följande typer:

  • GeocodingResponse – Om frågan har slutförts.

  • Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.
SearchGetReverseGeocodingBatchBodyParam
SearchGetReverseGeocodingBatchDefaultResponse

Get Reverse Geocoding Batch-API:et är en HTTP-POST begäran som skickar batchar med upp till 100 frågor till omvänd geokodning API med en enda begäran.

Skicka synkron Batch-begäran

Synkront 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 https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

POST-brödtext för Batch-begäran

Om du vill skicka omvänd geokodning frågor använder du en POST begäran där begärandetexten innehåller matrisen batchItems i json format och Content-Type-huvudet anges till application/json. Här är ett exempel på begärandetext som innehåller 2 omvänd geokodning frågor:

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

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-svarsmodell

Batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequests dvs. frågor som har körts korrekt. Batch-svaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt är av någon av följande typer:

  • GeocodingResponse – Om frågan har slutförts.

  • Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.
SearchGetReverseGeocodingBatchMediaTypesParam
SearchGetReverseGeocodingDefaultResponse

Get Reverse Geocoding-API:et är en HTTP-GET begäran som används för att översätta en koordinat (exempel: 37.786505, -122.3862) till en mänsklig begriplig gatuadress. Användbart för att spåra program där du får ett GPS-flöde från enheten eller tillgången och vill veta adressen som är associerad med koordinaterna. Den här slutpunkten returnerar adressinformation för en viss koordinat.
SearchGetReverseGeocodingQueryParam
SearchGetReverseGeocodingQueryParamProperties

Typalias

GeoJsonFeatureOutput

En giltig GeoJSON Feature objekttyp. Mer information finns i RFC 7946.
GeoJsonGeometryOutput

Ett giltigt GeoJSON geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946.
GeoJsonObjectOutput

Ett giltigt GeoJSON objekt. Mer information finns i RFC 7946.
MapsSearchClient
SearchGetGeocodingBatchParameters
SearchGetGeocodingParameters
SearchGetPolygonParameters
SearchGetReverseGeocodingBatchParameters
SearchGetReverseGeocodingParameters

Funktioner

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);
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>");
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);
isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)
isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)
isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)
isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)
isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)

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

MapsSearchClient

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

MapsSearchClient

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

MapsSearchClient

isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response

Parametrar

response

SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse

Returer

response

isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response

Parametrar

response

SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse

Returer

response

isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse) 

function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response

Parametrar

response

SearchGetPolygon200Response | SearchGetPolygonDefaultResponse

Returer

response

isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response

Parametrar

response

SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse

Returer

response

isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response

Parametrar

response

SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse

Returer

response