Search - Get Search Polygon

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.0

Służy do pobierania danych wielokątnych kształtu obszaru geograficznego, takiego jak miasto lub region kraju.

Interfejs API Get Polygon to żądanie GET HTTP, które zwraca dane geometryczne, takie jak kontur miasta lub kraju/regionu dla zestawu jednostek, które zostały wcześniej pobrane z żądania wyszukiwania online w formacie GeoJSON. Identyfikator geometrii jest zwracany w obiekcie sourceGeometry w obszarze "geometry" i "id" w wywołaniu wyszukiwania lub rozmyte wyszukiwanie.

Identyfikator geometrii pobrany z punktu końcowego wyszukiwania online ma ograniczony okres istnienia. Nie zaleca się przechowywania identyfikatorów geometrii w magazynie trwałym na potrzeby późniejszego odwołania. Oczekuje się, że żądanie metody Polygon zostanie wykonane w ciągu kilku minut od żądania do metody wyszukiwania online, która dostarczyła identyfikator. Usługa umożliwia wykonywanie żądań wsadowych do 20 identyfikatorów.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko format `json`.
api-version	query	True	string	Numer wersji interfejsu API usługi Azure Maps.
geometries	query	True	string[]	Rozdzielona przecinkami lista identyfikatorów UUID geometrii, wcześniej pobrana z żądania wyszukiwania online.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Microsoft Entra ID. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń identyfikatora Entra firmy Microsoft w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PolygonResult	OK
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy Microsoft Entra OAuth 2.0. Po połączeniu z dostępem opartym na rolach platformy Azure kontroli może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi mogą mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.

Aby zaimplementować scenariusze, zalecamy wyświetlenie koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwaga

Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id w celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania Maps.
Authorization URL jest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów Entra firmy Microsoft.
Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana na podstawie płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
Użycie zestawu Web SDK usługi Azure Maps umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.
Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Microsoft identity platform overview.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenie konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może służyć jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie poufnych aplikacji klienckich podejście do uzyskiwania dostępu do interfejsów API REST usługi Azure Maps, aby klucz mógł być bezpiecznie przechowywany.

Typ: apiKey
W: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji List SAS na zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.

Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej zabezpieczony niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.

Typ: apiKey
W: header

Przykłady

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

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
          }
        ]
      }
    }
  ]
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
GeoJsonFeature	Prawidłowy typ obiektu `GeoJSON Feature`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonFeatureCollection	Prawidłowy typ obiektu `GeoJSON FeatureCollection`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonGeometry	Prawidłowy obiekt geometrii `GeoJSON`. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonGeometryCollection	Prawidłowy typ obiektu `GeoJSON GeometryCollection`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonLineString	Prawidłowy typ geometrii `GeoJSON LineString`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonMultiLineString	Prawidłowy typ geometrii `GeoJSON MultiLineString`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonMultiPoint	Prawidłowy typ geometrii `GeoJSON MultiPoint`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonMultiPolygon	Prawidłowy typ obiektu `GeoJSON MultiPolygon`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonPoint	Prawidłowy typ geometrii `GeoJSON Point`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonPolygon	Prawidłowy typ geometrii `GeoJSON Polygon`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko format `json`.
Polygon
PolygonResult	Ten obiekt jest zwracany z pomyślnego wywołania wielokąta wyszukiwania

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

GeoJsonFeature

Objekt

Prawidłowy typ obiektu GeoJSON Feature. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwa	Typ	Opis
featureType	string	Typ funkcji. Wartość zależy od modelu danych, do której należy bieżąca funkcja. Niektóre modele danych mogą mieć pustą wartość.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Prawidłowy obiekt geometrii `GeoJSON`. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
id	string	Identyfikator funkcji.
type	string: Feature	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonFeatureCollection

Objekt

Prawidłowy typ obiektu GeoJSON FeatureCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwa	Typ	Opis
features	GeoJsonFeature[]	Zawiera listę prawidłowych obiektów `GeoJSON Feature`.
type	string: FeatureCollection	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonGeometry

Objekt

Prawidłowy obiekt geometrii GeoJSON. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwa	Typ	Opis
type	GeoJsonObjectType	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonGeometryCollection

Objekt

Prawidłowy typ obiektu GeoJSON GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwa	Typ	Opis
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Zawiera listę prawidłowych obiektów geometrii `GeoJSON`. Uwaga, że współrzędne w formacie GeoJSON znajdują się w kolejności x, y (długość geograficzna, szerokość geograficzna).
type	string: GeometryCollection	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonLineString

Objekt

Prawidłowy typ geometrii GeoJSON LineString. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwa	Typ	Opis
coordinates	number[] (double)	Współrzędne geometrii `GeoJson LineString`.
type	string: LineString	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonMultiLineString

Objekt

Prawidłowy typ geometrii GeoJSON MultiLineString. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwa	Typ	Opis
coordinates	number[] (double)	Współrzędne geometrii `GeoJson MultiLineString`.
type	string: MultiLineString	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonMultiPoint

Objekt

Prawidłowy typ geometrii GeoJSON MultiPoint. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwa	Typ	Opis
coordinates	number[] (double)	Współrzędne geometrii `GeoJson MultiPoint`.
type	string: MultiPoint	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonMultiPolygon

Objekt

Prawidłowy typ obiektu GeoJSON MultiPolygon. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwa	Typ	Opis
coordinates	number[] (double)	Zawiera listę prawidłowych obiektów `GeoJSON Polygon`. Uwaga, że współrzędne w formacie GeoJSON znajdują się w kolejności x, y (długość geograficzna, szerokość geograficzna).
type	string: MultiPolygon	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonPoint

Objekt

Prawidłowy typ geometrii GeoJSON Point. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwa	Typ	Opis
coordinates	number[] (double)	`Position` to tablica liczb z co najmniej dwoma elementami. Dwa pierwsze elementy to długości geograficznej i szerokości geograficznej, dokładnie w tej kolejności. wysokości/wysokości jest opcjonalnym trzecim elementem. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
type	string: Point	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonPolygon

Objekt

Prawidłowy typ geometrii GeoJSON Polygon. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwa	Typ	Opis
coordinates	number[] (double)	Współrzędne typu geometrii `GeoJson Polygon`.
type	string: Polygon	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

JsonFormat

Wyliczanie

Żądany format odpowiedzi. Obsługiwany jest tylko format json.

Wartość	Opis
json	format wymiany danych notacji obiektów JavaScript

Polygon

Objekt

Nazwa	Typ	Opis
geometryData	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	Dane geometryczne w formacie GeoJSON. Aby uzyskać szczegółowe informacje, zobacz RFC 7946. Występuje tylko wtedy, gdy "błąd" nie istnieje.
providerID	string	Identyfikator zwróconej jednostki

PolygonResult

Objekt

Ten obiekt jest zwracany z pomyślnego wywołania wielokąta wyszukiwania

Nazwa	Typ	Opis
additionalData	Polygon[]	Tablica wyników

Udostępnij za pośrednictwem

Search - Get Search Polygon

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

AADToken

Zakresy

subscription-key

SAS Token

Przykłady

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

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonFeature

GeoJsonFeatureCollection

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonPoint

GeoJsonPolygon

JsonFormat

Polygon

PolygonResult

Dodatkowe zasoby