Get-AzureRmMetricDefinition
Gets metric definitions.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Get-AzureRmMetricDefinition
[-ResourceId] <String>
[-MetricName <String[]>]
[-MetricNamespace <String>]
[-DetailedOutput]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzureRmMetricDefinition cmdlet gets metric definitions.
Examples
Example 1: Get metric definitions for a resource
PS C:\>Get-AzureRmMetricDefinition -ResourceId "/subscriptions/d33fb0c7-69d3-40be-e35b-4f0deba70fff/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website2"
Name : CpuTime
Dimensions : {}
MetricAvailabilities : {Microsoft.Azure.Insights.Models.MetricAvailability,
Microsoft.Azure.Insights.Models.MetricAvailability,
Microsoft.Azure.Insights.Models.MetricAvailability}
PrimaryAggregationType : Total
Properties : {}
ResourceUri :
Unit : Seconds
Name : Requests
Dimensions : {}
MetricAvailabilities : {Microsoft.Azure.Insights.Models.MetricAvailability,
Microsoft.Azure.Insights.Models.MetricAvailability,
Microsoft.Azure.Insights.Models.MetricAvailability}
PrimaryAggregationType : Total
Properties : {}
ResourceUri :
Unit : Count
This command gets the metrics definitions for the specified resource.
Example 2: Get metric definitions with detailed output
PS C:\>Get-AzureRmMetricDefinition -ResourceId "/subscriptions/d33fb0c7-69d3-40be-e35b-4f0deba70fff/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website2" -DetailedOutput
Dimensions :
MetricAvailabilities :
Location :
Retention : 2.00:00:00
Values : 00:01:00
Location :
Retention : 30.00:00:00
Values : 01:00:00
Location :
Retention : 90.00:00:00
Values : 1.00:00:00
Name : CpuTime
Properties :
PrimaryAggregationType : Total
ResourceUri :
Unit : Seconds
Dimensions :
MetricAvailabilities :
Location :
Retention : 2.00:00:00
Values : 00:01:00
Location :
Retention : 30.00:00:00
Values : 01:00:00
Location :
Retention : 90.00:00:00
Values : 1.00:00:00
Name : Requests
Properties :
PrimaryAggregationType : Total
ResourceUri :
Unit : Count
This command gets the metric definitions for website2. The output is detailed.
Example 3: Get metric definitions by name
PS C:\>Get-AzureRmMetricDefinition -ResourceId "/subscriptions/d33fb0c7-69d3-40be-e35b-4f0deba70fff/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website2" -DetailedOutput -MetricNames "BytesSent,CpuTime"
MetricAvailabilities :
Location :
Retention : 2.00:00:00
Values : 00:01:00
Location :
Retention : 30.00:00:00
Values : 01:00:00
Location :
Retention : 90.00:00:00
Values : 1.00:00:00
Name : CpuTime
Properties :
PrimaryAggregationType : Total
ResourceUri :
Unit : Seconds
Dimensions :
MetricAvailabilities :
Location :
Retention : 2.00:00:00
Values : 00:01:00
Location :
Retention : 30.00:00:00
Values : 01:00:00
Location :
Retention : 90.00:00:00
Values : 1.00:00:00
Name : BytesSent
Properties :
PrimaryAggregationType : Total
ResourceUri :
Unit : Bytes
This command gets definitions for the BytesSent and CpuTime metrics. The output is detailed.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DetailedOutput
Indicates that this operation included detailed output. If you do not specify this parameter, the output is summarized.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MetricName
Specifies an array of names of metrics.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-MetricNamespace
Specifies the metric namespace to query metric definitions for.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceId
Specifies the resource ID.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
String[]