Set-CsOnlineVoiceUser

 

Topic Last Modified: 2016-07-25

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

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

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

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

 

Parameter Required Type Description

Identity

Required

Microsoft.Rtc.Management.AD.UserIdParameter

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

  • User Principal Name (UPN)

    Example: jphillips@contoso.com

  • SIPAddress

    Example: sip:jphillips@contoso.com

  • ObjectID, or GUID

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

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

Confirm

Optional

System.Management.Automation.SwitchParameter

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

DomainController

Optional

Microsoft.Rtc.Management.Deploy.Fqdn

This parameter is reserved for internal Microsoft use.

Force

Optional

System.Management.Automation.SwitchParameter

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.

LocationID

Required on in US

System.Guid

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

NoteNote:
This parameter is required for users based in the US.

TelephoneNumber

Optional

System.String

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.

Tenant

Optional

System.Guid

This parameter is reserved for internal Microsoft use.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes.

 
Show: