|
| 1 | +--- |
| 2 | +applicable: Microsoft Teams |
| 3 | +author: juliiva |
| 4 | +external help file: Microsoft.Rtc.Management.dll-Help.xml |
| 5 | +Locale: en-US |
| 6 | +manager: jomarque |
| 7 | +Module Name: MicrosoftTeams |
| 8 | +ms.author: juliiva |
| 9 | +online version: https://learn.microsoft.com/powershell/module/microsoftteams/grant-csteamspersonalattendantpolicy |
| 10 | +schema: 2.0.0 |
| 11 | +title: Grant-CsTeamsPersonalAttendantPolicy |
| 12 | +--- |
| 13 | + |
| 14 | + |
| 15 | +# Grant-CsTeamsPersonalAttendantPolicy |
| 16 | + |
| 17 | +## SYNOPSIS |
| 18 | + |
| 19 | +**Limited Preview:** Functionality described in this document is currently in limited preview and only authorized organizations have access. |
| 20 | + |
| 21 | +Assigns a specific Teams Personal Attendant Policy to a user, a group of users, or sets the Global policy instance. |
| 22 | + |
| 23 | +## SYNTAX |
| 24 | + |
| 25 | +```powershell |
| 26 | +Grant-CsTeamsPersonalAttendantPolicy [-Identity <string>] [-PolicyName <string>] [-PassThru] [-Global] [-Rank <int>] [<CommonParameters>] |
| 27 | +``` |
| 28 | + |
| 29 | +## DESCRIPTION |
| 30 | +The Teams Personal Attendant Policies designate how users are able to use personal attendant and its functionalities within Microsoft Teams. This cmdlet allows admins to grant user level policies to individual users, to members of a group, or to set the Global policy instance. |
| 31 | + |
| 32 | +## EXAMPLES |
| 33 | + |
| 34 | +### Example 1 |
| 35 | +``` |
| 36 | +Grant-CsTeamsPersonalAttendantPolicy -identity [email protected] -PolicyName SalesPersonalAttendantPolicy |
| 37 | +``` |
| 38 | + |
| 39 | +Assigns the TeamsPersonalAttendantPolicy called "SalesPersonalAttendantPolicy" to [email protected] |
| 40 | + |
| 41 | +### Example 2 |
| 42 | +``` |
| 43 | +Grant-CsTeamsPersonalAttendantPolicy -Global -PolicyName SalesPersonalAttendantPolicy |
| 44 | +``` |
| 45 | + |
| 46 | +Assigns the TeamsPersonalAttendantPolicy called "SalesPersonalAttendantPolicy" to the Global policy instance. This sets the parameters in the Global policy instance to the values found |
| 47 | +in the SalesPersonalAttendantPolicy instance. |
| 48 | + |
| 49 | +### Example 3 |
| 50 | +``` |
| 51 | +Grant-CsTeamsPersonalAttendantPolicy -Group [email protected] -Rank 10 -PolicyName SalesPersonalAttendantPolicy |
| 52 | +``` |
| 53 | + |
| 54 | +Assigns the TeamsPersonalAttendantPolicy called "SalesPersonalAttendantPolicy" to the members of the group [email protected]. |
| 55 | + |
| 56 | +## PARAMETERS |
| 57 | + |
| 58 | +### -Identity |
| 59 | +The user object to whom the policy is being assigned. |
| 60 | + |
| 61 | +```yaml |
| 62 | +Type: String |
| 63 | +Parameter Sets: (Identity) |
| 64 | +Aliases: |
| 65 | + |
| 66 | +Required: False |
| 67 | +Position: Named |
| 68 | +Default value: None |
| 69 | +Accept pipeline input: False |
| 70 | +Accept wildcard characters: False |
| 71 | +``` |
| 72 | +
|
| 73 | +### -PolicyName |
| 74 | +The name of the policy being assigned. To remove an existing user level policy assignment, specify PolicyName as $null. |
| 75 | +
|
| 76 | +```yaml |
| 77 | +Type: String |
| 78 | +Parameter Sets: (All) |
| 79 | +Aliases: |
| 80 | + |
| 81 | +Required: False |
| 82 | +Position: Named |
| 83 | +Default value: None |
| 84 | +Accept pipeline input: False |
| 85 | +Accept wildcard characters: False |
| 86 | +``` |
| 87 | +
|
| 88 | +### -PassThru |
| 89 | +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsPersonalAttendantPolicy cmdlet does not pass objects through the pipeline. |
| 90 | +
|
| 91 | +```yaml |
| 92 | +Type: SwitchParameter |
| 93 | +Parameter Sets: (All) |
| 94 | +Aliases: |
| 95 | + |
| 96 | +Required: False |
| 97 | +Position: Named |
| 98 | +Default value: None |
| 99 | +Accept pipeline input: False |
| 100 | +Accept wildcard characters: False |
| 101 | +``` |
| 102 | +
|
| 103 | +### -Global |
| 104 | +Sets the parameters of the Global policy instance to the values in the specified policy instance. |
| 105 | +
|
| 106 | +```yaml |
| 107 | +Type: SwitchParameter |
| 108 | +Parameter Sets: (GrantToTenant) |
| 109 | +Aliases: |
| 110 | + |
| 111 | +Required: False |
| 112 | +Position: Named |
| 113 | +Default value: None |
| 114 | +Accept pipeline input: False |
| 115 | +Accept wildcard characters: False |
| 116 | +``` |
| 117 | +
|
| 118 | +### -Group |
| 119 | +Specifies the group used for the group policy assignment. |
| 120 | +
|
| 121 | +```yaml |
| 122 | +Type: String |
| 123 | +Parameter Sets: (GrantToGroup) |
| 124 | +Aliases: |
| 125 | + |
| 126 | +Required: True |
| 127 | +Position: Named |
| 128 | +Default value: None |
| 129 | +Accept pipeline input: False |
| 130 | +Accept wildcard characters: False |
| 131 | +``` |
| 132 | +
|
| 133 | +### -Rank |
| 134 | +The rank of the policy assignment, relative to other group policy assignments for the same policy type. |
| 135 | +
|
| 136 | +```yaml |
| 137 | +Type: Int32 |
| 138 | +Parameter Sets: (GrantToGroup) |
| 139 | +Aliases: |
| 140 | + |
| 141 | +Required: False |
| 142 | +Position: Named |
| 143 | +Default value: None |
| 144 | +Accept pipeline input: False |
| 145 | +Accept wildcard characters: False |
| 146 | +``` |
| 147 | +
|
| 148 | +### CommonParameters |
| 149 | +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). |
| 150 | +
|
| 151 | +## INPUTS |
| 152 | +
|
| 153 | +### None |
| 154 | +
|
| 155 | +## OUTPUTS |
| 156 | +
|
| 157 | +### System.Object |
| 158 | +
|
| 159 | +## NOTES |
| 160 | +
|
| 161 | +The cmdlet is available in Teams PowerShell module 7.2.1-preview or later. |
| 162 | +
|
| 163 | +## RELATED LINKS |
| 164 | +
|
| 165 | +[New-CsTeamsPersonalAttendantPolicy](./new-csteamspersonalattendantpolicy.md) |
| 166 | +
|
| 167 | +[Set-CsTeamsPersonalAttendantPolicy](./set-csteamspersonalattendantpolicy.md) |
| 168 | +
|
| 169 | +[Get-CsTeamsPersonalAttendantPolicy](./get-csteamspersonalattendantpolicy.md) |
| 170 | +
|
| 171 | +[Remove-CsTeamsPersonalAttendantPolicy](./remove-csteamspersonalattendantpolicy.md) |
0 commit comments