Skip to content

Latest commit

 

History

History
334 lines (274 loc) · 13.6 KB

Test-MgBetaUserSecurityInformationProtectionSensitivityLabelClassificationResult.md

File metadata and controls

334 lines (274 loc) · 13.6 KB
Raw
external help file Module Name online version schema
Microsoft.Graph.Beta.Users.Actions-help.xml
Microsoft.Graph.Beta.Users.Actions
2.0.0

Test-MgBetaUserSecurityInformationProtectionSensitivityLabelClassificationResult

SYNOPSIS

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

EvaluateExpanded (Default)

Test-MgBetaUserSecurityInformationProtectionSensitivityLabelClassificationResult -UserId <String>
 [-ResponseHeadersVariable <String>] [-AdditionalProperties <Hashtable>]
 [-ClassificationResults <IMicrosoftGraphSecurityClassificationResult[]>]
 [-ContentInfo <IMicrosoftGraphSecurityContentInfo>] [-Headers <IDictionary>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

Evaluate

Test-MgBetaUserSecurityInformationProtectionSensitivityLabelClassificationResult -UserId <String>
 -BodyParameter <IPaths12Nib3JUsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateclassificationresultsPostRequestbodyContentApplicationJsonSchema>
 [-ResponseHeadersVariable <String>] [-Headers <IDictionary>] [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

EvaluateViaIdentityExpanded

Test-MgBetaUserSecurityInformationProtectionSensitivityLabelClassificationResult
 -InputObject <IUsersActionsIdentity> [-ResponseHeadersVariable <String>] [-AdditionalProperties <Hashtable>]
 [-ClassificationResults <IMicrosoftGraphSecurityClassificationResult[]>]
 [-ContentInfo <IMicrosoftGraphSecurityContentInfo>] [-Headers <IDictionary>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

EvaluateViaIdentity

Test-MgBetaUserSecurityInformationProtectionSensitivityLabelClassificationResult
 -InputObject <IUsersActionsIdentity>
 -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 [!INCLUDE permissions-table]

PARAMETERS

-AdditionalProperties

Additional Parameters

Type: Hashtable
Parameter Sets: EvaluateExpanded, EvaluateViaIdentityExpanded
Aliases:

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

-BodyParameter

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

Type: IPaths12Nib3JUsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateclassificationresultsPostRequestbodyContentApplicationJsonSchema
Parameter Sets: Evaluate, EvaluateViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ClassificationResults

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

Type: IMicrosoftGraphSecurityClassificationResult[]
Parameter Sets: EvaluateExpanded, EvaluateViaIdentityExpanded
Aliases:

Required: False
Position: Named
Default value: None
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
Parameter Sets: EvaluateExpanded, EvaluateViaIdentityExpanded
Aliases:

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

-Headers

Optional headers that will be added to the request.

Type: IDictionary
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type: IUsersActionsIdentity
Parameter Sets: EvaluateViaIdentityExpanded, EvaluateViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

-ResponseHeadersVariable

Optional Response Headers Variable.

Type: String
Parameter Sets: (All)
Aliases: RHV

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

-UserId

The unique identifier of user

Type: String
Parameter Sets: EvaluateExpanded, Evaluate
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Graph.Beta.PowerShell.Models.IPaths12Nib3JUsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateclassificationresultsPostRequestbodyContentApplicationJsonSchema

Microsoft.Graph.Beta.PowerShell.Models.IUsersActionsIdentity

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 <IUsersActionsIdentity>: Identity Parameter

  • [AccessReviewInstanceId <String>]: The unique identifier of accessReviewInstance
  • [AccessReviewStageId <String>]: The unique identifier of accessReviewStage
  • [AppLogCollectionRequestId <String>]: The unique identifier of appLogCollectionRequest
  • [AuthenticationMethodId <String>]: The unique identifier of authenticationMethod
  • [CalendarId <String>]: The unique identifier of calendar
  • [ChatId <String>]: The unique identifier of chat
  • [ChatMessageId <String>]: The unique identifier of chatMessage
  • [ChatMessageId1 <String>]: The unique identifier of chatMessage
  • [CloudPcId <String>]: The unique identifier of cloudPC
  • [ContentTypeId <String>]: The unique identifier of contentType
  • [DeviceEnrollmentConfigurationId <String>]: The unique identifier of deviceEnrollmentConfiguration
  • [DeviceLogCollectionResponseId <String>]: The unique identifier of deviceLogCollectionResponse
  • [DocumentSetVersionId <String>]: The unique identifier of documentSetVersion
  • [DriveId <String>]: The unique identifier of drive
  • [DriveItemId <String>]: The unique identifier of driveItem
  • [DriveItemVersionId <String>]: The unique identifier of driveItemVersion
  • [EventId <String>]: The unique identifier of event
  • [EventId1 <String>]: The unique identifier of event
  • [JoinWebUrl <String>]: Alternate key of onlineMeeting
  • [ListItemId <String>]: The unique identifier of listItem
  • [ListItemVersionId <String>]: The unique identifier of listItemVersion
  • [MailFolderId <String>]: The unique identifier of mailFolder
  • [MailFolderId1 <String>]: The unique identifier of mailFolder
  • [ManagedDeviceId <String>]: The unique identifier of managedDevice
  • [MessageId <String>]: The unique identifier of message
  • [MobileAppTroubleshootingEventId <String>]: The unique identifier of mobileAppTroubleshootingEvent
  • [NotebookId <String>]: The unique identifier of notebook
  • [OnenotePageId <String>]: The unique identifier of onenotePage
  • [OnenoteSectionId <String>]: The unique identifier of onenoteSection
  • [OnlineMeetingId <String>]: The unique identifier of onlineMeeting
  • [OutlookTaskFolderId <String>]: The unique identifier of outlookTaskFolder
  • [OutlookTaskGroupId <String>]: The unique identifier of outlookTaskGroup
  • [OutlookTaskId <String>]: The unique identifier of outlookTask
  • [PermissionId <String>]: The unique identifier of permission
  • [PlannerPlanId <String>]: The unique identifier of plannerPlan
  • [SensitivityLabelId <String>]: The unique identifier of sensitivityLabel
  • [SubscriptionId <String>]: The unique identifier of subscription
  • [TeamsAppInstallationId <String>]: The unique identifier of teamsAppInstallation
  • [TodoTaskId <String>]: The unique identifier of todoTask
  • [TodoTaskListId <String>]: The unique identifier of todoTaskList
  • [UserId <String>]: The unique identifier of user

RELATED LINKS

https://learn.microsoft.com/powershell/module/microsoft.graph.beta.users.actions/test-mgbetausersecurityinformationprotectionsensitivitylabelclassificationresult

https://learn.microsoft.com/graph/api/security-sensitivitylabel-evaluateclassificationresults?view=graph-rest-1.0