Add-AIPScannerRepository

Module:
AzureInformationProtection
Adds a data repository to be scanned by the Azure Information Protection scanner.

Syntax

Add-AIPScannerRepository
   [-Path] <String>
   [-OverrideLabel <OverrideLabel>]
   [-PreserveFileDetails <PreserveFileDetails>]
   [-DefaultOwner <String>]
   [-SetDefaultLabel <DefaultLabel>]
   [-DefaultLabelId <Guid>]
   [-MatchPolicy <MatchPolicy>]
   [<CommonParameters>]

Description

Note: For the preview version of the scanner, this cmdlet is deprecated. Instead, use the Azure portal to configure the scanner.

For the general availability version, the Add-AIPScannerRepository cmdlet adds a data repository to be scanned by the Azure Information Protection scanner, and creates a profile of settings to be used for that repository. For example, you can specify a default label for unlabeled files, and whether to override an existing label.

For the data repository, you can specify local folders, UNC paths, and SharePoint Server URLs for SharePoint sites and libraries.

When you add a SharePoint path for "Shared Documents":

  • Specify "Shared Documents" in the path when you want to scan all documents and all folders from Shared Documents. For example: "http://sp2013/Shared Documents"

  • Specify "Documents" in the path when you want to scan all documents and all folders from a subfolder under Shared Documents. For example: "http://sp2013/Documents/Sales Reports"

If you later need to change the settings for this data repository, use the Set-AIPScannerRepository cmdlet. To remove this data repository, complete with its scanning settings, use the Remove-AIPScannerRepository cmdlet.

Examples

Example 1: Configure a local folder to be scanned and set the default label that is specified in the Azure Information Protection policy

PS C:\> Add-AIPScannerRepository -Path D:\Data\Finance -SetDefaultLabel UsePolicyDefault

The repository was added successfully.

This command adds the local folder named Data\Finance on the D drive to be scanned. For unlabeled files, apply the default label that is specified in the Azure Information Protection policy.

Example 2: Configure a network-attached storage (NAS) file share to be scanned with settings that apply a specific label to unlabeled files, override existing labels, and set the Owner custom property and Rights Management owner

PS C:\> Add-AIPScannerRepository -Path \\NAS\HR -SetDefaultLabel On -DefaultLabelId f018e9e7-0cfc-4c69-b27a-ac3cb7df43cc -OverrideLabel On -DefaultOwner "admin@contoso.com"

The repository was added successfully.

This command adds the file share named HR on the network-attached storage device named NAS to be scanned with the following settings:

  • For unlabeled files, apply the label that has an ID of f018e9e7-0cfc-4c69-b27a-ac3cb7df43cc.

  • For files that are already labeled, override that label with the new label.

  • Set the Owner custom property and Rights Management owner to the administrator's account.

Example 3: Configure a SharePoint "Shared Documents" library to be scanned with settings that do not apply a default label

PS C:\> Add-AIPScannerRepository -Path "http://sp2013/Shared Documents" -SetDefaultLabel Off

The repository was added successfully.

This command adds a SharePoint data repository to be scanned for all documents and folders from the "Shared Documents" library. For unlabeled files, do not apply a default label.

Example 4: Configure a specific folder in the SharePoint Server "Shared Documents" library to be scanned

PS C:\> Add-AIPScannerRepository -Path http://sp2016.res.local/Documents/HR

The repository was added successfully.

This command adds the SharePoint Server folder named HR, from the "Shared Documents" library.

Note that the path syntax for this scenario uses "Documents" rather than "Shared Documents".

Required Parameters

-Path

Specifies a local path, network path, or SharePoint Server URL for the data repository that you want to scan. Wildcards are not supported.

For SharePoint paths: SharePoint Server 2016 and SharePoint Server 2013 are supported. SharePoint Server 2010 is also supported for customers who have extended support for this version of SharePoint.

Examples include C:\Folder, C:\Folder\Filename, \\Server\Folder, http://sharepoint.contoso.com/Shared%20Documents/Folder. Paths can include spaces when you enclose the path value with quotes.

Type:String
Aliases:FullName
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False

Optional Parameters

-DefaultLabelId

Specifies the label ID to use as the default label for this data repository. This default label is applied to unlabeled files if no conditions are matched and the SetDefaultLabel parameter is set to On.

This parameter is ignored if SetDefaultLabel is set to Off.

When a label has sublabels, always specify the ID of just a sublabel and not the parent label.

The label ID value is displayed in the Azure portal, on the Label blade, when you view or configure the Azure Information Protection policy. For files that have labels applied, you can also run the Get-AIPFileStatus cmdlet to identify the label ID (MainLabelId or SubLabelId).

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultOwner

Specifies the email address for the Owner custom property when a file is classified, and for the Rights Management owner if the file is not already protected. For more information about the Rights Management owner, see Rights Management issuer and Rights Management owner.

For files on SharePoint Server, the SharePoint Editor (Last Modified By) value is always used.

For other files, the user that you specify with this parameter is set as the Owner custom property and Rights Management owner for the following scenarios:

  • Files on SharePoint Server that do not have the Editor (Last Modified By) property set.

  • Files on SharePoint Server if this property is set to a deleted user account.

  • Files that are stored on file shares or local folders.

If you do not specify this parameter for other files, the scanner's account is set as the owner.

To remove the currently set Owner custom property and Rights Management owner, specify "".

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MatchPolicy

Set this parameter to On to inspect the files for the conditions defined in the Azure Information Protection policy.

Set this parameter to Off to apply a default label to all files in the data repository, without inspecting the files for any conditions in the Azure Information Protection policy. If you have set the DefaultLabelId to set a default label for this data repository, that label will be applied. If no default label is configured for the data repository, the default label configured in the Azure Information Protection policy is used.

Type:MatchPolicy
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OverrideLabel

Specify whether to apply a different label to a file that's already labeled. By default, the scanner doesn't relabel the files, unless the new label has higher sensitivity than current label, and the initial label was not manually applied by an end user.

If set to On, the scanner replaces an existing label when the configured conditions apply and the MatchPolicy parameter is set to On.

The setting that you specify for this parameter is not used when the MatchPolicy parameter is set to Off.

Type:OverrideLabel
Accepted values:Off, On
Position:Named
Default value:Off
Accept pipeline input:False
Accept wildcard characters:False
-PreserveFileDetails

Specify this parameter to leave the modified date (Windows and SharePoint) and modified by (SharePoint) values unchanged for documents that you label:

  • For local or network files, the Date modified value remains unchanged.

  • For SharePoint files, the Modified date and Modified by values remain unchanged.

However, if your data repository displays the date the file was last accessed, this PowerShell parameter has no effect on that file attribute, which will be changed when the scanner discovers or labels files.

Type:PreserveFileDetails
Accepted values:Off, On
Position:Named
Default value:On
Accept pipeline input:False
Accept wildcard characters:False
-SetDefaultLabel

Specifies whether the scanner sets a default label on unlabeled files for this data repository. You can apply the default label from the Azure Information Protection policy, or another label.

  • UsePolicyDefault: For unlabeled files, apply the default label that is specified in the Azure Information Protection policy.

  • Off: For unlabeled files, do not apply a default label.

  • On: For unlabeled files, apply the label that is specified by its label ID.

Type:DefaultLabel
Accepted values:UsePolicyDefault, Off, On
Position:Named
Default value:UsePolicyDefault
Accept pipeline input:False
Accept wildcard characters:False

Inputs

System.String

Outputs

System.Object