Search - Get Search 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 devolve dados de geometria, como um destaque de cidade ou país/região para um conjunto de entidades, obtidos anteriormente a partir de um pedido de pesquisa online no formato GeoJSON. O ID de geometria é devolvido no sourceGeometry objeto em "geometria" e "id" num Endereço Pesquisa ou Pesquisa chamada difusa.
Um ID de geometria obtido a partir de um ponto final de pesquisa online tem uma duração limitada, não é recomendado armazenar IDs de geometria no armazenamento persistente para referência posterior. Espera-se que seja feito um pedido ao método Polygon dentro de alguns minutos após o pedido ao método de pesquisa online que forneceu o ID. O serviço permite pedidos em lote até 20 identificadores.
GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries={geometries}Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
format
|
path | True |
Formato pretendido da resposta. Apenas |
|
|
api-version
|
query | True |
string |
Número da versão da API Azure Maps. |
|
geometries
|
query | True |
string[] |
Lista separada por vírgulas de UUIDs de geometria, obtida anteriormente a partir de um pedido de pesquisa online. |
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 Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps veja os seguintes artigos para obter orientações. |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Ocorreu um erro inesperado. |
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 Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. 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 Azure Maps APIs REST.
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-idcabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas . - 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 de 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 de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
- A utilização do SDK Web 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 plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.
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 quando Cria uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.
Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.
Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.
Tipo:
apiKey
Em:
query
SAS Token
Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou 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 the Geometry using the geometry id returned by the previous Search
Pedido de amostra
GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries=8bceafe8-3d98-4445-b29b-fd81d3e9adf5,00005858-5800-1200-0000-0000773694ca
Resposta da amostra
{
"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"
}
]
}
}
]
}Definições
| Name | Description |
|---|---|
|
Error |
Informações adicionais sobre o erro de gestão de recursos. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta a erros |
|
Geo |
Um tipo de objeto válido |
|
Geo |
Um tipo de objeto válido |
|
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 |
|
Json |
Formato pretendido da resposta. Apenas |
| Polygon | |
|
Polygon |
Este objeto é devolvido a partir de uma chamada poligon Pesquisa bem-sucedida |
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ção adicional. |
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. |
GeoJsonFeature
Um tipo de objeto válido GeoJSON Feature . Consulte RFC 7946 para obter detalhes.
| Name | Tipo | Description |
|---|---|---|
| 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. |
| geometry | GeoJsonGeometry: |
Um objeto de geometria válido |
| id |
string |
Identificador da funcionalidade. |
| type |
string:
Feature |
Especifica o |
GeoJsonFeatureCollection
Um tipo de objeto válido GeoJSON FeatureCollection . Consulte RFC 7946 para obter detalhes.
| Name | Tipo | Description |
|---|---|---|
| features |
Contém uma lista de objetos válidos |
|
| type |
string:
Feature |
Especifica o |
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 |
|---|---|---|
| type |
Geo |
Especifica o |
GeoJsonGeometryCollection
Um tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obter detalhes.
| Name | Tipo | Description |
|---|---|---|
| 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 |
|---|---|---|
| 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 |
|---|---|---|
| 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 |
|---|---|---|
| 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 |
|---|---|---|
| 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 |
|---|---|---|
| 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 |
|---|---|---|
| coordinates |
number[] |
Coordenadas para o |
| type | string: |
Especifica o |
JsonFormat
Formato pretendido da resposta. Apenas json o formato é suportado.
| Name | Tipo | Description |
|---|---|---|
| json |
string |
O Formato de Intercâmbio de Dados de Notação de Objetos JavaScript |
Polygon
| Name | Tipo | Description |
|---|---|---|
| geometryData | GeoJsonObject: |
Dados de geometria no formato GeoJSON. Consulte RFC 7946 para obter detalhes. Presente apenas se "erro" não estiver presente. |
| providerID |
string |
ID da entidade devolvida |
PolygonResult
Este objeto é devolvido a partir de uma chamada poligon Pesquisa bem-sucedida
| Name | Tipo | Description |
|---|---|---|
| additionalData |
Polygon[] |
Matriz de resultados |