Get-ComplianceSearchAction

此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 某些参数和设置可能只属于一个环境或另一个环境。

使用 Get-ComplianceSearchAction cmdlet 查看有关合规性搜索作的信息。

有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法

语法

Identity

Get-ComplianceSearchAction
    [[-Identity] <ComplianceSearchActionIdParameter>]
    [-Case <String>]
    [-Details]
    [-DomainController <Fqdn>]
    [-IncludeCredential]
    [-Organization <OrganizationIdParameter>]
    [-ResultSize <Unlimited>]
    [<CommonParameters>]

Preview

Get-ComplianceSearchAction
    [-Preview]
    [-Case <String>]
    [-Details]
    [-DomainController <Fqdn>]
    [-IncludeCredential]
    [-Organization <OrganizationIdParameter>]
    [-ResultSize <Unlimited>]
    [<CommonParameters>]

Purge

Get-ComplianceSearchAction
    [-Purge]
    [-Case <String>]
    [-Details]
    [-DomainController <Fqdn>]
    [-IncludeCredential]
    [-Organization <OrganizationIdParameter>]
    [-ResultSize <Unlimited>]
    [<CommonParameters>]

Export

Get-ComplianceSearchAction
    [-Export]
    [-Case <String>]
    [-Details]
    [-DomainController <Fqdn>]
    [-IncludeCredential]
    [-Organization <OrganizationIdParameter>]
    [-ResultSize <Unlimited>]
    [<CommonParameters>]

说明

在使用 New-ComplianceSearch cmdlet 创建并运行合规性搜索,并使用 Start-ComplianceSearch cmdlet 开始搜索后,您可以使用 New-ComplianceSearchAction cmdlet 分配一个搜索操作。 使用 Get-ComplianceSearchAction cmdlet 可以跟踪合规性搜索操作的进度。

您必须先获得权限,然后才能运行此 cmdlet。 尽管本文列出了 cmdlet 的所有参数,但如果某些参数未包含在分配给你的权限中,则可能无法访问这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet

在本地 Exchange 中,此 cmdlet 在邮箱搜索角色中可用。 默认情况下,此角色仅分配给发现管理角色组。

要在安全与合规中心 PowerShell 中使用此 cmdlet,必须分配权限。 有关详细信息,请参阅 Microsoft Purview 合规门户中的权限

示例

示例 1

Get-ComplianceSearchAction

本示例显示所有合规性搜索操作的摘要列表。

示例 2

Get-ComplianceSearchAction -Identity "Case 1234_Preview" | Format-List

本示例显示有关名为“案例 1234_Preview”的合规性搜索操作的详细信息

参数

-Case

适用:安全 & 合规性

此参数仅在基于云的服务中可用。

Case 参数按指定事例的名称筛选结果。 如果值包含空格,则使用引号括住该值。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Details

适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全 & 符合性

Details 开关指定是否在结果中包括详细信息。 不必为此开关指定值。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DomainController

适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全 & 符合性

此参数仅在本地 Exchange 中有效。

DomainController 参数指定此 cmdlet 从 Active Directory 读取数据或向其写入数据时使用的域控制器。 可以使用完全限定的域名 (FQDN) 来标识域控制器。 例如,dc01.contoso.com。

参数属性

类型:Fqdn
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Export

适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全 & 符合性

注意:在 2025 年 5 月 26 日之后,此参数不再有效。 有关详细信息,请参阅即将对Microsoft Purview 电子数据展示进行更改

Export 开关按 Export 合规性搜索操作筛选结果。 不必为此开关指定值。

不能将此开关与“标识”、“预览”或“清除”参数一起使用。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

Export
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Identity

适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全 & 符合性

Identity 参数指定要查看的合规性搜索操作。 可以使用唯一标识合规性搜索操作的任何值。 例如:

  • 名称:符合性搜索作名称使用语法 "Compliance Search Name_Action"。 例如,"Case 1234_Preview"
  • JobRunId (GUID)

不能将此参数与“导出”、“预览”或“清除”参数一起使用。

使用 Identity 参数时,将在结果中返回更多详细信息。 例如:

  • 在“结果”行中,将填充“项计数”、“总大小”和“详细信息”属性的值。
  • 位置线将添加到结果中。
  • 将填充 NumBindings 属性值。 此属性包括主邮箱、主存档以及搜索中包含的用户的任何其他存档。 NumBindings 不是搜索中包含的用户数,因为每个包含的用户可能具有或没有主邮箱、主存档和其他存档的组合。
  • 受影响的位置属性 (例如,将填充 ExchangeLocation) 。
  • 将填充 CaseName 属性值。

参数属性

类型:ComplianceSearchActionIdParameter
默认值:None
支持通配符:False
不显示:False

参数集

Identity
Position:1
必需:False
来自管道的值:True
来自管道的值(按属性名称):True
来自剩余参数的值:False

-IncludeCredential

适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全 & 符合性

IncludeCredential 开关指定是否在结果中包含凭据。 不必为此开关指定值。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Organization

适用:安全 & 合规性

此参数仅在基于云的服务中可用。

保留此参数以供 Microsoft 内部使用。

参数属性

类型:OrganizationIdParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Preview

适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全 & 符合性

Preview 开关按 Preview 合规性搜索操作筛选结果。 不必为此开关指定值。

不能将此开关与“导出”、“标识”或“清除”参数一起使用。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

Preview
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Purge

适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全 & 符合性

注意:在安全 & 合规性 PowerShell 中,此参数仅在“搜索和清除”角色中可用。 默认情况下,此角色仅分配给组织管理和数据调查员角色组。

Purge 开关按 Purge 合规性搜索操作筛选结果。 不必为此开关指定值。

不能将此开关与导出、标识或预览参数一起使用。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

Purge
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ResultSize

适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全 & 符合性

ResultSize 参数指定了要返回的结果的最大数量。 若要返回所有与查询相匹配的请求,则请将此参数的值设为无限制。 默认值为 1000。

参数属性

类型:Unlimited
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters