Compartilhar via

Invoke-AzOperationalInsightsQuery

Módulo:
Az.OperationalInsights Module

Retorna os resultados da pesquisa com base nos parâmetros especificados.

Sintaxe

ByWorkspaceId (Default) 

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

ByWorkspaceObject 

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

Description

O cmdlet Invoke-AzOperationalInsightsQuery retorna os resultados da pesquisa com base nos parâmetros especificados. Você pode acessar o status da pesquisa na propriedade Metadados do objeto retornado. Se o status estiver pendente, a pesquisa não foi concluída e os resultados serão do arquivo morto. Você pode recuperar os resultados da pesquisa da propriedade Value do objeto retornado. Verifique os detalhes dos limites gerais de consulta aqui: https://learn.microsoft.com/azure/azure-monitor/service-limits#log-queries-and-language.

Observação: tente definir -Wait como um valor maior se você tiver o erro "A solicitação foi cancelada devido ao HttpClient.Timeout configurado de 100 segundos decorridos".

Exemplos

Exemplo 1: Obter resultados da pesquisa usando uma consulta

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

Depois de invocado, $queryResults.Results conterá todas as linhas resultantes da consulta.

Exemplo 2: Converter $results. Resultado IEnumerable para uma matriz

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

Algumas consultas podem resultar em conjuntos de dados muito grandes sendo retornados. Por isso, o comportamento padrão do cmdlet é retornar um IEnumerable para reduzir os custos de memória. Se preferir ter uma matriz de resultados, use o método de extensão LINQ Enumerable.ToArray() para converter o IEnumerable em uma matriz.

Exemplo 3: Obter resultados da pesquisa usando uma consulta em um período específico

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

Os resultados dessa consulta serão limitados às últimas 24 horas.

Exemplo 4: Incluir renderização e estatísticas no resultado da consulta

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

$queryResults.Render

$queryResults.Statistics

Parâmetros

-AsJob

Executar cmdlet em segundo plano

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

Propriedades do parâmetro

Tipo:IAzureContextContainer
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-IncludeRender

Se especificado, as informações de renderização para consultas de métrica serão incluídas na resposta.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-IncludeStatistics

Se especificado, as estatísticas de consulta serão incluídas na resposta.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Query

A consulta a ser executada.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Timespan

O tempo limite pelo qual a consulta será associada.

Propriedades do parâmetro

Tipo:

Nullable<T>[TimeSpan]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Wait

Coloca um limite superior na quantidade de tempo que o servidor gastará processando a consulta. Confira: https://learn.microsoft.com/azure/azure-monitor/logs/api/timeouts

Propriedades do parâmetro

Tipo:

Nullable<T>[Int32]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Workspace

O workspace

Propriedades do parâmetro

Tipo:PSWorkspace
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ByWorkspaceObject
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WorkspaceId

O identificador do espaço de trabalho.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ByWorkspaceId
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSWorkspace

Saídas

PSQueryResponse