Removes an existing dial-in conferencing access number. Dial-in conferencing provides a way for users to use a "regular" telephone or cell phone (that is, a device on the Public Switched Telephone Network) to join the audio portion of an online conference.
Syntax
Remove-CsDialInConferencingAccessNumber -Identity <UserIdParameter> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] |
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
SIP address |
SIP address of the dial-in conferencing access number (that is, the contact object that represents that number) to be removed. You must include the sip: prefix when specifying the Identity; for example, -Identity sip:RedmondDialIn@litwareinc.com. |
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
Dial-in conferencing enables users to use any kind of telephone - a standard "land line", a cell phone, a Voice over IP phone, etc. - to join the audio portion of an online conference. This enables users to participate in the meeting even if they do not have a computer or an Internet connection. Users have full audio capabilities: they can speak to other participants and hear everything they takes place. They just won’t be able to see shared slides, video feeds, or other visual elements.
In order to provide users with dial-in conferencing capabilities you must create dial-in conferencing access numbers: phone numbers users can call in order to be connected to a meeting. Dial-in conferencing access numbers are created using the New-CsDialInConferencingAccessNumber cmdlet. When you create a new dial-in conferencing access number, you actually create a new contact object in Active Directory; this contact object is used to represent the access number and all its properties. The Remove-CsDialInConferencingAccessNumber cmdlet enables you to delete any of the dial-in conferencing numbers created using New-CsDialInConferencingAccessNumber. When you run Remove-CsDialInConferencingAccessNumber the cmdlet not only deletes the number from the collection of dial-in conferencing access numbers but also deletes the Active Directory contact object that represents the given access number.
Return Types
Remove-CsDialInConferencingAccessNumber deletes instances of the Microsoft.Rtc.Management.Xds.AccessNumber object.
Examples
-------------------------- Example 1 ------------------------
Copy Code | |
---|---|
Remove-CsDialInConferencingAccessNumber -Identity sip:RedmondDialIn@litwareinc.com |
The command shown in Example 1 deletes the dial-in conferencing access number that has the Identity sip:RedmondDialIn@litwareinc.com.
-------------------------- Example 2 ------------------------
Copy Code | |
---|---|
Get-CsDialInConferencingAccessNumber -Filter {LineUri -like "tel:+1800*"} | Remove-CsDialInConferencingAccessNumber |
The preceding command deletes all the toll free (in this case, all the 1-800) dial-in conferencing access numbers. To do this, the command uses Get-CsDialInConferencingAccessNumber and the -Filter parameter to return a collection of all the toll free access numbers configured for use in the organization; the filter value {LineUri -like "tel:+1800*"} limits the returned data to those numbers where the LineUri property begins with the string value "tel:+1800". This filtered collection is then piped to Remove-CsDialInConferencingAccessNumber, which deletes each number in the collection.
-------------------------- Example 3 ------------------------
Copy Code | |
---|---|
Get-CsDialInConferencingAccessNumber -Region "Redmond" | Remove-CsDialInConferencingAccessNumber |
In Example 3, all the dial-in conferencing access numbers for the Redmond region are deleted. To carry out this task, Get-CsDialInConferencingAccessNumber and the -Region parameter are first called in order to return a collection of all the access numbers for the Redmond region. (That is, any access number that includes Redmond in its list of regions.) This collection is then piped to Remove-CsDialInConferencingAccessNumber, which deletes all the access numbers in the collection.
-------------------------- Example 4 ------------------------
Copy Code | |
---|---|
Get-CsDialInConferencingAccessNumber -EmptyRegion | Remove-CsDialInConferencingAccessNumber |
In Example 4, all the dial-in conferencing access numbers that are not associated with a region are deleted. To do this, Get-CsDialInConferencingAccessNumber is called along with the -EmptyRegion; this returns a collection of access numbers where the Regions property is empty. That collection is piped to Remove-CsDialInConferencingAccessNumber, which deletes all the numbers in the collection.
-------------------------- Example 5 ------------------------
Copy Code | |
---|---|
Get-CsDialInConferencingAccessNumber | Where-Object {$_.PrimaryLanguage -ne "it-IT"} | Remove-CsDialInConferencingAccessNumber |
The command shown in Example 5 deletes any dial-in conferencing access numbers where the primary language is not set to Italian. To do this, Get-CsDialInConferencingAccessNumber is first called, without any parameters in order to return a collection of all the dial-in conferencing access numbers configured for use in the organization. That collection is then piped to the Where-Object cmdlet, which picks out any numbers where the PrimaryLanguage property is not equal to (-ne) Italian ("it-IT"). This filtered collection is then piped to Remove-CsDialInConferencingAccessNumber, which deletes all the access numbers in the collection.
-------------------------- Example 6 ------------------------
Copy Code | |
---|---|
Get-CsDialInConferencingAccessNumber -Filter {DisplayName -eq "Default Dial-In Access Number"} | Remove-CsDialInConferencingAccessNumber |
In Example 6, a dial-in conferencing access number is deleted, by referring to the number’s display name. To accomplish this task, Get-CsDialInConferencingAccessNumber is called along with the -Filter parameter and the filter value {DisplayName -eq "Default Dial-In Access Number"}; this filter value limits the returned data to the access number where the DisplayName property is equal to (-eq) "Default Dial-In Access Number". The returned object is then piped to Remove-CsDialInConferencingAccessNumber, which deletes the corresponding access number.
-------------------------- Example 7 ------------------------
Copy Code | |
---|---|
Get-CsDialInConferencingAccessNumber | Where-Object {$_.PrimaryUri -eq "sip:dialin@litwareinc.com"} | Remove-CsDialInConferencingAccessNumber |
In Example 7, all the dial-in conferencing access numbers which use the URI sip:dialin@litwareinc.com are deleted. To carry out this task, the command first calls Get-CsDialInConferencingAccessNumber without any parameters; that returns a collection of all the access numbers used in the organization. This collection is then piped to Where-Object, which selects only those numbers where the PrimaryUri property is equal to (-eq) "sip:dialin@litwareinc.com". The filtered collection is then piped to the Remove-CsDialInConferencingAccessNumber, which deletes each access number that uses sip:dialin@litwareinc.com as its primary URI.