Search - Get Search Polygon
Use para obter dados de polígono 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 retorna dados de geometria, como uma estrutura de tópicos de cidade ou país/região para um conjunto de entidades, recuperados anteriormente de uma solicitação de pesquisa online no formato GeoJSON. A ID de geometria é retornada no sourceGeometry objeto em "geometria" e "id" em um endereço de Pesquisa ou Pesquisa chamada difusa.
Uma ID de geometria recuperada de um ponto de extremidade de pesquisa online tem um tempo de vida limitado, não é recomendável armazenar IDs de geometria no armazenamento persistente para referência posterior. Espera-se que uma solicitação para o método Polygon seja feita em poucos minutos após a solicitação para o método de pesquisa online que forneceu a ID. O serviço permite solicitações em lote de até 20 identificadores.
GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries={geometries}Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
format
|
path | True |
Formato desejado da resposta. Há suporte apenas para o formato |
|
|
api-version
|
query | True |
string |
Número de versão da API de Mapas Azure. |
|
geometries
|
query | True |
string[] |
Lista separada por vírgulas de UUIDs de geometria, recuperada anteriormente de uma solicitação de pesquisa online. |
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 Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Erro inesperado. |
Segurança
AADToken
Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. 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 Azure Mapas APIs REST.
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 acessar o controle em APIs e escopos específicos.
Observação
- Essa definição de segurança requer o uso do
x-ms-client-idcabeçalho para indicar a qual Azure Mapas recurso ao qual o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas . - O
Authorization URLé específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de Microsoft Entra ID. - O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
- O uso do SDK da Web 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 plataforma de identidade da Microsoft, consulte visão geral 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 quando você cria uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.
Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave master na conta em que elas são emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST para que sua chave possa ser armazenada com segurança.
Tipo:
apiKey
Em:
query
SAS Token
Esse é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado à expiração, taxa e regiõ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 maneira mais segura do que a chave compartilhada.
Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta do Mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.
Tipo:
apiKey
Em:
header
Exemplos
Get the Geometry using the geometry id returned by the previous Search
Solicitação de exemplo
GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries=8bceafe8-3d98-4445-b29b-fd81d3e9adf5,00005858-5800-1200-0000-0000773694ca
Resposta de exemplo
{
"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
| Nome | Description |
|---|---|
|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta de erro |
|
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 desejado da resposta. Há suporte apenas para o formato |
| Polygon | |
|
Polygon |
Esse objeto é retornado de uma chamada de polígono Pesquisa bem-sucedida |
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. |
GeoJsonFeature
Um tipo de objeto válido GeoJSON Feature . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| featureType |
string |
O tipo do recurso. O valor depende do modelo de dados do qual o recurso atual faz parte. Alguns modelos de dados podem ter um valor vazio. |
| geometry | GeoJsonGeometry: |
Um objeto de geometria válido |
| id |
string |
Identificador do recurso. |
| type |
string:
Feature |
Especifica o tipo de |
GeoJsonFeatureCollection
Um tipo de objeto válido GeoJSON FeatureCollection . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| features |
Contém uma lista de objetos válidos |
|
| type |
string:
Feature |
Especifica o tipo de |
GeoJsonGeometry
Um objeto de geometria válido GeoJSON . 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.
| Nome | Tipo | Description |
|---|---|---|
| type |
Geo |
Especifica o tipo de |
GeoJsonGeometryCollection
Um tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| geometries | GeoJsonGeometry[]: |
Contém uma lista de objetos de geometria válidos |
| type |
string:
Geometry |
Especifica o tipo de |
GeoJsonLineString
Um tipo de geometria válido GeoJSON LineString . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| coordinates |
number[] |
Coordenadas para a |
| type |
string:
Line |
Especifica o tipo de |
GeoJsonMultiLineString
Um tipo de geometria válido GeoJSON MultiLineString . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| coordinates |
number[] |
Coordenadas para a |
| type |
string:
Multi |
Especifica o tipo de |
GeoJsonMultiPoint
Um tipo de geometria válido GeoJSON MultiPoint . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| coordinates |
number[] |
Coordenadas para a |
| type |
string:
Multi |
Especifica o tipo de |
GeoJsonMultiPolygon
Um tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| coordinates |
number[] |
Contém uma lista de objetos válidos |
| type |
string:
Multi |
Especifica o tipo de |
GeoJsonPoint
Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| coordinates |
number[] |
Um |
| type |
string:
Point |
Especifica o tipo de |
GeoJsonPolygon
Um tipo de geometria válido GeoJSON Polygon . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| coordinates |
number[] |
Coordenadas para o |
| type | string: |
Especifica o tipo de |
JsonFormat
Formato desejado da resposta. Há suporte apenas para o formato json.
| Nome | Tipo | Description |
|---|---|---|
| json |
string |
O formato de intercâmbio de dados de notação de objeto JavaScript |
Polygon
| Nome | Tipo | Description |
|---|---|---|
| geometryData | GeoJsonObject: |
Dados de geometria no formato GeoJSON. Consulte RFC 7946 para obter detalhes. Apresente somente se "error" não estiver presente. |
| providerID |
string |
ID da entidade retornada |
PolygonResult
Esse objeto é retornado de uma chamada de polígono Pesquisa bem-sucedida
| Nome | Tipo | Description |
|---|---|---|
| additionalData |
Polygon[] |
Matriz de resultados |