Search - Get Search Polygon

Riferimento

Servizio:: Maps

Versione API:: 1.0

Usare per ottenere dati poligoni di una forma di area geografica, ad esempio una città o un'area geografica.

L'API Get Polygon è una richiesta HTTP GET che restituisce dati geometrici, ad esempio una struttura di città o paese/area geografica per un set di entità, precedentemente recuperato da una richiesta di ricerca online in formato GeoJSON. L'ID geometry viene restituito nell'oggetto sourceGeometry in "geometry" e "id" in una chiamata Search Address o Search Fuzzy.

Un ID geometria recuperato da un endpoint di ricerca online ha una durata limitata, non è consigliabile archiviare gli ID geometria nell'archiviazione permanente per una segnalazione successiva. È previsto che una richiesta al metodo Polygon venga effettuata entro pochi minuti dalla richiesta al metodo di ricerca online che ha fornito l'ID. Il servizio consente richieste batch fino a 20 identificatori.

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries={geometries}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
format	path	True	JsonFormat	Formato desiderato della risposta. È supportato solo `json` formato.
api-version	query	True	string	Numero di versione dell'API mappe di Azure.
geometries	query	True	string[]	Elenco delimitato da virgole di UUID geometry, recuperato in precedenza da una richiesta di ricerca online.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-id		string	Specifica quale account è destinato all'utilizzo in combinazione con il modello di sicurezza Microsoft Entra ID. Rappresenta un ID univoco per l'account mappe di Azure e può essere recuperato dall'API dell'account del piano di gestione di Mappe di Azure. Per usare la sicurezza di Microsoft Entra ID in Mappe di Azure, vedere gli articoli di seguenti per indicazioni.

Risposte

Nome	Tipo	Descrizione
200 OK	PolygonResult	Va bene
Other Status Codes	ErrorResponse	Errore imprevisto.

Sicurezza

AADToken

Questi sono i flussi di Microsoft Entra OAuth 2.0. Se abbinato a l'accesso in base al ruolo di Azure controllarlo, può essere usato per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più account di risorse di Mappe di Azure o a risorse secondarie. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per le API REST di Mappe di Azure.

Per implementare scenari, è consigliabile visualizzare concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.

Nota

Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare a quale risorsa di Mappe di Azure l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione Maps.
Il Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni microsoft Entra ID.
Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
L'utilizzo della Sdk Web di Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.
Per altre informazioni su Microsoft Identity Platform, vedere panoramica di Microsoft Identity Platform.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Si tratta di una chiave condivisa di cui viene effettuato il provisioning quando si Creare un account di Mappe di Azure nel portale di Azure o usando PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o l'API REST.

Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere usata come chiave master nell'account in cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'approccio applicazioni client riservate per accedere alle API REST di Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.

Tipo: apiKey
In: query

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione List SAS nell'risorsa di Mappe di Azure tramite il piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere ai controlli di accesso in base al ruolo di Azure e al controllo granulare per la scadenza, la frequenza e le aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.

Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

Get the Geometry using the geometry id returned by the previous Search

Esempio di richiesta

HTTP

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries=8bceafe8-3d98-4445-b29b-fd81d3e9adf5,00005858-5800-1200-0000-0000773694ca

Risposta di esempio

Codice di stato:: 200

{
  "additionalData": [
    {
      "providerID": "1111-2222-32-4444444444444",
      "geometryData": {
        "type": "FeatureCollection",
        "features": [
          {
            "type": "Feature",
            "properties": {},
            "geometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    -122.0665062,
                    47.6496252
                  ],
                  [
                    -122.0664863,
                    47.6496113
                  ],
                  [
                    -122.0664843,
                    47.6496014
                  ],
                  [
                    -122.0663693,
                    47.6495247
                  ],
                  [
                    -122.0663017,
                    47.6494664
                  ],
                  [
                    -122.0662679,
                    47.6494247
                  ],
                  [
                    -122.0661647,
                    47.6493314
                  ],
                  [
                    -122.067177,
                    47.649298
                  ],
                  [
                    -122.090715,
                    47.6543598
                  ],
                  [
                    -122.0907846,
                    47.6542921
                  ],
                  [
                    -122.0908284,
                    47.6542603
                  ]
                ]
              ]
            },
            "id": "1111-2222-32-4444444444444"
          }
        ]
      }
    }
  ]
}

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
GeoJsonFeature	Tipo di oggetto `GeoJSON Feature` valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonFeatureCollection	Tipo di oggetto `GeoJSON FeatureCollection` valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonGeometry	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.
GeoJsonGeometryCollection	Tipo di oggetto `GeoJSON GeometryCollection` valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonLineString	Tipo geometry `GeoJSON LineString` valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonMultiLineString	Tipo geometry `GeoJSON MultiLineString` valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonMultiPoint	Tipo geometry `GeoJSON MultiPoint` valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonMultiPolygon	Tipo di oggetto `GeoJSON MultiPolygon` valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonPoint	Tipo geometry `GeoJSON Point` valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonPolygon	Tipo geometry `GeoJSON Polygon` valido. Per informazioni dettagliate, vedere RFC 7946.
JsonFormat	Formato desiderato della risposta. È supportato solo `json` formato.
Polygon
PolygonResult	Questo oggetto viene restituito da una chiamata Polygon di ricerca riuscita

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

GeoJsonFeature

Object

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

Nome	Tipo	Descrizione
featureType	string	Tipo della funzionalità. Il valore dipende dal modello di dati di cui fa parte la funzionalità corrente. Alcuni modelli di dati possono avere un valore vuoto.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	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.
id	string	Identificatore della funzionalità.
type	string: Feature	Specifica il tipo di `GeoJSON`. Deve essere uno dei nove tipi di oggetto GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonFeatureCollection

Object

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

Nome	Tipo	Descrizione
features	GeoJsonFeature[]	Contiene un elenco di oggetti `GeoJSON Feature` validi.
type	string: FeatureCollection	Specifica il tipo di `GeoJSON`. Deve essere uno dei nove tipi di oggetto GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonGeometry

Object

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.

Nome	Tipo	Descrizione
type	GeoJsonObjectType	Specifica il tipo di `GeoJSON`. Deve essere uno dei nove tipi di oggetto GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonGeometryCollection

Object

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

Nome	Tipo	Descrizione
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Contiene un elenco di oggetti geometry `GeoJSON` validi. Si noti che le coordinate in GeoJSON sono in ordine x, y (longitudine, latitudine).
type	string: GeometryCollection	Specifica il tipo di `GeoJSON`. Deve essere uno dei nove tipi di oggetto GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonLineString

Object

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

Nome	Tipo	Descrizione
coordinates	number[] (double)	Coordinate per la geometria `GeoJson LineString`.
type	string: LineString	Specifica il tipo di `GeoJSON`. Deve essere uno dei nove tipi di oggetto GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiLineString

Object

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

Nome	Tipo	Descrizione
coordinates	number[] (double)	Coordinate per la geometria `GeoJson MultiLineString`.
type	string: MultiLineString	Specifica il tipo di `GeoJSON`. Deve essere uno dei nove tipi di oggetto GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPoint

Object

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

Nome	Tipo	Descrizione
coordinates	number[] (double)	Coordinate per la geometria `GeoJson MultiPoint`.
type	string: MultiPoint	Specifica il tipo di `GeoJSON`. Deve essere uno dei nove tipi di oggetto GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPolygon

Object

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

Nome	Tipo	Descrizione
coordinates	number[] (double)	Contiene un elenco di oggetti `GeoJSON Polygon` validi. Si noti che le coordinate in GeoJSON sono in ordine x, y (longitudine, latitudine).
type	string: MultiPolygon	Specifica il tipo di `GeoJSON`. Deve essere uno dei nove tipi di oggetto GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPoint

Object

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

Nome	Tipo	Descrizione
coordinates	number[] (double)	Un `Position` è una matrice di numeri con due o più elementi. I primi due elementi sono longitudine e latitudine, esattamente in tale ordine. altitudine/elevazione è un terzo elemento facoltativo. Per informazioni dettagliate, vedere RFC 7946.
type	string: Point	Specifica il tipo di `GeoJSON`. Deve essere uno dei nove tipi di oggetto GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPolygon

Object

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

Nome	Tipo	Descrizione
coordinates	number[] (double)	Coordinate per il tipo di geometria `GeoJson Polygon`.
type	string: Polygon	Specifica il tipo di `GeoJSON`. Deve essere uno dei nove tipi di oggetto GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

JsonFormat

Enumerazione

Formato desiderato della risposta. È supportato solo json formato.

Valore	Descrizione
json	il formato dell'interscambio dati notazione oggetto JavaScript

Polygon

Object

Nome	Tipo	Descrizione
geometryData	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	Dati geometry in formato GeoJSON. Per informazioni dettagliate, vedere RFC 7946. Presente solo se "error" non è presente.
providerID	string	ID dell'entità restituita

PolygonResult

Object

Questo oggetto viene restituito da una chiamata Polygon di ricerca riuscita

Nome	Tipo	Descrizione
additionalData	Polygon[]	Matrice di risultati

Condividi tramite

Search - Get Search Polygon

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

AADToken

Ambiti

subscription-key

SAS Token

Esempio

Get the Geometry using the geometry id returned by the previous Search

Esempio di richiesta

Risposta di esempio

Definizioni

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonFeature

GeoJsonFeatureCollection

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonPoint

GeoJsonPolygon

JsonFormat

Polygon

PolygonResult

Risorse aggiuntive