Skip to content

Commit d1bcb66

Browse files
tiburdtiburd
authored
Merge pull request #8464 from xinawang/master
Upload TeamsEnhancedEncryptionPolicy md
2 parents 1fce2bd + f96aec8 commit d1bcb66

6 files changed

+790
-0
lines changed

‎teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy
5+
title: Get-CsTeamsEnhancedEncryptionPolicy
6+
author: xinawang
7+
ms.author: xinawang
8+
manager: mdress
9+
schema: 2.0.0
10+
---
11+
12+
# Get-CsTeamsEnhancedEncryptionPolicy
13+
14+
## SYNOPSIS
15+
Returns information about the teams enhanced encryption policies configured for use in your organization.
16+
## SYNTAX
17+
18+
```
19+
Get-CsTeamsEnhancedEncryptionPolicy [-LocalStore] [[-Identity] <Object>] [-Filter <Object>]
20+
[<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
Returns information about the Teams enhanced encryption policies configured for use in your organization.
25+
The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently.
26+
27+
28+
## EXAMPLES
29+
30+
### EXAMPLE 1
31+
```PowerShell
32+
PS C:\> Get-CsTeamsEnhancedEncryptionPolicy
33+
```
34+
35+
The command shown in Example 1 returns information for all the teams enhanced encryption policies configured for use in the tenant.
36+
37+
### EXAMPLE 2
38+
```PowerShell
39+
PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerEnhancedEncryptionPolicy'
40+
```
41+
42+
In Example 2, information is returned for a single teams enhanced encryption policy: the policy with the Identity ContosoPartnerEnhancedEncryptionPolicy.
43+
44+
## PARAMETERS
45+
46+
### -LocalStore
47+
Internal Microsoft use only.
48+
49+
```yaml
50+
Type: SwitchParameter
51+
Parameter Sets: (All)
52+
Aliases:
53+
54+
Required: False
55+
Position: Named
56+
Default value: False
57+
Accept pipeline input: False
58+
Accept wildcard characters: False
59+
```
60+
61+
### -Identity
62+
Unique identifier assigned to the Teams enhanced encryption policy.
63+
64+
Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant.
65+
66+
67+
```yaml
68+
Type: XdsIdentity
69+
Parameter Sets: (All)
70+
Aliases:
71+
72+
Required: False
73+
Position: 1
74+
Default value: None
75+
Accept pipeline input: False
76+
Accept wildcard characters: False
77+
```
78+
79+
### -Filter
80+
If you don't know what policies have been pre-constructed, you can use filter to identify all policies available. This is a regex string against the name (Identity) of the pre-constructed policies.
81+
82+
```yaml
83+
Type: String
84+
Parameter Sets: (All)
85+
Aliases:
86+
87+
Required: False
88+
Position: Named
89+
Default value: None
90+
Accept pipeline input: False
91+
Accept wildcard characters: False
92+
```
93+
94+
### CommonParameters
95+
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).
96+
97+
98+
## INPUTS
99+
100+
## OUTPUTS
101+
102+
### System.Object
103+
## NOTES
104+
105+
## RELATED LINKS
106+
107+
[New-CsTeamsEnhancedEncryptionPolicy](New-CsTeamsEnhancedEncryptionPolicy.md)
108+
109+
[Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md)
110+
111+
[Remove-CsTeamsEnhancedEncryptionPolicy](Remove-CsTeamsEnhancedEncryptionPolicy.md)
112+
113+
[Grant-CsTeamsEnhancedEncryptionPolicy](Grant-CsTeamsEnhancedEncryptionPolicy.md)
114+

‎teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://docs.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy
5+
title: Grant-CsTeamsEnhancedEncryptionPolicy
6+
author: xinawang
7+
ms.author: xinawang
8+
manager: mdress
9+
schema: 2.0.0
10+
---
11+
12+
# Grant-CsTeamsEnhancedEncryptionPolicy
13+
14+
## SYNOPSIS
15+
Cmdlet to assign a specific Teams enhanced encryption Policy to a user.
16+
17+
## SYNTAX
18+
19+
```
20+
Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] <Object>] [[-Identity] <Object>] [-Global]
21+
[-WhatIf] [-Confirm] [<CommonParameters>]
22+
```
23+
24+
## DESCRIPTION
25+
Cmdlet to assign a specific Teams enhanced encryption Policy to a user.
26+
27+
The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently.
28+
29+
## EXAMPLES
30+
31+
### EXAMPLE 1
32+
```PowerShell
33+
PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity '[email protected]' -PolicyName 'ContosoPartnerTeamsEnhancedEncryptionPolicy'
34+
```
35+
36+
The command shown in Example 1 assigns the per-user Teams enhanced encryption policy, ContosoPartnerTeamsEnhancedEncryptionPolicy, to the user with the user principal name (UPN) "[email protected]".
37+
38+
39+
### EXAMPLE 2
40+
```PowerShell
41+
PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'Ken Myer' -PolicyName $null
42+
```
43+
44+
In Example 2, any per-user Teams enhanced encryption policy previously assigned to the user "Ken Myer" is revoked.
45+
46+
As a result, the user will be managed by the global Teams enhanced encryption policy.
47+
48+
49+
## PARAMETERS
50+
51+
### -PassThru
52+
Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEnhancedEncryptionPolicy cmdlet does not pass objects through the pipeline.
53+
54+
```yaml
55+
Type: SwitchParameter
56+
Parameter Sets: (All)
57+
Aliases:
58+
59+
Required: False
60+
Position: Named
61+
Default value: False
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -PolicyName
67+
Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"). A policy that has an identity of "Tag:ContosoPartnerTeamsEnhancedEncryptionPolicy" has a PolicyName of "ContosoPartnerTeamsEnhancedEncryptionPolicy". If you set PolicyName to a null value, then the command will unassign any individual policy assigned to the user. For example: Grant-CsTeamsEnhancedEncryptionPolicy -Identity "Ken Myer" -PolicyName $Null.
68+
69+
```yaml
70+
Type: String
71+
Parameter Sets: (All)
72+
Aliases:
73+
74+
Required: False
75+
Position: 2
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### -Identity
82+
Unique identifier assigned to the Teams enhanced encryption policy.
83+
84+
85+
```yaml
86+
Type: XdsIdentity
87+
Parameter Sets: (All)
88+
Aliases:
89+
90+
Required: False
91+
Position: 1
92+
Default value: None
93+
Accept pipeline input: True (ByPropertyName, ByValue)
94+
Accept wildcard characters: False
95+
```
96+
97+
### -Global
98+
Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant.
99+
100+
```yaml
101+
Type: SwitchParameter
102+
Parameter Sets: (All)
103+
Aliases:
104+
105+
Required: False
106+
Position: Named
107+
Default value: False
108+
Accept pipeline input: False
109+
Accept wildcard characters: False
110+
```
111+
112+
### -WhatIf
113+
Shows what would happen if the cmdlet runs.
114+
The cmdlet is not run.
115+
116+
```yaml
117+
Type: SwitchParameter
118+
Parameter Sets: (All)
119+
Aliases: wi
120+
121+
Required: False
122+
Position: Named
123+
Default value: None
124+
Accept pipeline input: False
125+
Accept wildcard characters: False
126+
```
127+
128+
### -Confirm
129+
Prompts you for confirmation before running the cmdlet.
130+
131+
```yaml
132+
Type: SwitchParameter
133+
Parameter Sets: (All)
134+
Aliases: cf
135+
136+
Required: False
137+
Position: Named
138+
Default value: None
139+
Accept pipeline input: False
140+
Accept wildcard characters: False
141+
```
142+
143+
### CommonParameters
144+
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).
145+
146+
147+
## INPUTS
148+
149+
### System.Object
150+
## OUTPUTS
151+
152+
### System.Object
153+
## NOTES
154+
155+
## RELATED LINKS
156+
157+
[Get-CsTeamsEnhancedEncryptionPolicy](Get-CsTeamsEnhancedEncryptionPolicy.md)
158+
159+
[New-CsTeamsEnhancedEncryptionPolicy](New-CsTeamsEnhancedEncryptionPolicy.md)
160+
161+
[Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md)
162+
163+
[Remove-CsTeamsEnhancedEncryptionPolicy](Remove-CsTeamsEnhancedEncryptionPolicy.md)
164+
165+
166+

0 commit comments

Comments
 (0)