Test-DataClassification

Reference

Module:: ExchangePowerShell

Applies to:: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Test-DataClassification cmdlet to find the confidence and count of a sensitive information type that's found in a specified text string.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

Test-DataClassification
    [-ClassificationNames <String[]>]
    [-DomainController <Fqdn>]
    [-FileExtension <String>]
    [-TestTextExtractionResults <TestTextExtractionResult[]>]
    [-TextToClassify <String>]
    [<CommonParameters>]

Description

This cmdlet lets you know the classification results that are returned by the Microsoft classification engine in specific text. The classification results include the sensitive type, its count, and confidence.

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

$r = Test-DataClassification -TextToClassify "Credit card information Visa: xxxx xxxx xxxx xxxx. Patient Identifier or SSN: xxx-xx-xxxx"

$r.ClassificationResults

This example lists all sensitive info types, their count, and confidence in the specified text string.

Parameters

-ClassificationNames

The ClassificationNames parameter specifies the sensitive information type that you want to find in the text specified by the TextToClassify parameter. Valid values are:

Name
Id (GUID value)

You can specify multiple values separated by commas.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance

-DomainController

This parameter is functional only in on-premises Exchange.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Type:	Fqdn
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019, Security & Compliance

-FileExtension

This parameter is available only in the cloud-based service.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online, Security & Compliance

-TestTextExtractionResults

The TestTextExtractionResults parameter specifies the extracted text from the Test-TextExtraction cmdlet as the input text stream.

Type:	TestTextExtractionResult[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance

-TextToClassify

The TextToClassify parameter specifies the text string for which classification results need to be shown.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance