Set-AIPScanner

Sets the service account and database for the Azure Information Protection scanner.

Syntax

Set-AIPScanner
   [[-SqlServerInstance] <String>]
   [-ServiceUserCredentials] <PSCredential>
   [-Profile |
   -Cluster <String>]
   [<CommonParameters>]

Description

The Set-AIPScanner cmdlet updates the service account and SQL Server database instance for the Azure Information Protection scanner. Use this command when you want to change the account or database details that was previously specified, for example, when you installed the scanner by running the Install-AIPScanner cmdlet.

The new configuration takes effects when the Azure Information Protection Scanner service is next started. This cmdlet does not automatically restart this service.

Examples

Example 1: Change the database and profile for the Azure Information Protection scanner

PS C:\> Set-AIPScanner -SqlServerInstance SERVER1\AIPSCANNER -Profile EU

Azure Information Protection Scanner service configuration change completed successfully.

This command configures the Azure Information Protection scanner to use the SQL Server database instance named AIPSCANNER on the server named SERVER1, using the scanner configuration database named AIPScanner_EU.

Parameters

-Cluster

Note

This parameter is required for the scanner from the unified labeling client. From version 2.7.0.0, we recommend using Cluster switch instead of Profile switch.

Specifies the scanner database name for configuration.

For Azure Information Protection client (classic), this parameter is optional and if not specified, the default database name for the scanner is AIPScanner_<computer_name>. When you specify a cluster name with this parameter, the database name for the scanner is AIPScanner_<cluster_name>.

For Azure Information Protection unified labeling client, this parameter is not optional and you must specify a cluster name. The database name for the scanner is AIPScannerUL_<cluster_name>.

If the database doesn't exist when the scanner is installed, the Install-AIPScanner command creates it.

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

Note: For the scanner from the unified labeling client, this parameter is required. From version 2.7.0.0, we recommend using Cluster switch instead of Profile switch.

Specifies that the scanner uses a named database name for its configuration. If this parameter is not specified for the scanner from the classic client, the default database name for the scanner is AIPScanner_<computer_name>. When you specify a profile name, this database name changes to AIPScanner_<profile_name>.

For the scanner from the unified labeling client, which must be installed with a profile name, the database name created is AIPScannerUL_<profile_name>.

If the database doesn't exist when the scanner is installed, the Install-AIIPScanner command creates it.

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

Specifies a PSCredential object for the new service account to run the Azure Information Protection Scanner service. For the user name, use the following format: Domain\Username. You are prompted for a password.

To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Cmdlet.

If you do not specify this parameter, you are prompted for the user name and password.

This account must be an Active Directory account. For additional requirements, see Prerequisites for the Azure Information Protection scanner.

Type:PSCredential
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SqlServerInstance

Specifies the new SQL Server instance on which to create a database for the Azure Information Protection scanner.

For information about the SQL Server requirements, see Prerequisites for the Azure Information Protection scanner.

For the default instance, specify the server name. For example: SQLSERVER1.

For a named instance, specify the server name and instance name. For example: SQLSERVER1\AIPSCANNER.

For SQL Server Express, specify the server name and SQLEXPRESS. For example: SQLSERVER1\SQLEXPRESS.

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

System.Object