Start-AIPScan
Relevant for: Unified labeling client only
Instructs the Azure Information Protection scanner to start a one-time scan cycle.
Syntax
Start-AIPScan
[-Reset]
[-Force]
[<CommonParameters>]
Description
The Start-AIPScan cmdlet instructs the Azure Information Protection scanner to immediately start a one-time scan cycle. The scanner service must be started already and the scanner schedule must be configured for a manual schedule.
To configure the schedule, use the Azure portal to configure the scanner.
By default, all files are scanned the first time the scanner runs and then, unless the Azure Information Protection policy is changed, only new or changed files are scanned. However, you can change this behavior when you use the -Reset parameter with this cmdlet, which forces the scanner to scan all files.
Note
If the scanner schedule is set to Always, this cmdlet is ignored.
Examples
Example 1: Initiate immediate one-time scan for new and changed files
PS C:\> Start-AIPScan
Because this is not the first time that the scanner has run and the Azure Information Protection policy has not changed since the last scanning cycle, the scanner initiates an incremental scan for all new or changed files since the last scanning cycle.
Example 2: Initiate immediate one time scan for all files
PS C:\> Start-AIPScan -Reset
The scanner initiates a full scan of all the files, even if they have been scanned before and the Azure Information Protection policy has not changed.
Parameters
-Force
Forces the command to run without asking for user confirmation.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Reset
Resets the scanner cache so that the scanner initiates a full scan of all the files, even if they have been scanned before and the Azure Information Protection policy has not changed.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
None
Outputs
System.Object