Get-NectarLocation

Returns a list of Nectar DXP locations

Syntax

Get-NectarLocation
  -SearchQuery  <String>
  -TenantName  <String>
  -ResultSize  <Int32>

Examples

Example 1

Get-NectarLocation

Returns the first 10 locations

Example 2

Get-NectarLocation -ResultSize 100

Returns the first 100 locations

Example 3

Get-NectarLocation -LocationName Location2

Returns up to 10 locations that contains "location2" anywhere in the name. The search is not case-sensitive. This example would return Location2, Location20, Location214, MyLocation299 etc

Example 4

Get-NectarLocation -LocationName ^Location2

Returns up to 10 locations that starts with "location2" in the name. The search is not case-sensitive. This example would return Location2, Location20, Location214 etc, but NOT MyLocation299

Example 5

Get-NectarLocation -LocationName ^Location2$

Returns a location explicitly named "Location2". The search is not case-sensitive.

Parameters

-SearchQuery <String>
The name of the location to get information on based on either network, networkName, City, StreetAddress, State, SiteName or SiteCode. Can be a partial match, and may return more than one entry.

-TenantName <String>
The name of the Nectar DXP tenant. Used in multi-tenant configurations.

-ResultSize <Int32>
The number of results to return. Defaults to 1000.