|
| 1 | +--- |
| 2 | +external help file: MicrosoftTeams-help.xml |
| 3 | +Module Name: MicrosoftTeams |
| 4 | +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# Grant-CsTeamsFilesPolicy |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | +Assigns an online teams files policy to a user account, to a group of users, or set the tenant Global instance. |
| 12 | +Online teams files policies manage usages of files-related features. |
| 13 | + |
| 14 | +## SYNTAX |
| 15 | + |
| 16 | +### GrantToTenant (Default) |
| 17 | +``` |
| 18 | +Grant-CsTeamsFilesPolicy [-Global] [-PassThru] [[-PolicyName] <String>] |
| 19 | + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| 20 | +``` |
| 21 | + |
| 22 | +### GrantToGroup |
| 23 | +``` |
| 24 | +Grant-CsTeamsFilesPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>] |
| 25 | + [-Group] <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| 26 | +``` |
| 27 | + |
| 28 | +### Identity |
| 29 | +``` |
| 30 | +Grant-CsTeamsFilesPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>] |
| 31 | + [-Identity <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| 32 | +``` |
| 33 | + |
| 34 | +## DESCRIPTION |
| 35 | +This cmdlet assigns an existing user-specific online teams files policy to a user, a group of users, or the Global policy instance. |
| 36 | + |
| 37 | +## EXAMPLES |
| 38 | + |
| 39 | +### Example 1 |
| 40 | +``` |
| 41 | +Grant-CsTeamsFilesPolicy -Identity "[email protected]" -PolicyName TranscriptionDisabled |
| 42 | +``` |
| 43 | + |
| 44 | +The command shown in Example 1 assigns the per-user online teams files policy TranscriptionDisabled to a single user [email protected]. |
| 45 | + |
| 46 | +### Example 2 |
| 47 | +``` |
| 48 | +Grant-CsTeamsFilesPolicy -Group [email protected] -Rank 10 -PolicyName TranscriptionDisabled |
| 49 | +``` |
| 50 | + |
| 51 | +The command shown in Example 2 assigns the online teams files policy TranscriptionDisabled to the members of the group [email protected]. |
| 52 | + |
| 53 | +## PARAMETERS |
| 54 | + |
| 55 | +### -Global |
| 56 | +Sets the parameters of the Global policy instance to the values in the specified policy instance. |
| 57 | + |
| 58 | +```yaml |
| 59 | +Type: SwitchParameter |
| 60 | +Parameter Sets: GrantToTenant |
| 61 | +Aliases: |
| 62 | + |
| 63 | +Required: False |
| 64 | +Position: Named |
| 65 | +Default value: None |
| 66 | +Accept pipeline input: False |
| 67 | +Accept wildcard characters: False |
| 68 | +``` |
| 69 | +
|
| 70 | +### -PassThru |
| 71 | +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. |
| 72 | +By default, the Grant-CsTeamsFilesPolicy cmdlet does not pass objects through the pipeline. |
| 73 | +
|
| 74 | +```yaml |
| 75 | +Type: SwitchParameter |
| 76 | +Parameter Sets: (All) |
| 77 | +Aliases: |
| 78 | + |
| 79 | +Required: False |
| 80 | +Position: Named |
| 81 | +Default value: False |
| 82 | +Accept pipeline input: False |
| 83 | +Accept wildcard characters: False |
| 84 | +``` |
| 85 | +
|
| 86 | +### -PolicyName |
| 87 | +A unique identifier(name) of the policy. |
| 88 | +
|
| 89 | +```yaml |
| 90 | +Type: String |
| 91 | +Parameter Sets: (All) |
| 92 | +Aliases: |
| 93 | + |
| 94 | +Required: False |
| 95 | +Position: 1 |
| 96 | +Default value: None |
| 97 | +Accept pipeline input: False |
| 98 | +Accept wildcard characters: False |
| 99 | +``` |
| 100 | +
|
| 101 | +### -Group |
| 102 | +Specifies the group used for the group policy assignment. |
| 103 | +
|
| 104 | +```yaml |
| 105 | +Type: String |
| 106 | +Parameter Sets: GrantToGroup |
| 107 | +Aliases: |
| 108 | + |
| 109 | +Required: True |
| 110 | +Position: 0 |
| 111 | +Default value: None |
| 112 | +Accept pipeline input: False |
| 113 | +Accept wildcard characters: False |
| 114 | +``` |
| 115 | +
|
| 116 | +### -Rank |
| 117 | +The rank of the policy assignment, relative to other group policy assignments for the same policy type. |
| 118 | +
|
| 119 | +```yaml |
| 120 | +Type: Int32 |
| 121 | +Parameter Sets: GrantToGroup |
| 122 | +Aliases: |
| 123 | + |
| 124 | +Required: False |
| 125 | +Position: Named |
| 126 | +Default value: None |
| 127 | +Accept pipeline input: False |
| 128 | +Accept wildcard characters: False |
| 129 | +``` |
| 130 | +
|
| 131 | +### -Identity |
| 132 | +The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP address or an Object ID. |
| 133 | +
|
| 134 | +```yaml |
| 135 | +Type: String |
| 136 | +Parameter Sets: Identity |
| 137 | +Aliases: |
| 138 | + |
| 139 | +Required: False |
| 140 | +Position: Named |
| 141 | +Default value: None |
| 142 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 143 | +Accept wildcard characters: False |
| 144 | +``` |
| 145 | +
|
| 146 | +### -WhatIf |
| 147 | +Describes what would happen if you executed the command without actually executing the command. |
| 148 | +
|
| 149 | +```yaml |
| 150 | +Type: SwitchParameter |
| 151 | +Parameter Sets: (All) |
| 152 | +Aliases: wi |
| 153 | + |
| 154 | +Required: False |
| 155 | +Position: Named |
| 156 | +Default value: False |
| 157 | +Accept pipeline input: False |
| 158 | +Accept wildcard characters: False |
| 159 | +``` |
| 160 | +
|
| 161 | +### -Confirm |
| 162 | +Prompts you for confirmation before executing the command. |
| 163 | +
|
| 164 | +```yaml |
| 165 | +Type: SwitchParameter |
| 166 | +Parameter Sets: (All) |
| 167 | +Aliases: cf |
| 168 | + |
| 169 | +Required: False |
| 170 | +Position: Named |
| 171 | +Default value: False |
| 172 | +Accept pipeline input: False |
| 173 | +Accept wildcard characters: False |
| 174 | +``` |
| 175 | +
|
| 176 | +### -MsftInternalProcessingMode |
| 177 | +{{ Fill MsftInternalProcessingMode Description }} |
| 178 | +
|
| 179 | +```yaml |
| 180 | +Type: String |
| 181 | +Parameter Sets: (All) |
| 182 | +Aliases: |
| 183 | + |
| 184 | +Required: False |
| 185 | +Position: Named |
| 186 | +Default value: None |
| 187 | +Accept pipeline input: False |
| 188 | +Accept wildcard characters: False |
| 189 | +``` |
| 190 | +
|
| 191 | +### CommonParameters |
| 192 | +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). |
| 193 | +
|
| 194 | +## INPUTS |
| 195 | +
|
| 196 | +## OUTPUTS |
| 197 | +
|
| 198 | +## NOTES |
| 199 | +The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. |
| 200 | +
|
| 201 | +## RELATED LINKS |
| 202 | +
|
| 203 | +[Get-CsTeamsFilesPolicy]() |
| 204 | +
|
| 205 | +[Set-CsTeamsFilesPolicy]() |
| 206 | +
|
| 207 | +[New-CsTeamsFilesPolicy]() |
| 208 | +
|
| 209 | +[Remove-CsTeamsFilesPolicy]() |
| 210 | +
|
0 commit comments