Get-CsUnassignedNumber

Retrieves one or more ranges of unassigned numbers and the routing rules that apply to those numbers. This cmdlet was introduced in Lync Server 2010.

Syntax

Get-CsUnassignedNumber
   [[-Identity] <XdsGlobalRelativeIdentity>]
   [-LocalStore]
   [<CommonParameters>]
Get-CsUnassignedNumber
   [-Filter <String>]
   [-LocalStore]
   [<CommonParameters>]

Description

Unassigned numbers are phone numbers that have been assigned to an organization but that have not been assigned to specific users or phones. Skype for Business Server can be set up to route calls to appropriate destinations when an unassigned number is called. This cmdlet retrieves one or more unassigned number ranges that define that routing.

Examples

-------------------------- Example --------------------------

Get-CsUnassignedNumber

Example 1 returns a collection of all the unassigned numbers configured for use in your organization.

-------------------------- Example --------------------------

Get-CsUnassignedNumber -Identity UNSet1

In Example 2, the Identity parameter is used to limit the retrieved data to unassigned numbers that have the Identity UNSet1. Because identities must be unique, this command will return only the specified unassigned number range.

-------------------------- Example --------------------------

Get-CsUnassignedNumber -Filter *Redmond*

This example uses the Filter parameter to return a collection of all the unassigned number settings with Identity values that include the string Redmond. For example, this command would return unassigned number setting with identities such as Redmond Numbers, Unassigned Redmond Numbers, UNRedmond, etc.

-------------------------- Example --------------------------

Get-CsUnassignedNumber | Where-Object {$_.AnnouncementName -match "Welcome"}

In Example 4, the Get-CsUnassignedNumber cmdlet and the Where-Object cmdlet are used to retrieve a collection of all the unassigned number settings that include the word Welcome in the name of the Announcement. To do this, the command first uses the Get-CsUnassignedNumber cmdlet to retrieve all the unassigned number settings. That collection is then piped to the Where-Object cmdlet, which applies a filter that limits the returned data to unassigned numbers that have the word Welcome somewhere in the name of the assigned announcement.

Parameters

-Filter

Performs a wildcard search that allows you to narrow down your results to only those unassigned number settings whose identities match the given wildcard string.

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

-Identity

The unique name of the unassigned number range to retrieve.

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

-LocalStore

Retrieves the unassigned number information from the local replica of the Central Management store, rather than 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 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Inputs

None.

Outputs

Returns an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange.