Find-BingPlace¶
SYNOPSIS¶
Searches for business entities or points of interest based on a query and geographic parameters.
SYNTAX¶
textquery (Default)¶
Find-BingPlace -Query <String> [-RegionBias <ccTLD>] [-Language <languages>] [-MaxResults <Int32>]
-BingMapsAPIKey <String> [<CommonParameters>]
Rectangle¶
Find-BingPlace [-Query <String>] -SouthLatitude <String> -WestLongitude <String> -NorthLatitude <String>
-EastLongitude <String> [-RegionBias <ccTLD>] [-Language <languages>] [-MaxResults <Int32>]
-BingMapsAPIKey <String> [<CommonParameters>]
Circle¶
Find-BingPlace [-Query <String>] [-CircleLatitude <String>] [-CircleLongitude <String>]
[-CircleRadius <String>] [-RegionBias <ccTLD>] [-Language <languages>] [-MaxResults <Int32>]
-BingMapsAPIKey <String> [<CommonParameters>]
Point¶
Find-BingPlace [-Query <String>] [-PointLatitude <String>] [-PointLongitude <String>] [-RegionBias <ccTLD>]
[-Language <languages>] [-MaxResults <Int32>] -BingMapsAPIKey <String> [<CommonParameters>]
DESCRIPTION¶
The Find-BingPlace function interfaces with the Bing Maps API to perform text-based searches for business entities or points of interest. By default, search results are biased based on the user's IP location, but this can be customized using various geographic parameters. This function is ideal for locating specific places or exploring areas of interest. Location bias and language can also be controlled via parameters.
EXAMPLES¶
EXAMPLE 1¶
Performs a search for "Krause's cafe" and biases the results based on the IP location of the user.
EXAMPLE 2¶
Searches for "Krause's cafe" and returns portions of the results in Spanish, biased by the user's IP location.
EXAMPLE 3¶
Find-BingPlace -Query 'cafe' -PointLatitude '29.7049806' -PointLongitude '-98.068343' -BingMapsAPIKey $bingAPIKey
Searches for cafes near the specified latitude and longitude coordinates.
EXAMPLE 4¶
Find-BingPlace -Query 'cafe' -CircleLatitude '29.7049806' -CircleLongitude '-98.068343' -CircleRadius '5000' -BingMapsAPIKey $bingAPIKey
Searches for cafes within a 5000-meter radius of the given lat/long point.
EXAMPLE 5¶
Find-BingPlace -Query 'cafe' -SouthLatitude '39.8592387' -WestLongitude '-75.295486' -NorthLatitude '40.0381942' -EastLongitude '-75.0064087' -BingMapsAPIKey $bingAPIKey
Searches for cafes within a specified rectangular area defined by two sets of lat/long coordinates. These are represented by the south/west and north/east points of a rectangle.
EXAMPLE 6¶
Find-BingPlace -Query 'cafe' -PointLatitude '29.7049806' -PointLongitude '-98.068343' -Language en -MaxResults 20 -BingMapsAPIKey $bingAPIKey
Finds up to 20 cafes near the specified point, with results in English.
EXAMPLE 7¶
$findBingPlaceSplat = @{
Query = 'cafe'
PointLatitude = '29.7049806'
PointLongitude = '-98.068343'
Language = 'en'
MaxResults = 20
BingMapsAPIKey = $bingAPIKey
}
Find-BingPlace @findBingPlaceSplat
Finds up to 20 cafes near the specified point, with results in English.
PARAMETERS¶
-Query¶
Specifies the search term string, such as an address, business name, or landmark name.
Type: String
Parameter Sets: textquery
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: Rectangle, Circle, Point
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PointLatitude¶
Specifies the latitude for location-based searches. Single coordinate for the north-south position of a point on the Earth's surface.
Type: String
Parameter Sets: Point
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PointLongitude¶
Specifies the longitude for location-based searches. Single coordinate for the east-west position of a point on the Earth's surface.
Type: String
Parameter Sets: Point
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CircleLatitude¶
Prefer results in a specified area by specifying a radius plus lat/long - north-south position of a point on the Earth's surface.
Type: String
Parameter Sets: Circle
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CircleLongitude¶
Prefer results in a specified area by specifying a radius plus lat/long - east-west position of a point on the Earth's surface.
Type: String
Parameter Sets: Circle
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CircleRadius¶
Prefer results in a specified area by specifying a radius plus lat/long - radius in meters
Type: String
Parameter Sets: Circle
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SouthLatitude¶
Prefer results in a specified area by specifying two lat/lng pairs representing the south/west and north/east points of a rectangle - south latitude
Type: String
Parameter Sets: Rectangle
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WestLongitude¶
Prefer results in a specified area by specifying two lat/lng pairs representing the south/west and north/east points of a rectangle - west longitude
Type: String
Parameter Sets: Rectangle
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NorthLatitude¶
Prefer results in a specified area by specifying two lat/lng pairs representing the south/west and north/east points of a rectangle - north latitude
Type: String
Parameter Sets: Rectangle
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EastLongitude¶
Prefer results in a specified area by specifying two lat/lng pairs representing the south/west and north/east points of a rectangle - east longitude
Type: String
Parameter Sets: Rectangle
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RegionBias¶
The region code, specified as a ccTLD ("top-level domain") two-character value.
Type: ccTLD
Parameter Sets: (All)
Aliases:
Accepted values: ac, ad, ae, af, ag, ai, al, am, ao, aq, ar, as, at, au, aw, ax, az, ba, bb, bd, be, bf, bg, bh, bi, bj, bm, bn, bo, br, bs, bt, bv, bw, by, bz, ca, cc, cd, cf, cg, ch, ci, ck, cl, cm, cn, co, cr, cu, cv, cw, cx, cy, cz, de, dj, dk, dm, do, dz, ec, ee, eg, er, es, et, eu, fi, fj, fk, fm, fo, fr, ga, gb, gd, ge, gf, gg, gh, gi, gl, gm, gn, gp, gq, gr, gs, gt, gu, gw, gy, hk, hm, hn, hr, ht, hu, id, ie, il, im, in, io, iq, ir, is, it, je, jm, jo, jp, ke, kg, kh, ki, km, kn, kp, kr, kw, ky, kz, la, lb, lc, li, lk, lr, ls, lt, lu, lv, ly, ma, mc, md, me, mg, mh, mk, ml, mm, mn, mo, mp, mq, mr, ms, mt, mu, mv, mw, mx, my, mz, na, nc, ne, nf, ng, ni, nl, no, np, nr, nu, nz, om, pa, pe, pf, pg, ph, pk, pl, pm, pn, pr, ps, pt, pw, py, qa, re, ro, rs, ru, rw, sa, sb, sc, sd, se, sg, sh, si, sj, sk, sl, sm, sn, so, sr, ss, st, su, sv, sx, sy, sz, tc, td, tf, tg, th, tj, tk, tl, tm, tn, to, tr, tt, tv, tw, tz, ua, ug, uk, us, uy, uz, va, vc, ve, vg, vi, vn, vu, wf, ws, ye, yt, za, zm, zw
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Language¶
The language in which to return results.
Type: languages
Parameter Sets: (All)
Aliases:
Accepted values: af, sq, am, ar, hy, az, eu, be, bn, bs, bg, my, ca, zh, hr, cs, da, nl, en, et, fa, fi, fil, fr, ka, de, el, iw, hi, hu, is, id, it, ja, kn, kk, km, ko, ky, lo, lv, lt, mk, ms, ml, mr, mn, ne, no, pl, pt, pa, ro, ru, sr, sk, es, sw, ta, te, th, uk, ur, uz, vi, zu
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MaxResults¶
Specifies the maximum number of locations to return in the response
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-BingMapsAPIKey¶
Bing Maps API Key
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS¶
OUTPUTS¶
Bing.Place¶
NOTES¶
Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/
Direct API Example: https://dev.virtualearth.net/REST/v1/LocalSearch/?query={query}&userLocation={point}&key={BingMapsAPIKey}
Ensure you have a valid Bing Maps API Key. How to get a Bing Maps API Key: https://pwshplaces.readthedocs.io/en/latest/BingMapsAPI/#how-to-get-a-bing-maps-api-key
RELATED LINKS¶
https://pwshplaces.readthedocs.io/en/latest/Find-BingPlace/
https://pwshplaces.readthedocs.io/en/latest/pwshPlaces-Bing-Maps-Examples/
https://docs.microsoft.com/bingmaps/rest-services/locations/local-search