Merge pull request MicrosoftDocs#9433 from JensTrier/UserCallingSettings

Update examples for Set/Get-CsUserCallingSettings

Author: tiburd

teams/teams-ps/teams/Get-CsUserCallingSettings.md

@@ -60,7 +60,7 @@ Get-CsUserCallingSettings -Identity [email protected]
 SipUri                    : sip:[email protected]
 IsForwardingEnabled       : True
 ForwardingType            : Simultaneous
-ForwardingTarget          : [email protected]
+ForwardingTarget          : sip:[email protected]
 ForwardingTargetType      : SingleTarget
 IsUnansweredEnabled       : True
 UnansweredTarget          :
@@ -74,8 +74,9 @@ GroupMembershipDetails    :
 GroupNotificationOverride :
 ```
 
-This example shows that [email protected] has simultaneous ringing set (IsForwardingEnabled and ForwardingType) to [email protected] (ForwardingTarget and ForwardingTargetType) 
-and if the call has not been answered (IsUnansweredEnabled) within 20 seconds (UnansweredDelay) the call is routed to voicemail (UnansweredTargetType).
+This example shows that [email protected] has simultaneous ringing set (IsForwardingEnabled and ForwardingType) to [email protected]
+(ForwardingTarget and ForwardingTargetType) and if the call has not been answered (IsUnansweredEnabled) within 20 seconds (UnansweredDelay) the call is routed
+to voicemail (UnansweredTargetType).
 
 ### Example 3
 ```powershell
@@ -94,8 +95,8 @@ UnansweredDelay           : 00:00:20
 Delegates                 :
 Delegators                :
 CallGroupOrder            : InOrder
-CallGroupTargets          : {[email protected]}
-GroupMembershipDetails    : CallGroupOwnerId:[email protected]
+CallGroupTargets          : {sip:[email protected]}
+GroupMembershipDetails    : CallGroupOwnerId:sip:[email protected]
 GroupNotificationOverride : Mute
 ```
 ```powershell
@@ -104,7 +105,7 @@ GroupNotificationOverride : Mute
 ```output
 CallGroupOwnerId            NotificationSetting
 ----------------            -------------------
-[email protected]           Ring
+sip:[email protected]           Ring
 ```
 
 This example shows that [email protected] has simultaneous ringing set to his/her call group (ForwardingTargetType) and that the call group contains [email protected] 
@@ -128,7 +129,7 @@ IsUnansweredEnabled       : True
 UnansweredTarget          :
 UnansweredTargetType      : Voicemail
 UnansweredDelay           : 00:00:20
-Delegates                 : Id:[email protected]
+Delegates                 : Id:sip:[email protected]
 Delegators                : 
 CallGroupOrder            : InOrder
 CallGroupTargets          : {}
@@ -139,14 +140,14 @@ GroupNotificationOverride : Ring
 (Get-CsUserCallingSettings -Identity [email protected]).Delegates
 ```
 ```output
-Id             : [email protected]
+Id             : sip:[email protected]
 MakeCalls      : True
 ManageSettings : True
 ReceiveCalls   : True
 ```
 
-This example shows that [email protected] has simultaneous ringing set to his/her delegates (ForwardingTargetType). [email protected] is the only delegate (Delegates) and 
-that user has all the permissions you can have as a delegate (Delegates).
+This example shows that [email protected] has simultaneous ringing set to his/her delegates (ForwardingTargetType). [email protected] is the only delegate
+(Delegates) and that user has all the permissions you can have as a delegate (Delegates).
 
 ### Example 5
 ```powershell
@@ -163,7 +164,7 @@ UnansweredTarget          :
 UnansweredTargetType      : Voicemail
 UnansweredDelay           : 00:00:20
 Delegates                 :
-Delegators                : Id:[email protected]
+Delegators                : Id:sip:[email protected]
 CallGroupOrder            : InOrder
 CallGroupTargets          : {}
 GroupMembershipDetails    :
@@ -173,14 +174,14 @@ GroupNotificationOverride : Ring
 (Get-CsUserCallingSettings -Identity [email protected]).Delegators
 ```
 ```output
