Search - Get Polygon
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 fornisce dati poligonali di un contorno di area geografica, ad esempio una città o una regione del paese.
GET {endpoint}/search/polygon?api-version=2026-01-01&coordinates={coordinates}GET {endpoint}/search/polygon?api-version=2026-01-01&coordinates={coordinates}&view={view}&resultType={resultType}&resolution={resolution}Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Il nome host del servizio Mappe di Azure. Usa |
|
api-version
|
query | True |
string minLength: 1 |
Versione dell'API da usare per questa operazione. |
|
coordinates
|
query | True |
number[] |
Un punto sulla terra specificato come longitudine e latitudine. Esempio: coordinate &=lon,lat |
|
resolution
|
query |
La risoluzione determina la quantità di punti da restituire. Se non viene specificato, l'impostazione predefinita è la risoluzione media. |
||
|
result
|
query |
Il concetto geopolitico per restituire un confine per. Se non specificato, il valore predefinito è |
||
|
view
|
query |
string |
Stringa che rappresenta un codice area/paese ISO 3166-1 Alpha-2. In questo modo verranno modificati i bordi e le etichette geopolitici contestati per allinearsi all'area utente specificata. Per impostazione predefinita, il parametro View è impostato su "Auto", anche se non è stato definito nella richiesta. Per informazioni dettagliate e per visualizzare le visualizzazioni disponibili, vedere viste supportate. |
Intestazione della richiesta
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| x-ms-client-id |
string |
Specifica quale account è destinato all'uso in combinazione con il modello di sicurezza di Azure AD. Rappresenta un ID unico per l'account Mappe di Azure e può essere recuperato dall'API Account del piano di gestione Mappe di Azure. Per maggiori informazioni sull'uso della sicurezza Microsoft Entra ID in Mappe di Azure, vedi Gestire l'autenticazione in Mappe di Azure. |
|
| Accept-Language |
string |
Lingua in cui devono essere restituiti i risultati della ricerca. Per informazioni dettagliate, vedere lingue supportate. |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
La richiesta ha avuto esito positivo. Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Risposta di errore imprevista. Media Types: "application/geo+json", "application/json" Intestazioni x-ms-error-code: string |
Sicurezza
AadToken
Questi sono i flussi Microsoft Entra OAuth 2.0. Quando abbinata al controllo Azure basato su ruolo può essere utilizzata per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso basati su ruoli di Azure sono utilizzati per designare l'accesso a uno o più account o sottorisorse risorse di Mappe di Azure. 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.
Note
- Questa definizione di sicurezza richiede l'uso dell'intestazione
x-ms-client-idper indicare a quale risorsa di Mappe di Azure l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione di mappe . - Il
Authorization URLè specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione unici 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 |
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:
header
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 polygon for a city at coordinates -122.204141,47.612560
Esempio di richiesta
GET https://atlas.microsoft.com/search/polygon?api-version=2026-01-01&coordinates=-122.204141,47.61256&resultType=locality&resolution=small
Risposta di esempio
Content-Type: application/geo+json{
"type": "Feature",
"geometry": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
-122.13035,
47.53502
],
[
-122.12882,
47.53567
],
[
-122.12638000000001,
47.535140000000006
],
[
-122.12378000000001,
47.53717
],
[
-122.12068000000001,
47.537620000000004
],
[
-122.12028000000001,
47.538000000000004
],
[
-122.11682,
47.537940000000006
],
[
-122.11527000000001,
47.53609
],
[
-122.11119000000001,
47.536080000000005
],
[
-122.11103000000001,
47.539280000000005
],
[
-122.10832,
47.539530000000006
],
[
-122.10830000000001,
47.54057
],
[
-122.11006,
47.54055
],
[
-122.10999000000001,
47.542640000000006
],
[
-122.11185,
47.54298000000001
],
[
-122.11183000000001,
47.54426
],
[
-122.1114,
47.543800000000005
],
[
-122.10936000000001,
47.54379
],
[
-122.10912,
47.54462
],
[
-122.10745000000001,
47.544830000000005
],
[
-122.10808000000002,
47.545190000000005
],
[
-122.10808000000002,
47.54656000000001
],
[
-122.10665000000002,
47.546580000000006
],
[
-122.10711,
47.544700000000006
],
[
-122.10530000000001,
47.54473
],
[
-122.1054,
47.546910000000004
],
[
-122.10434000000001,
47.54693
],
[
-122.10433,
47.544830000000005
],
[
-122.10056000000002,
47.544940000000004
],
[
-122.1007,
47.548500000000004
],
[
-122.10194000000001,
47.54849
],
[
-122.10194000000001,
47.54883
],
[
-122.10194000000001,
47.549510000000005
],
[
-122.10071,
47.54883
],
[
-122.10048,
47.54849
],
[
-122.10047000000002,
47.54883
],
[
-122.10038000000002,
47.55904
],
[
-122.09796000000001,
47.55923000000001
],
[
-122.09870000000001,
47.560570000000006
],
[
-122.09818000000001,
47.56248
],
[
-122.10011000000002,
47.56839
],
[
-122.09876000000001,
47.56884
],
[
-122.09942000000001,
47.569900000000004
],
[
-122.09782000000001,
47.56983
],
[
-122.09672,
47.58019
],
[
-122.09885000000001,
47.58666
],
[
-122.09796000000001,
47.59503
],
[
-122.09664000000001,
47.602230000000006
],
[
-122.09411000000001,
47.607240000000004
],
[
-122.09104,
47.610240000000005
],
[
-122.08366000000001,
47.615660000000005
],
[
-122.08008000000001,
47.61939
],
[
-122.07904,
47.62201
],
[
-122.07959000000001,
47.627520000000004
],
[
-122.08008000000001,
47.627520000000004
],
[
-122.09181000000001,
47.627520000000004
],
[
-122.09221000000001,
47.62717000000001
],
[
-122.09256,
47.627520000000004
],
[
-122.11094000000001,
47.62765
],
[
-122.11091,
47.636720000000004
],
[
-122.11091,
47.64609
],
[
-122.11431,
47.646060000000006
],
[
-122.11437000000001,
47.64533
],
[
-122.11597,
47.64374
],
[
-122.12254000000001,
47.638510000000004
],
[
-122.12542,
47.636720000000004
],
[
-122.12809000000001,
47.635200000000005
],
[
-122.13241000000001,
47.63515
],
[
-122.13234000000001,
47.63268
],
[
-122.13407000000001,
47.63156000000001
],
[
-122.13484000000001,
47.62935
],
[
-122.13626000000001,
47.62820000000001
],
[
-122.1372,
47.627860000000005
],
[
-122.14184000000002,
47.62787
],
[
-122.14321000000001,
47.62713
],
[
-122.14312000000001,
47.636720000000004
],
[
-122.14335000000001,
47.660590000000006
],
[
-122.1641,
47.66077000000001
],
[
-122.16453000000001,
47.646370000000005
],
[
-122.16797000000001,
47.64621
],
[
-122.19629,
47.64643
],
[
-122.19629,
47.64289
],
[
-122.19846000000001,
47.642860000000006
],
[
-122.19846000000001,
47.64242
],
[
-122.19982000000002,
47.6424
],
[
-122.20169000000001,
47.644600000000004
],
[
-122.20341,
47.643190000000004
],
[
-122.20818000000001,
47.6435
],
[
-122.21014000000001,
47.643130000000006
],
[
-122.20962000000002,
47.642920000000004
],
[
-122.20974000000001,
47.636720000000004
],
[
-122.21005000000001,
47.62107
],
[
-122.22268000000001,
47.62106000000001
],
[
-122.22268000000001,
47.62066
],
[
-122.22203,
47.620470000000005
],
[
-122.22282000000001,
47.619890000000005
],
[
-122.22142000000001,
47.618570000000005
],
[
-122.22248,
47.61838
],
[
-122.22271,
47.617200000000004
],
[
-122.22136,
47.617180000000005
],
[
-122.21985000000001,
47.61643
],
[
-122.22044000000001,
47.614470000000004
],
[
-122.22033,
47.603840000000005
],
[
-122.22043000000001,
47.59682
],
[
-122.21702,
47.59038
],
[
-122.21653,
47.59042
],
[
-122.21572,
47.588240000000006
],
[
-122.21067000000001,
47.58375
],
[
-122.20153,
47.57887
],
[
-122.20227000000001,
47.57864000000001
],
[
-122.20132000000001,
47.578770000000006
],
[
-122.20034000000001,
47.57822
],
[
-122.19901000000002,
47.57592
],
[
-122.19923000000001,
47.567460000000004
],
[
-122.20034000000001,
47.55962
],
[
-122.20072,
47.55966
],
[
-122.20114000000001,
47.557520000000004
],
[
-122.20119000000001,
47.54943
],
[
-122.20160000000001,
47.549440000000004
],
[
-122.20167000000001,
47.54883
],
[
-122.20200000000001,
47.54609000000001
],
[
-122.19676000000001,
47.54621
],
[
-122.19545000000001,
47.54609000000001
],
[
-122.19545000000001,
47.545750000000005
],
[
-122.19091000000002,
47.54580000000001
],
[
-122.1907,
47.54216
],
[
-122.18581,
47.542100000000005
],
[
-122.18116,
47.541140000000006
],
[
-122.17142000000001,
47.54086
],
[
-122.16987,
47.54008
],
[
-122.16797000000001,
47.540060000000004
],
[
-122.16554000000001,
47.54005
],
[
-122.16439000000001,
47.54281
],
[
-122.16433,
47.545480000000005
],
[
-122.15356000000001,
47.54538
],
[
-122.15359000000001,
47.541760000000004
],
[
-122.14280000000001,
47.541520000000006
],
[
-122.14288,
47.539370000000005
],
[
-122.13645000000001,
47.53826
],
[
-122.13035,
47.53502
]
],
[
[
-122.19957000000001,
47.58372000000001
],
[
-122.20448,
47.583830000000006
],
[
-122.20585000000001,
47.586780000000005
],
[
-122.19654000000001,
47.586740000000006
],
[
-122.19655000000002,
47.58379
],
[
-122.19957000000001,
47.58372000000001
]
]
]
}
]
},
"properties": {
"name": "Bellevue",
"copyright": "© 2022 Microsoft and its suppliers. This API and any results cannot be used or accessed without Microsoft's express written permission.",
"copyrightUrl": "https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/",
"geometriesCopyright": [
{
"sourceName": "TOM",
"copyright": "TomTom"
}
]
}
}Definizioni
| Nome | Descrizione |
|---|---|
|
Azure. |
Oggetto error. |
|
Azure. |
Risposta contenente i dettagli dell'errore. |
|
Azure. |
Oggetto contenente informazioni più specifiche sull'errore. Secondo le linee guida Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors. |
| Boundary |
Si noti che il servizio restituisce in genere un oggetto GeometryCollection con i sottotipi Polygon o MultiPolygon. |
|
Boundary |
Proprietà di un oggetto Boundary. |
|
Boundary |
Un enum che rappresenta il tipo di risultato al bordo. |
|
Feature |
Il tipo di una funzionalità deve essere Feature. |
|
Geo |
Tipo di oggetto |
|
Geo |
Tipo geometry |
|
Geo |
Tipo geometry |
|
Geo |
Tipo geometry |
|
Geo |
Tipo di oggetto |
|
Geo |
Specifica il tipo di |
|
Geo |
Tipo geometry |
|
Geo |
Tipo geometry |
|
Geometry |
Informazioni sul copyright di una geometria di un oggetto Boundary. |
|
Resolution |
Un enum che rappresenta la risoluzione della geometria del bordo restituito. |
Azure.Core.Foundations.Error
Oggetto error.
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
string |
Uno di un set definito dal server di codici di errore. |
| details |
Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato. |
|
| innererror |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
|
| message |
string |
Rappresentazione leggibile dell'errore. |
| target |
string |
Destinazione dell'errore. |
Azure.Core.Foundations.ErrorResponse
Risposta contenente i dettagli dell'errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
Oggetto error. |
Azure.Core.Foundations.InnerError
Oggetto contenente informazioni più specifiche sull'errore. Secondo le linee guida Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
string |
Uno di un set definito dal server di codici di errore. |
| innererror |
Errore interno. |
Boundary
GeoJSON GeocodingFeature che descrivono i confini di un'area geografica. La geometria della feature è descritta con GeoJSON GeometryCollection.
Si noti che il servizio restituisce in genere un oggetto GeometryCollection con i sottotipi Polygon o MultiPolygon.
BoundaryProperties
Proprietà di un oggetto Boundary.
| Nome | Tipo | Descrizione |
|---|---|---|
| copyright |
string |
La stringa del copyright. |
| copyrightUrl |
string |
Un URL che elenca molti dei fornitori di dati per Mappe di Azure e le relative informazioni sul copyright. |
| geometriesCopyright |
Una raccolta di informazioni sul copyright per ogni geometria dell'oggetto Boundary nello stesso ordine in cui appaiono. |
|
| name |
string |
Il nome associato all'area geografica. |
BoundaryResultTypeEnum
Un enum che rappresenta il tipo di risultato al bordo.
| Valore | Descrizione |
|---|---|
| countryRegion |
Paese o regione. |
| adminDistrict |
Primo livello amministrativo a livello di paese/area geografica, ad esempio uno stato o una provincia. |
| adminDistrict2 |
Secondo livello amministrativo a livello di paese/area geografica, ad esempio una contea. |
| postalCode |
La categoria di codice postale più piccola, ad esempio un codice postale. |
| postalCode2 |
La categoria di codice postale successiva a postalCode creata aggregando le aree postalCode. |
| postalCode3 |
La categoria di codice postale successiva a postalCode2 creata aggregando le aree postalCode2. |
| postalCode4 |
La categoria di codice postale successiva a postalCode3 creata aggregando le aree postalCode3. |
| neighborhood |
Una sezione di un luogo popolato che è tipicamente ben noto, ma spesso con confini indistinti. |
| locality |
Un'area concentrata di insediamento umano, come una città, un paese o un villaggio. |
FeatureTypeEnum
Il tipo di una funzionalità deve essere Feature.
| Valore | Descrizione |
|---|---|
| Feature |
Specifica il tipo di oggetto Feature |
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.
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.
| Valore | Descrizione |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
Oggetto |
| FeatureCollection |
Oggetto |
GeoJsonPoint
Tipo geometry GeoJSON Point valido. Per informazioni dettagliate, vedere RFC 7946.
GeoJsonPolygon
Tipo geometry GeoJSON Polygon valido. Per informazioni dettagliate, vedere RFC 7946.
GeometryCopyright
Informazioni sul copyright di una geometria di un oggetto Boundary.
| Nome | Tipo | Descrizione |
|---|---|---|
| copyright |
string |
La stringa di copyright per il fornitore di dati |
| sourceName |
string |
Il nome del fornitore di dati |
ResolutionEnum
Un enum che rappresenta la risoluzione della geometria del bordo restituito.
| Valore | Descrizione |
|---|---|
| small |
Restituite la geometria del contorno con il minor numero di punti. |
| medium |
Restituite la geometria del contorno con un numero di punti maggiore o uguale a quello piccolo. |
| large |
Restituisci la geometria del contorno con un numero di punti maggiore o uguale a quello del medio. |
| huge |
Restituite la geometria del contorno con un numero di punti maggiore o uguale a quello grande. |