Skip to content

Commit

Permalink
Fix example output don't match actual cmdlet (#25570)
Browse files Browse the repository at this point in the history
  • Loading branch information
@JoyerJin
JoyerJin authored Jul 23, 2024
1 parent 4f60073 commit 56c6bed
Showing 1 changed file with 41 additions and 134 deletions.
175 changes: 41 additions & 134 deletions src/Monitor/Monitor/help/Get-AzMetric.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,28 +40,16 @@ Get-AzMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/re
```

```output
DimensionName :
DimensionValue :
Name : AverageResponseTime
EndTime : 3/20/2015 6:40:46 PM
MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue,
Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...}
Properties : {}
ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3
StartTime : 3/20/2015 5:40:00 PM
TimeGrain : 00:01:00
Unit : Seconds
DimensionName :
DimensionValue :
Name : AverageMemoryWorkingSet
EndTime : 3/20/2015 6:40:46 PM
MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue,
Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...}
Properties : {}
ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3
StartTime : 3/20/2015 5:40:00 PM
TimeGrain : 00:01:00
Unit : Bytes
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}
```

This command gets the metric values for website3 with a time grain of 1 minute.
Expand All @@ -72,137 +60,56 @@ Get-AzMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/re
```

```output
MetricValues :
Average : 0
Count : 1
Last :
Maximum :
Minimum :
Properties :
Timestamp : 3/20/2015 6:37:00 PM
Total : 0
Average : 0.106
Count : 1
Last :
Maximum :
Minimum :
Properties :
Timestamp : 3/20/2015 6:39:00 PM
Total : 0.106
Average : 0.064
Count : 1
Last :
Maximum :
Minimum :
Properties :
Timestamp : 3/20/2015 6:41:00 PM
Total : 0.064
Properties :
DimensionName :
DimensionValue :
Name : AverageResponseTime
EndTime : 3/20/2015 6:43:33 PM
ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3
StartTime : 3/20/2015 5:43:00 PM
TimeGrain : 00:01:00
Unit : Seconds
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}
```

This command gets the metric values for website3 with a time grain of 1 minute.
The output is detailed.

### Example 3: Get detailed output for a specified metric
### Example 3: Get a specified metric
```powershell
Get-AzMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3" -MetricName "Requests" -TimeGrain 00:01:00 -DetailedOutput
Get-AzMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3" -MetricName "Requests" -TimeGrain 00:01:00
```

```output
MetricValues :
Average : 1
Count : 1
Last :
Maximum :
Minimum :
Properties :
Timestamp : 3/20/2015 6:39:00 PM
Total : 1
Average : 1
Count : 1
Last :
Maximum :
Minimum :
Properties :
Timestamp : 3/20/2015 6:41:00 PM
Total : 1
Average : 0
Count : 1
Last :
Maximum :
Minimum :
Properties :
Timestamp : 3/20/2015 6:43:00 PM
Total : 0
Average : 1
Count : 1
Last :
Maximum :
Minimum :
Properties :
Timestamp : 3/20/2015 6:44:00 PM
Total : 1
Average : 0
Count : 1
Last :
Maximum :
Minimum :
Properties :
Timestamp : 3/20/2015 6:45:00 PM
Total : 0
Properties :
DimensionName :
DimensionValue :
Name : Requests
EndTime : 3/20/2015 6:47:56 PM
ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3
StartTime : 3/20/2015 5:47:00 PM
TimeGrain : 00:01:00
Unit : Count
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}
```

This command gets detailed output for the Requests metric.

### Example 4: Get summarized output for a specified metric with specified dimension filter
```powershell
$dimFilter = "$(New-AzMetricFilter -Dimension City -Operator eq -Value "Seattle","Toronto") and $(New-AzMetricFilter -Dimension AuthenticationType -Operator eq -Value User)"
$dimFilter = New-AzMetricFilter -Dimension availabilityResult/location -Operator eq -Value "Seattle","Toronto"
Get-AzMetric -ResourceId <resourceId> -MetricName PageViews -TimeGrain 00:05:00 -MetricFilter $dimFilter -StartTime 2018-02-01T12:00:00Z -EndTime 2018-02-01T12:10:00Z -AggregationType Average
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
```

```output
ResourceId : [ResourceId]
MetricNamespace : Microsoft.Insights/ApplicationInsights
Metric Name :
LocalizedValue : Page Views
Value : PageViews
Unit : Seconds
Timeseries :
City : Seattle
AuthenticationType : User
Timestamp : 2018-02-01 12:00:00 PM
Average : 3518
Timestamp : 2018-02-01 12:05:00 PM
Average : 1984
City : Toronto
AuthenticationType : User
Timestamp : 2018-02-01 12:00:00 PM
Average : 894
Timestamp : 2018-02-01 12:05:00 PM
Average : 967
Id : [ResourceId]/providers/Microsoft.Insights/metrics/availabilityResults/availabilityPercentage
Name :
LocalizedValue : Availability
Value : availabilityResults/availabilityPercentage
Type : Microsoft.Insights/metrics
Unit : Percent
Data :
Timeseries : {}
```

This command gets summarized output for the PageViews metric with specified dimension filter and aggregation type.
Expand Down

0 comments on commit 56c6bed

Please sign in to comment.