Test-CsOnlineLisCivicAddress

 

Topic Last Modified: 2015-09-28

Use the Test-CsOnlineLisCivicAddress cmdlet to verify that a civic address exists in the master street address guide (MSAG), and is suitable for emergency dispatch.

Test-CsOnlineLisCivicAddress -CivicAddressId <Guid> <COMMON PARAMETERS>

Test-CsOnlineLisCivicAddress -CompanyName <String> -CountryOrRegion <String> [-City <String>] [-Description <String>] [-HouseNumber <String>] [-HouseNumberSuffix <String>] [-PostalCode <String>] [-PostDirectional <String>] [-PreDirectional <String>] [-StateOrProvince <String>] [-StreetName <String>] [-StreetSuffix <String>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-Tenant <Guid>]

This example tests emergency dispatch suitability for the civic address with the specified identification.

Test-CsOnlineLisCivicAddress -CivicAddressId a363a9b8-1acd-41de-916a-296c7998a024

This examples tests the emergency dispatch suitability for the civic address specified by address definition parameters.

Test-CsOnlineLisCivicAddress -HouseNumber 3910 -StreetName Smith -StreetSuffix Street -PostDirectional NE -City Redmond -StateorProvince Washington -CountryOrRegion US -PostalCode 98052 -Description "Puget Sound" -CompanyName Contoso

The Test-CsOnlineLisCivicAddress cmdlet operates in two modes.

  1. Validate and report: When called along with a list of address parameters, the cmdlet will test the address and report the result. Neither the address, nor the validation status is saved in the Location Information Service (LIS.) Use this mode to verify the address before creating it using the New-CsOnlineLisCivicAddress cmdlet.

  2. Validate and save: When called with only the CivicAddressId parameter specified, the cmdlet will test the address and, if validated, save the validation status in the Location Information Service (LIS.)

The Test-CsOnlineLisCivicAddress produces three results:

  • Accepted as is: The address entered (validate and report mode), or specified (validate and save mode) is valid.

  • Accepted with changes: The address entered or specified would be valid with changes. The changes required are specified in the output.

  • Rejected: The address entered or specified cannot be found, and no suggested changes can be defined. The output will contain the reason the validation failed.

 

Parameter Required Type Description

CivicAddressId

Required

System.Guid

Specifies the identification number of the civic address to test. If specified, no other address definition parameters are allowed. Civic address identities can be discovered by using the Get-CsOnlineLisCivicAddress cmdlet.

CompanyName

Required

System.String

Specifies the name of your organization.

CountryOrRegion

Required

System.String

Specifies the country or region of the civic address.

City

Optional

System.String

Specifies the city of the civic address.

Description

Optional

System.String

Specifies an administrator defined description of the civic address.

DomainController

Optional

Microsoft.Rtc.Management.Deploy.Fqdn

This parameter is reserved for internal Microsoft use.

Force

Optional

System.Management.Automation.SwitchParameter

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.

HouseNumber

Optional

System.String

Specifies the numeric portion of the civic address.

HouseNumberSuffix

Optional

System.String

Specifies the numeric suffix of the civic address. For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue".

PostalCode

Optional

System.String

Specifies the postal code of the civic address.

PostDirectional

Optional

System.String

Specifies the directional attribute of the civic address which follows the street name. For example, "425 Smith Avenue NE".

PreDirectional

Optional

System.String

Specifies the directional attribute of the civic address which precedes the street name. For example, "425 NE Smith Avenue ".

StateOrProvince

Optional

System.String

Specifies the state or province of the new civic address.

StreetName

Optional

System.String

Specifies the street name of the civic address.

StreetSuffix

Optional

System.String

Specifies a modifier of the street name of the civic address. The street suffix will typically be something like street, avenue, way, or boulevard.

Tenant

Optional

System.Guid

This parameter is reserved for internal Microsoft use.

The address accepts pipelined input from the Get-CsOnlineLisCivicAddress cmdlet.

 
Show: