Set-CsOnlinePstnUsage

Reference

Module:: SkypeForBusiness

Applies to:: Skype for Business Online

Modifies a set of strings that identify the allowed online public switched telephone network (PSTN) usages. This cmdlet can be used to add usages to the list of online PSTN usages or remove usages from the list.

Syntax

Set-CsOnlinePstnUsage
   [-Tenant <Guid>]
   [-Usage <PSListModifier>]
   [[-Identity] <XdsIdentity>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CsOnlinePstnUsage
   [-Tenant <Guid>]
   [-Usage <PSListModifier>]
   [-Instance <PSObject>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Online PSTN usages are string values that are used for call authorization. An online PSTN usage links an online voice policy to a route. The Set-CsOnlinePstnUsage cmdlet is used to add or remove phone usages to or from the usage list. This list is global so it can be used by policies and routes throughout the tenant.

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

Examples

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

PS C:\> Set-CsOnlinePstnUsage -Identity global -Usage @{add="International"}

This command adds the string "International" to the current list of available PSTN usages.

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

PS C:\> Set-CsOnlinePstnUsage -Identity global -Usage @{remove="Local"}

This command removes the string "Local" from the list of available PSTN usages.

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

PS C:\> Set-CsOnlinePstnUsage -Usage @{remove="Local"}

The command in this example performs the exact same action as the command in Example 2: it removes the "Local" PSTN usage. This example shows the command without the Identity parameter specified. The only Identity available to the Set-CsOnlinePstnUsage cmdlet is the Global identity; omitting the Identity parameter defaults to Global.

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

PS C:\> Set-CsOnlinePstnUsage -Usage @{replace="International","Restricted"}

This command replaces everything in the usage list with the values International and Restricted. All previously existing usages are removed.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Suppresses any confirmation prompts that would otherwise be displayed before making changes.

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

-Identity

The scope at which these settings are applied. The Identity for this cmdlet is always Global.

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

-Instance

A reference to a PSTN usage object. This object must be of type PstnUsages and can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet.

Type:	PSObject
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Tenant

Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example:

-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"

You can return your tenant ID by running this command:

Get-CsTenant | Select-Object DisplayName, TenantID

If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment.

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

-Usage

Contains a list of allowable usage strings. These entries can be any string value.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

System.Management.Automation.PSObject

Outputs

System.Object

Get-CsOnlinePstnUsage