Get-AzMetric

Moduł:

Az.Monitor Module

Pobiera wartości metryk zasobu.

Składnia

GetWithDefaultParameters (domyślnie)

Get-AzMetric
    [-ResourceId] <String>
    [[-MetricName] <String[]>]
    [-TimeGrain <TimeSpan>]
    [-StartTime <DateTime>]
    [-EndTime <DateTime>]
    [-MetricFilter <String>]
    [-Dimension <String[]>]
    [-DetailedOutput]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

GetWithFullParameters

Get-AzMetric
    [-ResourceId] <String>
    [-MetricName] <String[]>
    [-TimeGrain <TimeSpan>]
    [-AggregationType <AggregationType>]
    [-StartTime <DateTime>]
    [-EndTime <DateTime>]
    [-Top <Int32>]
    [-OrderBy <String>]
    [-MetricNamespace <String>]
    [-ResultType <ResultType>]
    [-MetricFilter <String>]
    [-Dimension <String[]>]
    [-DetailedOutput]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Opis

Polecenie cmdlet Get-AzMetric pobiera wartości metryk dla określonego zasobu.

Przykłady

Przykład 1. Pobieranie metryki z podsumowanymi danymi wyjściowymi

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}

To polecenie pobiera wartości metryk dla witryny web3 z ziarnem czasu 1 minuty.

Przykład 2. Pobieranie metryki ze szczegółowymi danymi wyjściowymi

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}

To polecenie pobiera wartości metryk dla witryny web3 z ziarnem czasu 1 minuty. Dane wyjściowe są szczegółowe.

Przykład 3. Pobieranie określonej metryki

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}

To polecenie pobiera szczegółowe dane wyjściowe dla metryki Żądania.

Przykład 4. Pobieranie podsumowanych danych wyjściowych dla określonej metryki z określonym filtrem wymiaru

$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 : {}

To polecenie pobiera podsumowane dane wyjściowe dla metryki PageViews z określonym filtrem wymiaru i typem agregacji.

Parametry

-AggregationType

Typ agregacji zapytania

Właściwości parametru

Typ:	Nullable<T>[Microsoft.Azure.Management.Monitor.Models.AggregationType]
Domyślna wartość:	None
Dopuszczalne wartości:	None, Average, Count, Minimum, Maximum, Total
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

GetWithFullParameters

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Właściwości parametru

Typ:	IAzureContextContainer
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	AzContext, AzureRmContext, AzureCredential

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-DetailedOutput

Wskazuje, że to polecenie cmdlet wyświetla szczegółowe dane wyjściowe. Domyślnie dane wyjściowe są sumowane.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-Dimension

Wymiary metryki do wykonywania zapytań o metryki dla

Właściwości parametru

Typ:	String[]
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-EndTime

Określa godzinę zakończenia zapytania w czasie lokalnym. Wartość domyślna to bieżąca godzina.

Właściwości parametru

Typ:	DateTime
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-MetricFilter

Określa filtr wymiaru metryki do wykonywania zapytań o metryki.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-MetricName

Określa tablicę nazw metryk.

Właściwości parametru

Typ:	String[]
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	MetricNames

Zestawy parametrów

GetWithDefaultParameters

Position:	1
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-MetricNamespace

Określa przestrzeń nazw metryki do wykonywania zapytań o metryki.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

GetWithFullParameters

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-OrderBy

Określa agregację do użycia do sortowania wyników i kierunku sortowania (Przykład: sum asc).

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

GetWithFullParameters

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-ResourceId

Określa identyfikator zasobu metryki.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	0
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-ResultType

Określa typ wyniku, który ma zostać zwrócony (metadane lub dane).

Właściwości parametru

Typ:	Nullable<T>[Microsoft.Azure.Management.Monitor.Models.ResultType]
Domyślna wartość:	None
Dopuszczalne wartości:	Data, Metadata
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

GetWithFullParameters

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-StartTime

Określa godzinę rozpoczęcia zapytania w czasie lokalnym. Wartość domyślna to bieżący czas lokalny minus jedna godzina.

Właściwości parametru

Typ:	DateTime
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-TimeGrain

Określa ziarno czasu metryki jako obiekt TimeSpan w formacie hh:mm:ss.

Właściwości parametru

Typ:	TimeSpan
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-Top

Określa maksymalną liczbę rekordów do pobrania (wartość domyślna:10), która ma zostać określona przy użyciu $filter.

Właściwości parametru

Typ:	Nullable<T>[Int32]
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

GetWithFullParameters

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

String

TimeSpan

Nullable<T>

DateTime

Nullable<T>

Nullable<T>

String

SwitchParameter

Dane wyjściowe

PSMetric

Uwagi

Więcej informacji na temat obsługiwanych metryk można znaleźć na stronie: https://learn.microsoft.com/azure/azure-monitor/platform/metrics-supported

Linki powiązane

• Get-AzMetricDefinition
• New-AzMetricFilter