Search - Get Polygon
Służy do pobierania danych wielokątnych kształtu obszaru geograficznego, takiego jak miasto lub region kraju.
Interfejs Get Polygon
API to żądanie HTTP GET
, które dostarcza dane wielokątne konturu obszaru geograficznego, takiego jak miasto lub region kraju.
GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates={coordinates}
GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates={coordinates}&view={view}&resultType={resultType}&resolution={resolution}
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
api-version
|
query | True |
string |
Numer wersji interfejsu API usługi Azure Maps. |
coordinates
|
query | True |
number[] |
Punkt na ziemi określony jako długość geograficzna i szerokość geograficzna. Przykład: współrzędne &=lon,lat |
resolution
|
query |
Rozwiązanie określa ilość punktów do wysłania. Jeśli nie zostanie określony, wartość domyślna to średnia rozdzielczość. |
||
result
|
query |
Koncepcja geopolityczna zwracająca granicę. Jeśli nie zostanie określony, wartością domyślną jest |
||
view
|
query |
string |
Ciąg reprezentujący kod kraju/regionu ISO 3166-1 Alfa-2. Spowoduje to zmianę spornych geopolitycznych granic i etykiet w celu dostosowania ich do określonego regionu użytkownika. Domyślnie parametr Widok jest ustawiony na wartość "Auto", nawet jeśli nie zdefiniowano go w żądaniu. Aby uzyskać szczegółowe informacje i wyświetlić dostępne widoki, zapoznaj się z tematem Obsługiwane widoki . |
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ń usługi Azure AD. 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ń usługi Azure AD w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki. |
|
Accept-Language |
string |
Język, w którym powinny być zwracane wyniki wyszukiwania. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane języki . |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK Media Types: "application/geo+json" |
|
Other Status Codes |
Wystąpił nieoczekiwany błąd. Media Types: "application/geo+json" |
Zabezpieczenia
AADToken
Są to przepływy protokołu Microsoft Entra OAuth 2.0 . Po połączeniu z kontrolą dostępu opartą na rolach platformy Azure można użyć jej 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 może 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 pojęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi 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ć z poziomu interfejsu API zarządzania usługami Maps. - Element
Authorization URL
jest specyficzny 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 z poziomu 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 SDK sieci Web 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 Omówienie platformy tożsamości firmy Microsoft.
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ółużytkowany podczas tworzenia zasobu 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.
Za pomocą tego klucza każda aplikacja jest autoryzowana do uzyskiwania dostępu do wszystkich interfejsów API REST. Innymi słowy, mogą one być obecnie traktowane jako klucze główne dla konta, dla którego są wystawiane.
W przypadku publicznie uwidocznionych aplikacji zalecamy użycie dostępu serwer-serwer do interfejsów API REST usługi Azure Maps, w których ten klucz może być bezpiecznie przechowywany.
Typ:
apiKey
W:
header
SAS Token
Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji list SYGNATUR dostępu współdzielonego w 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 oraz 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 bezpieczny niż klucz wspólny.
W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.
Typ:
apiKey
W:
header
Przykłady
Get polygon for a city at coordinates -122.204141,47.612560
Przykładowe żądanie
GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates=-122.204141,47.61256&resultType=locality&resolution=small
Przykładowa odpowiedź
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"
}
]
}
}
Definicje
Nazwa | Opis |
---|---|
Boundary |
Należy pamiętać, że usługa zwykle zwraca element GeometryCollection z podtypami Wielokąt lub MultiPolygon. |
Boundary |
Koncepcja geopolityczna zwracająca granicę. Jeśli nie zostanie określony, wartością domyślną jest |
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geometry |
Informacje o prawach autorskich geometrii obiektu granic. |
Resolution |
Rozwiązanie określa ilość punktów do wysłania z powrotem. Jeśli nie zostanie określony, wartość domyślna to średnia rozdzielczość. |
Boundary
GeoJSON GeocodingFeature
obiekt opisujący granice obszaru geograficznego. Geometria funkcji została opisana za pomocą polecenia GeoJSON GeometryCollection
.
Należy pamiętać, że usługa zwykle zwraca element GeometryCollection z podtypami Wielokąt lub MultiPolygon.
Nazwa | Typ | Opis |
---|---|---|
bbox |
number[] |
Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 . |
copyright |
string |
Ciąg praw autorskich. |
copyrightURL |
string |
Adres URL, który zawiera listę wielu dostawców danych dla usługi Azure Maps i powiązanych informacji o prawach autorskich. |
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ść. |
geometriesCopyright |
Kolekcja informacji o prawach autorskich dla każdej geometrii obiektu Granica w takiej samej kolejności, w której się pojawiają. |
|
geometry | GeoJsonGeometry: |
Prawidłowy |
id |
string |
Identyfikator funkcji. |
name |
string |
Nazwa skojarzona z obszarem geograficznym. |
type |
string:
Feature |
Określa |
BoundaryResultTypeEnum
Koncepcja geopolityczna zwracająca granicę. Jeśli nie zostanie określony, wartością domyślną jest countryRegion
typ wyniku.
Nazwa | Typ | Opis |
---|---|---|
adminDistrict |
string |
Pierwszy poziom administracyjny na poziomie kraju/regionu, taki jak stan lub prowincja. |
adminDistrict2 |
string |
Drugi poziom administracyjny na poziomie kraju/regionu, taki jak powiat. |
countryRegion |
string |
Kraj lub region. |
locality |
string |
Skoncentrowany obszar osady ludzkiej, taki jak miasto, miasto lub wioska. |
neighborhood |
string |
Sekcja wypełnionego miejsca, które jest zazwyczaj dobrze znane, ale często z niedystynowymi granicami. |
postalCode |
string |
Najmniejsza kategoria kodu pocztowego, taka jak kod pocztowy. |
postalCode2 |
string |
Następna największa kategoria kodu pocztowego po kodzie pocztowym, która jest tworzona przez agregowanie obszarów postalCode. |
postalCode3 |
string |
Następna największa kategoria kodu pocztowego po kodzie pocztowym2 utworzona przez agregowanie obszarów postalCode2. |
postalCode4 |
string |
Następna największa kategoria kodu pocztowego po kodzie pocztowym3 utworzona przez agregowanie obszarów postalCode3. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
Nazwa | Typ | Opis |
---|---|---|
info |
object |
Dodatkowe informacje. |
type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
Nazwa | Typ | Opis |
---|---|---|
additionalInfo |
Dodatkowe informacje o błędzie. |
|
code |
string |
Kod błędu. |
details |
Szczegóły błędu. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy błędu. |
ErrorResponse
Odpowiedź na błąd
Nazwa | Typ | Opis |
---|---|---|
error |
Obiekt błędu. |
GeoJsonGeometry
Prawidłowy GeoJSON
obiekt geometryczny. 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 |
---|---|---|
bbox |
number[] |
Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 . |
type |
Geo |
Określa |
GeoJsonGeometryCollection
Prawidłowy GeoJSON GeometryCollection
typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
bbox |
number[] |
Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 . |
geometries | GeoJsonGeometry[]: |
Zawiera listę prawidłowych |
type |
string:
Geometry |
Określa |
GeoJsonLineString
Prawidłowy GeoJSON LineString
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
bbox |
number[] |
Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 . |
coordinates |
number[] |
Współrzędne geometrii |
type |
string:
Line |
Określa |
GeoJsonMultiLineString
Prawidłowy GeoJSON MultiLineString
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
bbox |
number[] |
Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 . |
coordinates |
number[] |
Współrzędne geometrii |
type |
string:
Multi |
Określa |
GeoJsonMultiPoint
Prawidłowy GeoJSON MultiPoint
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
bbox |
number[] |
Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 . |
coordinates |
number[] |
Współrzędne geometrii |
type |
string:
Multi |
Określa |
GeoJsonMultiPolygon
Prawidłowy GeoJSON MultiPolygon
typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
bbox |
number[] |
Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 . |
coordinates |
number[] |
Zawiera listę prawidłowych |
type |
string:
Multi |
Określa |
GeoJsonPoint
Prawidłowy GeoJSON Point
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
bbox |
number[] |
Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 . |
coordinates |
number[] |
A |
type |
string:
Point |
Określa |
GeoJsonPolygon
Prawidłowy GeoJSON Polygon
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
bbox |
number[] |
Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 . |
coordinates |
number[] |
Współrzędne dla |
type |
string:
Polygon |
Określa |
GeometryCopyright
Informacje o prawach autorskich geometrii obiektu granic.
Nazwa | Typ | Opis |
---|---|---|
copyright |
string |
Ciąg praw autorskich dostawcy danych |
sourceName |
string |
Nazwa dostawcy danych |
ResolutionEnum
Rozwiązanie określa ilość punktów do wysłania z powrotem. Jeśli nie zostanie określony, wartość domyślna to średnia rozdzielczość.
Nazwa | Typ | Opis |
---|---|---|
huge |
string |
Zwróć geometrię granic z większą lub większą ilością punktów co duże. |
large |
string |
Zwraca geometrię granic z większą lub taką samą ilością punktów jak średnia. |
medium |
string |
Zwraca geometrię granic z większą lub większą ilością punktów co mała. |
small |
string |
Zwraca geometrię granic z najmniejszą ilością punktów. |