Topic Last Modified: 2010-10-01

Removes the specified collection of media configuration settings


Remove-CsMediaConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description




The unique identifier of the media configuration settings you want to remove. This identifier specifies the scope at which this configuration is applied (global, site, or service).




Suppresses any confirmation prompts that would otherwise be displayed before making changes.




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




Prompts you for confirmation before executing the command.

Detailed Description

This cmdlet removes a collection of media settings. These settings relate to audio and video calls between client endpoints.

This cmdlet can also be used to remove the global media settings. In that case, however, the settings will not actually be removed; instead, they will simply be reset to their default values.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsMediaConfiguration cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsMediaConfiguration"}

Input Types

Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object. Accepts pipelined input of media configuration objects.

Return Types

Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings.


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

Copy Code
Remove-CsMediaConfiguration -Identity site:Redmond1

In Example 1, Remove-CsMediaConfiguration is used to delete the media configuration collection with the Identity site:Redmond1. When media settings are removed from the site scope, that site will automatically begin to use the global media settings.

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

Copy Code
Get-CsMediaConfiguration | Where-Object {$_.EncryptionLevel -eq "RequireEncryption"} | Remove-CsMediaConfiguration

In the preceding example, three cmdlets--Get-CsMediaConfiguration, Where-Object, and Remove-CsMediaConfiguration--are used to remove all the media configuration collections where encryption is required of all parties involved in the conversation. To do this, Get-CsMediaConfiguration is first used to return all the media configuration collections in the organization. That information is then piped to Where-Object, which applies a filter that restricts the pipeline data to those collections where the EncryptionLevel property is equal to (-eq) RequireEncryption. Finally, that filtered set of data is passed to Remove-CsMediaConfiguration, which deletes each item in the set.

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

Copy Code
Get-CsMediaConfiguration -Filter service:* | Remove-CsMediaConfiguration

In this example all media configurations defined at the service scope (meaning the configuration applies to a specific service) are removed. This is accomplished by first calling Get-CsMediaConfiguration using the Filter service:*. This filter retrieves all media configuration collections with an Identity starting with service, which means all collections at the service scope. That set of collections is then piped the Remove-CsMediaConfiguration, which removes them all.

See Also