-Id             : [email protected]
+Id             : sip:[email protected]
 MakeCalls      : True
 ManageSettings : True
 ReceiveCalls   : True
 ```
 
-This example shows that [email protected] is a delegate of [email protected] (Delegators) and that [email protected] has given [email protected] all the permissions you can
-have as a delegate (Delegators).
+This example shows that [email protected] is a delegate of [email protected] (Delegators) and that [email protected] has given [email protected] all the
+permissions you can have as a delegate (Delegators).
 
 ### Example 6
 ```powershell

teams/teams-ps/teams/Set-CsUserCallingSettings.md

@@ -60,9 +60,8 @@ Set-CsUserCallingSettings -Identity <String> -GroupNotificationOverride <String>
 ## DESCRIPTION
 This cmdlet sets the call forwarding, simultaneous ringing and call group settings for the specified user.
 
-When specifying settings you need to specify all settings with a settings grouping, for instance, you can't just change a forwarding target. Instead, you need to start by 
-getting the current settings, making the necessary changes, and then setting/writing all settings within the settings group.
-
+When specifying settings you need to specify all settings with a settings grouping, for instance, you can't just change a forwarding target. Instead, you need to 
+start by  getting the current settings, making the necessary changes, and then setting/writing all settings within the settings group.
 
 
 ## EXAMPLES
@@ -93,7 +92,7 @@ This example shows setting unanswered call forward to the delegates after 30 sec
 
 ### Example 5
 ```powershell
-$cgm = @("[email protected]","[email protected]")
+$cgm = @("sip:[email protected]","sip:[email protected]")
 Set-CsUserCallingSettings -Identity [email protected] -CallGroupOrder InOrder -CallGroupTargets $cgm
 Set-CsUserCallingSettings -Identity [email protected] -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Group
 ```
@@ -103,21 +102,20 @@ This example shows creating a call group for [email protected] with 2 members an
 ```powershell
 $ucs = Get-CsUserCallingSettings -Identity [email protected]
 $cgt = {$ucs.CallGroupTargets}.Invoke()
-$cgt.Add("[email protected]")
-$cgt.Remove("[email protected]")
+$cgt.Add("sip:[email protected]")
+$cgt.Remove("sip:[email protected]")
 Set-CsUserCallingSettings -Identity [email protected] -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets $cgt
 
 $gmd = (Get-CsUserCallingSettings -Identity [email protected]).GroupMembershipDetails
-$gmd[[array]::IndexOf($gmd.CallGroupOwnerId,'[email protected]')].NotificationSetting = 'Banner'
+$gmd[[array]::IndexOf($gmd.CallGroupOwnerId,'sip:[email protected]')].NotificationSetting = 'Banner'
 Set-CsUserCallingSettings -Identity [email protected] -GroupMembershipDetails $gmd
 ```
 
 This example shows how to update the call group of [email protected] to add [email protected] and remove [email protected]. In addition the notification setting for
 [email protected] for [email protected]'s call group is set to Banner.
 
