Compartilhar via

@azure-rest/maps-search package

  • Referência

Interfaces

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput

O endereço do resultado
BoundaryOutput

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.
BoundaryPropertiesOutput

Propriedades de um objeto Boundary.
ErrorAdditionalInfoOutput

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetailOutput

O detalhe do erro.
ErrorResponseOutput

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
FeaturesItemOutput
FeaturesItemPropertiesOutput
GeoJsonFeatureCollectionDataOutput
GeoJsonFeatureCollectionOutput

Um tipo de objeto GeoJSON FeatureCollection válido. Consulte RFC 7946 para obter detalhes.
GeoJsonFeatureDataOutput
GeoJsonFeatureOutputParent

Um tipo de objeto GeoJSON Feature válido. Consulte RFC 7946 para obter detalhes.
GeoJsonGeometryCollectionDataOutput
GeoJsonGeometryCollectionOutput

Um tipo de objeto GeoJSON GeometryCollection válido. Consulte RFC 7946 para obter detalhes.
GeoJsonGeometryOutputParent

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.
GeoJsonLineStringDataOutput
GeoJsonLineStringOutput

Um tipo de geometria de GeoJSON LineString válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiLineStringDataOutput
GeoJsonMultiLineStringOutput

Um tipo de geometria de GeoJSON MultiLineString válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPointDataOutput

Dados contidos em um GeoJson MultiPoint.
GeoJsonMultiPointOutput

Um tipo de geometria de GeoJSON MultiPoint válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPolygonDataOutput
GeoJsonMultiPolygonOutput

Um tipo de objeto GeoJSON MultiPolygon válido. Consulte RFC 7946 para obter detalhes.
GeoJsonObjectOutputParent

Um objeto de GeoJSON válido. Consulte RFC 7946 para obter detalhes.
GeoJsonPointDataOutput

Dados contidos em um GeoJson Point.
GeoJsonPointOutput

Um tipo de geometria de GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
GeoJsonPolygonDataOutput
GeoJsonPolygonOutput

Um tipo de geometria de GeoJSON Polygon válido. Consulte RFC 7946 para obter detalhes.
GeocodePointsItemOutput
GeocodingBatchRequestBody

A lista de consultas/solicitações de geocodificação de endereço a serem processadas. A lista pode conter no máximo 100 consultas e deve conter pelo menos 1 consulta.
GeocodingBatchRequestItem

Objeto De Consulta em Lote
GeocodingBatchResponseItemOutput
GeocodingBatchResponseOutput

Esse objeto é retornado de uma chamada de serviço do Lote de Geocodificação bem-sucedida.
GeocodingBatchResponseSummaryOutput

Resumo da solicitação em lote
GeocodingResponseOutput

Esse objeto é retornado de uma chamada de geocodificação bem-sucedida
GeometryCopyrightOutput

Informações de direitos autorais de uma geometria de um objeto Boundary.
GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput

O endereço do resultado.
MapsSearchClientOptions

Os parâmetros opcionais para o cliente
ReverseGeocodingBatchRequestBody

A lista de consultas/solicitações de geocodificação reversa a serem processadas. A lista pode conter no máximo 100 consultas e deve conter pelo menos 1 consulta.
ReverseGeocodingBatchRequestItem

Objeto De Consulta em Lote
Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response

A API Get Geocoding é uma solicitação HTTP GET que retorna as coordenadas de longitude e latitude do local que está sendo pesquisado.

Em muitos casos, o serviço de pesquisa completo pode ser demais, por exemplo, se você estiver interessado apenas na geocodificação tradicional. A pesquisa também pode ser acessada para pesquisa de endereço exclusivamente. A geocodificação é executada atingindo o ponto de extremidade de geocodificação apenas com o endereço ou o endereço parcial em questão. O índice de pesquisa de geocodificação será consultado sobre tudo acima dos dados de nível de rua. Nenhuma POIs (Ponto de Interesse) será retornada. Observe que o geocodificador é muito tolerante a erros de digitação e endereços incompletos. Ele também lidará com tudo, desde endereços de rua exatos ou ruas ou cruzamentos, bem como geografias de nível superior, como centros urbanos, condados e estados. A resposta também retorna propriedades de endereço detalhadas, como informações de rua, cep, município e país/região.
SearchGetGeocodingBatch200Response

A API é uma solicitação http que envia lotes de até 100 consultas para a API de de Geocodificação em uma única solicitação.

Enviar solicitação de lote síncrona

A API síncrona é recomendada para solicitações em lotes leves. Quando o serviço receber uma solicitação, ele responderá assim que os itens do lote forem calculados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente. A API síncrona retornará um erro de tempo limite (uma resposta 408) se a solicitação levar mais de 60 segundos. O número de itens em lote é limitado a 100 para essa API.

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

Corpo POST para solicitação em lote

Para enviar a consultas de de geocodificação, você usará uma solicitação POST em que o corpo da solicitação conterá a matriz batchItems no formato json e o cabeçalho Content-Type será definido como application/json. Aqui está um corpo de solicitação de exemplo que contém 2 consultas de de geocodificação :

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Uma geocodificação objeto batchItem pode aceitar qualquer um dos parâmetros de URI dede geocodificação compatíveis.

O lote deve conter pelo menos 1 consulta.

Modelo de resposta em lote

A resposta em lote contém um componente summary que indica o totalRequests que faziam parte da solicitação em lote original e successfulRequests consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de batchItems que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação em lote. Cada item é de um dos seguintes tipos:

  • GeocodingResponse - Se a consulta foi concluída com êxito.

  • Error - Se a consulta falhou. A resposta conterá um code e um message nesse caso.
SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse

A API é uma solicitação http que envia lotes de até 100 consultas para a API de de Geocodificação em uma única solicitação.

Enviar solicitação de lote síncrona

A API síncrona é recomendada para solicitações em lotes leves. Quando o serviço receber uma solicitação, ele responderá assim que os itens do lote forem calculados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente. A API síncrona retornará um erro de tempo limite (uma resposta 408) se a solicitação levar mais de 60 segundos. O número de itens em lote é limitado a 100 para essa API.

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

Corpo POST para solicitação em lote

Para enviar a consultas de de geocodificação, você usará uma solicitação POST em que o corpo da solicitação conterá a matriz batchItems no formato json e o cabeçalho Content-Type será definido como application/json. Aqui está um corpo de solicitação de exemplo que contém 2 consultas de de geocodificação :

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Uma geocodificação objeto batchItem pode aceitar qualquer um dos parâmetros de URI dede geocodificação compatíveis.

O lote deve conter pelo menos 1 consulta.

Modelo de resposta em lote

A resposta em lote contém um componente summary que indica o totalRequests que faziam parte da solicitação em lote original e successfulRequests consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de batchItems que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação em lote. Cada item é de um dos seguintes tipos:

  • GeocodingResponse - Se a consulta foi concluída com êxito.

  • Error - Se a consulta falhou. A resposta conterá um code e um message nesse caso.
SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse

A API Get Geocoding é uma solicitação HTTP GET que retorna as coordenadas de longitude e latitude do local que está sendo pesquisado.

Em muitos casos, o serviço de pesquisa completo pode ser demais, por exemplo, se você estiver interessado apenas na geocodificação tradicional. A pesquisa também pode ser acessada para pesquisa de endereço exclusivamente. A geocodificação é executada atingindo o ponto de extremidade de geocodificação apenas com o endereço ou o endereço parcial em questão. O índice de pesquisa de geocodificação será consultado sobre tudo acima dos dados de nível de rua. Nenhuma POIs (Ponto de Interesse) será retornada. Observe que o geocodificador é muito tolerante a erros de digitação e endereços incompletos. Ele também lidará com tudo, desde endereços de rua exatos ou ruas ou cruzamentos, bem como geografias de nível superior, como centros urbanos, condados e estados. A resposta também retorna propriedades de endereço detalhadas, como informações de rua, cep, município e país/região.
SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response

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.
SearchGetPolygonDefaultResponse

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.
SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response

A API Get Reverse Geocoding é uma solicitação HTTP GET usada para converter uma coordenada (exemplo: 37.786505, -122.3862) em um endereço de rua compreensível por humanos. Útil no acompanhamento de aplicativos em que você recebe um feed gps do dispositivo ou ativo e deseja saber o endereço associado às coordenadas. Esse ponto de extremidade retornará informações de endereço para uma determinada coordenada.
SearchGetReverseGeocodingBatch200Response

A API Get Reverse Geocoding Batch é uma solicitação http POST que envia lotes de até 100 consultas para API de geocodificação reversa usando uma única solicitação.

Enviar solicitação de lote síncrona

A API síncrona é recomendada para solicitações em lotes leves. Quando o serviço receber uma solicitação, ele responderá assim que os itens do lote forem calculados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente. A API síncrona retornará um erro de tempo limite (uma resposta 408) se a solicitação levar mais de 60 segundos. O número de itens em lote é limitado a 100 para essa API.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

Corpo POST para solicitação em lote

Para enviar o consultas de de geocodificação reversa, você usará uma solicitação POST em que o corpo da solicitação conterá a matriz de batchItems no formato json e o cabeçalho Content-Type será definido como application/json. Aqui está um corpo de solicitação de exemplo que contém 2 consultas de de geocodificação reversa:

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Uma geocodificação reversa objeto batchItem pode aceitar qualquer um dos parâmetros de URI de de geocodificação reversacompatíveis.

O lote deve conter pelo menos 1 consulta.

Modelo de resposta em lote

A resposta em lote contém um componente summary que indica o totalRequests que faziam parte da solicitação em lote original e successfulRequests consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de batchItems que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação em lote. Cada item é de um dos seguintes tipos:

  • GeocodingResponse - Se a consulta foi concluída com êxito.

  • Error - Se a consulta falhou. A resposta conterá um code e um message nesse caso.
SearchGetReverseGeocodingBatchBodyParam
SearchGetReverseGeocodingBatchDefaultResponse

A API Get Reverse Geocoding Batch é uma solicitação http POST que envia lotes de até 100 consultas para API de geocodificação reversa usando uma única solicitação.

Enviar solicitação de lote síncrona

A API síncrona é recomendada para solicitações em lotes leves. Quando o serviço receber uma solicitação, ele responderá assim que os itens do lote forem calculados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente. A API síncrona retornará um erro de tempo limite (uma resposta 408) se a solicitação levar mais de 60 segundos. O número de itens em lote é limitado a 100 para essa API.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

Corpo POST para solicitação em lote

Para enviar o consultas de de geocodificação reversa, você usará uma solicitação POST em que o corpo da solicitação conterá a matriz de batchItems no formato json e o cabeçalho Content-Type será definido como application/json. Aqui está um corpo de solicitação de exemplo que contém 2 consultas de de geocodificação reversa:

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Uma geocodificação reversa objeto batchItem pode aceitar qualquer um dos parâmetros de URI de de geocodificação reversacompatíveis.

O lote deve conter pelo menos 1 consulta.

Modelo de resposta em lote

A resposta em lote contém um componente summary que indica o totalRequests que faziam parte da solicitação em lote original e successfulRequests consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de batchItems que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação em lote. Cada item é de um dos seguintes tipos:

  • GeocodingResponse - Se a consulta foi concluída com êxito.

  • Error - Se a consulta falhou. A resposta conterá um code e um message nesse caso.
SearchGetReverseGeocodingBatchMediaTypesParam
SearchGetReverseGeocodingDefaultResponse

A API Get Reverse Geocoding é uma solicitação HTTP GET usada para converter uma coordenada (exemplo: 37.786505, -122.3862) em um endereço de rua compreensível por humanos. Útil no acompanhamento de aplicativos em que você recebe um feed gps do dispositivo ou ativo e deseja saber o endereço associado às coordenadas. Esse ponto de extremidade retornará informações de endereço para uma determinada coordenada.
SearchGetReverseGeocodingQueryParam
SearchGetReverseGeocodingQueryParamProperties

Aliases de tipo

GeoJsonFeatureOutput

Um tipo de objeto GeoJSON Feature válido. Consulte RFC 7946 para obter detalhes.
GeoJsonGeometryOutput

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.
GeoJsonObjectOutput

Um objeto de GeoJSON válido. Consulte RFC 7946 para obter detalhes.
MapsSearchClient
SearchGetGeocodingBatchParameters
SearchGetGeocodingParameters
SearchGetPolygonParameters
SearchGetReverseGeocodingBatchParameters
SearchGetReverseGeocodingParameters

Funções

default(AzureKeyCredential, ClientOptions)

Cria uma instância do MapsSearchClient a partir de uma chave de assinatura.

Exemplo

import MapsSearch from "@azure-rest/maps-search";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsSearch(credential);
default(TokenCredential, string, ClientOptions)

Cria uma instância do MapsSearch de um TokenCredentialde Identidade do Azure.

Exemplo

import MapsSearch from "@azure-rest/maps-search";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsSearch(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)

Cria uma instância do MapsSearch de um AzureSASCredentialde Identidade do Azure.

Exemplo

import MapsSearch from "@azure-rest/maps-search";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsSearch(credential);
isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)
isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)
isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)
isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)
isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)

Detalhes da função

default(AzureKeyCredential, ClientOptions)

Cria uma instância do MapsSearchClient a partir de uma chave de assinatura.

Exemplo

import MapsSearch from "@azure-rest/maps-search";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsSearch(credential);

function default(credential: AzureKeyCredential, options?: ClientOptions): MapsSearchClient

Parâmetros

credential
AzureKeyCredential

Uma instância do AzureKeyCredential usada para autenticar solicitações para o serviço

options
ClientOptions

Opções usadas para configurar o Cliente de Pesquisa

Retornos

MapsSearchClient

default(TokenCredential, string, ClientOptions)

Cria uma instância do MapsSearch de um TokenCredentialde Identidade do Azure.

Exemplo

import MapsSearch from "@azure-rest/maps-search";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsSearch(credential, "<maps-account-client-id>");

function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsSearchClient

Parâmetros

credential
TokenCredential

Uma instância tokenCredential usada para autenticar solicitações para o serviço

mapsAccountClientId

string

A ID do cliente do Azure Mapas de um recurso de mapa específico

options
ClientOptions

Opções usadas para configurar o Cliente de Pesquisa

Retornos

MapsSearchClient

default(AzureSASCredential, ClientOptions)

Cria uma instância do MapsSearch de um AzureSASCredentialde Identidade do Azure.

Exemplo

import MapsSearch from "@azure-rest/maps-search";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsSearch(credential);

function default(credential: AzureSASCredential, options?: ClientOptions): MapsSearchClient

Parâmetros

credential
AzureSASCredential

Uma instância do AzureSASCredential usada para autenticar solicitações no serviço

options
ClientOptions

Opções usadas para configurar o Cliente de Pesquisa

Retornos

MapsSearchClient

isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response

Parâmetros

response

SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse

Retornos

response

isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response

Parâmetros

response

SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse

Retornos

response

isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse) 

function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response

Parâmetros

response

SearchGetPolygon200Response | SearchGetPolygonDefaultResponse

Retornos

response

isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response

Parâmetros

response

SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse

Retornos

response

isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response

Parâmetros

response

SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse

Retornos

response