Skip to content

Commit ca525b1

Browse files
chrisdachrisda
authored
Merge pull request MicrosoftDocs#11035 from MicrosoftDocs/TP-chrisda
TP-chrisda to Main
2 parents 51589eb + c7b4707 commit ca525b1

8 files changed

+1036
-0
lines changed

‎exchange/exchange-ps/exchange/Get-TeamsProtectionPolicy.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
external help file: Microsoft.Exchange.TransportMailflow-Help.xml
3+
online version: https://learn.microsoft.com/powershell/module/exchange/get-teamsprotectionpolicy
4+
applicable: Exchange Online
5+
title: Get-TeamsProtectionPolicy
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# Get-TeamsProtectionPolicy
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the cloud-based service.
16+
17+
Use the Get-TeamsProtectionPolicy cmdlet to view Microsoft Teams protection policies.
18+
19+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
20+
21+
## SYNTAX
22+
23+
```
24+
Get-TeamsProtectionPolicy [[-Identity] <TeamsProtectionPolicyIdParameter>]
25+
[-Organization <OrganizationIdParameter>]
26+
[<CommonParameters>]
27+
```
28+
29+
## DESCRIPTION
30+
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
31+
32+
## EXAMPLES
33+
34+
### Example 1
35+
```powershell
36+
Get-TeamsProtectionPolicy
37+
```
38+
39+
This example shows detailed information about the Teams protection policy in the organization.
40+
41+
## PARAMETERS
42+
43+
### -Identity
44+
The Identity parameter specifies the Teams protection policy that you want to view. There's only one Teams protection policy in an organization named Teams Protection Policy.
45+
46+
```yaml
47+
Type: TeamsProtectionPolicyIdParameter
48+
Parameter Sets: (All)
49+
Aliases:
50+
Applicable: Exchange Online
51+
52+
Required: False
53+
Position: 1
54+
Default value: None
55+
Accept pipeline input: True (ByPropertyName, ByValue)
56+
Accept wildcard characters: False
57+
```
58+
59+
### -Organization
60+
This parameter is reserved for internal Microsoft use.
61+
62+
```yaml
63+
Type: OrganizationIdParameter
64+
Parameter Sets: (All)
65+
Aliases:
66+
Applicable: Exchange Online
67+
68+
Required: False
69+
Position: Named
70+
Default value: None
71+
Accept pipeline input: False
72+
Accept wildcard characters: False
73+
```
74+
75+
### CommonParameters
76+
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/p/?LinkID=113216).
77+
78+
## INPUTS
79+
80+
## OUTPUTS
81+
82+
## NOTES
83+
84+
## RELATED LINKS

‎exchange/exchange-ps/exchange/Get-TeamsProtectionPolicyRule.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
external help file: Microsoft.Exchange.TransportMailflow-Help.xml
3+
online version: https://learn.microsoft.com/powershell/module/exchange/get-teamsprotectionpolicyrule
4+
applicable: Exchange Online
5+
title: Get-TeamsProtectionPolicyRule
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# Get-TeamsProtectionPolicyRule
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the cloud-based service.
16+
17+
Use the Get-TeamsProtectionPolicyRule cmdlet to view Microsoft Teams protection policy rules.
18+
19+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
20+
21+
## SYNTAX
22+
23+
```
24+
Get-TeamsProtectionPolicyRule [[-Identity] <RuleIdParameter>]
25+
[-Organization <OrganizationIdParameter>]
26+
[-State <RuleState>]
27+
[<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
32+
33+
## EXAMPLES
34+
35+
### Example 1
36+
```powershell
37+
Get-TeamsProtectionPolicyRule
38+
```
39+
40+
This example shows detailed information about the Teams protection policy in the organization.
41+
42+
## PARAMETERS
43+
44+
### -Identity
45+
The Identity parameter specifies the Teams protection policy rule that you want to view. There's only one Teams protection policy rule in an organization named Teams Protection Policy Rule.
46+
47+
```yaml
48+
Type: RuleIdParameter
49+
Parameter Sets: (All)
50+
Aliases:
51+
Applicable: Exchange Online
52+
53+
Required: False
54+
Position: 1
55+
Default value: None
56+
Accept pipeline input: True (ByPropertyName, ByValue)
57+
Accept wildcard characters: False
58+
```
59+
60+
### -Organization
61+
This parameter is reserved for internal Microsoft use.
62+
63+
```yaml
64+
Type: OrganizationIdParameter
65+
Parameter Sets: (All)
66+
Aliases:
67+
Applicable: Exchange Online
68+
69+
Required: False
70+
Position: Named
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
76+
### -State
77+
The State parameter filters the results by the State value of the rule. Valid values are:
78+
79+
- Enabled
80+
- Disabled
81+
82+
```yaml
83+
Type: RuleState
84+
Parameter Sets: (All)
85+
Aliases:
86+
Applicable: Exchange Online
87+
88+
Required: False
89+
Position: Named
90+
Default value: None
91+
Accept pipeline input: False
92+
Accept wildcard characters: False
93+
```
94+
95+
### CommonParameters
96+
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/p/?LinkID=113216).
97+
98+
## INPUTS
99+
100+
## OUTPUTS
101+
102+
## NOTES
103+
104+
## RELATED LINKS

