你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Get-AzureRmOperationalInsightsSearchResults

基于指定的参数返回搜索结果。

警告

截至 2024 年 2 月 29 日,AzureRM PowerShell 模块已正式弃用。 为了确保持续获得支持和更新,建议用户从 AzureRM 迁移到 Az PowerShell 模块。

尽管 AzureRM 模块仍可能正常运行,但它不再维护或受支持,但会根据用户的自由裁量权和风险继续使用任何继续使用模块。 有关过渡到 Az 模块的指导,请参阅我们的迁移资源

语法

Get-AzureRmOperationalInsightsSearchResults
   [-ResourceGroupName] <String>
   [-WorkspaceName] <String>
   [[-Top] <Int64>]
   [[-PreHighlight] <String>]
   [[-PostHighlight] <String>]
   [[-Query] <String>]
   [[-Start] <DateTime>]
   [[-End] <DateTime>]
   [[-Id] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

说明

Get-AzureRmOperationalInsightsSearchResults cmdlet 基于指定的参数返回搜索结果。 可以在返回对象的 Metadata 属性中访问搜索的状态。 如果状态为“挂起”,则搜索尚未完成,结果将从存档中获取。 可以从返回对象的 Value 属性检索搜索结果。

示例

示例 1:使用查询获取搜索结果

PS C:\>Get-AzureRmOperationalInsightsSearchResults -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -Query "Type=Event" -Top 100

此命令使用查询获取所有搜索结果。

示例 2:使用 ID 获取搜索结果

PS C:\>Get-AzureRmOperationalInsightsSearchResults -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -Id "ContosoSearchId"

此命令使用 ID 获取搜索结果。

示例 3:等待搜索完成,然后显示结果

PS C:\>$error.clear()
$response = @{}
$StartTime = Get-Date

$resGroup = "ContosoResourceGroup"
$wrkspace = "ContosoWorkspace"

# Sample Query
$query = "Type=Event"

# Get Initial response
$response = Get-AzureRmOperationalInsightsSearchResults -WorkspaceName $wrkspace -ResourceGroupName $resGroup -Query $query -Top 15000
$elapsedTime = $(get-date) - $script:StartTime
Write-Host "Elapsed: " $elapsedTime "Status: " $response.Metadata.Status

# Split and extract request Id
$reqIdParts = $response.Id.Split("/")
$reqId = $reqIdParts[$reqIdParts.Count -1]

# Poll if pending
while($response.Metadata.Status -eq "Pending" -and $error.Count -eq 0) {
    $response = Get-AzureRmOperationalInsightsSearchResults -WorkspaceName $wrkspace -ResourceGroupName $resGroup -Id $reqId
    $elapsedTime = $(get-date) - $script:StartTime
    Write-Host "Elapsed: " $elapsedTime "Status: " $response.Metadata.Status
}

Write-Host "Returned " $response.Value.Count " documents"
Write-Host $error

此脚本启动搜索并等待它完成,然后显示结果。

参数

-DefaultProfile

用于与 azure 通信的凭据、帐户、租户和订阅

类型:IAzureContextContainer
别名:AzureRmContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-End

查询时间范围的结束。

类型:Nullable<T>[DateTime]
Position:7
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-Id

如果给定 ID,将使用原始查询参数检索该 ID 的搜索结果。

类型:String
Position:8
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-PostHighlight

类型:String
Position:4
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-PreHighlight

类型:String
Position:3
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-Query

将执行的搜索查询。

类型:String
Position:5
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-ResourceGroupName

包含工作区的资源组的名称。

类型:String
Position:0
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-Start

查询时间范围的开始。

类型:Nullable<T>[DateTime]
Position:6
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-Top

要返回的最大结果数,限制为 5000。

类型:Int64
Position:2
默认值:10
必需:False
接受管道输入:True
接受通配符:False

-WorkspaceName

指定工作区名称。

类型:String
别名:Name
Position:1
默认值:None
必需:True
接受管道输入:True
接受通配符:False

输入

String

Int64

Nullable<T>[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

输出

PSSearchGetSearchResultsResponse