Search - Get Polygon
Use para obter dados de polígonos de uma forma de área geográfica, como uma cidade ou uma região do país.
A Get Polygon API é uma solicitação HTTP GET que fornece dados de polígonos de uma estrutura de tópicos de área geográfica, como uma cidade ou uma região do país.
GET {endpoint}/search/polygon?api-version=2026-01-01&coordinates={coordinates}GET {endpoint}/search/polygon?api-version=2026-01-01&coordinates={coordinates}&view={view}&resultType={resultType}&resolution={resolution}Parâmetros do URI
| Nome | Em | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
O nome de host do serviço Azure Maps. Usa |
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a utilizar para esta operação. |
|
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 é resolução média. |
||
|
result
|
query |
O conceito geopolítico para devolver uma fronteira. Se não for especificado, o padrão será |
||
|
view
|
query |
string |
Uma cadeia de caracteres que representa um código de região/país ISO 3166-1 Alpha-2 . Isso alterará fronteiras e rótulos disputados geopoliticamente para se alinhar com a região de usuário especificada. Por defeito, o parâmetro View está definido como "Auto" mesmo que não o tenhas definido no pedido. Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis. |
Cabeçalho do Pedido
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| x-ms-client-id |
string |
Especifica qual a conta destinada a ser usada em conjunto com o modelo de segurança do Azure AD. Representa um ID único para a conta Azure Maps e pode ser recuperado na API de Contas do plano de gestão do Azure Maps. Para mais informações sobre o uso da segurança Microsoft Entra ID em Azure Maps, consulte Gerir autenticação em Azure Maps. |
|
| Accept-Language |
string |
Idioma em que os resultados da pesquisa devem ser retornados. |
Respostas
| Nome | Tipo | Descrição |
|---|---|---|
| 200 OK |
O pedido foi bem-sucedido. Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Uma resposta de erro inesperada. Media Types: "application/geo+json", "application/json" Cabeçalhos x-ms-error-code: string |
Segurança
AadToken
Estes são os fluxos Microsoft Entra OAuth 2.0. Quando combinado com controlo Azure baseado em funções, pode ser usado para controlar o acesso a APIs REST Azure Maps. Os controlos de acesso baseados em papéis do Azure são usados para designar o acesso a uma ou mais contas ou subrecursos de recursos do Azure Maps. 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 Maps.
Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.
Note
- Essa definição de segurança requer o uso do cabeçalho
x-ms-client-idpara indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento do Maps. - O
Authorization URLé específico para a instância de nuvem pública do Azure. As clouds soberanas têm URLs de Autorização e configurações de Microsoft Entra ID únicas. - O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
- O uso do SDK da Web do Azure Maps 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
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
| Nome | Descrição |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.
Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.
Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de de aplicativos cliente confidenciais para acessar APIs REST do Azure Maps para que sua chave possa ser armazenada com segurança.
Tipo:
apiKey
Em:
header
SAS Token
Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do
Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(ões) 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 segura 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 do
Tipo:
apiKey
Em:
header
Exemplos
Get polygon for a city at coordinates -122.204141,47.612560
Pedido de amostra
GET https://atlas.microsoft.com/search/polygon?api-version=2026-01-01&coordinates=-122.204141,47.61256&resultType=locality&resolution=small
Resposta da amostra
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 | Descrição |
|---|---|
|
Azure. |
O objeto de erro. |
|
Azure. |
Uma resposta contendo detalhes do erro. |
|
Azure. |
Um objeto que contém informações mais específicas sobre o erro. De acordo com Azure diretrizes da API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors. |
| Boundary |
O corpo de resposta bem-sucedida retornou por |
|
Boundary |
A |
|
Boundary |
O nível da hierarquia geográfica solicitado ao chamar |
|
Feature |
O |
|
Geo |
Um tipo de objeto |
|
Geo |
Um tipo de geometria |
|
Geo |
Um tipo de geometria |
|
Geo |
Um tipo de geometria |
|
Geo |
Um tipo de objeto |
|
Geo |
Especifica o tipo de |
|
Geo |
Um tipo de geometria |
|
Geo |
Um tipo de geometria |
|
Geometry |
Uma única entrada de atribuição por fornecedor de dados por geometria dentro |
|
Resolution |
O nível de detalhe usado para o |
Azure.Core.Foundations.Error
O objeto de erro.
| Nome | Tipo | Descrição |
|---|---|---|
| code |
string |
Um de um conjunto de códigos de erro definido pelo servidor. |
| details |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
|
| innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
| message |
string |
Uma representação legível por humanos do erro. |
| target |
string |
O alvo do erro. |
Azure.Core.Foundations.ErrorResponse
Uma resposta contendo detalhes do erro.
| Nome | Tipo | Descrição |
|---|---|---|
| error |
O objeto de erro. |
Azure.Core.Foundations.InnerError
Um objeto que contém informações mais específicas sobre o erro. De acordo com Azure diretrizes da API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Nome | Tipo | Descrição |
|---|---|---|
| code |
string |
Um de um conjunto de códigos de erro definido pelo servidor. |
| innererror |
Erro interno. |
Boundary
O corpo de resposta bem-sucedida retornou por Get Polygon. Codificado como um GeoJSON Feature cujo geometry é um GeometryCollection de uma ou mais MultiPolygonPolygon formas que descrevem o contorno da área geográfica solicitada, e que properties transportam o nome de exibição e a atribuição de direitos de autor da área.
| Nome | Tipo | Descrição |
|---|---|---|
| geometry |
A |
|
| properties |
Nome de exibição e atribuição de direitos de autor para a área devolvida. Veja |
|
| type |
O tipo de |
BoundaryProperties
A properties carga útil de um Boundary. Inclui o nome de exibição da área geográfica devolvida juntamente com atribuição de direitos de autor, tanto um aviso à escala da API como créditos por fornecedor de dados geométricos.
| Nome | Tipo | Descrição |
|---|---|---|
| copyright |
string |
O aviso de direitos de autor e uso da API Azure Maps que se aplica a esta resposta. Distinto das atribuições de fornecedores de dados por geometria em |
| copyrightUrl |
string |
Um URL para informações de direitos de autor e licenciamento do Azure Maps para a API e as suas fontes de dados subjacentes. |
| geometriesCopyright |
Atribuição por fornecedor de dados em geometria. Cada entrada corresponde posicionalmente à forma correspondente no array pai |
|
| name |
string |
O nome de exibição da área geográfica, por exemplo, |
BoundaryResultTypeEnum
O nível da hierarquia geográfica solicitado ao chamar Get Polygon. O valor é fornecido como resultType parâmetro de consulta e seleciona qual nível da hierarquia administrativa ou postal o polígono devolvido Boundary delineia. Por predefinição, assume countryRegion quando não é especificado.
| Valor | Descrição |
|---|---|
| countryRegion |
Um país ou região. |
| adminDistrict |
Primeiro nível administrativo dentro do país/região, como um estado ou província. |
| adminDistrict2 |
Segundo nível administrativo dentro do país/região, como um condado. |
| postalCode |
A menor categoria de código postal, como um código postal. |
| postalCode2 |
A segunda maior categoria de código postal depois |
| postalCode3 |
A segunda maior categoria de código postal depois |
| postalCode4 |
A segunda maior categoria de código postal depois |
| neighborhood |
Uma área reconhecida localmente dentro de um local povoado, frequentemente com limites informais ou culturalmente definidos. |
| locality |
Uma área concentrada de assentamento humano, como uma cidade, vila ou aldeia. |
FeatureTypeEnum
O GeoJSON tipo de objeto para Feature os objetos. Etiqueta cada entrada dentro do features array de uma FeatureCollection resposta (geocodificação, geocodificação reversa, autocompletamento) e aparece na raiz da Get Polygon resposta. O único valor é Feature, conforme definido no RFC 7946.
| Valor | Descrição |
|---|---|
| Feature |
O tipo de |
GeoJsonGeometryCollection
Um tipo de objeto GeoJSON GeometryCollection válido. Consulte RFC 7946 para obter detalhes.
GeoJsonLineString
Um tipo de geometria GeoJSON LineString válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiLineString
Um tipo de geometria GeoJSON MultiLineString válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPoint
Um tipo de geometria 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.
GeoJsonObjectType
Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.
| Valor | Descrição |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
|
| FeatureCollection |
|
GeoJsonPoint
Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
GeoJsonPolygon
Um tipo de geometria GeoJSON Polygon válido. Consulte RFC 7946 para obter detalhes.
GeometryCopyright
Uma única entrada de atribuição por fornecedor de dados por geometria dentro BoundaryProperties.geometriesCopyrightde . Identifica a origem de uma geometria no array pai Boundary.geometry.geometries .
| Nome | Tipo | Descrição |
|---|---|---|
| copyright |
string |
A cadeia de atribuição legível por humanos para o fornecedor de dados. Por exemplo, |
| sourceName |
string |
Um identificador para o fornecedor de dados que forneceu esta geometria. |
ResolutionEnum
O nível de detalhe usado para o Boundary polígono devolvido por Get Polygon. Fornecido como resolution parâmetro de consulta, o valor seleciona quantos pontos delineiam a fronteira, por ordem crescente: small, medium, large, huge. Os níveis superiores usam o mesmo número de pontos que o nível inferior seguinte ou mais. Por predefinição, assume medium quando não é especificado.
| Valor | Descrição |
|---|---|
| small |
Devolve a geometria da fronteira com menos pontos. |
| medium |
Devolve a geometria da fronteira com o mesmo número de pontos que |
| large |
Devolve a geometria da fronteira com o mesmo número de pontos que |
| huge |
Devolve a geometria da fronteira com o mesmo número de pontos que |