Test-MgBetaInformationProtectionPolicyLabelApplication

Module:

Microsoft.Graph.Beta.Identity.SignIns

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 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-MgBetaInformationProtectionPolicyLabelApplication
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-ContentInfo <IMicrosoftGraphContentInfo>]
    [-LabelingOptions <IMicrosoftGraphLabelingOptions>]
    [-Headers <IDictionary>]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Test-MgBetaInformationProtectionPolicyLabelApplication
    -BodyParameter <IPaths1Aushj1InformationprotectionPolicyLabelsMicrosoftGraphEvaluateapplicationPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

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 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.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"
		"metadata@odata.type" = "#Collection(microsoft.graph.keyValuePair)"
		metadata = @(
			@{
				"@odata.type" = "#microsoft.graph.keyValuePair"
				name = "MSIP_Label_722a5300-ac39-4c9a-88e3-f54c46676417_Enabled"
				value = "True"
			}
			@{
				"@odata.type" = "#microsoft.graph.keyValuePair"
				name = "MSIP_Label_722a5300-ac39-4c9a-88e3-f54c46676417_Method"
				value = "Standard"
			}
			@{
				"@odata.type" = "#microsoft.graph.keyValuePair"
				name = "MSIP_Label_722a5300-ac39-4c9a-88e3-f54c46676417_SetDate"
				value = "1/1/0001 12:00:00 AM"
			}
			@{
				"@odata.type" = "#microsoft.graph.keyValuePair"
				name = "MSIP_Label_722a5300-ac39-4c9a-88e3-f54c46676417_SiteId"
				value = "cfa4cf1d-a337-4481-aa99-19d8f3d63f7c"
			}
			@{
				"@odata.type" = "#microsoft.graph.keyValuePair"
				name = "MSIP_Label_722a5300-ac39-4c9a-88e3-f54c46676417_Name"
				value = "General"
			}
			@{
				"@odata.type" = "#microsoft.graph.keyValuePair"
				name = "MSIP_Label_722a5300-ac39-4c9a-88e3-f54c46676417_ContentBits"
				value = "0"
			}
			@{
				"@odata.type" = "#microsoft.graph.keyValuePair"
				name = "MSIP_Label_722a5300-ac39-4c9a-88e3-f54c46676417_ActionId"
				value = "00000000-0000-0000-0000-000000000000"
			}
		)
	}
	labelingOptions = @{
		"@odata.type" = "#microsoft.graph.labelingOptions"
		"assignmentMethod@odata.type" = "#microsoft.graph.assignmentMethod"
		assignmentMethod = "standard"
		"labelId@odata.type" = "#Guid"
		labelId = "97309856-9c28-4ac6-9382-5f8bc20c457b"
		downgradeJustification = $null
		"extendedProperties@odata.type" = "#Collection(microsoft.graph.keyValuePair)"
		extendedProperties = @(
		)
	}
}

Test-MgBetaInformationProtectionPolicyLabelApplication -BodyParameter $params

This example shows how to use the Test-MgBetaInformationProtectionPolicyLabelApplication 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:	IPaths1Aushj1InformationprotectionPolicyLabelsMicrosoftGraphEvaluateapplicationPostRequestbodyContentApplicationJsonSchema
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:	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

-LabelingOptions

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

Type:	IMicrosoftGraphLabelingOptions
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

-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.IPaths1Aushj1InformationprotectionPolicyLabelsMicrosoftGraphEvaluateapplicationPostRequestbodyContentApplicationJsonSchema

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 <IPaths1Aushj1InformationprotectionPolicyLabelsMicrosoftGraphEvaluateapplicationPostRequestbodyContentApplicationJsonSchema>: .

• [(Any) <Object>]: This indicates any property can be added to this object.
• [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
• [LabelingOptions <IMicrosoftGraphLabelingOptions>]: labelingOptions
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [AssignmentMethod <String>]: assignmentMethod
  • [DowngradeJustification <IMicrosoftGraphDowngradeJustification>]: 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 <IMicrosoftGraphKeyValuePair- []>]: Extended properties will be parsed and returned in the standard MIP labeled metadata format as part of the label information.
  • [LabelId <String>]: The GUID of the label that should be applied to the information.

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

LABELINGOPTIONS <IMicrosoftGraphLabelingOptions>: labelingOptions

• [(Any) <Object>]: This indicates any property can be added to this object.
• [AssignmentMethod <String>]: assignmentMethod
• [DowngradeJustification <IMicrosoftGraphDowngradeJustification>]: 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 <IMicrosoftGraphKeyValuePair- []>]: Extended properties will be parsed and returned in the standard MIP 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.

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.beta.identity.signins/test-mgbetainformationprotectionpolicylabelapplication
• https://learn.microsoft.com/graph/api/informationprotectionlabel-evaluateapplication?view=graph-rest-beta