Get-CsOnlineTelephoneNumber

Use the `Get-CsOnlineTelephoneNumber` to retrieve telephone numbers from the Business Voice Directory.

Syntax

Get-CsOnlineTelephoneNumber
   [-ActivationState <String>]
   [-Assigned <MultiValuedProperty>]
   [-CapitalOrMajorCity <String>]
   [-DomainController <Fqdn>]
   [-ExpandLocation]
   [-Force]
   [-InventoryType <MultiValuedProperty>]
   [-IsNotAssigned]
   [-ResultSize <UInt32>]
   [-TelephoneNumber <String>]
   [-TelephoneNumberGreaterThan <String>]
   [-TelephoneNumberLessThan <String>]
   [-TelephoneNumberStartsWith <String>]
   [-Tenant <Guid>]
   [-AsJob]
   [<CommonParameters>]

Description

Here is an example of the output of the Get-CsOnlineTelephoneNumber cmdlet.

RunspaceId : f90303a9-c6a8-483c-b3b3-a5b8cdbab19c

ActivationState : Activated

BridgeNumber :

CallingProfile : BandwidthUS

InventoryType : Service

CityCode : NOAM-US-NY-NY

Id : 19294450177

InventoryType : Service

Location :

O365Region : NOAM

SourceType : Tnm

TargetType : caa

Tenant :

TenantId :

UserId :

IsManagedByServiceDesk : True

PortInOrderStatus :

Examples

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

PS C:\> Get-CsOnlineTelephoneNumber -TelephoneNumber 19294450177

This example gets the attributes of a specific phone number.

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

PS C:\> Get-CsOnlineTelephoneNumber -CapitalOrMajorCity NOAM-US-NY-NY

This example gets the phone numbers with the city code designating New York, New York.

Parameters

-ActivationState

This parameter is reserved for internal Microsoft use.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-AsJob

Indicates that this cmdlet runs as a background job.

When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs and about_Remote_Jobs.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-Assigned

Specifies the function of the telephone number. The acceptable values are:

  • "caa" for numbers assigned to conferencing functions.

  • "user" for numbers assigned to public switched telephone network (PSTN) functions.

The values for the Assigned parameter are case-sensitive.

Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-CapitalOrMajorCity

Specifies the city by a concatenated string in the form: region-country-area-city. For example, "NOAM-US-OR-PO" would specify Portland, Oregon.

The values for the CapitalOrMajorCity parameter are case-sensitive.

Type:String
Aliases:CityCode
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-DomainController

This parameter is reserved for internal Microsoft use.

Type:Fqdn
Aliases:DC
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-ExpandLocation

Displays the location parameter with its value.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-Force

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.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-InventoryType

Specifies the target telephone number type for the cmdlet. Acceptable values are:

  • "Service" for numbers assigned to conferencing support.

  • "Subscriber" for numbers supporting public switched telephone network (PSTN) functions.

Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-IsNotAssigned

Specifying this switch parameter will return only telephone numbers which are not assigned.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-ResultSize

Specifies the number of records returned by the cmdlet. The result size can be set to any whole number between 0 and 2147483647, inclusive. If set to 0, the command will run, but no data will be returned.

Type:UInt32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-TelephoneNumber

Specifies the target telephone number. For example:

-TelephoneNumber tel:+18005551234, or -TelephoneNumber +14251234567

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-TelephoneNumberGreaterThan

Specifies a telephone number used by the cmdlet as the lower boundary of the telephone numbers returned. The telephone numbers returned will all be greater than the number provided. The telephone number should be in E.164 format.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-TelephoneNumberLessThan

Specifies a telephone number used by the cmdlet as the upper boundary of the telephone numbers returned. The telephone numbers returned will all be less than the number provided. The telephone number should be in E.164 format.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-TelephoneNumberStartsWith

Specifies the digits that the returned telephone numbers must begin with. To return numbers in the North American Numbering Plan 425 area code, use this syntax: -TelephoneNumberStartsWith 1425. To return numbers that are in the 206 area code and that begin with 88, use this syntax: -TelephoneNumberStartsWith 120688. You can use up to nine digits.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-Tenant

This parameter is reserved for internal Microsoft use.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

Inputs

None

Outputs

Deserialized.Microsoft.Skype.EnterpriseVoice.BVDClient.Number

An instance or array of the objects.