Share via

Test-MgBetaInformationProtectionPolicyLabelClassificationResult

  • Reference
Module:
Microsoft.Graph.Beta.Identity.SignIns

Using classification results, compute the information protection label that should be applied and return the set of actions that must be taken to correctly label the information. This API is useful when a label should be set automatically based on classification of the file contents, rather than labeled directly by a user or service. To evaluate based on classification results, provide contentInfo, which includes existing content metadata key/value pairs, and classification results. The API returns an informationProtectionAction that contains one of more of the following:

Syntax

Test-MgBetaInformationProtectionPolicyLabelClassificationResult
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-ClassificationResults <IMicrosoftGraphClassificationResult[]>]
    [-ContentInfo <IMicrosoftGraphContentInfo>]
    [-Headers <IDictionary>]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Test-MgBetaInformationProtectionPolicyLabelClassificationResult
    -BodyParameter <IPathsLeqqhcInformationprotectionPolicyLabelsMicrosoftGraphEvaluateclassificationresultsPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Using classification results, compute the information protection label that should be applied and return the set of actions that must be taken to correctly label the information. This API is useful when a label should be set automatically based on classification of the file contents, rather than labeled directly by a user or service. To evaluate based on classification results, provide contentInfo, which includes existing content metadata key/value pairs, and classification results. The API returns an informationProtectionAction that contains one of more of the following:

Permissions

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) InformationProtectionPolicy.Read Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application InformationProtectionPolicy.Read.All Not available.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.Identity.SignIns

$params = @{
	contentInfo = @{
		"@odata.type" = "#microsoft.graph.contentInfo"
		"format@odata.type" = "#microsoft.graph.contentFormat"
		format = "default"
		identifier = $null
		"state@odata.type" = "#microsoft.graph.contentState"
		state = "rest"
	}
	classificationResults = @(
		@{
			sensitiveTypeId = "cb353f78-2b72-4c3c-8827-92ebe4f69fdf"
			count = 4
			confidenceLevel = 75
		}
	)
}

Test-MgBetaInformationProtectionPolicyLabelClassificationResult -BodyParameter $params

This example shows how to use the Test-MgBetaInformationProtectionPolicyLabelClassificationResult Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BodyParameter

. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type:IPathsLeqqhcInformationprotectionPolicyLabelsMicrosoftGraphEvaluateclassificationresultsPostRequestbodyContentApplicationJsonSchema
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ClassificationResults

. To construct, see NOTES section for CLASSIFICATIONRESULTS properties and create a hash table.

Type:IMicrosoftGraphClassificationResult[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContentInfo

contentInfo To construct, see NOTES section for CONTENTINFO properties and create a hash table.

Type:IMicrosoftGraphContentInfo
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Headers

Optional headers that will be added to the request.

Type:IDictionary
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:String
Aliases:RHV
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IPathsLeqqhcInformationprotectionPolicyLabelsMicrosoftGraphEvaluateclassificationresultsPostRequestbodyContentApplicationJsonSchema

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphInformationProtectionAction

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IPathsLeqqhcInformationprotectionPolicyLabelsMicrosoftGraphEvaluateclassificationresultsPostRequestbodyContentApplicationJsonSchema>: .

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [ClassificationResults <IMicrosoftGraphClassificationResult- []>]:
    • [ConfidenceLevel <Int32?>]: The confidence level, 0 to 100, of the result.
    • [Count <Int32?>]: The number of instances of the specific information type in the input.
    • [SensitiveTypeId <String>]: The GUID of the discovered sensitive information type.
  • [ContentInfo <IMicrosoftGraphContentInfo>]: contentInfo
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Format <String>]: contentFormat
    • [Identifier <String>]: Identifier used for Azure Information Protection Analytics.
    • [Metadata <IMicrosoftGraphKeyValuePair- []>]: Existing Microsoft Purview Information Protection metadata is passed as key/value pairs, where the key is the MSIPLabelGUID_PropName.
      • [Name <String>]: Name for this key-value pair
      • [Value <String>]: Value for this key-value pair
    • [State <String>]: contentState

CLASSIFICATIONRESULTS <IMicrosoftGraphClassificationResult- []>: .

  • [ConfidenceLevel <Int32?>]: The confidence level, 0 to 100, of the result.
  • [Count <Int32?>]: The number of instances of the specific information type in the input.
  • [SensitiveTypeId <String>]: The GUID of the discovered sensitive information type.

CONTENTINFO <IMicrosoftGraphContentInfo>: contentInfo

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Format <String>]: contentFormat
  • [Identifier <String>]: Identifier used for Azure Information Protection Analytics.
  • [Metadata <IMicrosoftGraphKeyValuePair- []>]: Existing Microsoft Purview Information Protection metadata is passed as key/value pairs, where the key is the MSIPLabelGUID_PropName.
    • [Name <String>]: Name for this key-value pair
    • [Value <String>]: Value for this key-value pair
  • [State <String>]: contentState