MapsSearchClient.SearchAddressAsync Method

Definition

Namespace:

Azure.Maps.Search

Assembly:

Azure.Maps.Search.dll

Package:

Azure.Maps.Search v1.0.0-beta.5

Source:

MapsSearchClient.cs

Address geocoding. The geocoding is performed by hitting the geocode 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 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.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Maps.Search.Models.SearchAddressResult>> SearchAddressAsync (string query, Azure.Maps.Search.SearchAddressOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member SearchAddressAsync : string * Azure.Maps.Search.SearchAddressOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Maps.Search.Models.SearchAddressResult>>
override this.SearchAddressAsync : string * Azure.Maps.Search.SearchAddressOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Maps.Search.Models.SearchAddressResult>>

Public Overridable Function SearchAddressAsync (query As String, Optional options As SearchAddressOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SearchAddressResult))

Parameters

query

String

The POI name to search for (e.g., "statue of liberty", "starbucks", "pizza"). Must be properly URL encoded.

options

SearchAddressOptions

additional options

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<SearchAddressResult>>

Remarks

Address Geocoding