Copy-CsVoicePolicy
Topic Last Modified: 2012-08-13
Copies an existing per-user voice policy to an Office 365 tenant. This cmdlet was introduced in Lync Server 2013.
Copy-CsVoicePolicy -PolicyName <String> -Tenant <Guid> [-Identity <XdsIdentity>] [-Force <SwitchParameter>] [-LocalStore <SwitchParameter>]
The command shown in Example 1 copies the per-user voice policy RedmondVoicePolicy to the tenant with the TenantID 38aad667-af54-4397-aaa7-e94c79ec2308.
Copy-CsVoicePolicy -PolicyName "RedmondVoicePolicy" -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"
The Copy-CsVoicePolicy allows you to take an existing per-user voice policy and then assign a copy of that policy to an Office 365 tenant. When using this cmdlet, keep in mind that you are creating and assigning a copy of the per-user policy in question. For example, suppose you have a voice policy named RedmondVoicePolicy that you assign to an Office 365 tenant. If you later make a change to RedmondVoicePolicy, that change will not be reflected in the copy of the policy assigned to the Office 365 tenant. If you want the same change made to the tenant policy, then you will need to use the Set-CsVoicePolicy command to modify the tenant policy.
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 "Copy-CsVoicePolicy"}
Lync Server Control Panel: The functions carried out by the Copy-CsVoicePolicy cmdlet are not available in the Lync Server Control Panel.
| Parameter | Required | Type | Description |
|---|---|---|---|
| PolicyName | Required | System.String | Identity of the per-user policy being copied. For example: -PolicyName "tag:NorthAmericaVoicePolicy" Note that you do not have to include the "tag:" prefix when specifying the PolicyName: -PolicyName "NorthAmericaVoicePolicy" |
| Tenant | Required | System.Guid | Globally unique identifier (GUID) of the tenant account where the policy will be copied. For example: –Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" You can return the tenant ID for each of your tenants by running this command: Get-CsTenant | Select-Object DisplayName, TenantID |
| Force | Optional | System.Management.Automation.SwitchParameter | Suppresses the display of any non-fatal error message that might arise when running the command. |
| Identity | Optional | Microsoft.Rtc.Management.Xds.XdsIdentity | Scope for the copied policy. Because the only allowed value is "global" you can omit this parameter when calling Copy-CsVoicePolicy. |
| LocalStore | Optional | System.Management.Automation.SwitchParameter | Retrieves the voice policy data from the local replica of the Central Management store rather than from the Central Management store itself. |
None. Copy-CsVoicePolicy does not accept pipelined input.
Copy-CsVoicePolicy creates new instance of the Microsoft.Rtc.Management.WritableConfig.Voice.VoicePolicy object.
