Search - Get Search Polygon

Slouží k získání mnohoúhelníku obrazce zeměpisné oblasti, jako je město nebo oblast země.

Rozhraní Get Polygon API je požadavek HTTP GET , který vrací geometrické údaje, jako je obrys města nebo země/oblasti, pro sadu entit, které byly dříve načteny z žádosti o online vyhledávání ve formátu GeoJSON. ID geometrie je vráceno v objektu sourceGeometry v části "geometrie" a "id" v Search Adrese nebo Search Volání Fuzzy.

ID geometrie načtené z koncového bodu online vyhledávání má omezenou životnost, nedoporučuje se ukládat ID geometrie v trvalém úložišti pro pozdější referenci. Očekává se, že požadavek na metodu Polygon se provede během několika minut od požadavku na metodu online vyhledávání, která poskytla ID. Služba umožňuje dávkové požadavky až 20 identifikátorů.

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

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

AADToken

Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a obory.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

subscription-key

Jedná se o sdílený klíč, který se zřídí při vytvoření účtu Azure Maps v Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace přístup ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve který je vystavený.

U veřejně vystavených aplikací doporučujeme používat pro přístup k rozhraním REST API Azure Maps přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.

Typ: apiKey
V: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.

Typ: apiKey
V: header

Příklady

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

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

{
  "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"
          }
        ]
      }
    }
  ]
}

Definice

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě

ErrorResponse

Chybová odpověď

GeoJsonFeature

Platný GeoJSON Feature typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

GeoJsonFeatureCollection

Platný GeoJSON FeatureCollection typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

GeoJsonGeometry

Platný GeoJSON objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .

GeoJsonGeometryCollection

Platný GeoJSON GeometryCollection typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

GeoJsonLineString

Platný GeoJSON LineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

GeoJsonMultiLineString

Platný GeoJSON MultiLineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

GeoJsonMultiPoint

Platný GeoJSON MultiPoint typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

GeoJsonMultiPolygon

Platný GeoJSON MultiPolygon typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

GeoJsonPoint

Platný GeoJSON Point typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

GeoJsonPolygon

Platný GeoJSON Polygon typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

JsonFormat

Požadovaný formát odpovědi Podporuje se pouze json formát.

Polygon

PolygonResult

Tento objekt je vrácen úspěšným voláním polygonu Search.