Search - Get Search Polygon

Referencia

Szolgáltatás:: Maps

API-verzió:: 1.0

Egy földrajzi terület alakzatának , például egy városnak vagy egy országrégiónak a sokszögadatainak lekérésére használható.

A Get Polygon API egy HTTP-GET-kérés, amely geometriai adatokat ad vissza, például egy város- vagy ország-/régiószerkezetet egy entitáskészlethez, amelyet korábban geoJSON formátumú online keresési kérelemből kérnek le. A geometria azonosítóját a rendszer a sourceGeometry objektumban adja vissza a "geometria" és az "id" kifejezés alatt egy keresési címben vagy egy keresési Fuzzy-hívásban.

Az online keresési végpontról lekért geometriai azonosító élettartama korlátozott, a geometriai azonosítók tárolása nem ajánlott állandó tárban későbbi átirányítás céljából. A Polygon metódusra irányuló kérés várhatóan néhány percen belül megtörténik az azonosítót tartalmazó online keresési metódushoz való kéréstől számított néhány percen belül. A szolgáltatás legfeljebb 20 azonosítót engedélyez a kötegkérelmek számára.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
format	path	True	JsonFormat	A válasz kívánt formátuma. Csak `json` formátum támogatott.
api-version	query	True	string	Az Azure Maps API verziószáma.
geometries	query	True	string[]	A geometriai UUID-k vesszővel tagolt listája, amely korábban egy online keresési kérelemből származott.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Megadja, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Az Azure Maps-fiók egyedi azonosítóját jelöli, amely az Azure Maps felügyeleti sík fiók API-jából kérhető le. A Microsoft Entra ID-biztonság Azure Mapsben való használatához az alábbi cikkeket útmutatásért.

Válaszok

Name	Típus	Description
200 OK	PolygonResult	OKÉ
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

Ezek a Microsoft Entra OAuth 2.0 folyamatok . Ha Azure-beli szerepköralapú hozzáférés- vezérléssel párosítva szabályozható az Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps-erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörön vagy egy vagy több Azure Maps REST API-ra vonatkozó engedélyből álló egyéni szerepkörön keresztül.

Forgatókönyvek implementálásához javasoljuk, hogy tekintse meg hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást kínál az alkalmazások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.

Megjegyzés

Ez a biztonsági definíciós megköveteli, hogy a x-ms-client-id fejléc használatával jelezze, hogy melyik Azure Maps-erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps felügyeleti API-ból szerezhető be.
A Authorization URL az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra-azonosító konfigurációkkal rendelkeznek.
Az Azure szerepköralapú hozzáférés-vezérlés a Azure felügyeleti síkjáról van konfigurálva, az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kkal vagy REST API-kkal.
Az Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esethez.
További információ a Microsoft identitásplatformról: Microsoft Identitásplatform áttekintése.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Azure Maps-fiók létrehozása az Azure Portalon, vagy PowerShell, CLI, Azure SDK vagy REST API használatával.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ez a kulcs használható főkulcsként abban a fiókban, amelyben ki vannak adva.

A nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy használja a bizalmas ügyfélalkalmazásokat, megközelítést az Azure Maps REST API-k eléréséhez, hogy a kulcs biztonságosan tárolható legyen.

Típus: apiKey
In: query

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat a listázási SAS műveletből jön létre a Azure Maps-erőforráson az Azure felügyeleti síkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül.

Ezzel a jogkivonattal minden alkalmazás jogosult az Azure szerepköralapú hozzáférés-vezérlőivel való hozzáférésre, valamint az adott jogkivonat lejáratának, sebességének és régióinak részletes szabályozására. Más szóval az SAS-jogkivonat segítségével az alkalmazások biztonságosabban szabályozhatják a hozzáférést, mint a megosztott kulcs.

A nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfigurálja a -fiók erőforrás- engedélyezett forrásainak listáját a renderelési visszaélések korlátozása és az SAS-jogkivonat rendszeres megújítása érdekében.

Típus: apiKey
In: header

Példák

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

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 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"
          }
        ]
      }
    }
  ]
}

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
GeoJsonFeature	Érvényes `GeoJSON Feature` objektumtípus. Részletekért tekintse meg RFC 7946.
GeoJsonFeatureCollection	Érvényes `GeoJSON FeatureCollection` objektumtípus. Részletekért tekintse meg RFC 7946.
GeoJsonGeometry	Érvényes `GeoJSON` geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Pont, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon és GeometryCollection. Részletekért tekintse meg RFC 7946.
GeoJsonGeometryCollection	Érvényes `GeoJSON GeometryCollection` objektumtípus. Részletekért tekintse meg RFC 7946.
GeoJsonLineString	Érvényes `GeoJSON LineString` geometriatípus. Részletekért tekintse meg RFC 7946.
GeoJsonMultiLineString	Érvényes `GeoJSON MultiLineString` geometriatípus. Részletekért tekintse meg RFC 7946.
GeoJsonMultiPoint	Érvényes `GeoJSON MultiPoint` geometriatípus. Részletekért tekintse meg RFC 7946.
GeoJsonMultiPolygon	Érvényes `GeoJSON MultiPolygon` objektumtípus. Részletekért tekintse meg RFC 7946.
GeoJsonPoint	Érvényes `GeoJSON Point` geometriatípus. Részletekért tekintse meg RFC 7946.
GeoJsonPolygon	Érvényes `GeoJSON Polygon` geometriatípus. Részletekért tekintse meg RFC 7946.
JsonFormat	A válasz kívánt formátuma. Csak `json` formátum támogatott.
Polygon
PolygonResult	Ezt az objektumot egy sikeres keresési sokszög-hívás adja vissza

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

GeoJsonFeature

Objektum

Érvényes GeoJSON Feature objektumtípus. Részletekért tekintse meg RFC 7946.

Name	Típus	Description
featureType	string	A szolgáltatás típusa. Az érték attól függ, hogy az aktuális funkció melyik adatmodell része. Egyes adatmodellek üres értékkel rendelkezhetnek.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Érvényes `GeoJSON` geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Pont, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon és GeometryCollection. Részletekért tekintse meg RFC 7946.
id	string	A szolgáltatás azonosítója.
type	string: Feature	Megadja a `GeoJSON` típusát. A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonFeatureCollection

Objektum

Érvényes GeoJSON FeatureCollection objektumtípus. Részletekért tekintse meg RFC 7946.

Name	Típus	Description
features	GeoJsonFeature[]	Az érvényes `GeoJSON Feature` objektumok listáját tartalmazza.
type	string: FeatureCollection	Megadja a `GeoJSON` típusát. A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonGeometry

Objektum

Érvényes GeoJSON geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Pont, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon és GeometryCollection. Részletekért tekintse meg RFC 7946.

Name	Típus	Description
type	GeoJsonObjectType	Megadja a `GeoJSON` típusát. A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonGeometryCollection

Objektum

Érvényes GeoJSON GeometryCollection objektumtípus. Részletekért tekintse meg RFC 7946.

Name	Típus	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Érvényes `GeoJSON` geometriai objektumok listáját tartalmazza. Vegye figyelembe, hogy a GeoJSON koordinátái x, y sorrendben vannak (hosszúság, szélesség).
type	string: GeometryCollection	Megadja a `GeoJSON` típusát. A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonLineString

Objektum

Érvényes GeoJSON LineString geometriatípus. Részletekért tekintse meg RFC 7946.

Name	Típus	Description
coordinates	number[] (double)	A `GeoJson LineString` geometria koordinátái.
type	string: LineString	Megadja a `GeoJSON` típusát. A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonMultiLineString

Objektum

Érvényes GeoJSON MultiLineString geometriatípus. Részletekért tekintse meg RFC 7946.

Name	Típus	Description
coordinates	number[] (double)	A `GeoJson MultiLineString` geometria koordinátái.
type	string: MultiLineString	Megadja a `GeoJSON` típusát. A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonMultiPoint

Objektum

Érvényes GeoJSON MultiPoint geometriatípus. Részletekért tekintse meg RFC 7946.

Name	Típus	Description
coordinates	number[] (double)	A `GeoJson MultiPoint` geometria koordinátái.
type	string: MultiPoint	Megadja a `GeoJSON` típusát. A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonMultiPolygon

Objektum

Érvényes GeoJSON MultiPolygon objektumtípus. Részletekért tekintse meg RFC 7946.

Name	Típus	Description
coordinates	number[] (double)	Az érvényes `GeoJSON Polygon` objektumok listáját tartalmazza. Vegye figyelembe, hogy a GeoJSON koordinátái x, y sorrendben vannak (hosszúság, szélesség).
type	string: MultiPolygon	Megadja a `GeoJSON` típusát. A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonPoint

Objektum

Érvényes GeoJSON Point geometriatípus. Részletekért tekintse meg RFC 7946.

Name	Típus	Description
coordinates	number[] (double)	A `Position` két vagy több elemet tartalmazó számtömb. Az első két elem hosszúsági és szélességi, pontosan ebben a sorrendben. magassági/magassági nem kötelező harmadik elem. Részletekért tekintse meg RFC 7946.
type	string: Point	Megadja a `GeoJSON` típusát. A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonPolygon

Objektum

Érvényes GeoJSON Polygon geometriatípus. Részletekért tekintse meg RFC 7946.

Name	Típus	Description
coordinates	number[] (double)	A `GeoJson Polygon` geometriatípus koordinátái.
type	string: Polygon	Megadja a `GeoJSON` típusát. A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

JsonFormat

Enumerálás

A válasz kívánt formátuma. Csak json formátum támogatott.

Érték	Description
json	A JavaScript objektum jelölési adatcseréjének formátuma

Polygon

Objektum

Name	Típus	Description
geometryData	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	Geometriai adatok GeoJSON formátumban. Részletekért tekintse meg RFC 7946. Csak akkor jelenik meg, ha a "hiba" nem jelenik meg.
providerID	string	A visszaadott entitás azonosítója

PolygonResult

Objektum

Ezt az objektumot egy sikeres keresési sokszög-hívás adja vissza

Name	Típus	Description
additionalData	Polygon[]	Eredménytömb

Megosztás a következőn keresztül:

Search - Get Search Polygon

URI-paraméterek

Kérelem fejléce

Válaszok

Biztonság

AADToken

Hatókörök

subscription-key

SAS Token

Példák

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

Mintakérelem

Mintaválasz

Definíciók

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonFeature

GeoJsonFeatureCollection

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonPoint

GeoJsonPolygon

JsonFormat

Polygon

PolygonResult