[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Adds a new audio conference provider to a user or group of users, or modifies an existing audio conference provider already assigned to a user.

Syntax

Set-CsUserAcp -Identity <UserIdParameter> -Domain <String> -Name <String> -ParticipantPasscode <String> -TollNumber <String> [-Confirm [<SwitchParameter>]] [-IsDefault <$true | $false>] [-PassThru <SwitchParameter>] [-TollFreeNumbers <String[]>] [-Url <String>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Required

User Identity

Indicates the Identity of the user account to be modified. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's Universal Principal Name; 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 Domain Services display name (for example, Ken Myer). Note that the SamAccountName cannot be used as an identity because it is not necessarily unique in a forest.

You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. For example, the Identity "* Smith" returns all the users with a display name that ends in the string value " Smith".

TollNumber

Required

String

Non-toll-free phone number used for audio conferences. For example: -TollNumber "14255551298".

TollFreeNumbers

Optional

String

Collection of toll-free phone number used for audio conferences. For example: -TollFreeNumbers "18005551298". To add multiple toll-free numbers, separate the individual numbers by using commas: -TollFreeNumber "18005551298", "18005559876".

ParticipantPasscode

Required

String

Passcode required when connecting to a conference via the audio conference provider. For example: -PassCode "0712".

Domain

Required

String

Domain name of the audio conference provider. For example: -Domain "fabrikam.com".

Name

Required

String

Name of the audio conference provider. For example: -Name "Fabrikam Conference Services".

Url

Optional

String

Web URL for the audio conference provider. For example: -Url "http://acp.fabrikam.com".

IsDefault

Optional

Boolean

Indicates whether or not this is the default audio conference provider for the user. Each user can only have one default provider.

PassThru

Optional

Switch Parameter

Enables you to pass a user object through the pipeline that represents the user having the audio conference provider removed. By default, the Remove-CsUserAcp cmdlet does not pass objects through the pipeline.

Force

Optional

Switch Parameter

Suppresses the display of any non-fatal error message that might arise when running the command.

WhatIf

Optional

Switch Parameter

Describes what would happen if you executed the command without actually executing the command.

Confirm

Optional

Switch Parameter

Prompts you for confirmation before executing the command.

Detailed Description

An audio conference provider is a third-party company that provides organizations with conferencing services. Among other things, audio conference providers provide a way for users located off site, and not connected to the corporate network or the Internet, to participate in the audio portion of a conference or online meeting. Audio conference providers often provide high-end services such as live translation, transcription, and live per-conference operator-assistance.

Audio conference providers can be assigned to a user account by using the Set-CsUserAcp cmdlet. (Note that any one user can be assigned multiple audio conference providers.) Set-CsUserAcp is also used to modify the properties of an existing audio conference provider. If you call Set-CsUserAcp, the cmdlet uses the parameter information included in the call to check the existing audio conference providers assigned to the user. If a match is found, then the existing provider is modified. For example, supposed you issue the following command:

Set-CsUserAcp –Identity "Ken Myer" –TollNumber "15554251298" –ParticipantPassCode 13761 –Domain "fabrikam.com" –Name "Fabrikam ACP"

Further suppose that Ken Myer has already been assigned a conferencing provider named Fabrikam ACP that has the same TollNumber and Domain as those specified in the command. (In other words, the only difference is the ParticipantPassCode,) In that case, Set-CsUserAcp will modify the existing Fabrikam ACP provider. If a match is not found, then a new provider will be added to Ken Myer’s user account.

Return Types

Examples

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

Copy Code 
Set-CsUserAcp -Identity "Ken Myer" -TollNumber "15554251298" -ParticipantPassCode 13761 -Domain "fabrikam.com" -Name "Fabrikam ACP"

In Example 1, Set-CsUserAcp is used to assign a new audio conference provider to the user Ken Myer. To do this, the –Identity parameter is used to indicate the user account to be modified; in this example, that’s the user with the Active Directory display name "Ken Myer". In addition, the required parameters –TollNumber, -ParticipantPassCode, -Domain, and –Name are included, along with the appropriate parameter values.

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

Copy Code 
Get-CsUser -LdapFilter "Department=Finance" | Set-CsUserAcp -TollNumber "15554251298" -ParticipantPassCode 13761 -Domain "fabrikam.com" -Name "Fabrikam ACP"

The command shown in Example 2 assigns the same audio conferencing provider to all the users who work in the Finance department. To do this, the command first uses Get-CsUser and the –LdapFilter (with the filter value "Department=Finance") to return a collection of all the users who work in the Finance department. This collection is then piped to the Set-CsUserAcp cmdlet, which assigns the same audio conference provider (Fabrikam ACP) to each user in the collection.

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

Copy Code 
Get-CsUser -Filter {AcpInfo -eq $Null} | Set-CsUserAcp -TollNumber "15554251298" -ParticipantPassCode 13761 -Domain "fabrikam.com" -Name "Fabrikam ACP"

In Example 3, a specified audio conference provider is assigned to each user who is not currently assigned an audio conference provider. To perform this task, the command first calls Get-CsUser and the –Filter parameter; the filter value {AcpInfo –eq $Null) limits the returned data to user accounts where the AcpInfo property is equal to (-eq) a null value ($Null). This collection in then piped to Set-CsUserAcp, which, in turns, assigned the Fabrikam ACP audio conference provider to each user in the collection.

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

Copy Code 
Set-CsUserAcp -Identity "Ken Myer" -TollNumber "15554251298" -ParticipantPassCode 13761 -Domain "fabrikam.com" -Name "Fabrikam ACP" -TollFreeNumbers "18005551010", "18005551020"

The preceding command assigns the Fabrikam ACP audio conference provider to the user Ken Myer. In addition to specifying the TollNumber, ParticipantPassCode, Domain, and Name, this command also includes a pair of toll-free phone numbers. To assign these two values, the –TollFreeNumbers parameter is included followed by the two phone numbers, separated from one another by using a comma.