Remove-CsHostedVoicemailPolicy
Topic Last Modified: 2012-03-27
Removes a hosted voice mail policy.
Syntax
Remove-CsHostedVoicemailPolicy -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
This cmdlet removes a policy that specifies how to route unanswered calls to the user to a hosted Exchange Unified Messaging (UM) service.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsHostedVoicemailPolicy 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-CsHostedVoicemailPolicy"}
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
XdsIdentity |
A unique identifier for the hosted voice mail policy that you want to remove. This identifier includes the scope (in the case of global), the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as HVUserPolicy). |
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.HostedVoicemailPolicy object. Accepts pipelined input of hosted voice mail policy objects.
Return Types
This cmdlet does not return an object. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy.
Example
-------------------------- Example 1 --------------------------
Remove-CsHostedVoicemailPolicy -Identity ExRedmond
This command removes the hosted voice mail policy for the ExRedmond per-user policy.
-------------------------- Example 2 --------------------------
Get-CsHostedVoicemailPolicy -Filter tag* | Remove-CsHostedVoicemailPolicy
The command in Example 2 removes all per-user hosted voice mail policies. The command starts by calling the Get-CsHostedVoicemailPolicy cmdlet with a Filter of tag*, which will retrieve all policies defined as per-user policies. That set of policies is then piped to Remove-CsHostedVoicemailPolicy, which deletes each one.
See Also
Other Resources
New-CsHostedVoicemailPolicy
Set-CsHostedVoicemailPolicy
Get-CsHostedVoicemailPolicy
Grant-CsHostedVoicemailPolicy