Share via


MapsSearchClient Class

Definition

The Search service client.

public class MapsSearchClient
type MapsSearchClient = class
Public Class MapsSearchClient
Inheritance
MapsSearchClient

Constructors

MapsSearchClient()

Initializes a new instance of MapsSearchClient.

MapsSearchClient(AzureKeyCredential)

Initializes a new instance of MapsSearchClient.

MapsSearchClient(AzureKeyCredential, MapsSearchClientOptions)

Initializes a new instance of MapsSearchClient.

MapsSearchClient(AzureSasCredential)

Initializes a new instance of MapsSearchClient.

MapsSearchClient(AzureSasCredential, MapsSearchClientOptions)

Initializes a new instance of MapsSearchClient.

MapsSearchClient(TokenCredential, String)

Initializes a new instance of MapsSearchClient.

MapsSearchClient(TokenCredential, String, MapsSearchClientOptions)

Initializes a new instance of MapsSearchClient.

Methods

GetGeocoding(String, GeocodingQuery, CancellationToken)

In many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocoding endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No Point of Interest (POIs) will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.

GetGeocodingAsync(String, GeocodingQuery, CancellationToken)

In many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocoding endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No Point of Interest (POIs) will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.

GetGeocodingBatch(IEnumerable<GeocodingQuery>, CancellationToken)
GetGeocodingBatchAsync(IEnumerable<GeocodingQuery>, CancellationToken)
GetPolygon(GetPolygonOptions, CancellationToken)

Supplies polygon data of a geographical area outline such as a city or a country region.

GetPolygonAsync(GetPolygonOptions, CancellationToken)

Supplies polygon data of a geographical area outline such as a city or a country region.

GetReverseGeocoding(GeoPosition, ReverseGeocodingQuery, CancellationToken)

Translate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return address information for a given coordinate.

GetReverseGeocodingAsync(GeoPosition, ReverseGeocodingQuery, CancellationToken)

Translate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return address information for a given coordinate.

GetReverseGeocodingBatch(IEnumerable<ReverseGeocodingQuery>, CancellationToken)

The Reverse Geocoding Batch API sends batches of queries to Reverse Geocoding API using just a single API call. The API allows caller to batch up to 100 queries.

A reverse geocoding batchItem object can accept any of the supported reverse geocoding URI parameters.

The batch should contain at least 1 query.

GetReverseGeocodingBatchAsync(IEnumerable<ReverseGeocodingQuery>, CancellationToken)

The Reverse Geocoding Batch API sends batches of queries to Reverse Geocoding API using just a single API call. The API allows caller to batch up to 100 queries.

A reverse geocoding batchItem object can accept any of the supported reverse geocoding URI parameters.

The batch should contain at least 1 query.

Applies to