|
| 1 | +--- |
| 2 | +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml |
| 3 | +online version: https://docs.microsoft.com/powershell/module/skype/get-csteamscallholdpolicy |
| 4 | +applicable: Skype for Business Online |
| 5 | +title: Get-CsTeamsCallHoldPolicy |
| 6 | +schema: 2.0.0 |
| 7 | +ms.reviewer: |
| 8 | +manager: abnair |
| 9 | +ms.author: jomarque |
| 10 | +author: joelhmarquez |
| 11 | +--- |
| 12 | + |
| 13 | +# Get-CsTeamsCallHoldPolicy |
| 14 | + |
| 15 | +## SYNOPSIS |
| 16 | + |
| 17 | +Returns information about the policies configured to customize the call hold experience for Teams clients. |
| 18 | + |
| 19 | +> [!NOTE] |
| 20 | +> **Preview** The use of this cmdlet is in Public Preview. |
| 21 | +
|
| 22 | +## SYNTAX |
| 23 | + |
| 24 | +### Identity (Default) |
| 25 | +``` |
| 26 | +Get-CsTeamsCallHoldPolicy [-Tenant <System.Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] |
| 27 | + [<CommonParameters>] |
| 28 | +``` |
| 29 | + |
| 30 | +### Filter |
| 31 | +``` |
| 32 | +Get-CsTeamsCallHoldPolicy [-Tenant <System.Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] |
| 33 | +``` |
| 34 | + |
| 35 | +## DESCRIPTION |
| 36 | +Teams call hold policies are used to customize the call hold experience for teams clients. |
| 37 | +When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. |
| 38 | + |
| 39 | +Assigning a Teams call hold policy to a user sets an audio file to be played during the duration of the hold. |
| 40 | + |
| 41 | +## EXAMPLES |
| 42 | + |
| 43 | +### Example 1 |
| 44 | +```powershell |
| 45 | +PS C:\> Get-CsTeamsCallHoldPolicy |
| 46 | +``` |
| 47 | + |
| 48 | +The command shown in Example 1 returns information for all the Teams call hold policies configured for use in the tenant. |
| 49 | + |
| 50 | +### Example 2 |
| 51 | +```powershell |
| 52 | +PS C:\> Get-CsTeamsCallHoldPolicy -Identity 'ContosoPartnerCallHoldPolicy' |
| 53 | +``` |
| 54 | + |
| 55 | +In Example 2, information is returned for a single Teams call hold policy: the policy with the Identity ContosoPartnerCallHoldPolicy. |
| 56 | + |
| 57 | +### Example 3 |
| 58 | +```powershell |
| 59 | +PS C:\> Get-CsTeamsCallHoldPolicy -Filter 'Tag:*' |
| 60 | +``` |
| 61 | + |
| 62 | +The command shown in Example 3 returns information about all the Teams call hold policies configured at the per-user scope. |
| 63 | +To do this, the command uses the Filter parameter and the filter value "Tag:\*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "Tag:". |
| 64 | + |
| 65 | +## PARAMETERS |
| 66 | + |
| 67 | +### -Filter |
| 68 | +Enables you to use wildcards when retrieving one or more Teams call hold policies. |
| 69 | +For example, to return all the policies configured at the per-user scope, use this syntax: |
| 70 | + |
| 71 | +-Filter "Tag:\*" |
| 72 | + |
| 73 | +```yaml |
| 74 | +Type: String |
| 75 | +Parameter Sets: Filter |
| 76 | +Aliases: |
| 77 | + |
| 78 | +Required: False |
| 79 | +Position: Named |
| 80 | +Default value: None |
| 81 | +Accept pipeline input: False |
| 82 | +Accept wildcard characters: False |
| 83 | +``` |
| 84 | +
|
| 85 | +### -Identity |
| 86 | +Unique identifier of the Teams call hold policy to be retrieved. |
| 87 | +
|
| 88 | +To return the global policy, use this syntax: |
| 89 | +
|
| 90 | +`-Identity "Global"` |
| 91 | + |
| 92 | +To return a policy configured at the per-user scope, use syntax like this: |
| 93 | + |
| 94 | +`-Identity "ContosoPartnerCallHoldPolicy"` |
| 95 | + |
| 96 | +You cannot use wildcard characters when specifying the Identity. |
| 97 | + |
| 98 | +```yaml |
| 99 | +Type: XdsIdentity |
| 100 | +Parameter Sets: Identity |
| 101 | +Aliases: |
| 102 | +
|
| 103 | +Required: False |
| 104 | +Position: 1 |
| 105 | +Default value: None |
| 106 | +Accept pipeline input: False |
| 107 | +Accept wildcard characters: False |
| 108 | +``` |
| 109 | + |
| 110 | +### -LocalStore |
| 111 | +This parameter is reserved for internal Microsoft use. |
| 112 | + |
| 113 | +```yaml |
| 114 | +Type: SwitchParameter |
| 115 | +Parameter Sets: (All) |
| 116 | +Aliases: |
| 117 | +
|
| 118 | +Required: False |
| 119 | +Position: Named |
| 120 | +Default value: None |
| 121 | +Accept pipeline input: False |
| 122 | +Accept wildcard characters: False |
| 123 | +``` |
| 124 | + |
| 125 | +### -Tenant |
| 126 | +This parameter is reserved for internal Microsoft use. |
| 127 | + |
| 128 | +```yaml |
| 129 | +Type: System.Guid |
| 130 | +Parameter Sets: (All) |
| 131 | +Aliases: |
| 132 | +
|
| 133 | +Required: False |
| 134 | +Position: Named |
| 135 | +Default value: None |
| 136 | +Accept pipeline input: False |
| 137 | +Accept wildcard characters: False |
| 138 | +``` |
| 139 | + |
| 140 | +### CommonParameters |
| 141 | +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). |
| 142 | + |
| 143 | +## INPUTS |
| 144 | + |
| 145 | +### None |
| 146 | + |
| 147 | +## OUTPUTS |
| 148 | + |
| 149 | +### System.Object |
| 150 | + |
| 151 | +## NOTES |
| 152 | + |
| 153 | +## RELATED LINKS |
| 154 | + |
| 155 | +[New-CsTeamsCallHoldPolicy](New-CsTeamsCallHoldPolicy.md) |
| 156 | + |
| 157 | +[Set-CsTeamsCallHoldPolicy](Set-CsTeamsCallHoldPolicy.md) |
| 158 | + |
| 159 | +[Grant-CsTeamsCallHoldPolicy](Grant-CsTeamsCallHoldPolicy.md) |
| 160 | + |
| 161 | +[Remove-CsTeamsCallHoldPolicy](Remove-CsTeamsCallHoldPolicy.md) |
0 commit comments