Set-AtpPolicyForO365
This cmdlet is available only in the cloud-based service.
Use the Set-AtpPolicyForO365 cmdlet to modify the settings for the following features in Microsoft Defender for Office 365:
- Safe Links protection for supported Office 365 apps.
- Safe Documents: Uses Microsoft Defender for Endpoint to scan documents and files that are opened in Protected View in Microsoft 365 apps for enterprise.
- Safe Attachments for SharePoint, OneDrive, and Microsoft Teams.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Set-AtpPolicyForO365
[[-Identity] <AtpPolicyForO365IdParameter>]
[-AllowSafeDocsOpen <Boolean>]
[-Confirm]
[-EnableATPForSPOTeamsODB <Boolean>]
[-EnableSafeDocs <Boolean>]
[-WhatIf]
[<CommonParameters>] Description
Safe Links protection for Office 365 apps checks links in Office documents, not links in email messages. For more information, see Safe Links settings for Office 365 apps.
Safe Documents scans documents and files that are opened in Protected View. For more information, see Safe Documents in Microsoft 365 E5.
Safe Attachments for SharePoint, OneDrive, and Microsoft Teams prevents users from opening and downloading files that are identified as malicious. For more information, see Safe Attachments for SharePoint, OneDrive, and Microsoft Teams.
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.
Examples
Example 1
Set-AtpPolicyForO365 -EnableATPForSPOTeamsODB $trueThis example enables Safe Documents and Safe Attachments for SharePoint, OneDrive, and Microsoft Teams.
Parameters
-AllowSafeDocsOpen
The AllowSafeDocsOpen parameter specifies whether users can click through and bypass the Protected View container even when Safe Documents identifies a file as malicious. Valid values are:
- $true: Users are allowed to exit the Protected View container even if the document has been identified as malicious.
- $false: Users aren't allowed to exit Protected View in case of a malicious detection.
This parameter is meaningful only when the EnableSafeDocs parameter value is $true.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Confirm
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.
- 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. - 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.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-EnableATPForSPOTeamsODB
The EnableATPForSPOTeamsODB parameter enables or disables Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. Valid values are:
- $true: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is enabled. SharePoint Online admins can use the DisallowInfectedFileDownload parameter on the Set-SPOTenant cmdlet to control whether users are allowed to download files that are found to be malicious.
- $false: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is disabled. This is the default value.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-EnableSafeDocs
The EnableSafeDocs parameter enables or disables Safe Documents in organizations with Microsoft 365 A5 or Microsoft 365 E5 Security licenses. Valid values are:
- $true: Safe Documents is enabled and will upload user files to Microsoft Defender for Endpoint for scanning and verification.
- $false: Safe Documents is disabled. This is the default value.
For more information about Safe Documents, see Safe Documents in Microsoft 365 A5 or E5 Security
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Identity
The Identity parameter specifies the policy that you want to modify. There's only one policy named Default.
| Type: | AtpPolicyForO365IdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-WhatIf
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.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |