Skip to content

Commit 0565058

Browse files
authored
Merge pull request #979 from YanyanTraveller/main
update powershell cmd doc Test-DefenderAndAmsiWorkProperly
2 parents 6bca9bb + 99bf816 commit 0565058

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

sharepoint/sharepoint-server-ps/SharePointServer/SharePointServer.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2448,6 +2448,9 @@ Replaces existing certificate assignments with a new certificate.
24482448
### [Sync-SPProjectPermissions](Sync-SPProjectPermissions.md)
24492449
Manually synchronizes permissions between a Project Web App instance and its associated project sites.
24502450

2451+
### [Test-DefenderAndAmsiWorkProperly](Test-DefenderAndAmsiWorkProperly.md)
2452+
Tests that Windows Defender components and SharePoint AMSI integration are properly installed and running.
2453+
24512454
### [Test-SPContentDatabase](Test-SPContentDatabase.md)
24522455
Tests a content database.
24532456

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
Module Name: SharePointServer
3+
online version: https://learn.microsoft.com/powershell/module/sharepoint-server/test-defenderandamsiworkproperly
4+
applicable: SharePoint Server Subscription Edition
5+
title: Test-DefenderAndAmsiWorkProperly
6+
schema: 2.0.0
7+
---
8+
9+
# Test-DefenderAndAmsiWorkProperly
10+
11+
## SYNOPSIS
12+
13+
Tests that Windows Defender components and SharePoint AMSI integration are properly installed and running.
14+
15+
## SYNTAX
16+
17+
```
18+
Test-DefenderAndAmsiWorkProperly [<CommonParameters>]
19+
```
20+
21+
## DESCRIPTION
22+
23+
Use the `Test-DefenderAndAmsiWorkProperly` cmdlet to verify that all Windows Defender components are installed and running correctly, and that SharePoint AMSI (Antimalware Scan Interface) integration is functioning properly.
24+
25+
This cmdlet performs comprehensive checks to ensure that the security infrastructure is operational and can protect SharePoint Server from malicious content. It validates both the Windows Defender antimalware engine and the AMSI integration that allows SharePoint to scan content for potential threats.
26+
27+
The cmdlet does not make any changes to the system configuration but provides diagnostic information about the current state of security components.
28+
29+
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets).
30+
31+
## EXAMPLES
32+
33+
### EXAMPLE 1
34+
35+
```powershell
36+
Test-DefenderAndAmsiWorkProperly
37+
```
38+
39+
This example tests the Windows Defender components and SharePoint AMSI integration to verify they are properly installed and running.
40+
41+
### EXAMPLE 2
42+
43+
```powershell
44+
Test-DefenderAndAmsiWorkProperly -Verbose
45+
```
46+
47+
This example tests the Windows Defender components and SharePoint AMSI integration with verbose output to provide detailed information about each component being checked.
48+
49+
## PARAMETERS
50+
51+
### CommonParameters
52+
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).
53+
54+
## OUTPUTS
55+
56+
### System.Object
57+
58+
This cmdlet returns diagnostic information about the status of Windows Defender components and SharePoint AMSI integration.
59+
60+
## NOTES
61+
62+
- This cmdlet requires administrator privileges to access security component information.
63+
- Ensure that Windows Defender is properly configured and enabled before running this test.
64+
- SharePoint AMSI integration requires Windows Server 2016 or later with appropriate updates installed.
65+
66+
## RELATED LINKS
67+
68+
[SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets)
69+
70+
[Windows Defender Antivirus](https://learn.microsoft.com/defender-endpoint/microsoft-defender-antivirus-windows)
71+
72+
[Antimalware Scan Interface (AMSI)](https://learn.microsoft.com/windows/win32/amsi/antimalware-scan-interface-portal)

0 commit comments

Comments
 (0)