Поделиться через

Invoke-AzOperationalInsightsQuery

Модуль:
Az.OperationalInsights Module

Возвращает результаты поиска на основе указанных параметров.

Синтаксис

ByWorkspaceId (по умолчанию) 

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>]

Описание

Командлет Invoke-AzOperationalInsightsQuery возвращает результаты поиска на основе указанных параметров. Вы можете получить доступ к состоянию поиска в свойстве метаданных возвращаемого объекта. Если состояние ожидается, поиск не завершен, и результаты будут находиться в архиве. Результаты поиска можно получить из свойства Value возвращаемого объекта. Ознакомьтесь с подробными сведениями об общих ограничениях запросов: https://learn.microsoft.com/azure/azure-monitor/service-limits#log-queries-and-language

Примечание. Попробуйте задать -Wait большее значение, если возникла ошибка "Запрос был отменен из-за настроенного httpClient.Timeout в 100 секунд истекает".

Примеры

Пример 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

Запуск командлета в фоновом режиме

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure.

Свойства параметра

Тип:IAzureContextContainer
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-IncludeRender

Если задано, в ответ будут включены сведения о отрисовке запросов метрик.

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-IncludeStatistics

Если задано, статистика запросов будет включена в ответ.

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Query

Выполняемый запрос.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Timespan

Интервал времени для привязки запроса.

Свойства параметра

Тип:

Nullable<T>[TimeSpan]

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Wait

Помещает верхнюю границу на время, которое сервер будет тратить на обработку запроса. См.: https://learn.microsoft.com/azure/azure-monitor/logs/api/timeouts

Свойства параметра

Тип:

Nullable<T>[Int32]

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Workspace

Рабочая область

Свойства параметра

Тип:PSWorkspace
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

ByWorkspaceObject
Position:Named
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-WorkspaceId

Идентификатор рабочей области.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

ByWorkspaceId
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Входные данные

PSWorkspace

Выходные данные

PSQueryResponse