Set-CsOnlineVoiceUser

Reference

Module:: MicrosoftTeamsPowerShell

Applies to:: Microsoft Teams

Use the Set-CsOnlineVoiceUser cmdlet to set the PSTN specific parameters (like telephone numbers and emergency response locations.)

Note: This cmdlet has been deprecated. Use the new Set-CsPhoneNumberAssignment and Remove-CsPhoneNumberAssignment cmdlets instead.

Syntax

Set-CsOnlineVoiceUser
   [-Identity] <UserIdParameter>
   [-Tenant <Guid>]
   [-TelephoneNumber <String>]
   [-LocationID <Guid>]
   [-DomainController <Fqdn>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Examples

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

Set-CsOnlineVoiceUser -Identity 3c37e1c7-78f9-4703-82ee-a6b68516794e -TelephoneNumber +14255037311 -LocationID c7c5a17f-00d7-47c0-9ddb-3383229d606b

This example sets the telephone number and location for a user identified by the user ObjectID.

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

Set-CsOnlineVoiceUser -Identity [email protected] -TelephoneNumber $null

This example removes the telephone number for a user identified by the user's SIP address.

Parameters

-Confirm

The Confirm switch causes the command to pause processing and requires confirmation to proceed.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-DomainController

This parameter is reserved for internal Microsoft use.

Type:	Fqdn
Aliases:	DC
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-Identity

Specifies the identity of the target user. Acceptable values include:

Example: [email protected]

Example: sip:[email protected]

Example: 98403f08-577c-46dd-851a-f0460a13b03d

You can use the Get-CsOnlineUser cmdlet to identify the users you want to modify.

Type:	Object
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-LocationID

Specifies the unique identifier of the emergency location to assign to the user. Location identities can be discovered by using the Get-CsOnlineLisLocation cmdlet.

This parameter is required for users based in the US.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-TelephoneNumber

Specifies the telephone number to be assigned to the user. The value must be in E.164 format: +14255043920. Setting the value to $Null clears the user's telephone number.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-Tenant