Condividi tramite

@azure-rest/maps-search package

  • Riferimento

Interfacce

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput

Indirizzo del risultato
BoundaryOutput

GeoJSON GeocodingFeature oggetto che descrivono i limiti di un'area geografica. La geometria della funzionalità è descritta con GeoJSON GeometryCollection.

Si noti che il servizio restituisce in genere un oggetto GeometryCollection con sottotipi Polygon o MultiPolygon.
BoundaryPropertiesOutput

Proprietà di un oggetto Boundary.
ErrorAdditionalInfoOutput

Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetailOutput

Dettagli dell'errore.
ErrorResponseOutput

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.
FeaturesItemOutput
FeaturesItemPropertiesOutput
GeoJsonFeatureCollectionDataOutput
GeoJsonFeatureCollectionOutput

Tipo di oggetto GeoJSON FeatureCollection valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonFeatureDataOutput
GeoJsonFeatureOutputParent

Tipo di oggetto GeoJSON Feature valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonGeometryCollectionDataOutput
GeoJsonGeometryCollectionOutput

Tipo di oggetto GeoJSON GeometryCollection valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonGeometryOutputParent

Oggetto geometry GeoJSON valido. Il tipo deve essere uno dei sette tipi di geometria GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonLineStringDataOutput
GeoJsonLineStringOutput

Tipo geometry GeoJSON LineString valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonMultiLineStringDataOutput
GeoJsonMultiLineStringOutput

Tipo geometry GeoJSON MultiLineString valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonMultiPointDataOutput

Dati contenuti da un GeoJson MultiPoint.
GeoJsonMultiPointOutput

Tipo geometry GeoJSON MultiPoint valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonMultiPolygonDataOutput
GeoJsonMultiPolygonOutput

Tipo di oggetto GeoJSON MultiPolygon valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonObjectOutputParent

Oggetto GeoJSON valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonPointDataOutput

Dati contenuti da un GeoJson Point.
GeoJsonPointOutput

Tipo geometry GeoJSON Point valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonPolygonDataOutput
GeoJsonPolygonOutput

Tipo geometry GeoJSON Polygon valido. Per informazioni dettagliate, vedere RFC 7946.
GeocodePointsItemOutput
GeocodingBatchRequestBody

Elenco di query/richieste di geocodifica degli indirizzi da elaborare. L'elenco può contenere un massimo di 100 query e deve contenere almeno 1 query.
GeocodingBatchRequestItem

Oggetto Query batch
GeocodingBatchResponseItemOutput
GeocodingBatchResponseOutput

Questo oggetto viene restituito da una chiamata al servizio Batch di geocodifica riuscita.
GeocodingBatchResponseSummaryOutput

Riepilogo per la richiesta batch
GeocodingResponseOutput

Questo oggetto viene restituito da una chiamata geocodifica riuscita
GeometryCopyrightOutput

Informazioni sul copyright di una geometria di un oggetto Boundary.
GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput

Indirizzo del risultato.
MapsSearchClientOptions

Parametri facoltativi per il client
ReverseGeocodingBatchRequestBody

Elenco di query/richieste di geocodifica inversa da elaborare. L'elenco può contenere un massimo di 100 query e deve contenere almeno 1 query.
ReverseGeocodingBatchRequestItem

Oggetto Query batch
Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response

L'API Get Geocoding è una richiesta HTTP GET che restituisce le coordinate di longitudine e latitudine della posizione in cui viene eseguita la ricerca.

In molti casi, il servizio di ricerca completo potrebbe essere troppo, ad esempio se si è interessati solo alla geocodifica tradizionale. È anche possibile accedere alla ricerca dell'indirizzo in modo esclusivo. La geocodifica viene eseguita premendo l'endpoint di geocodifica con solo l'indirizzo o l'indirizzo parziale in questione. L'indice di ricerca di geocodifica verrà sottoposto a query per tutti gli elementi al di sopra dei dati a livello stradale. Non verrà restituito alcun punto di interesse (POI). Si noti che il geocoder è molto tollerante di errori di digitazioni e indirizzi incompleti. Gestirà anche tutto da indirizzi esatti o strade o intersezioni, nonché aree geografiche di livello superiore, ad esempio centri città, contee e stati. La risposta restituisce anche proprietà dettagliate relative agli indirizzi, ad esempio via, codice postale, comune e paese/area geografica.
SearchGetGeocodingBatch200Response

L'API Get Geocoding Batch è una richiesta http POST che invia batch fino a 100 query all'API geocodifica in una singola richiesta.

Inviare una richiesta batch sincrona

L'API sincrona è consigliata per le richieste batch leggere. Quando il servizio riceve una richiesta, risponderà non appena vengono calcolati gli elementi batch e non sarà possibile recuperare i risultati in un secondo momento. L'API sincrona restituirà un errore di timeout (una risposta 408) se la richiesta richiede più di 60 secondi. Il numero di elementi batch è limitato a 100 per questa API.

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

Corpo POST per la richiesta batch

Per inviare la geocodifica query, si userà una richiesta di POST in cui il corpo della richiesta conterrà la matrice batchItems in formato json e l'intestazione Content-Type verrà impostata su application/json. Ecco un corpo di richiesta di esempio contenente 2 query di geocodifica:

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

Un oggetto geocodifica batchItem può accettare uno qualsiasi dei parametri URI geocodifica supportati.

Il batch deve contenere almeno 1 query.

Modello di risposta batch

La risposta batch contiene un componente summary che indica il totalRequests che faceva parte della richiesta batch originale e successfulRequests ad esempio le query eseguite correttamente. La risposta batch include anche una matrice di batchItems che contiene una risposta per ogni query e ogni query nella richiesta batch. Il batchItems conterrà i risultati nello stesso ordine in cui le query originali sono state inviate nella richiesta batch. Ogni elemento è di uno dei tipi seguenti:

  • GeocodingResponse: se la query è stata completata correttamente.

  • Error: se la query non è riuscita. La risposta conterrà un code e un message in questo caso.
SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse

L'API Get Geocoding Batch è una richiesta http POST che invia batch fino a 100 query all'API geocodifica in una singola richiesta.

Inviare una richiesta batch sincrona

L'API sincrona è consigliata per le richieste batch leggere. Quando il servizio riceve una richiesta, risponderà non appena vengono calcolati gli elementi batch e non sarà possibile recuperare i risultati in un secondo momento. L'API sincrona restituirà un errore di timeout (una risposta 408) se la richiesta richiede più di 60 secondi. Il numero di elementi batch è limitato a 100 per questa API.

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

Corpo POST per la richiesta batch

Per inviare la geocodifica query, si userà una richiesta di POST in cui il corpo della richiesta conterrà la matrice batchItems in formato json e l'intestazione Content-Type verrà impostata su application/json. Ecco un corpo di richiesta di esempio contenente 2 query di geocodifica:

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

Un oggetto geocodifica batchItem può accettare uno qualsiasi dei parametri URI geocodifica supportati.

Il batch deve contenere almeno 1 query.

Modello di risposta batch

La risposta batch contiene un componente summary che indica il totalRequests che faceva parte della richiesta batch originale e successfulRequests ad esempio le query eseguite correttamente. La risposta batch include anche una matrice di batchItems che contiene una risposta per ogni query e ogni query nella richiesta batch. Il batchItems conterrà i risultati nello stesso ordine in cui le query originali sono state inviate nella richiesta batch. Ogni elemento è di uno dei tipi seguenti:

  • GeocodingResponse: se la query è stata completata correttamente.

  • Error: se la query non è riuscita. La risposta conterrà un code e un message in questo caso.
SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse

L'API Get Geocoding è una richiesta HTTP GET che restituisce le coordinate di longitudine e latitudine della posizione in cui viene eseguita la ricerca.

In molti casi, il servizio di ricerca completo potrebbe essere troppo, ad esempio se si è interessati solo alla geocodifica tradizionale. È anche possibile accedere alla ricerca dell'indirizzo in modo esclusivo. La geocodifica viene eseguita premendo l'endpoint di geocodifica con solo l'indirizzo o l'indirizzo parziale in questione. L'indice di ricerca di geocodifica verrà sottoposto a query per tutti gli elementi al di sopra dei dati a livello stradale. Non verrà restituito alcun punto di interesse (POI). Si noti che il geocoder è molto tollerante di errori di digitazioni e indirizzi incompleti. Gestirà anche tutto da indirizzi esatti o strade o intersezioni, nonché aree geografiche di livello superiore, ad esempio centri città, contee e stati. La risposta restituisce anche proprietà dettagliate relative agli indirizzi, ad esempio via, codice postale, comune e paese/area geografica.
SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response

L'API Get Polygon è una richiesta HTTP GET che fornisce dati poligoni di una struttura geografica, ad esempio una città o un'area geografica.
SearchGetPolygonDefaultResponse

L'API Get Polygon è una richiesta HTTP GET che fornisce dati poligoni di una struttura geografica, ad esempio una città o un'area geografica.
SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response

L'API Get Reverse Geocoding è una richiesta HTTP GET usata per convertire una coordinata (ad esempio: 37.786505, -122.3862) in un indirizzo di strada comprensibile. Utile nelle applicazioni di rilevamento in cui si riceve un feed GPS dal dispositivo o asset e si desidera conoscere l'indirizzo associato alle coordinate. Questo endpoint restituirà informazioni sull'indirizzo per una determinata coordinata.
SearchGetReverseGeocodingBatch200Response

L'API Get Reverse Geocoding Batch è una richiesta http POST che invia batch fino a 100 query per 'API di geocodifica inversa usando una singola richiesta.

Inviare una richiesta batch sincrona

L'API sincrona è consigliata per le richieste batch leggere. Quando il servizio riceve una richiesta, risponderà non appena vengono calcolati gli elementi batch e non sarà possibile recuperare i risultati in un secondo momento. L'API sincrona restituirà un errore di timeout (una risposta 408) se la richiesta richiede più di 60 secondi. Il numero di elementi batch è limitato a 100 per questa API.

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

Corpo POST per la richiesta batch

Per inviare la geocodifica inversa query, si userà una richiesta di POST in cui il corpo della richiesta conterrà la matrice batchItems in formato json e l'intestazione Content-Type verrà impostata su application/json. Ecco un corpo di richiesta di esempio contenente 2 query di geocodifica inversa:

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

Un geocodifica inversa oggetto batchItem può accettare uno qualsiasi dei parametri di geocodifica inversa parametri URI.

Il batch deve contenere almeno 1 query.

Modello di risposta batch

La risposta batch contiene un componente summary che indica il totalRequests che faceva parte della richiesta batch originale e successfulRequests ad esempio le query eseguite correttamente. La risposta batch include anche una matrice di batchItems che contiene una risposta per ogni query e ogni query nella richiesta batch. Il batchItems conterrà i risultati nello stesso ordine in cui le query originali sono state inviate nella richiesta batch. Ogni elemento è di uno dei tipi seguenti:

  • GeocodingResponse: se la query è stata completata correttamente.

  • Error: se la query non è riuscita. La risposta conterrà un code e un message in questo caso.
SearchGetReverseGeocodingBatchBodyParam
SearchGetReverseGeocodingBatchDefaultResponse

L'API Get Reverse Geocoding Batch è una richiesta http POST che invia batch fino a 100 query per 'API di geocodifica inversa usando una singola richiesta.

Inviare una richiesta batch sincrona

L'API sincrona è consigliata per le richieste batch leggere. Quando il servizio riceve una richiesta, risponderà non appena vengono calcolati gli elementi batch e non sarà possibile recuperare i risultati in un secondo momento. L'API sincrona restituirà un errore di timeout (una risposta 408) se la richiesta richiede più di 60 secondi. Il numero di elementi batch è limitato a 100 per questa API.

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

Corpo POST per la richiesta batch

Per inviare la geocodifica inversa query, si userà una richiesta di POST in cui il corpo della richiesta conterrà la matrice batchItems in formato json e l'intestazione Content-Type verrà impostata su application/json. Ecco un corpo di richiesta di esempio contenente 2 query di geocodifica inversa:

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

Un geocodifica inversa oggetto batchItem può accettare uno qualsiasi dei parametri di geocodifica inversa parametri URI.

Il batch deve contenere almeno 1 query.

Modello di risposta batch

La risposta batch contiene un componente summary che indica il totalRequests che faceva parte della richiesta batch originale e successfulRequests ad esempio le query eseguite correttamente. La risposta batch include anche una matrice di batchItems che contiene una risposta per ogni query e ogni query nella richiesta batch. Il batchItems conterrà i risultati nello stesso ordine in cui le query originali sono state inviate nella richiesta batch. Ogni elemento è di uno dei tipi seguenti:

  • GeocodingResponse: se la query è stata completata correttamente.

  • Error: se la query non è riuscita. La risposta conterrà un code e un message in questo caso.
SearchGetReverseGeocodingBatchMediaTypesParam
SearchGetReverseGeocodingDefaultResponse

L'API Get Reverse Geocoding è una richiesta HTTP GET usata per convertire una coordinata (ad esempio: 37.786505, -122.3862) in un indirizzo di strada comprensibile. Utile nelle applicazioni di rilevamento in cui si riceve un feed GPS dal dispositivo o asset e si desidera conoscere l'indirizzo associato alle coordinate. Questo endpoint restituirà informazioni sull'indirizzo per una determinata coordinata.
SearchGetReverseGeocodingQueryParam
SearchGetReverseGeocodingQueryParamProperties

Alias tipo

GeoJsonFeatureOutput

Tipo di oggetto GeoJSON Feature valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonGeometryOutput

Oggetto geometry GeoJSON valido. Il tipo deve essere uno dei sette tipi di geometria GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonObjectOutput

Oggetto GeoJSON valido. Per informazioni dettagliate, vedere RFC 7946.
MapsSearchClient
SearchGetGeocodingBatchParameters
SearchGetGeocodingParameters
SearchGetPolygonParameters
SearchGetReverseGeocodingBatchParameters
SearchGetReverseGeocodingParameters

Funzioni

default(AzureKeyCredential, ClientOptions)

Crea un'istanza di MapsSearchClient da una chiave di sottoscrizione.

Esempio

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)

Crea un'istanza di MapsSearch da un'identità di Azure TokenCredential.

Esempio

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)

Crea un'istanza di MapsSearch da un'identità di Azure AzureSASCredential.

Esempio

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)

Dettagli funzione

default(AzureKeyCredential, ClientOptions)

Crea un'istanza di MapsSearchClient da una chiave di sottoscrizione.

Esempio

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

Parametri

credential
AzureKeyCredential

Istanza di AzureKeyCredential usata per autenticare le richieste al servizio

options
ClientOptions

Opzioni usate per configurare il client di ricerca

Restituisce

MapsSearchClient

default(TokenCredential, string, ClientOptions)

Crea un'istanza di MapsSearch da un'identità di Azure TokenCredential.

Esempio

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

Parametri

credential
TokenCredential

Istanza tokenCredential usata per autenticare le richieste al servizio

mapsAccountClientId

string

ID client di Mappe di Azure di una risorsa mappa specifica

options
ClientOptions

Opzioni usate per configurare il client di ricerca

Restituisce

MapsSearchClient

default(AzureSASCredential, ClientOptions)

Crea un'istanza di MapsSearch da un'identità di Azure AzureSASCredential.

Esempio

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

Parametri

credential
AzureSASCredential

Istanza di AzureSASCredential usata per autenticare le richieste al servizio

options
ClientOptions

Opzioni usate per configurare il client di ricerca

Restituisce

MapsSearchClient

isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response

Parametri

response

SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse

Restituisce

response

isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response

Parametri

response

SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse

Restituisce

response

isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse) 

function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response

Parametri

response

SearchGetPolygon200Response | SearchGetPolygonDefaultResponse

Restituisce

response

isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response

Parametri

response

SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse

Restituisce

response

isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response

Parametri

response

SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse

Restituisce

response