Delen via

@azure-rest/maps-search package

  • Referentie

Interfaces

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput

Het adres van het resultaat
BoundaryOutput

GeoJSON GeocodingFeature object dat de grenzen van een geografisch gebied beschrijft. Geometrie van de functie wordt beschreven met GeoJSON GeometryCollection.

Houd er rekening mee dat de service doorgaans een GeometryCollection retourneert met subtypen Polygon of MultiPolygon.
BoundaryPropertiesOutput

Eigenschappen van een grensobject.
ErrorAdditionalInfoOutput

Aanvullende informatie over de resourcebeheerfout.
ErrorDetailOutput

De foutdetails.
ErrorResponseOutput

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
FeaturesItemOutput
FeaturesItemPropertiesOutput
GeoJsonFeatureCollectionDataOutput
GeoJsonFeatureCollectionOutput

Een geldig GeoJSON FeatureCollection objecttype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonFeatureDataOutput
GeoJsonFeatureOutputParent

Een geldig GeoJSON Feature objecttype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonGeometryCollectionDataOutput
GeoJsonGeometryCollectionOutput

Een geldig GeoJSON GeometryCollection objecttype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonGeometryOutputParent

Een geldig GeoJSON geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonLineStringDataOutput
GeoJsonLineStringOutput

Een geldig GeoJSON LineString geometrietype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonMultiLineStringDataOutput
GeoJsonMultiLineStringOutput

Een geldig GeoJSON MultiLineString geometrietype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonMultiPointDataOutput

Gegevens die zijn opgenomen in een GeoJson MultiPoint.
GeoJsonMultiPointOutput

Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonMultiPolygonDataOutput
GeoJsonMultiPolygonOutput

Een geldig GeoJSON MultiPolygon objecttype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonObjectOutputParent

Een geldig GeoJSON-object. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonPointDataOutput

Gegevens die zijn opgenomen in een GeoJson Point.
GeoJsonPointOutput

Een geldig GeoJSON Point geometrietype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonPolygonDataOutput
GeoJsonPolygonOutput

Een geldig GeoJSON Polygon geometrietype. Raadpleeg RFC 7946- voor meer informatie.
GeocodePointsItemOutput
GeocodingBatchRequestBody

De lijst met adresgeocoderingsquery's/aanvragen die moeten worden verwerkt. De lijst kan maximaal 100 query's bevatten en moet ten minste 1 query bevatten.
GeocodingBatchRequestItem

BatchQuery-object
GeocodingBatchResponseItemOutput
GeocodingBatchResponseOutput

Dit object wordt geretourneerd door een geslaagde Geocodering Batch-serviceoproep.
GeocodingBatchResponseSummaryOutput

Samenvatting voor de batchaanvraag
GeocodingResponseOutput

Dit object wordt geretourneerd door een geslaagde geocoderingsoproep
GeometryCopyrightOutput

Copyrightinformatie van een geometrie van een Grensobject.
GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput

Het adres van het resultaat.
MapsSearchClientOptions

De optionele parameters voor de client
ReverseGeocodingBatchRequestBody

De lijst met omgekeerde geocoderingsquery's/aanvragen die moeten worden verwerkt. De lijst kan maximaal 100 query's bevatten en moet ten minste 1 query bevatten.
ReverseGeocodingBatchRequestItem

BatchQuery-object
Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response

De Get Geocoding-API is een HTTP-GET-aanvraag die de lengte- en breedtegraadcoördinaten retourneert van de locatie waarop wordt gezocht.

In veel gevallen kan de volledige zoekservice te veel zijn, bijvoorbeeld als u alleen geïnteresseerd bent in traditionele geocodering. Zoeken kan ook uitsluitend worden geopend voor adreszoekopdrachten. De geocodering wordt uitgevoerd door het geocoderingseindpunt te bereiken met alleen het adres of gedeeltelijke adres in kwestie. De zoekindex voor geocodering wordt opgevraagd voor alles boven de gegevens op straatniveau. Er worden geen nuttige plaatsen geretourneerd. Houd er rekening mee dat de geocoder zeer tolerant is voor typefouten en onvolledige adressen. Het behandelt ook alles van exacte straatadressen of straat- of snijpunten, evenals geografische gebieden op een hoger niveau, zoals stadscentra, provincies en staten. Het antwoord retourneert ook gedetailleerde adreseigenschappen, zoals straat-, postcode-, gemeente- en land-/regiogegevens.
SearchGetGeocodingBatch200Response

De Get Geocoding Batch-API is een HTTP-POST-aanvraag waarmee batches van maximaal 100 query's naar de Geo coderings-API in één aanvraag worden verzonden.

Synchrone batchaanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batchitems worden berekend en kan de resultaten later niet meer worden opgehaald. De synchrone API retourneert een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batchitems is beperkt tot 100 voor deze API.

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

POST-hoofdtekst voor Batch-aanvraag

Als u de geocoderingsquery's wilt verzenden, gebruikt u een POST aanvraag waarin de aanvraagbody de batchItems matrix in json indeling bevat en de Content-Type header wordt ingesteld op application/json. Hier volgt een voorbeeld van een aanvraagbody met 2 geocodering query's:

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

Een geocodering batchItem-object kan een van de ondersteunde geocoderingURI-parametersaccepteren.

De batch moet ten minste 1 query bevatten.

Batch-antwoordmodel

Het batchantwoord bevat een summary onderdeel dat de totalRequests aangeeft die deel uitmaakten van de oorspronkelijke batchaanvraag en successfulRequests d.w.w.v. query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's zijn verzonden in de batchaanvraag. Elk item heeft een van de volgende typen:

  • GeocodingResponse: als de query is voltooid.

  • Error: als de query is mislukt. Het antwoord bevat in dit geval een code en een message.
SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse

De Get Geocoding Batch-API is een HTTP-POST-aanvraag waarmee batches van maximaal 100 query's naar de Geo coderings-API in één aanvraag worden verzonden.

Synchrone batchaanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batchitems worden berekend en kan de resultaten later niet meer worden opgehaald. De synchrone API retourneert een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batchitems is beperkt tot 100 voor deze API.

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

POST-hoofdtekst voor Batch-aanvraag

Als u de geocoderingsquery's wilt verzenden, gebruikt u een POST aanvraag waarin de aanvraagbody de batchItems matrix in json indeling bevat en de Content-Type header wordt ingesteld op application/json. Hier volgt een voorbeeld van een aanvraagbody met 2 geocodering query's:

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

Een geocodering batchItem-object kan een van de ondersteunde geocoderingURI-parametersaccepteren.

De batch moet ten minste 1 query bevatten.

Batch-antwoordmodel

Het batchantwoord bevat een summary onderdeel dat de totalRequests aangeeft die deel uitmaakten van de oorspronkelijke batchaanvraag en successfulRequests d.w.w.v. query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's zijn verzonden in de batchaanvraag. Elk item heeft een van de volgende typen:

  • GeocodingResponse: als de query is voltooid.

  • Error: als de query is mislukt. Het antwoord bevat in dit geval een code en een message.
SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse

De Get Geocoding-API is een HTTP-GET-aanvraag die de lengte- en breedtegraadcoördinaten retourneert van de locatie waarop wordt gezocht.

In veel gevallen kan de volledige zoekservice te veel zijn, bijvoorbeeld als u alleen geïnteresseerd bent in traditionele geocodering. Zoeken kan ook uitsluitend worden geopend voor adreszoekopdrachten. De geocodering wordt uitgevoerd door het geocoderingseindpunt te bereiken met alleen het adres of gedeeltelijke adres in kwestie. De zoekindex voor geocodering wordt opgevraagd voor alles boven de gegevens op straatniveau. Er worden geen nuttige plaatsen geretourneerd. Houd er rekening mee dat de geocoder zeer tolerant is voor typefouten en onvolledige adressen. Het behandelt ook alles van exacte straatadressen of straat- of snijpunten, evenals geografische gebieden op een hoger niveau, zoals stadscentra, provincies en staten. Het antwoord retourneert ook gedetailleerde adreseigenschappen, zoals straat-, postcode-, gemeente- en land-/regiogegevens.
SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response

