Get-CsOnlineLisCivicAddress
Use the Get-CsOnlineLisCivicAddress cmdlet to retrieve information about existing emergency civic addresses defined in the Location Information Service (LIS).
Syntax
Default (Default)
Get-CsOnlineLisCivicAddress
[-AssignmentStatus <string>]
[-City <string>]
[-CivicAddressId <guid>]
[-CountryOrRegion <string>]
[-Description <string>]
[-Force]
[-LocationId <guid>]
[-NumberOfResultsToSkip <int>]
[-PopulateNumberOfTelephoneNumbers]
[-PopulateNumberOfVoiceUsers]
[-ResultSize <long>]
[-Filter <string>]
[-ValidationStatus <string>]
[<CommonParameters>]
Description
Returns one or more emergency civic addresses.
Use the Filter parameter to retrieve civic addresses that match a filter expression, such as addresses in a list of countries or regions or addresses with a matching description.
Examples
Example 1
Get-CsOnlineLisCivicAddress -CivicAddressId abcd1234-abcd-1234-abcd-1234abcd5678
This example returns the civic address with the specified identification.
Example 2
Get-CsOnlineLisCivicAddress -City Seattle
This example returns all the civic addresses in the city of Seattle.
Example 3: Filter by country or region
Get-CsOnlineLisCivicAddress -Filter "Country -in ['CA', 'US']"
This example returns civic addresses in Canada or the United States.
The -in operator matches any value in the comma-separated list enclosed in square brackets.
Example 4: Match part of a description
Get-CsOnlineLisCivicAddress -Filter "Description -like '*office*'"
This example returns civic addresses whose descriptions contain "office". The asterisks match text before or after "office".
Example 5: Combine filter conditions
Get-CsOnlineLisCivicAddress -Filter "Country -eq 'US' -and City -like 'Sea*'"
This example returns civic addresses in the United States whose city names start with "Sea".
The -and operator requires both conditions to match.
Example 6: Exclude a description
Get-CsOnlineLisCivicAddress -Filter "Description -ne 'boxes'"
This example returns civic addresses whose descriptions aren't equal to "boxes".
Parameters
-AssignmentStatus
Applicable: Microsoft Teams
Note
This parameter is deprecated from the Teams PowerShell Module version 3.0.0 or later.
Specifies whether the retrieved addresses are assigned to users. 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 civic address.
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 |
-CivicAddressId
Applicable: Microsoft Teams
Specifies the identity of the civic address to return.
Parameter properties
| Type: | Guid |
| 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 |
-CountryOrRegion
Applicable: Microsoft Teams
Specifies the country or region of the target civic address.
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 |
-Description
Applicable: Microsoft Teams
Specifies the administrator defined description of the target civic address.
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 |
-Filter
Applicable: Microsoft Teams
Filters civic addresses by property values.
For example, use Country -in ['CA', 'US'] to match a list of countries or regions, or Description -like '*office*' to match part of a description.
Use -eq for equality, -ne for inequality, and -and to combine conditions.
Pass the filter expression as a string, with double quotation marks around the expression and single quotation marks around string values.
For -in, enclose the comma-separated values in square brackets.
Note
The -Filter parameter is available in Teams PowerShell module 8.0.0 or later.
Parameter properties
| Type: | System.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 parameter suppresses warning and confirmation messages.
It can be useful in scripting to suppress interactive prompts.
If you don't provide the -Force parameter in the command, the command prompts you 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 |
-LocationId
Applicable: Microsoft Teams
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | Guid |
| 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 |
-NumberOfResultsToSkip
Applicable: Microsoft Teams
Specifies the number of results to skip.
If there are a large number of civic addresses, 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 results you reviewed.
For example, the following command returns civic addresses 26-50 for Seattle.
`Get-CsOnlineLisCivicAddress -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 phone numbers at the returned addresses.
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 addresses.
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 |
-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 return.
Valid inputs are: Valid, 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.