-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create Grant-CsTeamsFilesPolicy.md #11892
Open
mayurkl100
wants to merge
2
commits into
MicrosoftDocs:main
Choose a base branch
from
mayurkl100:patch-5
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,210 @@ | ||
--- | ||
external help file: MicrosoftTeams-help.xml | ||
Module Name: MicrosoftTeams | ||
online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy | ||
schema: 2.0.0 | ||
--- | ||
|
||
# Grant-CsTeamsFilesPolicy | ||
|
||
## SYNOPSIS | ||
Assigns an online teams files policy to a user account, to a group of users, or set the tenant Global instance. | ||
Online teams files policies manage usages of files-related features. | ||
|
||
## SYNTAX | ||
|
||
### GrantToTenant (Default) | ||
``` | ||
Grant-CsTeamsFilesPolicy [-Global] [-PassThru] [[-PolicyName] <String>] | ||
[-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] | ||
``` | ||
|
||
### GrantToGroup | ||
``` | ||
Grant-CsTeamsFilesPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>] | ||
[-Group] <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] | ||
``` | ||
|
||
### Identity | ||
``` | ||
Grant-CsTeamsFilesPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>] | ||
[-Identity <String>] [-WhatIf] [-Confirm] [<CommonParameters>] | ||
``` | ||
|
||
## DESCRIPTION | ||
This cmdlet assigns an existing user-specific online teams files policy to a user, a group of users, or the Global policy instance. | ||
|
||
## EXAMPLES | ||
|
||
### Example 1 | ||
``` | ||
Grant-CsTeamsFilesPolicy -Identity "[email protected]" -PolicyName TranscriptionDisabled | ||
``` | ||
|
||
The command shown in Example 1 assigns the per-user online teams files policy TranscriptionDisabled to a single user [email protected]. | ||
|
||
### Example 2 | ||
``` | ||
Grant-CsTeamsFilesPolicy -Group [email protected] -Rank 10 -PolicyName TranscriptionDisabled | ||
``` | ||
|
||
The command shown in Example 2 assigns the online teams files policy TranscriptionDisabled to the members of the group [email protected]. | ||
|
||
## PARAMETERS | ||
|
||
### -Global | ||
Sets the parameters of the Global policy instance to the values in the specified policy instance. | ||
|
||
```yaml | ||
Type: SwitchParameter | ||
Parameter Sets: GrantToTenant | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -PassThru | ||
Enables you to pass a user object through the pipeline that represents the user being assigned the policy. | ||
By default, the Grant-CsTeamsFilesPolicy cmdlet does not pass objects through the pipeline. | ||
|
||
```yaml | ||
Type: SwitchParameter | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: False | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -PolicyName | ||
A unique identifier(name) of the policy. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: False | ||
Position: 1 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -Group | ||
Specifies the group used for the group policy assignment. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: GrantToGroup | ||
Aliases: | ||
|
||
Required: True | ||
Position: 0 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -Rank | ||
The rank of the policy assignment, relative to other group policy assignments for the same policy type. | ||
|
||
```yaml | ||
Type: Int32 | ||
Parameter Sets: GrantToGroup | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -Identity | ||
The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP address or an Object ID. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: Identity | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: True (ByPropertyName, ByValue) | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -WhatIf | ||
Describes what would happen if you executed the command without actually executing the command. | ||
|
||
```yaml | ||
Type: SwitchParameter | ||
Parameter Sets: (All) | ||
Aliases: wi | ||
|
||
Required: False | ||
Position: Named | ||
Default value: False | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -Confirm | ||
Prompts you for confirmation before executing the command. | ||
|
||
```yaml | ||
Type: SwitchParameter | ||
Parameter Sets: (All) | ||
Aliases: cf | ||
|
||
Required: False | ||
Position: Named | ||
Default value: False | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -MsftInternalProcessingMode | ||
{{ Fill MsftInternalProcessingMode Description }} | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
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](http://go.microsoft.com/fwlink/?LinkID=113216). | ||
|
||
## INPUTS | ||
|
||
## OUTPUTS | ||
|
||
## NOTES | ||
The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. | ||
|
||
## RELATED LINKS | ||
|
||
[Get-CsTeamsFilesPolicy]() | ||
|
||
[Set-CsTeamsFilesPolicy]() | ||
|
||
[New-CsTeamsFilesPolicy]() | ||
|
||
[Remove-CsTeamsFilesPolicy]() | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mayurkl100 - Please add text here. The recommended text is "For internal use only"