Test-MgBetaUserSecurityInformationProtectionSensitivityLabelApplication
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 manually or explicitly by a user or service, rather than automatically based on file contents. Given contentInfo, which includes existing content metadata key-value pairs, and labelingOptions as an input, the API returns an informationProtectionAction object that contains one of more of the following:
Syntax
Test-MgBetaUserSecurityInformationProtectionSensitivityLabelApplication
-UserId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-ContentInfo <IMicrosoftGraphSecurityContentInfo>]
[-LabelingOptions <IMicrosoftGraphSecurityLabelingOptions>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Test-MgBetaUserSecurityInformationProtectionSensitivityLabelApplication
-UserId <String>
-BodyParameter <IPaths1Ssqny1UsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateapplicationPostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Test-MgBetaUserSecurityInformationProtectionSensitivityLabelApplication
-InputObject <IUsersActionsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-ContentInfo <IMicrosoftGraphSecurityContentInfo>]
[-LabelingOptions <IMicrosoftGraphSecurityLabelingOptions>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Test-MgBetaUserSecurityInformationProtectionSensitivityLabelApplication
-InputObject <IUsersActionsIdentity>
-BodyParameter <IPaths1Ssqny1UsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateapplicationPostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
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 manually or explicitly by a user or service, rather than automatically based on file contents. Given contentInfo, which includes existing content metadata key-value pairs, and labelingOptions as an input, the API returns an informationProtectionAction object 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.Users.Actions
$params = @{
contentInfo = @{
"@odata.type" = "#microsoft.graph.security.contentInfo"
"format@odata.type" = "#microsoft.graph.security.contentFormat"
contentFormat = "File"
format = "default"
identifier = $null
"state@odata.type" = "#microsoft.graph.security.contentState"
state = "rest"
"metadata@odata.type" = "#Collection(microsoft.graph.security.keyValuePair)"
metadata = @(
@{
"@odata.type" = "#microsoft.graph.security.keyValuePair"
name = "MSIP_Label_3a80e051-487c-40d4-b491-73ad25d997e6_Enabled"
value = "True"
}
@{
"@odata.type" = "#microsoft.graph.security.keyValuePair"
name = "MSIP_Label_3a80e051-487c-40d4-b491-73ad25d997e6_Method"
value = "Standard"
}
@{
"@odata.type" = "#microsoft.graph.security.keyValuePair"
name = "MSIP_Label_3a80e051-487c-40d4-b491-73ad25d997e6_SetDate"
value = "1/1/0001 12:00:00 AM"
}
@{
"@odata.type" = "#microsoft.graph.security.keyValuePair"
name = "MSIP_Label_3a80e051-487c-40d4-b491-73ad25d997e6_SiteId"
value = "cfa4cf1d-a337-4481-aa99-19d8f3d63f7c"
}
@{
"@odata.type" = "#microsoft.graph.security.keyValuePair"
name = "MSIP_Label_3a80e051-487c-40d4-b491-73ad25d997e6_Name"
value = "LabelScopedToBob_Tests"
}
@{
"@odata.type" = "#microsoft.graph.security.keyValuePair"
name = "MSIP_Label_3a80e051-487c-40d4-b491-73ad25d997e6_ContentBits"
value = "0"
}
@{
"@odata.type" = "#microsoft.graph.security.keyValuePair"
name = "MSIP_Label_3a80e051-487c-40d4-b491-73ad25d997e6_ActionId"
value = "00000000-0000-0000-0000-000000000000"
}
)
}
labelingOptions = @{
"@odata.type" = "#microsoft.graph.security.labelingOptions"
"assignmentMethod@odata.type" = "#microsoft.graph.security.assignmentMethod"
assignmentMethod = "standard"
"labelId@odata.type" = "#Guid"
labelId = "836ff34f-b604-4a62-a68c-d6be4205d569"
downgradeJustification = @{
justificationMessage = "Justified"
isDowngradeJustified = $true
}
"extendedProperties@odata.type" = "#Collection(microsoft.graph.security.keyValuePair)"
extendedProperties = @(
)
}
}
Test-MgBetaUserSecurityInformationProtectionSensitivityLabelApplication -UserId $userId -BodyParameter $params
This example shows how to use the Test-MgBetaUserSecurityInformationProtectionSensitivityLabelApplication 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: | IPaths1Ssqny1UsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateapplicationPostRequestbodyContentApplicationJsonSchema |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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: | IUsersActionsIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LabelingOptions
labelingOptions To construct, see NOTES section for LABELINGOPTIONS properties and create a hash table.
Type: | IMicrosoftGraphSecurityLabelingOptions |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
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.IPaths1Ssqny1UsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateapplicationPostRequestbodyContentApplicationJsonSchema
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 <IPaths1Ssqny1UsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateapplicationPostRequestbodyContentApplicationJsonSchema>
: .
[(Any) <Object>]
: This indicates any property can be added to this object.[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
[LabelingOptions <IMicrosoftGraphSecurityLabelingOptions>]
: labelingOptions[(Any) <Object>]
: This indicates any property can be added to this object.[AssignmentMethod <String>]
: assignmentMethod[DowngradeJustification <IMicrosoftGraphSecurityDowngradeJustification>]
: downgradeJustification[(Any) <Object>]
: This indicates any property can be added to this object.[IsDowngradeJustified <Boolean?>]
: Indicates whether the downgrade is or isn't justified.[JustificationMessage <String>]
: Message that indicates why a downgrade is justified. The message appears in administrative logs.
[ExtendedProperties <IMicrosoftGraphSecurityKeyValuePair-
[]>]
: Extended properties will be parsed and returned in the standard Microsoft Purview Information Protection labeled metadata format as part of the label information.[LabelId <String>]
: The GUID of the label that should be applied to the information.
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
LABELINGOPTIONS <IMicrosoftGraphSecurityLabelingOptions>
: labelingOptions
[(Any) <Object>]
: This indicates any property can be added to this object.[AssignmentMethod <String>]
: assignmentMethod[DowngradeJustification <IMicrosoftGraphSecurityDowngradeJustification>]
: downgradeJustification[(Any) <Object>]
: This indicates any property can be added to this object.[IsDowngradeJustified <Boolean?>]
: Indicates whether the downgrade is or isn't justified.[JustificationMessage <String>]
: Message that indicates why a downgrade is justified. The message appears in administrative logs.
[ExtendedProperties <IMicrosoftGraphSecurityKeyValuePair-
[]>]
: Extended properties will be parsed and returned in the standard Microsoft Purview Information Protection labeled metadata format as part of the label information.[Name <String>]
: Name for this key-value pair.[Value <String>]
: Value for this key-value pair.
[LabelId <String>]
: The GUID of the label that should be applied to the information.