Edit

Share via


Get-CsOnlineLisLocation

Use the Get-CsOnlineLisLocation cmdlet to retrieve information on previously defined locations in the Location Information Service (LIS.)

Syntax

GetByLocationID (Default)

Get-CsOnlineLisLocation
    [-AssignmentStatus <string>]
    [-City <string>]
    [-CountryOrRegion <string>]
    [-Description <string>]
    [-Force]
    [-NumberOfResultsToSkip <int>]
    [-PopulateNumberOfTelephoneNumbers]
    [-PopulateNumberOfVoiceUsers]
    [-ResultSize <long>]
    [-ValidationStatus <string>]
    [<CommonParameters>]

UseCivicAddressId

Get-CsOnlineLisLocation
    -CivicAddressId <guid>
    [-AssignmentStatus <string>]
    [-City <string>]
    [-CountryOrRegion <string>]
    [-Description <string>]
    [-Force]
    [-NumberOfResultsToSkip <int>]
    [-PopulateNumberOfTelephoneNumbers]
    [-PopulateNumberOfVoiceUsers]
    [-ResultSize <long>]
    [-ValidationStatus <string>]
    [<CommonParameters>]

UseLocation

Get-CsOnlineLisLocation
    -Location <string>
    [-AssignmentStatus <string>]
    [-City <string>]
    [-CountryOrRegion <string>]
    [-Description <string>]
    [-Force]
    [-NumberOfResultsToSkip <int>]
    [-PopulateNumberOfTelephoneNumbers]
    [-PopulateNumberOfVoiceUsers]
    [-ResultSize <long>]
    [-ValidationStatus <string>]
    [<CommonParameters>]

UseLocationId

Get-CsOnlineLisLocation
    [-AssignmentStatus <string>]
    [-City <string>]
    [-CountryOrRegion <string>]
    [-Description <string>]
    [-Force]
    [-NumberOfResultsToSkip <int>]
    [-PopulateNumberOfTelephoneNumbers]
    [-PopulateNumberOfVoiceUsers]
    [-ResultSize <long>]
    [-ValidationStatus <string>]
    [-LocationId <guid>]
    [<CommonParameters>]

Examples

Example 1

Get-CsOnlineLisLocation -City Seattle -ResultSize 25 -ValidationStatus Validated

This example returns a maximum of 25 validated locations in Seattle.

Example 2

Get-CsOnlineLisLocation -CivicAddressId a363a9b8-1acd-41de-916a-296c7998a024

This example returns the locations associated with a civic address specified by its unique identifier.

Example 3

Get-CsOnlineLisLocation -Location "3rd Floor Cafe"

This example returns the location described as the "3rd Floor Cafe".

Example 4

Get-CsOnlineLisLocation -LocationId 5aa884e8-d548-4b8e-a289-52bfd5265a6e

This example returns the information on one location specified by its unique identifier.

Parameters

-AssignmentStatus

Applicable: Microsoft Teams

Note: This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later.

Specifies whether the retrieved locations have been assigned to users or not. Valid inputs are "Assigned", or "Unassigned".

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-City

Applicable: Microsoft Teams

Specifies the city of the target location.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-CivicAddressId

Applicable: Microsoft Teams

Specifies the identification number of the civic address that is associated with the target locations.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UseCivicAddressId
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-CountryOrRegion

Applicable: Microsoft Teams

Specifies the country or region of the target location.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-Description

Applicable: Microsoft Teams

Specifies the administrator defined description of the civic address that is associated with the target locations.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Applicable: Microsoft Teams

The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Location

Applicable: Microsoft Teams

Specifies an administrator defined description of the location to retrieve. For example, "2nd Floor Cafe", "Main Lobby", or "Office 250".

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UseLocation
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LocationId

Applicable: Microsoft Teams

Specifies the unique identifier of the target location.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UseLocationId
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-NumberOfResultsToSkip

Applicable: Microsoft Teams

Specifies the number of results to skip. If there are a large number of locations, you can limit the number of results by using the ResultSize parameter. If you limited the first cmdlet execution to 25 results, and want to look at the next 25 locations, then you leave ResultSize at 25 and set NumberOfResultsToSkip to 25 to omit the first 25 you've reviewed. For example the command below will return locations 26-50 for Seattle.

`Get-CsOnlineLisLocation -City Seattle -ResultSize 25 -NumberOfResultsToSkip 25`

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PopulateNumberOfTelephoneNumbers

Applicable: Microsoft Teams

If present, the PopulateNumberOfTelephoneNumbers switch causes the cmdlet to provide the number of telephone numbers at the returned locations.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PopulateNumberOfVoiceUsers

Applicable: Microsoft Teams

If present, the PopulateNumberOfVoiceUsers switch causes the cmdlet to provide the number of voice users at the returned locations.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-ResultSize

Applicable: Microsoft Teams

Specifies the maximum number of results to return.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ValidationStatus

Applicable: Microsoft Teams

Specifies the validation status of the addresses to be returned. Valid inputs are: Validated, Invalid, and Notvalidated.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

PSObject

Returns an instance, or instances of emergency location objects.