Share via

Test-MgBetaUserSecurityInformationProtectionSensitivityLabelRemoval

Module:
Microsoft.Graph.Beta.Security Module

Indicate to the consuming application what actions it should take to remove the label information. Given contentInfo as an input, which includes existing content metadata key-value pairs, the API returns an informationProtectionAction that contains some combination of one or more of the following:

Syntax

EvaluateExpanded (Default) 

Test-MgBetaUserSecurityInformationProtectionSensitivityLabelRemoval
    -UserId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-ContentInfo <IMicrosoftGraphSecurityContentInfo>]
    [-DowngradeJustification <IMicrosoftGraphSecurityDowngradeJustification>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Evaluate 

Test-MgBetaUserSecurityInformationProtectionSensitivityLabelRemoval
    -UserId <string>
    -BodyParameter <IPathsZhdpmhUsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateremovalPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

EvaluateViaIdentityExpanded 

Test-MgBetaUserSecurityInformationProtectionSensitivityLabelRemoval
    -InputObject <ISecurityIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-ContentInfo <IMicrosoftGraphSecurityContentInfo>]
    [-DowngradeJustification <IMicrosoftGraphSecurityDowngradeJustification>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

EvaluateViaIdentity 

Test-MgBetaUserSecurityInformationProtectionSensitivityLabelRemoval
    -InputObject <ISecurityIdentity>
    -BodyParameter <IPathsZhdpmhUsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateremovalPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Indicate to the consuming application what actions it should take to remove the label information. Given contentInfo as an input, which includes existing content metadata key-value pairs, the API returns an informationProtectionAction that contains some combination of one or 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"
		identifier = $null
		state = "rest"
		metadata = @(
			@{
				name = "MSIP_Label_836ff34f-b604-4a62-a68c-d6be4205d569_Enabled"
				value = "True"
			}
			@{
				name = "MSIP_Label_836ff34f-b604-4a62-a68c-d6be4205d569_Method"
				value = "Standard"
			}
			@{
				name = "MSIP_Label_836ff34f-b604-4a62-a68c-d6be4205d569_SetDate"
				value = "1/1/0001 12:00:00 AM"
			}
			@{
				"@odata.type" = "#microsoft.graph.security.keyValuePair"
				name = "MSIP_Label_836ff34f-b604-4a62-a68c-d6be4205d569_SiteId"
				value = "cfa4cf1d-a337-4481-aa99-19d8f3d63f7c"
			}
			@{
				"@odata.type" = "#microsoft.graph.security.keyValuePair"
				name = "MSIP_Label_836ff34f-b604-4a62-a68c-d6be4205d569_Name"
				value = "LabelScopedToBob_Tests"
			}
			@{
				"@odata.type" = "#microsoft.graph.security.keyValuePair"
				name = "MSIP_Label_836ff34f-b604-4a62-a68c-d6be4205d569_ContentBits"
				value = "0"
			}
			@{
				"@odata.type" = "#microsoft.graph.security.keyValuePair"
				name = "MSIP_Label_836ff34f-b604-4a62-a68c-d6be4205d569_ActionId"
				value = "00000000-0000-0000-0000-000000000000"
			}
		)
	}
	downgradeJustification = @{
		justificationMessage = "The information has been declassified."
		isDowngradeJustified = $true
	}
}

Test-MgBetaUserSecurityInformationProtectionSensitivityLabelRemoval -UserId $userId -BodyParameter $params

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

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

EvaluateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
EvaluateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

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

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IPathsZhdpmhUsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateremovalPostRequestbodyContentApplicationJsonSchema
Supports wildcards:False
DontShow:False

Parameter sets

EvaluateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
Evaluate
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Break

Wait for .NET debugger to attach

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ContentInfo

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

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphSecurityContentInfo
Supports wildcards:False
DontShow:False

Parameter sets

EvaluateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
EvaluateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DowngradeJustification

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

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphSecurityDowngradeJustification
Supports wildcards:False
DontShow:False

Parameter sets

EvaluateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
EvaluateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:System.Collections.IDictionary
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

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

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.ISecurityIdentity
Supports wildcards:False
DontShow:False

Parameter sets

EvaluateViaIdentityExpanded
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
EvaluateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Proxy

The URI for the proxy server to use

Parameter properties

Type:System.Uri
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:System.Management.Automation.PSCredential
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserId

The unique identifier of user

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

EvaluateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Evaluate
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IPathsZhdpmhUsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateremovalPostRequestbodyContentApplicationJsonSchema

{{ Fill in the Description }}

Microsoft.Graph.Beta.PowerShell.Models.ISecurityIdentity

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphSecurityInformationProtectionAction

{{ Fill in the Description }}

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 <IPathsZhdpmhUsersUserIdSecurityInformationprotectionSensitivitylabelsMicrosoftGraphSecurityEvaluateremovalPostRequestbodyContentApplicationJsonSchema>: . [(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 [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.

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

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.

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 [ContentFormats <String[]>]: Usage: contentFormats={contentFormats} [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 [IdentityAccountsId <String>]: The unique identifier of identityAccounts [IncidentId <String>]: The unique identifier of incident [IncidentTaskId <String>]: The unique identifier of incidentTask [IntelligenceProfileId <String>]: The unique identifier of intelligenceProfile [IntelligenceProfileIndicatorId <String>]: The unique identifier of intelligenceProfileIndicator [LabelIds <String[]>]: Usage: labelIds={labelIds} [LandingPageDetailId <String>]: The unique identifier of landingPageDetail [LandingPageId <String>]: The unique identifier of landingPage [Locale <String>]: Usage: locale='{locale}' [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 [PolicyFileId <String>]: The unique identifier of policyFile [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 [SensitivityLabelId1 <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