Search - Get Search Polygon
Şehir veya ülke bölgesi gibi coğrafi alan şeklinin çokgen verilerini almak için kullanın.
Get Polygon
API, daha önce GeoJSON biçiminde bir çevrimiçi arama isteğinden alınan bir varlık kümesi için şehir veya ülke/bölge ana hattı gibi geometri verilerini döndüren bir HTTP GET
isteğidir. Geometri kimliği, nesnede sourceGeometry
Arama Adresi'nde "geometri" ve "kimlik" altında döndürülür veya Belirsiz çağrı Arama.
Çevrimiçi arama uç noktasından alınan geometri kimliğinin kullanım ömrü sınırlıdır; daha sonra başvuru için geometri kimliklerinin kalıcı depolamada depolanması önerilmez. Kimliği sağlayan çevrimiçi arama yöntemine istekten sonra birkaç dakika içinde Polygon yöntemine bir istek yapılması beklenir. Hizmet, en fazla 20 tanımlayıcıya kadar toplu iş isteğine izin verir.
GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries={geometries}
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
format
|
path | True |
Yanıtın istenen biçimi. Yalnızca |
|
api-version
|
query | True |
string |
Azure Haritalar API'sinin sürüm numarası. |
geometries
|
query | True |
string[] |
Daha önce çevrimiçi arama isteğinden alınan geometri UUID'lerinin virgülle ayrılmış listesi. |
İstek Başlığı
Name | Gerekli | Tür | Description |
---|---|---|---|
x-ms-client-id |
string |
Hangi hesabın Microsoft Entra ID güvenlik modeliyle birlikte kullanıma yönelik olduğunu belirtir. Azure Haritalar hesabı için benzersiz bir kimliği temsil eder ve Azure Haritalar yönetim düzlemi Hesap API'sinden alınabilir. Azure Haritalar Microsoft Entra ID güvenliğini kullanmak için kılavuz için aşağıdaki makalelere bakın. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Tamam |
|
Other Status Codes |
Beklenmeyen bir hata oluştu. |
Güvenlik
AADToken
Bunlar Microsoft Entra OAuth 2.0 Akışlarıdır. Azure rol tabanlı erişim denetimiyle eşleştirildiğinde, Azure Haritalar REST API'lerine erişimi denetlemek için kullanılabilir. Azure rol tabanlı erişim denetimleri, bir veya daha fazla Azure Haritalar kaynak hesabına veya alt kaynağına erişimi tanımlamak için kullanılır. Herhangi bir kullanıcı, grup veya hizmet sorumlusuna yerleşik bir rol veya REST API'lerini Azure Haritalar için bir veya daha fazla izinden oluşan özel bir rol aracılığıyla erişim verilebilir.
Senaryoları uygulamak için kimlik doğrulama kavramlarını görüntülemenizi öneririz. Özetle, bu güvenlik tanımı belirli API'ler ve kapsamlar üzerinde erişim denetimi yapabilen nesneler aracılığıyla uygulamaları modellemeye yönelik bir çözüm sağlar.
Not
- Bu güvenlik tanımı, uygulamanın erişim isteğinde
x-ms-client-id
bulunduğu Azure Haritalar kaynağı belirtmek için üst bilginin kullanılmasını gerektirir. Bu, Haritalar yönetim API'sinden edinilebilir. -
Authorization URL
, Azure genel bulut örneğine özgüdür. Bağımsız bulutların benzersiz Yetkilendirme URL'leri ve Microsoft Entra ID yapılandırmaları vardır. - Azure rol tabanlı erişim denetimi Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzleminden yapılandırılır.
- Azure Haritalar Web SDK'sının kullanımı, bir uygulamanın birden çok kullanım örneği için yapılandırma tabanlı kurulumuna olanak tanır.
- Microsoft kimlik platformu hakkında daha fazla bilgi için bkz. Microsoft kimlik platformu genel bakış.
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/authorize
Kapsamlar
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Bu, Azure portal Azure Haritalar hesabı oluşturduğunuzda veya PowerShell, CLI, Azure SDK'ları veya REST API'sini kullandığınızda sağlanan paylaşılan bir anahtardır.
Bu anahtarla, tüm uygulamalar tüm REST API'lere erişebilir. Başka bir deyişle, bu anahtar, verildikleri hesapta ana anahtar olarak kullanılabilir.
Herkese açık uygulamalar için, anahtarınızın güvenli bir şekilde depolanabilmesi için gizli istemci uygulamaları yaklaşımını kullanarak Azure Haritalar REST API'lerine erişmenizi öneririz.
Tür:
apiKey
İçinde:
query
SAS Token
Bu paylaşılan erişim imzası belirteci, Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzlemi aracılığıyla Azure Haritalar kaynağındaki SAS listeleme işleminden oluşturulur.
Bu belirteçle, tüm uygulamalar Azure rol tabanlı erişim denetimleri ve belirli bir belirteç için kullanım süre sonu, oran ve bölgeler için ayrıntılı denetim ile erişim yetkisine sahip olur. Başka bir deyişle SAS Belirteci, uygulamaların paylaşılan anahtardan daha güvenli bir şekilde erişimi denetlemesine izin vermek için kullanılabilir.
Herkese açık uygulamalar için önerimiz, işleme kötüye kullanımını sınırlamak ve SAS Belirtecini düzenli olarak yenilemek için Harita hesabı kaynağında izin verilen kaynakların belirli bir listesini yapılandırmayı önermektedir.
Tür:
apiKey
İçinde:
header
Örnekler
Get the Geometry using the geometry id returned by the previous Search
Örnek isteği
GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries=8bceafe8-3d98-4445-b29b-fd81d3e9adf5,00005858-5800-1200-0000-0000773694ca
Örnek yanıt
{
"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"
}
]
}
}
]
}
Tanımlar
Name | Description |
---|---|
Error |
Kaynak yönetimi hatası ek bilgileri. |
Error |
Hata ayrıntısı. |
Error |
Hata yanıtı |
Geo |
Geçerli |
Geo |
Geçerli |
Geo |
Geçerli |
Geo |
Geçerli |
Geo |
Geçerli |
Geo |
Geçerli |
Geo |
Geçerli |
Geo |
Geçerli |
Geo |
Geçerli |
Geo |
Geçerli |
Json |
Yanıtın istenen biçimi. Yalnızca |
Polygon | |
Polygon |
Bu nesne başarılı bir Arama Çokgen çağrısından döndürülür |
ErrorAdditionalInfo
Kaynak yönetimi hatası ek bilgileri.
Name | Tür | Description |
---|---|---|
info |
object |
Ek bilgiler. |
type |
string |
Ek bilgi türü. |
ErrorDetail
Hata ayrıntısı.
Name | Tür | Description |
---|---|---|
additionalInfo |
Hata ek bilgileri. |
|
code |
string |
Hata kodu. |
details |
Hata ayrıntıları. |
|
message |
string |
Hata iletisi. |
target |
string |
Hata hedefi. |
ErrorResponse
Hata yanıtı
Name | Tür | Description |
---|---|---|
error |
Hata nesnesi. |
GeoJsonFeature
Geçerli GeoJSON Feature
bir nesne türü. Ayrıntılar için lütfen RFC 7946'ya bakın.
Name | Tür | Description |
---|---|---|
featureType |
string |
Özelliğin türü. Değer, geçerli özelliğin parçası olduğu veri modeline bağlıdır. Bazı veri modellerinin değeri boş olabilir. |
geometry | GeoJsonGeometry: |
Geçerli |
id |
string |
Özelliğin tanımlayıcısı. |
type |
string:
Feature |
|
GeoJsonFeatureCollection
Geçerli GeoJSON FeatureCollection
bir nesne türü. Ayrıntılar için lütfen RFC 7946'ya bakın.
Name | Tür | Description |
---|---|---|
features |
Geçerli |
|
type |
string:
Feature |
|
GeoJsonGeometry
Geçerli GeoJSON
bir geometri nesnesi. Tür yedi geçerli GeoJSON geometri türünden biri olmalıdır: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon ve GeometryCollection. Ayrıntılar için lütfen RFC 7946'ya bakın.
Name | Tür | Description |
---|---|---|
type |
Geo |
|
GeoJsonGeometryCollection
Geçerli GeoJSON GeometryCollection
bir nesne türü. Ayrıntılar için lütfen RFC 7946'ya bakın.
Name | Tür | Description |
---|---|---|
geometries | GeoJsonGeometry[]: |
Geçerli |
type |
string:
Geometry |
|
GeoJsonLineString
Geçerli GeoJSON LineString
bir geometri türü. Ayrıntılar için lütfen RFC 7946'ya bakın.
Name | Tür | Description |
---|---|---|
coordinates |
number[] |
Geometrinin |
type |
string:
Line |
|
GeoJsonMultiLineString
Geçerli GeoJSON MultiLineString
bir geometri türü. Ayrıntılar için lütfen RFC 7946'ya bakın.
Name | Tür | Description |
---|---|---|
coordinates |
number[] |
Geometrinin |
type |
string:
Multi |
|
GeoJsonMultiPoint
Geçerli GeoJSON MultiPoint
bir geometri türü. Ayrıntılar için lütfen RFC 7946'ya bakın.
Name | Tür | Description |
---|---|---|
coordinates |
number[] |
Geometrinin |
type |
string:
Multi |
|
GeoJsonMultiPolygon
Geçerli GeoJSON MultiPolygon
bir nesne türü. Ayrıntılar için lütfen RFC 7946'ya bakın.
Name | Tür | Description |
---|---|---|
coordinates |
number[] |
Geçerli |
type |
string:
Multi |
|
GeoJsonPoint
Geçerli GeoJSON Point
bir geometri türü. Ayrıntılar için lütfen RFC 7946'ya bakın.
Name | Tür | Description |
---|---|---|
coordinates |
number[] |
A |
type |
string:
Point |
|
GeoJsonPolygon
Geçerli GeoJSON Polygon
bir geometri türü. Ayrıntılar için lütfen RFC 7946'ya bakın.
Name | Tür | Description |
---|---|---|
coordinates |
number[] |
Geometri türü için |
type | string: |
|
JsonFormat
Yanıtın istenen biçimi. Yalnızca json
biçim desteklenir.
Name | Tür | Description |
---|---|---|
json |
string |
Polygon
Name | Tür | Description |
---|---|---|
geometryData | GeoJsonObject: |
GeoJSON biçiminde geometri verileri. Ayrıntılar için lütfen RFC 7946'ya bakın. Yalnızca "hata" yoksa sunulur. |
providerID |
string |
Döndürülen varlığın kimliği |
PolygonResult
Bu nesne başarılı bir Arama Çokgen çağrısından döndürülür
Name | Tür | Description |
---|---|---|
additionalData |
Polygon[] |
Sonuçlar dizisi |