Test-MgBetaUserSecurityInformationProtectionSensitivityLabelClassificationResult
Use the classification results to compute the sensitivity 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 the 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-MgBetaUserSecurityInformationProtectionSensitivityLabelClassificationResult
-UserId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-ClassificationResults <IMicrosoftGraphSecurityClassificationResult[]>]
[-ContentInfo <IMicrosoftGraphSecurityContentInfo>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Test-MgBetaUserSecurityInformationProtectionSensitivityLabelClassificationResult
-UserId <String>
-BodyParameter <IPaths12Nib3JUsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateclassificationresultsPostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Test-MgBetaUserSecurityInformationProtectionSensitivityLabelClassificationResult
-InputObject <ISecurityIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-ClassificationResults <IMicrosoftGraphSecurityClassificationResult[]>]
[-ContentInfo <IMicrosoftGraphSecurityContentInfo>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Test-MgBetaUserSecurityInformationProtectionSensitivityLabelClassificationResult
-InputObject <ISecurityIdentity>
-BodyParameter <IPaths12Nib3JUsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateclassificationresultsPostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Use the classification results to compute the sensitivity 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 the 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 | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | InformationProtectionPolicy.Read, |
Delegated (personal Microsoft account) | Not supported |
Application | InformationProtectionPolicy.Read.All, |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Beta.Security
$params = @{
contentInfo = @{
"@odata.type" = "#microsoft.graph.security.contentInfo"
"format@odata.type" = "#microsoft.graph.security.contentFormat"
format = "default"
contentFormat = "File"
identifier = "c:\user\new.docx"
"state@odata.type" = "#microsoft.graph.security.contentState"
state = "rest"
metadata = @(
)
}
classificationResults = @(
@{
sensitiveTypeId = "50842eb7-edc8-4019-85dd-5a5c1f2bb085"
count = 7
confidenceLevel = 99
}
)
}
Test-MgBetaUserSecurityInformationProtectionSensitivityLabelClassificationResult -UserId $userId -BodyParameter $params
This example shows how to use the Test-MgBetaUserSecurityInformationProtectionSensitivityLabelClassificationResult 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: | IPaths12Nib3JUsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateclassificationresultsPostRequestbodyContentApplicationJsonSchema |
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: | IMicrosoftGraphSecurityClassificationResult[] |
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: | IMicrosoftGraphSecurityContentInfo |
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 |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | ISecurityIdentity |
Position: | Named |
Default value: | None |
Required: | True |
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 |
-UserId
The unique identifier of user
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
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.IPaths12Nib3JUsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateclassificationresultsPostRequestbodyContentApplicationJsonSchema
Microsoft.Graph.Beta.PowerShell.Models.ISecurityIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphSecurityInformationProtectionAction
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 <IPaths12Nib3JUsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateclassificationresultsPostRequestbodyContentApplicationJsonSchema>
: .
[(Any) <Object>]
: This indicates any property can be added to this object.[ClassificationResults <IMicrosoftGraphSecurityClassificationResult-
[]>]
:[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 <IMicrosoftGraphSecurityContentInfo>]
: contentInfo[(Any) <Object>]
: This indicates any property can be added to this object.[ContentFormat <String>]
: The format of the content to be labeled. Possible values are: file, email.[Identifier <String>]
: Identifier used for Azure Information Protection Analytics.[Metadata <IMicrosoftGraphSecurityKeyValuePair-
[]>]
: 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 <IMicrosoftGraphSecurityClassificationResult-
[]>
: .
[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 <IMicrosoftGraphSecurityContentInfo>
: contentInfo
[(Any) <Object>]
: This indicates any property can be added to this object.[ContentFormat <String>]
: The format of the content to be labeled. Possible values are: file, email.[Identifier <String>]
: Identifier used for Azure Information Protection Analytics.[Metadata <IMicrosoftGraphSecurityKeyValuePair-
[]>]
: 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
INPUTOBJECT <ISecurityIdentity>
: Identity Parameter
[AlertId <String>]
: The unique identifier of alert[AnalyzedEmailId <String>]
: The unique identifier of analyzedEmail[ArticleId <String>]
: The unique identifier of article[ArticleIndicatorId <String>]
: The unique identifier of articleIndicator[AttackSimulationOperationId <String>]
: The unique identifier of attackSimulationOperation[AuditLogQueryId <String>]
: The unique identifier of auditLogQuery[AuditLogRecordId <String>]
: The unique identifier of auditLogRecord[AuthoredNoteId <String>]
: The unique identifier of authoredNote[AuthorityTemplateId <String>]
: The unique identifier of authorityTemplate[CaseOperationId <String>]
: The unique identifier of caseOperation[CategoryTemplateId <String>]
: The unique identifier of categoryTemplate[CitationTemplateId <String>]
: The unique identifier of citationTemplate[CloudAppDiscoveryReportId <String>]
: The unique identifier of cloudAppDiscoveryReport[CloudAppSecurityProfileId <String>]
: The unique identifier of cloudAppSecurityProfile[CustomerInsightTenantId <String>]
: The unique identifier of customerInsight[DataSourceId <String>]
: The unique identifier of dataSource[DepartmentTemplateId <String>]
: The unique identifier of departmentTemplate[DetectionRuleId <String>]
: The unique identifier of detectionRule[DispositionReviewStageNumber <String>]
: The unique identifier of dispositionReviewStage[DomainSecurityProfileId <String>]
: The unique identifier of domainSecurityProfile[EdiscoveryCaseId <String>]
: The unique identifier of ediscoveryCase[EdiscoveryCaseMemberId <String>]
: The unique identifier of ediscoveryCaseMember[EdiscoveryCustodianId <String>]
: The unique identifier of ediscoveryCustodian[EdiscoveryFileId <String>]
: The unique identifier of ediscoveryFile[EdiscoveryHoldPolicyId <String>]
: The unique identifier of ediscoveryHoldPolicy[EdiscoveryNoncustodialDataSourceId <String>]
: The unique identifier of ediscoveryNoncustodialDataSource[EdiscoveryReviewSetId <String>]
: The unique identifier of ediscoveryReviewSet[EdiscoveryReviewSetQueryId <String>]
: The unique identifier of ediscoveryReviewSetQuery[EdiscoveryReviewTagId <String>]
: The unique identifier of ediscoveryReviewTag[EdiscoveryReviewTagId1 <String>]
: The unique identifier of ediscoveryReviewTag[EdiscoverySearchId <String>]
: The unique identifier of ediscoverySearch[EmailThreatSubmissionId <String>]
: The unique identifier of emailThreatSubmission[EmailThreatSubmissionPolicyId <String>]
: The unique identifier of emailThreatSubmissionPolicy[EndUserNotificationDetailId <String>]
: The unique identifier of endUserNotificationDetail[EndUserNotificationId <String>]
: The unique identifier of endUserNotification[FilePlanReferenceTemplateId <String>]
: The unique identifier of filePlanReferenceTemplate[FileSecurityProfileId <String>]
: The unique identifier of fileSecurityProfile[FileThreatSubmissionId <String>]
: The unique identifier of fileThreatSubmission[HealthIssueId <String>]
: The unique identifier of healthIssue[HostComponentId <String>]
: The unique identifier of hostComponent[HostCookieId <String>]
: The unique identifier of hostCookie[HostId <String>]
: The unique identifier of host[HostPairId <String>]
: The unique identifier of hostPair[HostPortId <String>]
: The unique identifier of hostPort[HostSecurityProfileId <String>]
: The unique identifier of hostSecurityProfile[HostSslCertificateId <String>]
: The unique identifier of hostSslCertificate[HostTrackerId <String>]
: The unique identifier of hostTracker[IPSecurityProfileId <String>]
: The unique identifier of ipSecurityProfile[IncidentId <String>]
: The unique identifier of incident[IntelligenceProfileId <String>]
: The unique identifier of intelligenceProfile[IntelligenceProfileIndicatorId <String>]
: The unique identifier of intelligenceProfileIndicator[LandingPageDetailId <String>]
: The unique identifier of landingPageDetail[LandingPageId <String>]
: The unique identifier of landingPage[LoginPageId <String>]
: The unique identifier of loginPage[PartnerSecurityAlertId <String>]
: The unique identifier of partnerSecurityAlert[PassiveDnsRecordId <String>]
: The unique identifier of passiveDnsRecord[PayloadId <String>]
: The unique identifier of payload[ProviderTenantSettingId <String>]
: The unique identifier of providerTenantSetting[RetentionEventId <String>]
: The unique identifier of retentionEvent[RetentionEventTypeId <String>]
: The unique identifier of retentionEventType[RetentionLabelId <String>]
: The unique identifier of retentionLabel[SecureScoreControlProfileId <String>]
: The unique identifier of secureScoreControlProfile[SecureScoreId <String>]
: The unique identifier of secureScore[SecurityActionId <String>]
: The unique identifier of securityAction[SecurityRequirementId <String>]
: The unique identifier of securityRequirement[SecurityScoreHistoryId <String>]
: The unique identifier of securityScoreHistory[SensitivityLabelId <String>]
: The unique identifier of sensitivityLabel[SensorId <String>]
: The unique identifier of sensor[SimulationAutomationId <String>]
: The unique identifier of simulationAutomation[SimulationAutomationRunId <String>]
: The unique identifier of simulationAutomationRun[SimulationId <String>]
: The unique identifier of simulation[SiteSourceId <String>]
: The unique identifier of siteSource[SslCertificateId <String>]
: The unique identifier of sslCertificate[SubcategoryTemplateId <String>]
: The unique identifier of subcategoryTemplate[SubdomainId <String>]
: The unique identifier of subdomain[SubjectRightsRequestId <String>]
: The unique identifier of subjectRightsRequest[TiIndicatorId <String>]
: The unique identifier of tiIndicator[TrainingCampaignId <String>]
: The unique identifier of trainingCampaign[TrainingId <String>]
: The unique identifier of training[TrainingLanguageDetailId <String>]
: The unique identifier of trainingLanguageDetail[UnifiedGroupSourceId <String>]
: The unique identifier of unifiedGroupSource[UrlThreatSubmissionId <String>]
: The unique identifier of urlThreatSubmission[UserId <String>]
: The unique identifier of user[UserPrincipalName <String>]
: Alternate key of user[UserSecurityProfileId <String>]
: The unique identifier of userSecurityProfile[UserSourceId <String>]
: The unique identifier of userSource[VulnerabilityComponentId <String>]
: The unique identifier of vulnerabilityComponent[VulnerabilityId <String>]
: The unique identifier of vulnerability[WhoisHistoryRecordId <String>]
: The unique identifier of whoisHistoryRecord[WhoisRecordId <String>]
: The unique identifier of whoisRecord