Edit

Get-CsOnlineVoiceRoute

  • Reference
Module:
MicrosoftTeamsPowerShell
Applies to:
Microsoft Teams

Returns information about the online voice routes configured for use in your tenant. Online voice routes contain instructions that tell Skype for Business Online how to route calls from Office 365 users to phone numbers on the public switched telephone network (PSTN) or a private branch exchange (PBX).

Syntax

Get-CsOnlineVoiceRoute
   [[-Identity] <string>]
   [<CommonParameters>]
Get-CsOnlineVoiceRoute
   [-Filter <string>]
   [<CommonParameters>]

Description

Use this cmdlet to retrieve one or more existing online voice routes in your tenant. Online voice routes contain instructions that tell Skype for Business Online how to route calls from Office 365 users to phone numbers on the public switched telephone network (PSTN) or a private branch exchange (PBX).

This cmdlet can be used to retrieve voice route information such as which online PSTN gateways the route is associated with (if any), which online PSTN usages are associated with the route, the pattern (in the form of a regular expression) that identifies the phone numbers to which the route applies, and caller ID settings. The PSTN usage associates the voice route to an online voice policy.

This cmdlet is used when configuring Microsoft Phone System Direct Routing.

Examples

-------------------------- Example 1 --------------------------

PS C:\> Get-CsOnlineVoiceRoute

Retrieves the properties for all voice routes defined within the tenant.

-------------------------- Example 2 --------------------------

PS C:\> Get-CsOnlineVoiceRoute -Identity Route1

Retrieves the properties for the Route1 voice route.

-------------------------- Example 3 --------------------------

PS C:\> Get-CsOnlineVoiceRoute -Filter *test*

This command displays voice route settings where the Identity contains the string "test" anywhere within the value. To find the string test only at the end of the Identity, use the value *test. Similarly, to find the string test only if it occurs at the beginning of the Identity, specify the value test*.

-------------------------- Example 4 --------------------------

PS C:\> Get-CsOnlineVoiceRoute | Where-Object {$_.OnlinePstnGatewayList.Count -eq 0}

This command retrieves all voice routes that have not had any PSTN gateways assigned. First all voice routes are retrieved using the Get-CsOnlineVoiceRoute cmdlet. These voice routes are then piped to the Where-Object cmdlet. The Where-Object cmdlet narrows down the results of the Get operation. In this case we look at each voice route (that's what the $_ represents) and check the Count property of the PstnGatewayList property. If the count of PSTN gateways is 0, the list is empty and no gateways have been defined for the route.

Parameters

-Filter

This parameter filters the results of the Get operation based on the wildcard value passed to this parameter.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Identity

A string that uniquely identifies the voice route. If no identity is provided, all voice routes for the organization are returned.

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

System.Object