|
| 1 | +--- |
| 2 | +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml |
| 3 | +online version: https://docs.microsoft.com/powershell/module/skype/get-csteamscortanapolicy |
| 4 | +applicable: Skype for Business Online |
| 5 | +title: Grant-CsTeamsCortanaPolicy |
| 6 | +schema: 2.0.0 |
| 7 | +manager: amehta |
| 8 | +author: akshbhat |
| 9 | +ms.author: akshbhat |
| 10 | +ms.reviewer: |
| 11 | +--- |
| 12 | + |
| 13 | +# Grant-CsTeamsCortanaPolicy |
| 14 | + |
| 15 | +## SYNOPSIS |
| 16 | +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. |
| 17 | + |
| 18 | +## SYNTAX |
| 19 | + |
| 20 | +### Identity (Default) |
| 21 | +``` |
| 22 | +Grant-CsTeamsCortanaPolicy [[-Identity] <UserIdParameter>] [-PolicyName] <String> [-Tenant <System.Guid>] |
| 23 | + [-DomainController <Fqdn>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] |
| 24 | +``` |
| 25 | + |
| 26 | +### GrantToTenant |
| 27 | +``` |
| 28 | +Grant-CsTeamsCortanaPolicy [-PolicyName] <String> [-Tenant <System.Guid>] [-DomainController <Fqdn>] |
| 29 | + [-PassThru] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] |
| 30 | +``` |
| 31 | + |
| 32 | +## DESCRIPTION |
| 33 | + |
| 34 | +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. Specifically, these specify if a user can use Cortana voice assistant in Microsoft Teams and Cortana invocation behavior via CortanaVoiceInvocationMode parameter - |
| 35 | +* Disabled - Cortana voice assistant is disabled |
| 36 | +* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation |
| 37 | +* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported |
| 38 | + |
| 39 | +This cmdlet lets you assign a Teams Cortana policy at the per-user scope. |
| 40 | + |
| 41 | +## EXAMPLES |
| 42 | + |
| 43 | +### Example 1 |
| 44 | +```powershell |
| 45 | +PS C:\> Grant-CsTeamsCortanaPolicy -identity "Ken Myer" -PolicyName MyCortanaPolicy |
| 46 | +``` |
| 47 | + |
| 48 | +In this example, a user with identity "Ken Myer" is being assigned the MyCortanaPolicy |
| 49 | + |
| 50 | +## PARAMETERS |
| 51 | + |
| 52 | +### -Confirm |
| 53 | +Prompts you for confirmation before running the cmdlet. |
| 54 | + |
| 55 | +```yaml |
| 56 | +Type: SwitchParameter |
| 57 | +Parameter Sets: (All) |
| 58 | +Aliases: cf |
| 59 | + |
| 60 | +Required: False |
| 61 | +Position: Named |
| 62 | +Default value: None |
| 63 | +Accept pipeline input: False |
| 64 | +Accept wildcard characters: False |
| 65 | +``` |
| 66 | +
|
| 67 | +### -DomainController |
| 68 | +
|
| 69 | +```yaml |
| 70 | +Type: Fqdn |
| 71 | +Parameter Sets: (All) |
| 72 | +Aliases: |
| 73 | + |
| 74 | +Required: False |
| 75 | +Position: Named |
| 76 | +Default value: None |
| 77 | +Accept pipeline input: False |
| 78 | +Accept wildcard characters: False |
| 79 | +``` |
| 80 | +
|
| 81 | +### -Global |
| 82 | +
|
| 83 | +```yaml |
| 84 | +Type: SwitchParameter |
| 85 | +Parameter Sets: GrantToTenant |
| 86 | +Aliases: |
| 87 | + |
| 88 | +Required: False |
| 89 | +Position: Named |
| 90 | +Default value: None |
| 91 | +Accept pipeline input: False |
| 92 | +Accept wildcard characters: False |
| 93 | +``` |
| 94 | +
|
| 95 | +### -Identity |
| 96 | +Indicates the identity of the user account the policy should be assigned to. User identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's ___domain name and logon name, in the form ___domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. |
| 97 | +
|
| 98 | +```yaml |
| 99 | +Type: UserIdParameter |
| 100 | +Parameter Sets: Identity |
| 101 | +Aliases: |
| 102 | + |
| 103 | +Required: False |
| 104 | +Position: 0 |
| 105 | +Default value: None |
| 106 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 107 | +Accept wildcard characters: False |
| 108 | +``` |
| 109 | +
|
| 110 | +### -PassThru |
| 111 | +
|
| 112 | +```yaml |
| 113 | +Type: SwitchParameter |
| 114 | +Parameter Sets: (All) |
| 115 | +Aliases: |
| 116 | + |
| 117 | +Required: False |
| 118 | +Position: Named |
| 119 | +Default value: None |
| 120 | +Accept pipeline input: False |
| 121 | +Accept wildcard characters: False |
| 122 | +``` |
| 123 | +
|
| 124 | +### -PolicyName |
| 125 | +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. |
| 126 | +
|
| 127 | +```yaml |
| 128 | +Type: String |
| 129 | +Parameter Sets: (All) |
| 130 | +Aliases: |
| 131 | + |
| 132 | +Required: True |
| 133 | +Position: 1 |
| 134 | +Default value: None |
| 135 | +Accept pipeline input: False |
| 136 | +Accept wildcard characters: False |
| 137 | +``` |
| 138 | +
|
| 139 | +### -Tenant |
| 140 | +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: |
| 141 | +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" |
| 142 | +You can return your tenant ID by running this command: |
| 143 | +Get-CsTenant | Select-Object DisplayName, TenantID |
| 144 | +
|
| 145 | +```yaml |
| 146 | +Type: System.Guid |
| 147 | +Parameter Sets: (All) |
| 148 | +Aliases: |
| 149 | + |
| 150 | +Required: False |
| 151 | +Position: Named |
| 152 | +Default value: None |
| 153 | +Accept pipeline input: False |
| 154 | +Accept wildcard characters: False |
| 155 | +``` |
| 156 | +
|
| 157 | +### -WhatIf |
| 158 | +Shows what would happen if the cmdlet runs. |
| 159 | +The cmdlet is not run. |
| 160 | +
|
| 161 | +```yaml |
| 162 | +Type: SwitchParameter |
| 163 | +Parameter Sets: (All) |
| 164 | +Aliases: wi |
| 165 | + |
| 166 | +Required: False |
| 167 | +Position: Named |
| 168 | +Default value: None |
| 169 | +Accept pipeline input: False |
| 170 | +Accept wildcard characters: False |
| 171 | +``` |
| 172 | +
|
| 173 | +### CommonParameters |
| 174 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). |
| 175 | +
|
| 176 | +## INPUTS |
| 177 | +
|
| 178 | +### Microsoft.Rtc.Management.AD.UserIdParameter |
| 179 | +
|
| 180 | +## OUTPUTS |
| 181 | +
|
| 182 | +### System.Object |
| 183 | +## NOTES |
| 184 | +
|
| 185 | +## RELATED LINKS |
0 commit comments