Get-CsOutboundCallingNumberTranslationRule

  • Reference
Module:
SkypeForBusiness
Applies to:
Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Returns information about the outbound calling number translation rules created for use in your organization. An outbound calling number translation rule converts the E.164 phone numbers used by Skype for Business Server to a format that can be used by trunking peers that do not support E.164 numbers. This cmdlet was introduced in Lync Server 2013.

Syntax

Get-CsOutboundCallingNumberTranslationRule
   [-Filter <String>]
   [-LocalStore]
   [<CommonParameters>]
Get-CsOutboundCallingNumberTranslationRule
   [[-Identity] <XdsIdentity>]
   [-LocalStore]
   [<CommonParameters>]

Description

Outbound calling number translation rules convert the E.164 phone numbers used by Skype for Business to a format that can be used by trunking peers that do not support E.164 numbers; when you create a translation rule you supply a regular expression representing the outbound E.164 number (the Pattern) as well as a regular expression representing the converted number (the Translation).

Outbound calling number translation rules must be bound to a collection of trunk configuration settings; when you create a new translation rule you must specify both the Identity of the trunking configuration settings and a name for the new rule (for example, site:Redmond/RedmondTranslationRule). Note that the trunking configuration settings do not necessarily have to exist at the time you create a new rule. For example, suppose you create the rule site:Redmond/RedmondTranslationRule but no trunk configuration settings have been created for the Redmond site. If the Redmond site is a valid site, trunk configuration settings will automatically be created for the site and the new translation rule will be assigned to that collection of settings. However, your command will fail if the Redmond site does not exist.

Skype for Business Server Control Panel: To view outbound calling number translation roles in the Skype for Business Server Control Panel, click Voice Routing and then click Trunk Configuration. Double-click appropriate entry in the Name column and then, in the Edit Trunk Configuration dialog box, scroll down to the section labeled Calling number translation rules.

Examples

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

Get-CsOutboundCallingNumberTranslationRule

The command shown in Example 1 returns information about all the outbound calling number translation rules currently configured for use in the organization.

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

Get-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond/SevenDigit"

In Example 2, information is returned only for the outbound calling number translation rule that has the Identity "site:Redmond/SevenDigit."

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

Get-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond"

Example 3 returns information for all the outbound calling number translation rules configured for the Redmond site. This is done by setting the value of the Identity parameter to the Identity of the Redmond site (site:Redmond).

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

Get-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond" | Where-Object {$_.Priority -eq 0}

The command shown in Example 4 returns information only for outbound calling number translation rules that are on the Redmond site and have a Priority equal to 0. To do this, the command first uses the Get-CsOutboundCallingNumberTranslationRule cmdlet and the Identity parameter to return a collection of all the translation rules assigned to the Redmond site. This collection is then piped to the Where-Object cmdlet, which picks out only those rules that have a Priority equal to 0.

Parameters

-Filter

Performs a wildcard search that allows you to return only those outbound translation rules that have Identities that match the wildcard string. For example, this syntax returns all the translation rules that include the string value "Redmond":

-Filter "*Redmond*"

To return all the translation rules configured at the site scope use this syntax:

-Filter "site:*"

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Identity

Unique identifier for the outbound calling number translation rule you want to retrieve. The Identity consists of the scope followed by a unique name within each scope; for example:

-Identity "site:Redmond/OutboundRule1"

To return all the translation rules configured for a specific scope (such as the Redmond site) simply set the Identity to the scope itself:

-Identity "site:Redmond"

If neither the Identity parameter nor the Filter parameter is specified the Get-CsOutboundCallingNumberTranslationRule cmdlet returns information about all your outbound calling number translation rules.

Type:XdsIdentity
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-LocalStore

Retrieves the outbound calling number translation rule data from the local replica of the Central Management store rather than from the Central Management store itself.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Inputs

None

Outputs

Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule