Partilhar 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 Border.
ErrorAdditionalInfoOutput

O erro de gerenciamento de recursos informações adicionais.
ErrorDetailOutput

O detalhe do erro.
ErrorResponseOutput

Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar 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 GeoJSON LineString válido. Consulte RFC 7946 para obter detalhes.
GeoJsonMultiLineStringDataOutput
GeoJsonMultiLineStringOutput

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

Dados contidos por um GeoJson MultiPoint.
GeoJsonMultiPointOutput

Um tipo de geometria 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 GeoJSON válido. Consulte RFC 7946 para obter detalhes.
GeoJsonPointDataOutput

Dados contidos por um GeoJson Point.
GeoJsonPointOutput

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

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

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

Objeto Batch Query
GeocodingBatchResponseItemOutput
GeocodingBatchResponseOutput

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

Resumo do pedido de lote
GeocodingResponseOutput

Este objeto é retornado de uma chamada de Geocoding bem-sucedida
GeometryCopyrightOutput

Informações de direitos autorais de uma geometria de um objeto Border.
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 processar. A lista pode conter um máximo de 100 consultas e deve conter pelo menos 1 consulta.
ReverseGeocodingBatchRequestItem

Objeto Batch Query
Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response

A API Get Geocoding é uma solicitação de GET HTTP 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 é realizada batendo no ponto de extremidade de geocodificação apenas com o endereço ou endereço parcial em questão. O índice de pesquisa de geocodificação será consultado para tudo acima dos dados do nível da rua. Nenhum Ponto de Interesse (POIs) será devolvido. Note que o geocodificador é muito tolerante a erros de digitação e endereços incompletos. Ele também lidará com tudo, desde endereços exatos de ruas 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 rua, código postal, município e informações de país/região.
SearchGetGeocodingBatch200Response

A API Get Geocoding Batch é uma solicitação de POST HTTP que envia lotes de até 100 consultas para a Geocoding API em uma única solicitação.

Enviar solicitação de lote síncrona

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

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

Corpo POST para solicitação de lote

Para enviar as consultas de geocodificação você usará uma solicitação de onde o corpo da solicitação conterá a matriz em formato e o cabeçalho será definido como . Aqui está um corpo de solicitação de exemplo contendo 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 URIgeocodificação suportados.

O lote deve conter pelo menos 1 consulta.

Modelo de resposta em lote

A resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequests ou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz 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 de lote. Cada item é de um dos seguintes tipos:

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

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

A API Get Geocoding Batch é uma solicitação de POST HTTP que envia lotes de até 100 consultas para a Geocoding API em uma única solicitação.

Enviar solicitação de lote síncrona

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

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

Corpo POST para solicitação de lote

Para enviar as consultas de geocodificação você usará uma solicitação de onde o corpo da solicitação conterá a matriz em formato e o cabeçalho será definido como . Aqui está um corpo de solicitação de exemplo contendo 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 URIgeocodificação suportados.

O lote deve conter pelo menos 1 consulta.

Modelo de resposta em lote

A resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequests ou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz 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 de lote. Cada item é de um dos seguintes tipos:

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

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

A API Get Geocoding é uma solicitação de GET HTTP 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 é realizada batendo no ponto de extremidade de geocodificação apenas com o endereço ou endereço parcial em questão. O índice de pesquisa de geocodificação será consultado para tudo acima dos dados do nível da rua. Nenhum Ponto de Interesse (POIs) será devolvido. Note que o geocodificador é muito tolerante a erros de digitação e endereços incompletos. Ele também lidará com tudo, desde endereços exatos de ruas 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 rua, código postal, município e informações de país/região.
SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response

A API Get Polygon é uma solicitação de GET HTTP 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.
SearchGetPolygonDefaultResponse

A API Get Polygon é uma solicitação de GET HTTP 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.
SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response

A API Get Reverse Geocoding é uma solicitação de GET HTTP usada para traduzir uma coordenada (exemplo: 37.786505, -122.3862) em um endereço de rua compreensível por humanos. Útil em aplicações de rastreamento onde 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 de POST HTTP que envia lotes de até 100 consultas para Geocodificação Reversa API usando uma única solicitação.

Enviar solicitação de lote síncrona

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

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

Corpo POST para solicitação de lote

Para enviar as consultas de de geocodificação reversa , você usará uma solicitação de onde o corpo da solicitação conterá a matriz em formato e o cabeçalho será definido como . Aqui está um corpo de solicitação de exemplo contendo 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 URIgeocodificação reversa suportados.

O lote deve conter pelo menos 1 consulta.

Modelo de resposta em lote

A resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequests ou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz 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 de lote. Cada item é de um dos seguintes tipos:

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

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

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

Enviar solicitação de lote síncrona

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

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

Corpo POST para solicitação de lote

Para enviar as consultas de de geocodificação reversa , você usará uma solicitação de onde o corpo da solicitação conterá a matriz em formato e o cabeçalho será definido como . Aqui está um corpo de solicitação de exemplo contendo 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 URIgeocodificação reversa suportados.

O lote deve conter pelo menos 1 consulta.

Modelo de resposta em lote

A resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequests ou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz 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 de lote. Cada item é de um dos seguintes tipos:

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

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

A API Get Reverse Geocoding é uma solicitação de GET HTTP usada para traduzir uma coordenada (exemplo: 37.786505, -122.3862) em um endereço de rua compreensível por humanos. Útil em aplicações de rastreamento onde 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 GeoJSON válido. Consulte RFC 7946 para obter detalhes.
MapsSearchClient
SearchGetGeocodingBatchParameters
SearchGetGeocodingParameters
SearchGetPolygonParameters
SearchGetReverseGeocodingBatchParameters
SearchGetReverseGeocodingParameters

Funções

default(AzureKeyCredential, ClientOptions)

Cria uma instância de 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 a partir 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 a partir 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 de Função

default(AzureKeyCredential, ClientOptions)

Cria uma instância de 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 AzureKeyCredential usada para autenticar solicitações para o serviço

options
ClientOptions

Opções usadas para configurar o Cliente de Pesquisa

Devoluções

MapsSearchClient

default(TokenCredential, string, ClientOptions)

Cria uma instância do MapsSearch a partir 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 Maps de um recurso de mapa específico

options
ClientOptions

Opções usadas para configurar o Cliente de Pesquisa

Devoluções

MapsSearchClient

default(AzureSASCredential, ClientOptions)

Cria uma instância do MapsSearch a partir 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 AzureSASCredential usada para autenticar solicitações para o serviço

options
ClientOptions

Opções usadas para configurar o Cliente de Pesquisa

Devoluções

MapsSearchClient

isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response

Parâmetros

response

SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse

Devoluções

response

isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response

Parâmetros

response

SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse

Devoluções

response

isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse) 

function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response

Parâmetros

response

SearchGetPolygon200Response | SearchGetPolygonDefaultResponse

Devoluções

response

isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response

Parâmetros

response

SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse

Devoluções

response

isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response

Parâmetros

response

SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse

Devoluções

response