De Get Polygon-API is een HTTP-GET-aanvraag die veelhoekgegevens levert van een geografisch gebiedsoverzicht, zoals een stad of een landregio.
SearchGetPolygonDefaultResponse

De Get Polygon-API is een HTTP-GET-aanvraag die veelhoekgegevens levert van een geografisch gebiedsoverzicht, zoals een stad of een landregio.
SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response

De Get Reverse Geocoding-API is een HTTP-GET aanvraag die wordt gebruikt voor het vertalen van een coördinaat (bijvoorbeeld: 37.786505, -122.3862) in een begrijpelijk adres voor mensen. Handig bij het volgen van toepassingen waarbij u een GPS-feed ontvangt van het apparaat of de asset en wilt weten welk adres aan de coördinaten is gekoppeld. Dit eindpunt retourneert adresgegevens voor een bepaalde coördinaat.
SearchGetReverseGeocodingBatch200Response

De Get Reverse Geocoding Batch-API is een HTTP-POST-aanvraag waarmee batches van maximaal 100 query's worden verzonden naar api voor reverse geocodering met één aanvraag.

Synchrone batchaanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batchitems worden berekend en kan de resultaten later niet meer worden opgehaald. De synchrone API retourneert een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batchitems is beperkt tot 100 voor deze API.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

POST-hoofdtekst voor Batch-aanvraag

Als u de omgekeerde geocodering query's wilt verzenden, gebruikt u een POST aanvraag waarin de aanvraagbody de batchItems matrix in json indeling bevat en de Content-Type-header wordt ingesteld op application/json. Hier volgt een voorbeeld van een aanvraagbody met 2 omgekeerde geocodering query's:

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

Een omgekeerde geocodering batchItem-object kan een van de ondersteunde omgekeerde geocoderingURI-parametersaccepteren.

De batch moet ten minste 1 query bevatten.

Batch-antwoordmodel

Het batchantwoord bevat een summary onderdeel dat de totalRequests aangeeft die deel uitmaakten van de oorspronkelijke batchaanvraag en successfulRequests d.w.w.v. query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's zijn verzonden in de batchaanvraag. Elk item heeft een van de volgende typen:

  • GeocodingResponse: als de query is voltooid.

  • Error: als de query is mislukt. Het antwoord bevat in dit geval een code en een message.
SearchGetReverseGeocodingBatchBodyParam
SearchGetReverseGeocodingBatchDefaultResponse

De Get Reverse Geocoding Batch-API is een HTTP-POST-aanvraag waarmee batches van maximaal 100 query's worden verzonden naar api voor reverse geocodering met één aanvraag.

Synchrone batchaanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batchitems worden berekend en kan de resultaten later niet meer worden opgehaald. De synchrone API retourneert een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batchitems is beperkt tot 100 voor deze API.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

POST-hoofdtekst voor Batch-aanvraag

Als u de omgekeerde geocodering query's wilt verzenden, gebruikt u een POST aanvraag waarin de aanvraagbody de batchItems matrix in json indeling bevat en de Content-Type-header wordt ingesteld op application/json. Hier volgt een voorbeeld van een aanvraagbody met 2 omgekeerde geocodering query's:

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

Een omgekeerde geocodering batchItem-object kan een van de ondersteunde omgekeerde geocoderingURI-parametersaccepteren.

De batch moet ten minste 1 query bevatten.

Batch-antwoordmodel

