Set-CsOnlineDialInConferencingUser

 

Topic Last Modified: 2016-04-15

Use the Set-CsOnlineDialInConferencingUser cmdlet to modify the properties of a user that has been enabled for Microsoft's audio conferencing service.

Set-CsOnlineDialInConferencingUser -Identity <UserIdParameter> [-AllowPSTNOnlyMeetings <$true | $false>] [-BridgeId <Guid>] [-BridgeName <String>] [-ConferenceId <Int32>] [-Force <SwitchParameter>] [-ResetConferenceId <SwitchParameter>] [-ResetLeaderPin <SwitchParameter>] [-ServiceNumber <String>] [-Tenant <Guid>] [-TollFreeServiceNumber <String>] <COMMON PARAMETERS>

Set-CsOnlineDialInConferencingUser -Identity <UserIdParameter> -TenantDomain <String> [-AllowPSTNOnlyMeetings <$true | $false>] [-BridgeId <Guid>] [-BridgeName <String>] [-ConferenceId <Int32>] [-Force <SwitchParameter>] [-ResetConferenceId <SwitchParameter>] [-ResetLeaderPin <SwitchParameter>] [-ServiceNumber <String>] [-TollFreeServiceNumber <String>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-SendEmail <SwitchParameter>] [-SendEmailFromAddress <String>] [-SendEmailFromDisplayName <String>] [-SendEmailToAddress <String>] [-WhatIf [<SwitchParameter>]]

This example shows how to set a ConferenceId for a user, reset the meeting leader’s PIN, and set the audio conferencing provider default meeting phone number.

Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers"  -ConferenceId 3542699 -ResetLeaderPin -ServiceNumber 14255037265

This example sets a user's ConferenceId and conference bridge assignment.

Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -BridgeName "Conference Bridge" -ConferenceId 3542699

The Set-CsOnlineDialInConferencingUser cmdlet is used to modify properties for a Microsoft audio conferencing user. This cmdlet will not work for users with third-party conferencing providers. The cmdlet will verify that the correct license is assigned to the user.

 

Parameter Required Type Description

Identity

Required

Microsoft.Rtc.Management.AD.UserIdParameter

Specifies the Identity of the user account to be to be modified. A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user’s Active Directory distinguished name.

TenantDomain

Required

System.String

Specifies the domain name for the tenant or organization.

This parameter is reserved for internal Microsoft use.

AllowPSTNOnlyMeetings

Optional

System.Boolean

If true, non-authenticated users can start meetings. If false, non-authenticated callers wait in the lobby until an authenticated user joins, thereby starting the meeting. An authenticated user is a user who joins the meeting using a Skype for Business client, or the organizer that joined the meeting via dial-in conferencing and was authenticated by a PIN number. The default is false.

BridgeId

Optional

System.Guid

Specifies the globally-unique identifier (GUID) for the audio conferencing bridge.

BridgeName

Optional

System.String

Specifies the name of the audio conferencing bridge.

ConferenceId

Optional

System.Int32

Specifies the ConferenceId that will be used by the user for dial-in meetings. The cmdlet will fail if:

  • The ConferenceId is already being used in the bridge where the user is assigned, or to which the user would be assigned.

  • The ConferenceId doesn't meet the ConferenceId format requirements.

ConferenceId and ResetConferenceId are mutually exclusive. When ConferenceId is specified the new ConferenceId will be assigned to the user. When ResetConferenceId is specified, the user will get an auto-generated ConferenceId.

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

Specifies the domain controller that's used by the cmdlet to read or write the specified data. Valid inputs for this parameter include:

  • Fully qualified domain name (FQDN): -DomainController atl-cs-001.Contoso.com.

  • Computer name: -DomainController atl-cs-001

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.

ResetConferenceId

Optional

System.Management.Automation.SwitchParameter

Specifies whether to reset the ConferenceId for meetings that the user is organizing. If specified, the meetings using the old ConferenceId will fail. The user will have to reschedule his existing meetings, or run the meeting migration tool.

ConferenceId and ResetConferenceId are mutually exclusive. When ConferenceId is specified the new ConferenceId will be assigned to the user. When ResetConferenceId is specified, the user will get an auto-generated ConferenceId.

ResetLeaderPin

Optional

System.Management.Automation.SwitchParameter

Specifies whether to reset the meeting organizer or leaders PIN for meetings.

SendEmail

Optional

System.Management.Automation.SwitchParameter

PARAMVALUE: SwitchParameter

SendEmailFromAddress

Optional

System.String

PARAMVALUE: String

SendEmailFromDisplayName

Optional

System.String

PARAMVALUE: String

SendEmailToAddress

Optional

System.String

PARAMVALUE: String

ServiceNumber

Optional

System.String

Specifies the default service number for the user. The default number is used in meeting invitations. The cmdlet will verify that the service number is assigned to the user's current conference bridge, or the one the user is being assigned to.

The service number can be specified in the following formats: E.164 number, +<E.164 number> and tel:<E.164 number>.

Tenant

Optional

System.Guid

Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". You can find your tenant ID by running this command: Get-CsTenant | Select-Object DisplayName, TenantID

This parameter is reserved for internal Microsoft use.

TollFreeServiceNumber

Optional

System.String

PARAMVALUE: String

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.

SetDialinUrl

Optional

System.Management.Automation.SwitchParameter

Specifies whether to set the URL for

 
Show: