Get-AzMetric
Возвращает значения метрик ресурса.
Синтаксис
Get-AzMetric
[-ResourceId] <String>
[-TimeGrain <TimeSpan>]
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-MetricFilter <String>]
[-Dimension <String[]>]
[[-MetricName] <String[]>]
[-DetailedOutput]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzMetric
[-ResourceId] <String>
[-TimeGrain <TimeSpan>]
[-AggregationType <AggregationType>]
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-Top <Int32>]
[-OrderBy <String>]
[-MetricNamespace <String>]
[-ResultType <ResultType>]
[-MetricFilter <String>]
[-Dimension <String[]>]
[-MetricName] <String[]>
[-DetailedOutput]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Описание
Командлет Get-AzMetric получает значения метрик для указанного ресурса.
Примеры
Пример 1. Получение метрики с сводными выходными данными
Get-AzMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3" -TimeGrain 00:01:00
Id : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3/providers/Microsoft.Insights/metrics/Requests
Name :
LocalizedValue : Requests
Value : Requests
Type : Microsoft.Insights/metrics
Unit : Count
Data : {Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricValue, Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricValue,
Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricValue, Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricValue…}
Timeseries : {Microsoft.Azure.Management.Monitor.Models.TimeSeriesElement}
Эта команда получает значения метрик для веб-сайта3 с интервалом времени в 1 минуту.
Пример 2. Получение метрики с подробными выходными данными
Get-AzMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3" -TimeGrain 00:01:00 -DetailedOutput
Id : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3/providers/Microsoft.Insights/metrics/Requests
Name : Microsoft.Azure.Management.Monitor.Models.LocalizableString
Type : Microsoft.Insights/metrics
Unit : Count
Data : {Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricValue, Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricValue,
Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricValue, Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricValue…}
Timeseries : {Microsoft.Azure.Management.Monitor.Models.TimeSeriesElement}
Эта команда получает значения метрик для веб-сайта3 с интервалом времени в 1 минуту. Выходные данные подробно описаны.
Пример 3. Получение указанной метрики
Get-AzMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3" -MetricName "Requests" -TimeGrain 00:01:00
Id : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3/providers/Microsoft.Insights/metrics/Requests
Name :
LocalizedValue : Requests
Value : Requests
Type : Microsoft.Insights/metrics
Unit : Count
Data : {Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricValue, Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricValue,
Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricValue, Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricValue…}
Timeseries : {Microsoft.Azure.Management.Monitor.Models.TimeSeriesElement}
Эта команда получает подробные выходные данные для метрики запросов.
Пример 4. Получение суммированных выходных данных для указанной метрики с указанным фильтром измерений
$dimFilter = "$(New-AzMetricFilter -Dimension City -Operator eq -Value "Seattle","Toronto") and $(New-AzMetricFilter -Dimension AuthenticationType -Operator eq -Value User)"
Get-AzMetric -ResourceId <ResourceId> -MetricName availabilityResults/availabilityPercentage -TimeGrain 00:05:00 -MetricFilter $dimFilter -StartTime 2024-07-02T00:00:00Z -EndTime 2024-07-02T00:10:00Z -AggregationType Average
Id : [ResourceId]/providers/Microsoft.Insights/metrics/availabilityResults/availabilityPercentage
Name :
LocalizedValue : Availability
Value : availabilityResults/availabilityPercentage
Type : Microsoft.Insights/metrics
Unit : Percent
Data :
Timeseries : {}
Эта команда получает суммированные выходные данные для метрики PageViews с указанным фильтром измерений и типом агрегирования.
Параметры
-AggregationType
Тип агрегирования запроса
Тип: | Nullable<T>[AggregationType] |
Допустимые значения: | None, Average, Count, Minimum, Maximum, Total |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-DefaultProfile
Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure.
Тип: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-DetailedOutput
Указывает, что этот командлет отображает подробные выходные данные. По умолчанию выходные данные суммируются.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-Dimension
Измерения метрик для запроса метрик
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-EndTime
Указывает время окончания запроса в локальном времени. Значение по умолчанию — текущее время.
Тип: | DateTime |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-MetricFilter
Указывает фильтр измерения метрик для запроса метрик.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-MetricName
Задает массив имен метрик.
Тип: | String[] |
Aliases: | MetricNames |
Position: | 1 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-MetricNamespace
Указывает пространство имен метрик для запроса метрик.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-OrderBy
Указывает агрегирование, используемое для сортировки результатов и направление сортировки (пример: sum asc).
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ResourceId
Указывает идентификатор ресурса метрики.
Тип: | String |
Position: | 0 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ResultType
Указывает тип результата, возвращаемый (метаданные или данные).
Тип: | Nullable<T>[ResultType] |
Допустимые значения: | Data, Metadata |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-StartTime
Указывает время начала запроса в локальном времени. По умолчанию используется текущее локальное время минус один час.
Тип: | DateTime |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-TimeGrain
Задает интервал времени для метрики в виде объекта TimeSpan в формате hh:mm:ss.
Тип: | TimeSpan |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-Top
Указывает максимальное количество записей для получения (по умолчанию:10), которое необходимо указать с помощью $filter.
Тип: | Nullable<T>[Int32] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
Входные данные
Nullable<T>[[Microsoft.Azure.Management.Monitor.Models.AggregationType, Microsoft.Azure.Management.Monitor, Version=0.21.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
Nullable<T>[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Nullable<T>[[Microsoft.Azure.Management.Monitor.Models.ResultType, Microsoft.Azure.Management.Monitor, Version=0.21.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
String[]
Выходные данные
Примечания
Дополнительные сведения о поддерживаемых метриках можно найти по адресу: https://learn.microsoft.com/azure/azure-monitor/platform/metrics-supported