|
| 1 | +--- |
| 2 | +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml |
| 3 | +Module Name: MicrosoftTeams |
| 4 | +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# Get-CsTeamsFilesPolicy |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | +Use the \`Get-CsTeamsFilesPolicy\` cmdlet to get a list of all pre-configured policy instances related to teams files. |
| 12 | + |
| 13 | +## SYNTAX |
| 14 | + |
| 15 | +### Identity (Default) |
| 16 | +``` |
| 17 | +Get-CsTeamsFilesPolicy [[-Identity] <String>] [<CommonParameters>] |
| 18 | +``` |
| 19 | + |
| 20 | +### Filter |
| 21 | +``` |
| 22 | +Get-CsTeamsFilesPolicy [-Filter <String>] [<CommonParameters>] |
| 23 | +``` |
| 24 | + |
| 25 | +## DESCRIPTION |
| 26 | +This cmdlet retrieves information about one or more teams files policies that have been configured for use in your organization. |
| 27 | +teams files policies are used by the organization to manage files-related features such as third party storage provider for files from teams. |
| 28 | + |
| 29 | +## EXAMPLES |
| 30 | + |
| 31 | +### Example 1 |
| 32 | +``` |
| 33 | +Get-CsTeamsFilesPolicy |
| 34 | +``` |
| 35 | + |
| 36 | +In Example 1, the Get-CsTeamsFilesPolicy cmdlet is called without any additional parameters; this returns a collection of all the teams files policies configured for use in your organization. |
| 37 | + |
| 38 | +### Example 2 |
| 39 | +``` |
| 40 | +Get-CsTeamsFilesPolicy -Identity TranscriptionDisabled |
| 41 | +``` |
| 42 | + |
| 43 | +In Example 2, the Get-CsTeamsFilesPolicy cmdlet is used to return the per-user teams files policy that has an Identity TranscriptionDisabled. |
| 44 | +Because identities are unique, this command will never return more than one item. |
| 45 | + |
| 46 | +### Example 3 |
| 47 | +``` |
| 48 | +Get-CsTeamsFilesPolicy -Filter "tag:*" |
| 49 | +``` |
| 50 | + |
| 51 | +Example 3 uses the Filter parameter to return all the teams files policies that have been configured at the per-user scope. |
| 52 | +The filter value "tag:*" tells the Get-CsTeamsFilesPolicy cmdlet to return only those policies that have an Identity that begins with the string value "tag:". |
| 53 | + |
| 54 | +## PARAMETERS |
| 55 | + |
| 56 | +### -Identity |
| 57 | +A unique identifier specifying the scope, and in some cases the name, of the policy. |
| 58 | +If this parameter is omitted, all teams files policies available for use are returned. |
| 59 | + |
| 60 | +```yaml |
| 61 | +Type: String |
| 62 | +Parameter Sets: Identity |
| 63 | +Aliases: |
| 64 | + |
| 65 | +Required: False |
| 66 | +Position: 1 |
| 67 | +Default value: None |
| 68 | +Accept pipeline input: False |
| 69 | +Accept wildcard characters: False |
| 70 | +``` |
| 71 | +
|
| 72 | +### -Filter |
| 73 | +This parameter accepts a wildcard string and returns all teams files policies with identities matching that string. |
| 74 | +For example, a Filter value of Tag:* will return all preconfigured teams files policy instances (excluding forest default "Global") available to use by the tenant admins. |
| 75 | +
|
| 76 | +```yaml |
| 77 | +Type: String |
| 78 | +Parameter Sets: Filter |
| 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 | +### CommonParameters |
| 89 | +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). |
| 90 | +
|
| 91 | +## INPUTS |
| 92 | +
|
| 93 | +### None |
| 94 | +## OUTPUTS |
| 95 | +
|
| 96 | +### System.Object |
| 97 | +## NOTES |
| 98 | +
|
| 99 | +## RELATED LINKS |
| 100 | +
|
| 101 | +[Set-CsTeamsFilesPolicy]() |
| 102 | +
|
| 103 | +[New-CsTeamsFilesPolicy]() |
| 104 | +
|
| 105 | +[Remove-CsTeamsFilesPolicy]() |
| 106 | +
|
| 107 | +[Grant-CsTeamsFilesPolicy]() |
| 108 | +
|
0 commit comments