Search - Get Polygon
Use para obter dados de polígono de uma forma de área geográfica, como uma cidade ou uma região de país.
A API Get Polygon é uma solicitação http GET que fornece dados de polígono de uma estrutura de tópicos de área geográfica, como uma cidade ou uma região do país.
GET https://atlas.microsoft.com/search/polygon?api-version=2025-01-01&coordinates={coordinates}
GET https://atlas.microsoft.com/search/polygon?api-version=2025-01-01&coordinates={coordinates}&view={view}&resultType={resultType}&resolution={resolution}
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Número de versão da API do Azure Mapas. |
|
coordinates
|
query | True |
number[] |
Um ponto na Terra especificado como longitude e latitude. Exemplo: &coordinates=lon,lat |
|
resolution
|
query |
A resolução determina a quantidade de pontos a serem enviados de volta. Se não for especificado, o padrão será a resolução média. |
||
|
result
|
query |
O conceito geopolítico para o qual retornar um limite. Se não for especificado, o padrão será |
||
|
view
|
query |
string |
Uma cadeia de caracteres que representa uma de código de região/país iso 3166-1 do ISO 3166-1 alfa-2. Isso alterará as bordas e rótulos contestados geopolíticos para se alinharem com a região de usuário especificada. Por padrão, o parâmetro View é definido como "Automático", mesmo que você não o tenha definido na solicitação. Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis. |
Cabeçalho da solicitação
| Nome | Obrigatório | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança do Azure AD. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para obter mais informações sobre como usar a segurança de ID do Microsoft Entra no Azure Mapas, consulte Gerenciar autenticação no Azure Mapas. |
|
| Accept-Language |
string |
Idioma no qual os resultados da pesquisa devem ser retornados. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
OKEY Media Types: "application/geo+json" |
|
| Other Status Codes |
Ocorreu um erro inesperado. Media Types: "application/geo+json" |
Segurança
AADToken
Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Mapas.
Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de controlar o acesso em APIs e escopos específicos.
Observação
- Essa definição de segurança requer o uso do cabeçalho
x-ms-client-idpara indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas. - O
Authorization URLé específico para a instância de nuvem pública do Azure. Nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. - O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
- O uso do SDK da Web do do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
- Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
| Nome | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Essa é uma chave compartilhada provisionada ao criar um recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como chaves mestras para a conta para a qual são emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor a servidor de APIs REST do Azure Mapas, em que essa chave pode ser armazenada com segurança.
Tipo:
apiKey
Em:
header
SAS Token
Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais protegida do que a chave compartilhada.
Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta de mapa de
Tipo:
apiKey
Em:
header
Exemplos
Get polygon for a city at coordinates -122.204141,47.612560
Solicitação de exemplo
GET https://atlas.microsoft.com/search/polygon?api-version=2025-01-01&coordinates=-122.204141,47.61256&resultType=locality&resolution=small
Resposta de exemplo
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"
}
]
}
}
Definições
| Nome | Description |
|---|---|
| Boundary |
Observe que o serviço normalmente retorna um GeometryCollection com subtipos Polygon ou MultiPolygon. |
|
Boundary |
Propriedades de um objeto Boundary. |
|
Boundary |
O conceito geopolítico para o qual retornar um limite. Se não for especificado, o padrão será |
|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta de erro |
|
Feature |
O tipo de um recurso deve ser Feature. |
|
Geo |
Um objeto de geometria |
|
Geo |
Um tipo de objeto |
|
Geo |
Um tipo de geometria de |
|
Geo |
Um tipo de geometria de |
|
Geo |
Um tipo de geometria de |
|
Geo |
Um tipo de objeto |
|
Geo |
Um tipo de geometria de |
|
Geo |
Um tipo de geometria de |
|
Geometry |
Informações de direitos autorais de uma geometria de um objeto Boundary. |
|
Resolution |
A resolução determina a quantidade de pontos a serem enviados de volta. Se não for especificado, o padrão será a resolução média. |
Boundary
GeoJSON GeocodingFeature objeto que descreve os limites de uma área geográfica. A geometria do recurso é descrita com GeoJSON GeometryCollection.
Observe que o serviço normalmente retorna um GeometryCollection com subtipos Polygon ou MultiPolygon.
BoundaryProperties
Propriedades de um objeto Boundary.
| Nome | Tipo | Description |
|---|---|---|
| copyright |
string |
A cadeia de caracteres de direitos autorais. |
| copyrightURL |
string |
Uma URL que lista muitos dos provedores de dados para o Azure Mapas e suas informações de direitos autorais relacionadas. |
| geometriesCopyright |
Uma coleção de informações de direitos autorais para cada geometria do objeto Boundary na mesma ordem em que aparecem. |
|
| name |
string |
O nome associado à área geográfica. |
BoundaryResultTypeEnum
O conceito geopolítico para o qual retornar um limite. Se não for especificado, o padrão será countryRegion tipo de resultado.
| Valor | Description |
|---|---|
| countryRegion |
País ou região. |
| adminDistrict |
Primeiro nível administrativo no nível do país/região, como um estado ou uma província. |
| adminDistrict2 |
Segundo nível administrativo no nível de país/região, como um município. |
| postalCode |
A menor categoria de pós-código, como um cep. |
| postalCode2 |
A próxima maior categoria de código postal após o postalCode que é criado agregando áreas postalCode. |
| postalCode3 |
A próxima maior categoria de post code após o postalCode2 que é criado agregando áreas postalCode2. |
| postalCode4 |
A próxima maior categoria de post code após o postalCode3 que é criado agregando áreas postalCode3. |
| neighborhood |
Uma seção de um local populado que normalmente é bem conhecido, mas muitas vezes com limites indistintos. |
| locality |
Uma área concentrada de assentamento humano, como uma cidade, cidade ou vila. |
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
| Nome | Tipo | Description |
|---|---|---|
| info |
object |
As informações adicionais. |
| type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
| Nome | Tipo | Description |
|---|---|---|
| additionalInfo |
As informações adicionais do erro. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
| Nome | Tipo | Description |
|---|---|---|
| error |
O objeto de erro. |
FeatureTypeEnum
O tipo de um recurso deve ser Feature.
| Valor | Description |
|---|---|
| Feature |
GeoJsonGeometry
Um objeto de geometria GeoJSON válido. O tipo deve ser um dos sete tipos de geometria GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
GeoJsonGeometryCollection
Um tipo de objeto GeoJSON GeometryCollection válido. Consulte RFC 7946 para obter detalhes.
GeoJsonLineString
Um tipo de geometria de GeoJSON LineString válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiLineString
Um tipo de geometria de GeoJSON MultiLineString válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPoint
Um tipo de geometria de GeoJSON MultiPoint válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPolygon
Um tipo de objeto GeoJSON MultiPolygon válido. Consulte RFC 7946 para obter detalhes.
GeoJsonPoint
Um tipo de geometria de GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
GeoJsonPolygon
Um tipo de geometria de GeoJSON Polygon válido. Consulte RFC 7946 para obter detalhes.
GeometryCopyright
Informações de direitos autorais de uma geometria de um objeto Boundary.
| Nome | Tipo | Description |
|---|---|---|
| copyright |
string |
A cadeia de caracteres de direitos autorais para o provedor de dados |
| sourceName |
string |
O nome do provedor de dados |
ResolutionEnum
A resolução determina a quantidade de pontos a serem enviados de volta. Se não for especificado, o padrão será a resolução média.
| Valor | Description |
|---|---|
| small |
Retorne a geometria de limite com a menor quantidade de pontos. |
| medium |
Retorne a geometria de limite com mais ou a mesma quantidade de pontos que pequena. |
| large |
Retorne a geometria de limite com mais ou a mesma quantidade de pontos que a média. |
| huge |
Retorne a geometria de limite com mais ou a mesma quantidade de pontos que grandes. |