Het batchantwoord bevat een summary onderdeel dat de totalRequests aangeeft die deel uitmaakten van de oorspronkelijke batchaanvraag en successfulRequests d.w.w.v. query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's zijn verzonden in de batchaanvraag. Elk item heeft een van de volgende typen:

  • GeocodingResponse: als de query is voltooid.

  • Error: als de query is mislukt. Het antwoord bevat in dit geval een code en een message.
SearchGetReverseGeocodingBatchMediaTypesParam
SearchGetReverseGeocodingDefaultResponse

De Get Reverse Geocoding-API is een HTTP-GET aanvraag die wordt gebruikt voor het vertalen van een coördinaat (bijvoorbeeld: 37.786505, -122.3862) in een begrijpelijk adres voor mensen. Handig bij het volgen van toepassingen waarbij u een GPS-feed ontvangt van het apparaat of de asset en wilt weten welk adres aan de coördinaten is gekoppeld. Dit eindpunt retourneert adresgegevens voor een bepaalde coördinaat.
SearchGetReverseGeocodingQueryParam
SearchGetReverseGeocodingQueryParamProperties

Type-aliassen

GeoJsonFeatureOutput

Een geldig GeoJSON Feature objecttype. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonGeometryOutput

Een geldig GeoJSON geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946- voor meer informatie.
GeoJsonObjectOutput

Een geldig GeoJSON-object. Raadpleeg RFC 7946- voor meer informatie.
MapsSearchClient
SearchGetGeocodingBatchParameters
SearchGetGeocodingParameters
SearchGetPolygonParameters
SearchGetReverseGeocodingBatchParameters
SearchGetReverseGeocodingParameters

Functies

default(AzureKeyCredential, ClientOptions)

Hiermee maakt u een exemplaar van MapsSearchClient op basis van een abonnementssleutel.

Voorbeeld

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)

Hiermee maakt u een exemplaar van MapsSearch op basis van een Azure Identity TokenCredential.

Voorbeeld

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)

Hiermee maakt u een exemplaar van MapsSearch op basis van een Azure Identity AzureSASCredential.

Voorbeeld

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)

Functiedetails

default(AzureKeyCredential, ClientOptions)

Hiermee maakt u een exemplaar van MapsSearchClient op basis van een abonnementssleutel.

Voorbeeld

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

Parameters

credential
AzureKeyCredential

Een AzureKeyCredential-exemplaar dat wordt gebruikt voor het verifiëren van aanvragen voor de service

options
ClientOptions

Opties die worden gebruikt voor het configureren van de zoekclient

Retouren

MapsSearchClient

default(TokenCredential, string, ClientOptions)

Hiermee maakt u een exemplaar van MapsSearch op basis van een Azure Identity TokenCredential.

Voorbeeld

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

Parameters

credential
TokenCredential

Een TokenCredential-exemplaar dat wordt gebruikt voor het verifiëren van aanvragen voor de service

mapsAccountClientId

string

De Azure Maps-client-id van een specifieke toewijzingsresource

options
ClientOptions

Opties die worden gebruikt voor het configureren van de zoekclient

Retouren

MapsSearchClient

default(AzureSASCredential, ClientOptions)

Hiermee maakt u een exemplaar van MapsSearch op basis van een Azure Identity AzureSASCredential.

Voorbeeld

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

Parameters

credential
AzureSASCredential

Een AzureSASCredential-exemplaar dat wordt gebruikt voor het verifiëren van aanvragen voor de service

options
ClientOptions

Opties die worden gebruikt voor het configureren van de zoekclient

Retouren

MapsSearchClient

isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response

Parameters

response

SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse

Retouren

response

isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response

Parameters

response

SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse

Retouren

response

isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse) 

function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response

Parameters

response

SearchGetPolygon200Response | SearchGetPolygonDefaultResponse

Retouren

response

isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response

Parameters

response

SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse

Retouren

response

isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response

Parameters

response

SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse

Retouren

response