Remove a potential threat from end users' mailboxes.
Remediation means to take prescribed action against a threat.
This API can trigger email purge actions like move to junk, move to deleted items, soft delete, hard delete, or move to Inbox.
This API enables scenarios and use cases such as SOAR integration, playbooks, and automations.
For more information read email remediation, trigger action and track actions.
If there is false positives admins can take move to inbox action.
Remove a potential threat from end users' mailboxes.
Remediation means to take prescribed action against a threat.
This API can trigger email purge actions like move to junk, move to deleted items, soft delete, hard delete, or move to Inbox.
This API enables scenarios and use cases such as SOAR integration, playbooks, and automations.
For more information read email remediation, trigger action and track actions.
If there is false positives admins can take move to inbox action.
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type:
SwitchParameter
Default value:
None
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
-Description
Remove a potential threat from end users' mailboxes.
Remediation means to take prescribed action against a threat.
This API can trigger email purge actions like move to junk, move to deleted items, soft delete, hard delete, or move to Inbox.
This API enables scenarios and use cases such as SOAR integration, playbooks, and automations.
For more information read email remediation, trigger action and track actions.
If there is false positives admins can take move to inbox action.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
RemediateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-DisplayName
Remove a potential threat from end users' mailboxes.
Remediation means to take prescribed action against a threat.
This API can trigger email purge actions like move to junk, move to deleted items, soft delete, hard delete, or move to Inbox.
This API enables scenarios and use cases such as SOAR integration, playbooks, and automations.
For more information read email remediation, trigger action and track actions.
If there is false positives admins can take move to inbox action.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
RemediateExpanded
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:
IDictionary
Default value:
None
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
-PassThru
Returns true when the command succeeds
Parameter properties
Type:
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
-RemediateSendersCopy
Remove a potential threat from end users' mailboxes.
Remediation means to take prescribed action against a threat.
This API can trigger email purge actions like move to junk, move to deleted items, soft delete, hard delete, or move to Inbox.
This API enables scenarios and use cases such as SOAR integration, playbooks, and automations.
For more information read email remediation, trigger action and track actions.
If there is false positives admins can take move to inbox action.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Parameter sets
RemediateExpanded
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:
String
Default value:
None
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
-Severity
remediationSeverity
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
RemediateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type:
SwitchParameter
Default value:
None
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.
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.
[(Any) <Object>]: This indicates any property can be added to this object.
[CompositeAuthentication <String>]: A value used by Microsoft 365 to combine email authentication such as SPF, DKIM, and DMARC, to determine whether the message is authentic.
[Dkim <String>]: DomainKeys identified mail (DKIM).
Indicates whether it was pass/fail/soft fail.
[Dmarc <String>]: Domain-based Message Authentication.
Indicates whether it was pass/fail/soft fail.
[SenderPolicyFramework <String>]: Sender Policy Framework (SPF).
Indicates whether it was pass/fail/soft fail.
[BulkComplaintLevel <String>]: The bulk complaint level of the email.
A higher level is more likely to be spam.
[ClientType <String>]:
[Contexts <String- []>]: Provides context of the email.
[DetectionMethods <String- []>]: The methods of detection used.
[Directionality <String>]: antispamDirectionality
[DistributionList <String>]: The distribution list details to which the email was sent.
[EmailClusterId <String>]: The identifier for the group of similar emails clustered based on heuristic analysis of their content.
[ExchangeTransportRules <IMicrosoftGraphSecurityAnalyzedEmailExchangeTransportRuleInfo- []>]: The name of the Exchange transport rules (ETRs) associated with the email.
[Name <String>]: Name of the Exchange transport rules (ETRs) that are part of the email.
[RuleId <String>]: The ETR rule ID.
[ForwardingDetail <String>]:
[InboundConnectorFormattedName <String>]:
[InternetMessageId <String>]: A public-facing identifier for the email that is sent.
The message ID is in the format specified by RFC2822.
[Language <String>]: The detected language of the email content.
[(Any) <Object>]: This indicates any property can be added to this object.
[DisplayName <String>]:
[DomainCreationDateTime <DateTime?>]:
[DomainName <String>]:
[DomainOwner <String>]:
[FromAddress <String>]: The sender email address in the mail From header, also known as the envelope sender or the P1 sender.
[Ipv4 <String>]: The IPv4 address of the last detected mail server that relayed the message.
[Location <String>]:
[MailFromAddress <String>]: The sender email address in the From header, which is visible to email recipients on their email clients.
Also known as P2 sender.
[MailFromDomainName <String>]:
[SizeInBytes <Int32?>]: Size of the email in bytes.
[SpamConfidenceLevel <String>]: Spam confidence of the email.
[(Any) <Object>]: This indicates any property can be added to this object.
[CompositeAuthentication <String>]: A value used by Microsoft 365 to combine email authentication such as SPF, DKIM, and DMARC, to determine whether the message is authentic.
[Dkim <String>]: DomainKeys identified mail (DKIM).
Indicates whether it was pass/fail/soft fail.
[Dmarc <String>]: Domain-based Message Authentication.
Indicates whether it was pass/fail/soft fail.
[SenderPolicyFramework <String>]: Sender Policy Framework (SPF).
Indicates whether it was pass/fail/soft fail.
[BulkComplaintLevel <String>]: The bulk complaint level of the email.
A higher level is more likely to be spam.
[ClientType <String>]:
[Contexts <String- []>]: Provides context of the email.
[DetectionMethods <String- []>]: The methods of detection used.
[Directionality <String>]: antispamDirectionality
[DistributionList <String>]: The distribution list details to which the email was sent.
[EmailClusterId <String>]: The identifier for the group of similar emails clustered based on heuristic analysis of their content.
[ExchangeTransportRules <IMicrosoftGraphSecurityAnalyzedEmailExchangeTransportRuleInfo- []>]: The name of the Exchange transport rules (ETRs) associated with the email.
[Name <String>]: Name of the Exchange transport rules (ETRs) that are part of the email.
[RuleId <String>]: The ETR rule ID.
[ForwardingDetail <String>]:
[InboundConnectorFormattedName <String>]:
[InternetMessageId <String>]: A public-facing identifier for the email that is sent.
The message ID is in the format specified by RFC2822.
[Language <String>]: The detected language of the email content.
[(Any) <Object>]: This indicates any property can be added to this object.
[DisplayName <String>]:
[DomainCreationDateTime <DateTime?>]:
[DomainName <String>]:
[DomainOwner <String>]:
[FromAddress <String>]: The sender email address in the mail From header, also known as the envelope sender or the P1 sender.
[Ipv4 <String>]: The IPv4 address of the last detected mail server that relayed the message.
[Location <String>]:
[MailFromAddress <String>]: The sender email address in the From header, which is visible to email recipients on their email clients.
Also known as P2 sender.
[MailFromDomainName <String>]:
[SizeInBytes <Int32?>]: Size of the email in bytes.
[SpamConfidenceLevel <String>]: Spam confidence of the email.