‎exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
---
2+
external help file: Microsoft.Exchange.TransportMailflow-Help.xml
3+
online version: https://learn.microsoft.com/powershell/module/exchange/new-teamsprotectionpolicy
4+
applicable: Exchange Online
5+
title: New-TeamsProtectionPolicy
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# New-TeamsProtectionPolicy
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the cloud-based service.
16+
17+
Use the New-TeamsProtectionPolicy cmdlet to create Microsoft Teams protection policies.
18+
19+
**Note**: If the policy already exists (the Get-TeamsProtectionPolicy cmdlet returns output), you can't use this cmdlet.
20+
21+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
22+
23+
## SYNTAX
24+
25+
```
26+
New-TeamsProtectionPolicy [-Name] <String>
27+
[-Confirm]
28+
[-HighConfidencePhishQuarantineTag <String>]
29+
[-MalwareQuarantineTag <String>]
30+
[-Organization <OrganizationIdParameter>]
31+
[-WhatIf]
32+
[-ZapEnabled <Boolean>]
33+
[<CommonParameters>]
34+
```
35+
36+
## DESCRIPTION
37+
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
38+
39+
## EXAMPLES
40+
41+
### Example 1
42+
```powershell
43+
New-TeamsProtectionPolicy -Name "Teams Protection Policy"
44+
```
45+
46+
This example creates the Teams protection policy with the default values.
47+
48+
## PARAMETERS
49+
50+
### -Name
51+
The Name parameter specifies the unique name of the Teams protection policy. If the value contains spaces, enclose the value in quotation marks. The default name of the Teams protection policy in an organization is Teams Protection Policy. We recommend using this value.
52+
53+
```yaml
54+
Type: String
55+
Parameter Sets: (All)
56+
Aliases:
57+
Applicable: Exchange Online
58+
59+
Required: True
60+
Position: 1
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -Confirm
67+
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
68+
69+
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
70+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
71+
72+
```yaml
73+
Type: SwitchParameter
74+
Parameter Sets: (All)
75+
Aliases: cf
76+
Applicable: Exchange Online
77+
Applicable: Exchange Online
78+
79+
Required: False
80+
Position: Named
81+
Default value: None
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
86+
### -HighConfidencePhishQuarantineTag
87+
The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used on Teams messages that are quarantined as high confidence phishing. You can use any value that uniquely identifies the quarantine policy. For example:
88+
89+
- Name
90+
- Distinguished name (DN)
91+
- GUID
92+
93+
Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies).
94+
95+
If you don't use this parameter, the default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies#anatomy-of-a-quarantine-policy).
96+
97+
```yaml
98+
Type: String
99+
Parameter Sets: (All)
100+
Aliases:
101+
Applicable: Exchange Online
102+
103+
Required: False
104+
Position: Named
105+
Default value: None
106+
Accept pipeline input: False
107+
Accept wildcard characters: False
108+
```
109+
110+
### -MalwareQuarantineTag
111+
The MalwareQuarantineTag parameter specifies the quarantine policy that's used on Teams messages that are quarantined as malware. You can use any value that uniquely identifies the quarantine policy. For example:
112+
113+
- Name
114+
- Distinguished name (DN)
115+
- GUID
116+
117+
Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies).
118+
119+
If you don't use this parameter, the default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies#anatomy-of-a-quarantine-policy).
120+
121+
```yaml
122+
Type: String
123+
Parameter Sets: (All)
124+
Aliases:
125+
Applicable: Exchange Online
126+
127+
Required: False
128+
Position: Named
129+
Default value: None
130+
Accept pipeline input: False
131+
Accept wildcard characters: False
132+
```
133+
134+
### -Organization
135+
This parameter is reserved for internal Microsoft use.
136+
137+
```yaml
138+
Type: OrganizationIdParameter
139+
Parameter Sets: (All)
140+
Aliases:
141+
Applicable: Exchange Online
142+
143+
Required: False
144+
Position: Named
145+
Default value: None
146+
Accept pipeline input: False
147+
Accept wildcard characters: False
148+
```
149+
150+
### -WhatIf
151+
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
152+
153+
```yaml
154+
Type: SwitchParameter
155+
Parameter Sets: (All)
156+
Aliases: wi
157+
Applicable: Exchange Online
158+
159+
Required: False
160+
Position: Named
161+
Default value: None
162+
Accept pipeline input: False
163+
Accept wildcard characters: False
164+
```
165+
166+
### -ZapEnabled
167+
The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for malware and high confidence phishing messages in Teams messages. Valid values are:
168+
169+
- $true: ZAP for malware and high confidence phishing messages in Teams is enabled. This is the default value.
170+
- $false: ZAP for malware and high confidence phishing messages in Teams is disabled.
171+
172+
```yaml
173+
Type: Boolean
174+
Parameter Sets: (All)
175+
Aliases:
176+
Applicable: Exchange Online
177+
178+
Required: False
179+
Position: Named
180+
Default value: False
181+
Accept pipeline input: False
182+
Accept wildcard characters: False
183+
```
184+
185+
### CommonParameters
186+
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/p/?LinkID=113216).
187+
188+
## INPUTS
189+
190+
## OUTPUTS
191+
192+
## NOTES
193+
194+
## RELATED LINKS

0 commit comments

Comments
 (0)