Get-AzureRmAppServicePlanMetrics

Reference

Module:: AzureRM.Websites

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-AzureRmAppServicePlanMetrics
   [-Metrics] <String[]>
   [-StartTime] <DateTime>
   [[-EndTime] <DateTime>]
   [-Granularity] <String>
   [-InstanceDetails]
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmAppServicePlanMetrics
   [-Metrics] <String[]>
   [-StartTime] <DateTime>
   [[-EndTime] <DateTime>]
   [-Granularity] <String>
   [-InstanceDetails]
   [-AppServicePlan] <PSAppServicePlan>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmAppServicePlanMetrics gets App Service Plan metrics.

Examples

1:

PS C:\>Get-AzureRmAppServicePlanMetrics -ResourceGroupName "Default-Web-WestUS" -Name "ContosoAppServPlan" -StartTime 2016-11-30T22:00:00Z -EndTime 2016-11-30T22:30:00Z -Granularity PT1M -Metrics "CPU Percentage"

This command gets CPU percentage of the App Service Plan per minute(PT1M - Poll Time 1 minute) between StartTime and EndTime

Parameters

-AppServicePlan

App Service Plan Object

Type:	PSAppServicePlan
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-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

-EndTime

End Time in UTC

Type:	Nullable<T>[DateTime]
Position:	4
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Granularity

Granularity

Type:	String
Accepted values:	PT1M, PT1H, P1D
Position:	5
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InstanceDetails

Instance Details

Type:	SwitchParameter
Position:	6
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Metrics

Metrics

Type:	String[]
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

App Service Plan Name

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Resource Group Name

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-StartTime

Start Time in UTC

Type:	DateTime
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

AppServicePlan

Parameters: AppServicePlan (ByValue)

Outputs

Microsoft.Azure.Management.WebSites.Models.ResourceMetric

Share via