Remove-CsVoiceTestConfiguration
Topic Last Modified: 2012-03-25
Removes a voice test configuration that was used to test phone numbers against specified routes and rules.
Syntax
Remove-CsVoiceTestConfiguration -Identity <XdsGlobalRelativeIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
Before implementing voice routes and voice policies, it's a good idea to test them out on various phone numbers to ensure the results are what you're expecting. When you’re done with those tests and won’t need them again, use this cmdlet to remove them.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsVoiceTestConfiguration 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-CsVoiceTestConfiguration"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
XdsGlobalRelativeIdentity |
A string uniquely identifying the test configuration you want to remove. |
Force |
Optional |
SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
Input Types
Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration object. Accepts pipelined input of voice test configuration objects.
Return Types
Removes an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration.
Example
-------------------------- Example 1 --------------------------
Remove-CsVoiceTestConfiguration -Identity TestConfig1
This example removes the voice test configuration settings with the Identity TestConfig1.
-------------------------- Example 2 --------------------------
Get-CsVoiceTestConfiguration -Filter *test* | Remove-CsVoiceTestConfiguration
This example removes all voice test configuration settings for any configuration with an Identity containing the string test. The command first calls the Get-CsVoiceTestConfiguration cmdlet with the Filter parameter to retrieve all voice test configurations that have an Identity with the string "test" anywhere in its value. The resulting set of configurations is then piped to the Remove-CsVoiceTestConfiguration cmdlet and removed.