Partager via

Invoke-AzOperationalInsightsQuery

Module:
Az.OperationalInsights Module

Retourne les résultats de la recherche en fonction des paramètres spécifiés.

Syntaxe

ByWorkspaceId (Par défaut) 

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

L’applet de commande Invoke-AzOperationalInsightsQuery retourne les résultats de la recherche en fonction des paramètres spécifiés. Vous pouvez accéder à l’état de la recherche dans la propriété Métadonnées de l’objet retourné. Si l’état est En attente, la recherche n’est pas terminée et les résultats proviennent de l’archive. Vous pouvez récupérer les résultats de la recherche à partir de la propriété Value de l’objet retourné. Consultez les détails des limites de requête générales ici : https://learn.microsoft.com/azure/azure-monitor/service-limits#log-queries-and-language.

Remarque : essayez de définir -Wait une valeur supérieure si vous rencontrez l’erreur « La requête a été annulée en raison du délai d’expiration httpClient.Timeout configuré de 100 secondes ».

Exemples

Exemple 1 : Obtenir les résultats de la recherche à l’aide d’une requête

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

Une fois appelée, $queryResults.Results contiendra toutes les lignes résultantes de votre requête.

Exemple 2 : Convertir $results. Résultat IEnumerable dans un tableau

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

Certaines requêtes peuvent entraîner un retour de jeux de données très volumineux. En raison de cela, le comportement par défaut de l’applet de commande consiste à retourner un IEnumerable pour réduire les coûts de mémoire. Si vous préférez avoir un tableau de résultats, vous pouvez utiliser la méthode d’extension LINQ Enumerable.ToArray() pour convertir IEnumerable en tableau.

Exemple 3 : Obtenir des résultats de recherche à l’aide d’une requête sur une période spécifique

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

Les résultats de cette requête seront limités aux 24 dernières heures.

Exemple 4 : Inclure le rendu et les statistiques dans le résultat de la requête

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

$queryResults.Render

$queryResults.Statistics

Paramètres

-AsJob

Exécuter l’applet de commande en arrière-plan

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Propriétés du paramètre

Type:IAzureContextContainer
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-IncludeRender

Si elle est spécifiée, les informations de rendu des requêtes de métriques sont incluses dans la réponse.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-IncludeStatistics

Si elle est spécifiée, les statistiques de requête sont incluses dans la réponse.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Query

Requête à exécuter.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Timespan

Intervalle de temps pour lier la requête.

Propriétés du paramètre

Type:

Nullable<T>[TimeSpan]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Wait

Place une limite supérieure sur la durée pendant laquelle le serveur passe le traitement de la requête. Consultez : https://learn.microsoft.com/azure/azure-monitor/logs/api/timeouts

Propriétés du paramètre

Type:

Nullable<T>[Int32]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Workspace

Espace de travail

Propriétés du paramètre

Type:PSWorkspace
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByWorkspaceObject
Position:Named
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-WorkspaceId

Identifiant de l’espace de travail.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByWorkspaceId
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

PSWorkspace

Sorties

PSQueryResponse