-The key to note here is the call group membership is defined on the object of the owner of the call group, in the above case this is [email protected]. However, the notification
-
-setting for a member for a particular call group is defined on the member. In this case [email protected].
+The key to note here is the call group membership is defined on the object of the owner of the call group, in the above case this is [email protected]. However, 
+the notification setting for a member for a particular call group is defined on the member. In this case [email protected].
 
 ### Example 7
 ```powershell
@@ -130,15 +128,14 @@ This example shows how to remove all members of the call group.
 ### Example 8
 ```powershell
 [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[]]$gmd = @(
-	[Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='[email protected]';NotificationSetting='Banner'}
-	[Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='[email protected]';NotificationSetting='Mute'}
+	[Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:[email protected]';NotificationSetting='Banner'}
+	[Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:[email protected]';NotificationSetting='Mute'}
 )
 Set-CsUserCallingSettings -Identity [email protected] -GroupMembershipDetails $gmd
 ```
 
-In this example [email protected] is a member of two call groups: [email protected] and [email protected]. [email protected] would like to have Banner notification for the 
-
-first call group and Mute notification for the last one.
+In this example [email protected] is a member of two call groups: [email protected] and [email protected]. [email protected] would like to have Banner 
+notification for the first call group and Mute notification for the last one.
 
 ### Example 9
 ```powershell
@@ -221,8 +218,8 @@ Accept wildcard characters: False
 
 The forwarding target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. Voicemail is only supported for Immediate forwarding.
 
-SingleTarget is used when forwarding to another user or PSTN phone number. MyDelegates is used when forwarding to the users's delegates (there needs to be at least 1 delegate).
-Group is used when forwarding to the user's call group (it needs to have at least 1 member). 
+SingleTarget is used when forwarding to another user or PSTN phone number. MyDelegates is used when forwarding to the users's delegates (there needs to be at least 1
+delegate). Group is used when forwarding to the user's call group (it needs to have at least 1 member). 
 
 ```yaml
 Type: System.String
@@ -252,8 +249,8 @@ Accept wildcard characters: False
 
 ### -GroupMembershipDetails
 
-The group membership details for the specified user. It is an array of ICallGroupMembershipDetails, which is an object containing the identity of an owner of a call group and the notification
-setting for the specified user for that call group.
+The group membership details for the specified user. It is an array of ICallGroupMembershipDetails, which is an object containing the identity of an owner of a
+call group and the notification setting for the specified user for that call group.
 
 This parameter only exists if the specified user is a member of a call group. You can't create it, you can only change it.
 
@@ -332,8 +329,8 @@ Accept wildcard characters: False
 
 ### -UnansweredDelay
 
-The time the call will ring the user before it is forwarded to the unanswered target. The supported format is hh:mm:ss and the delay range needs to be between 10 and 60 seconds in
-10 seconds increments, i.e. 00:00:10, 00:00:20, 00:00:30, 00:00:40, 00:00:50 and 00:01:00. The default value is 20 seconds.
+The time the call will ring the user before it is forwarded to the unanswered target. The supported format is hh:mm:ss and the delay range needs to be between 10 and
+60 seconds in 10 seconds increments, i.e. 00:00:10, 00:00:20, 00:00:30, 00:00:40, 00:00:50 and 00:01:00. The default value is 20 seconds.
 
 ```yaml
 Type: System.String
@@ -368,8 +365,8 @@ Accept wildcard characters: False
 
 The unanswered target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. 
 
-SingleTarget is used when forwarding the unanswered call to another user or phone number. MyDelegates is used when forwarding the unanswered call to the users's delegates.
-Group is used when forwarding the unanswered call to the specified user's call group. 
+SingleTarget is used when forwarding the unanswered call to another user or phone number. MyDelegates is used when forwarding the unanswered call to the users's 
+delegates. Group is used when forwarding the unanswered call to the specified user's call group. 
 
 ```yaml
 Type: System.String
@@ -383,8 +380,7 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction,
-and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 
@@ -399,12 +395,13 @@ The cmdlet is available in Teams PowerShell module 4.0.0 or later.
 
 The specified user need to have the Microsoft Phone System license assigned.
 
-When forwarding to MyDelegates, the specified user needs to have one or more delegates defined that are allowed to receive calls. When forwarding to Group, the specified user needs
-to have one or more members of the user's call group.
+When forwarding to MyDelegates, the specified user needs to have one or more delegates defined that are allowed to receive calls. When forwarding to Group, the
+specified user needs to have one or more members of the user's call group.
 
+The cmdlet is validating the different settings and is always writing all the parameters in a settings group. You might see validation errors from the cmdlet due to
+this behavior. As an example, if you have ForwardingTargetType set to Group and you want to remove all members of the call group, you will get a validation error.
 
-The cmdlet is validating the different settings and is always writing all the parameters in a settings group. You might see validation errors from the cmdlet due to this behavior.
-As an example, if you have ForwardingTargetType set to Group and you want to remove all members of the call group, you will get a validation error.
+You can specify a SIP URI without 'sip:' on input, but the output from Get-CsUserCallingSettings will show the full SIP URI.
 
 You are not able to configure delegates via this cmdlet. Please use New-CsUserCallingDelegate, Set-CsUserCallingDelegate cmdlets and Remove-CsUserCallingDelegate.