Search - Get Polygon
Utilizado 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 é um pedido HTTP GET
que fornece dados de polígonos de um destaque de área geográfica, como uma cidade ou uma região do país.
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}
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Número da versão da API do Azure Maps. |
coordinates
|
query | True |
number[] |
Um ponto na terra especificado como uma longitude e latitude. Exemplo: &coordenadas=lon,lat |
resolution
|
query |
A resolução determina a quantidade de pontos a enviar de volta. Se não for especificado, a predefinição é a resolução média. |
||
result
|
query |
O conceito geopolítico para o que devolver um limite. Se não for especificado, a predefinição é |
||
view
|
query |
string |
Uma cadeia que representa um código de região/país ISO 3166-1 Alpha-2. Isto irá alterar os limites e etiquetas geopolíticos contestados para se alinharem com a região de utilizador especificada. Por predefinição, o parâmetro Ver está definido como "Automático", mesmo que não o tenha definido no pedido. Consulte As Vistas Suportadas para obter detalhes e ver as Vistas disponíveis. |
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
x-ms-client-id |
string |
Especifica a conta que se destina à utilização em conjunto com o modelo de segurança do Azure AD. Representa um ID exclusivo para a conta do Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão do Azure Maps. Para utilizar a segurança do Azure AD no Azure Maps, veja os seguintes artigos para obter orientações. |
|
Accept-Language |
string |
Idioma no qual os resultados da pesquisa devem ser devolvidos. Consulte idiomas suportados para obter detalhes. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
OK Media Types: "application/geo+json" |
|
Other Status Codes |
Ocorreu um erro inesperado. Media Types: "application/geo+json" |
Segurança
AADToken
Estes são os Fluxos Microsoft Entra OAuth 2.0 . Quando emparelhado com o controlo de acesso baseado em funções do Azure , pode ser utilizado para controlar o acesso às APIs REST do Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais contas de recursos ou sub-recursos do Azure Maps. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para as APIs REST do Azure Maps.
Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.
Nota
- Esta definição de segurança requer a utilização do
x-ms-client-id
cabeçalho para indicar a que recurso do Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps. - O
Authorization URL
é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Microsoft Entra ID. - O controlo de acesso baseado em funções do Azure é configurado a partir do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
- A utilização do SDK Web do Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.
- Para obter mais informações sobre a plataforma de identidades da Microsoft, consulte Descrição geral da plataforma de identidades da Microsoft.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Esta é uma chave partilhada que é aprovisionada ao criar um recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
Com esta chave, qualquer aplicação está autorizada a aceder a todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras da conta para a qual são emitidas.
Para aplicações expostas publicamente, a nossa recomendação é utilizar o acesso servidor a servidor das APIs REST do Azure Maps, onde esta chave pode ser armazenada de forma segura.
Tipo:
apiKey
Em:
header
SAS Token
Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.
Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.
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=2023-06-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
Name | Description |
---|---|
Boundary |
Tenha em atenção que o serviço normalmente devolve uma GeometryCollection com subtipos Polygon ou MultiPolygon. |
Boundary |
O conceito geopolítico para o que devolver um limite. Se não for especificado, a predefinição é |
Error |
Informações adicionais sobre o erro de gestão de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta a erros |
Geo |
Um objeto de geometria válido |
Geo |
Um tipo de objeto válido |
Geo |
Um tipo de geometria válido |
Geo |
Um tipo de geometria válido |
Geo |
Um tipo de geometria válido |
Geo |
Um tipo de objeto válido |
Geo |
Um tipo de geometria válido |
Geo |
Um tipo de geometria válido |
Geometry |
Informações sobre direitos de autor de uma geometria de um objeto Boundary. |
Resolution |
A resolução determina a quantidade de pontos a enviar de volta. Se não for especificado, a predefinição é a resolução média. |
Boundary
GeoJSON GeocodingFeature
objeto que descreve os limites de uma área geográfica. A geometria da funcionalidade é descrita com GeoJSON GeometryCollection
.
Tenha em atenção que o serviço normalmente devolve uma GeometryCollection com subtipos Polygon ou MultiPolygon.
Name | Tipo | Description |
---|---|---|
bbox |
number[] |
Caixa delimitadora. Projeção utilizada – EPSG:3857. Consulte RFC 7946 para obter detalhes. |
copyright |
string |
A cadeia de direitos autorais. |
copyrightURL |
string |
Um URL que lista muitos dos fornecedores de dados do Azure Maps e as respetivas informações relacionadas com direitos de autor. |
featureType |
string |
O tipo da funcionalidade. O valor depende do modelo de dados do qual a funcionalidade atual faz parte. Alguns modelos de dados podem ter um valor vazio. |
geometriesCopyright |
Uma coleção de informações de direitos de autor para cada geometria do objeto Limite pela mesma ordem em que aparecem. |
|
geometry | GeoJsonGeometry: |
Um objeto de geometria válido |
id |
string |
Identificador da funcionalidade. |
name |
string |
O nome associado à área geográfica. |
type |
string:
Feature |
Especifica o |
BoundaryResultTypeEnum
O conceito geopolítico para o que devolver um limite. Se não for especificado, a predefinição é countryRegion
o tipo de resultado.
Name | Tipo | Description |
---|---|---|
adminDistrict |
string |
Primeiro nível administrativo ao nível do país/região, como um estado ou uma província. |
adminDistrict2 |
string |
Segundo nível administrativo ao nível do país/região, como um concelho. |
countryRegion |
string |
País ou região. |
locality |
string |
Uma área concentrada de povoação humana, como uma cidade, cidade ou aldeia. |
neighborhood |
string |
Uma secção de um local povoado que é normalmente bem conhecida, mas muitas vezes com limites indistintos. |
postalCode |
string |
A categoria de código postal mais pequena, como um código postal. |
postalCode2 |
string |
A categoria de código postal maior seguinte após o código postal que é criado através da agregação de áreas de código postal. |
postalCode3 |
string |
A próxima maior categoria de código postal após postalCode2 que é criada através da agregação de áreas postalCode2. |
postalCode4 |
string |
A categoria de código postal maior seguinte após postalCode3 que é criada através da agregação de áreas postalCode3. |
ErrorAdditionalInfo
Informações adicionais sobre o erro de gestão de recursos.
Name | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informações adicionais. |
ErrorDetail
O detalhe do erro.
Name | 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 a erros
Name | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
GeoJsonGeometry
Um objeto de geometria válido GeoJSON
. O tipo tem de ser um dos sete tipos de geometria GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
Name | Tipo | Description |
---|---|---|
bbox |
number[] |
Caixa delimitadora. Projeção utilizada – EPSG:3857. Consulte RFC 7946 para obter detalhes. |
type |
Geo |
Especifica o |
GeoJsonGeometryCollection
Um tipo de objeto válido GeoJSON GeometryCollection
. Consulte RFC 7946 para obter detalhes.
Name | Tipo | Description |
---|---|---|
bbox |
number[] |
Caixa delimitadora. Projeção utilizada – EPSG:3857. Consulte RFC 7946 para obter detalhes. |
geometries | GeoJsonGeometry[]: |
Contém uma lista de objetos de geometria válidos |
type |
string:
Geometry |
Especifica o |
GeoJsonLineString
Um tipo de geometria válido GeoJSON LineString
. Consulte RFC 7946 para obter detalhes.
Name | Tipo | Description |
---|---|---|
bbox |
number[] |
Caixa delimitadora. Projeção utilizada – EPSG:3857. Consulte RFC 7946 para obter detalhes. |
coordinates |
number[] |
Coordenadas para a |
type |
string:
Line |
Especifica o |
GeoJsonMultiLineString
Um tipo de geometria válido GeoJSON MultiLineString
. Consulte RFC 7946 para obter detalhes.
Name | Tipo | Description |
---|---|---|
bbox |
number[] |
Caixa delimitadora. Projeção utilizada – EPSG:3857. Consulte RFC 7946 para obter detalhes. |
coordinates |
number[] |
Coordenadas para a |
type |
string:
Multi |
Especifica o |
GeoJsonMultiPoint
Um tipo de geometria válido GeoJSON MultiPoint
. Consulte RFC 7946 para obter detalhes.
Name | Tipo | Description |
---|---|---|
bbox |
number[] |
Caixa delimitadora. Projeção utilizada – EPSG:3857. Consulte RFC 7946 para obter detalhes. |
coordinates |
number[] |
Coordenadas para a |
type |
string:
Multi |
Especifica o |
GeoJsonMultiPolygon
Um tipo de objeto válido GeoJSON MultiPolygon
. Consulte RFC 7946 para obter detalhes.
Name | Tipo | Description |
---|---|---|
bbox |
number[] |
Caixa delimitadora. Projeção utilizada – EPSG:3857. Consulte RFC 7946 para obter detalhes. |
coordinates |
number[] |
Contém uma lista de objetos válidos |
type |
string:
Multi |
Especifica o |
GeoJsonPoint
Um tipo de geometria válido GeoJSON Point
. Consulte RFC 7946 para obter detalhes.
Name | Tipo | Description |
---|---|---|
bbox |
number[] |
Caixa delimitadora. Projeção utilizada – EPSG:3857. Consulte RFC 7946 para obter detalhes. |
coordinates |
number[] |
A |
type |
string:
Point |
Especifica o |
GeoJsonPolygon
Um tipo de geometria válido GeoJSON Polygon
. Consulte RFC 7946 para obter detalhes.
Name | Tipo | Description |
---|---|---|
bbox |
number[] |
Caixa delimitadora. Projeção utilizada – EPSG:3857. Consulte RFC 7946 para obter detalhes. |
coordinates |
number[] |
Coordenadas para o |
type |
string:
Polygon |
Especifica o |
GeometryCopyright
Informações sobre direitos de autor de uma geometria de um objeto Boundary.
Name | Tipo | Description |
---|---|---|
copyright |
string |
A cadeia de direitos de autor do fornecedor de dados |
sourceName |
string |
O nome do fornecedor de dados |
ResolutionEnum
A resolução determina a quantidade de pontos a enviar de volta. Se não for especificado, a predefinição é a resolução média.
Name | Tipo | Description |
---|---|---|
huge |
string |
Devolver a geometria de limites com mais ou a mesma quantidade de pontos que grandes. |
large |
string |
Devolva a geometria de limites com mais ou a mesma quantidade de pontos que o médio. |
medium |
string |
Devolva a geometria de limites com mais ou a mesma quantidade de pontos que pequeno. |
small |
string |
Devolver a geometria de limites com a menor quantidade de pontos. |