Invoke-AzOperationalInsightsQuery

リファレンス

モジュール:: Az.OperationalInsights

指定したパラメーターに基づいて検索結果を返します。

構文

Invoke-AzOperationalInsightsQuery
      -WorkspaceId <String>
      -Query <String>
      [-Timespan <TimeSpan>]
      [-Wait <Int32>]
      [-IncludeRender]
      [-IncludeStatistics]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Invoke-AzOperationalInsightsQuery
      -Workspace <PSWorkspace>
      -Query <String>
      [-Timespan <TimeSpan>]
      [-Wait <Int32>]
      [-IncludeRender]
      [-IncludeStatistics]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

説明

Invoke-AzOperationalインサイトQuery コマンドレットは、指定されたパラメーターに基づいて検索結果を返します。検索の状態には、返されたオブジェクトの Metadata プロパティでアクセスできます。状態が [保留中] の場合、検索は完了せず、結果はアーカイブから取得されます。検索の結果は、返されたオブジェクトの Value プロパティから取得できます。一般的なクエリ制限の詳細については、以下をチェックhttps://learn.microsoft.com/azure/azure-monitor/service-limits#log-queries-and-languageしてください。

例

例 1: クエリを使用して検索結果を取得する

$query = "union * | take 10"
$queryResults = Invoke-AzOperationalInsightsQuery -WorkspaceId "63613592-b6f7-4c3d-a390-22ba13102111" -Query $query
$queryResults.Results

呼び出されると、$queryResults.Results には、クエリから得られるすべての行が含まれます。

例 2: $resultsを変換します。配列に対する結果 IEnumerable

$query = "union * | take 10"
$queryResults = Invoke-AzOperationalInsightsQuery -WorkspaceId "63613592-b6f7-4c3d-a390-22ba13102111" -Query $query
$resultsArray = [System.Linq.Enumerable]::ToArray($queryResults.Results)

クエリによっては、非常に大きなデータセットが返される場合があります。このため、このコマンドレットの既定の動作では、メモリコストを削減するために IEnumerable を返します。結果の配列を作成する場合は、LINQ Enumerable.ToArray() 拡張メソッドを使用して、IEnumerable を配列に変換できます。

例 3: 特定の期間のクエリを使用して検索結果を取得する

$query = "union * | take 10"
$queryResults = Invoke-AzOperationalInsightsQuery -WorkspaceId "63613592-b6f7-4c3d-a390-22ba13102111" -Query $query -Timespan (New-TimeSpan -Hours 24)
$queryResults.Results

このクエリの結果は、過去 24 時間に制限されます。

例 4: クエリ結果にレンダリングと統計を含める

$query = "union * | take 10"
$queryResults = Invoke-AzOperationalInsightsQuery -WorkspaceId "63613592-b6f7-4c3d-a390-22ba13102111" -Query $query -IncludeRender -IncludeStatistics
$queryResults.Results

$queryResults.Render

$queryResults.Statistics

パラメーター

-AsJob

バックグラウンドでコマンドレットを実行する

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IncludeRender

指定した場合、メトリッククエリのレンダリング情報が応答に含まれます。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IncludeStatistics

指定した場合、クエリ統計が応答に含まれます。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Query

実行するクエリ。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Timespan

クエリをバインドする期間。

Type:	Nullable<T>[TimeSpan]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Wait

サーバーがクエリの処理に費やす時間の上限を設定します。

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Workspace

ワークスペース

Type:	PSWorkspace
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WorkspaceId

ワークスペース ID。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

入力

PSWorkspace

出力

PSQueryResponse